AAPT2: XML configuration file parser.
The XML file is parsed with the aapt::xml::XmlDom parser and actions are
used for the elements we are interested in. This means that there are
cases where a user could add aditional tags/elements to the document
that are technically invalid (acording to the schema) but are ignored by
the parser. This allows us to be more lenient which probably isn't a bad
thing.
Documents have the namespace stripped before processing as the
XmlActionExecutor ignores any elements with a namespace. The namespace
is validated before being removed.
The test cases are all based off the previous example XML file.
Test: Unit tests
Change-Id: I86d7e0dc6347ace3eaa60c1842d59f3cd0d4f749
diff --git a/tools/aapt2/configuration/ConfigurationParser_test.cpp b/tools/aapt2/configuration/ConfigurationParser_test.cpp
new file mode 100644
index 0000000..72a97b2
--- /dev/null
+++ b/tools/aapt2/configuration/ConfigurationParser_test.cpp
@@ -0,0 +1,401 @@
+/*
+ * Copyright (C) 2017 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "configuration/ConfigurationParser.h"
+
+#include <string>
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "androidfw/ResourceTypes.h"
+
+#include "test/Test.h"
+#include "xml/XmlDom.h"
+
+namespace aapt {
+namespace {
+
+using android::ResTable_config;
+using configuration::Abi;
+using configuration::AndroidSdk;
+using configuration::Configuration;
+using configuration::DeviceFeature;
+using configuration::GlTexture;
+using configuration::Locale;
+using configuration::AndroidManifest;
+using testing::ElementsAre;
+using xml::Element;
+using xml::NodeCast;
+
+constexpr const char* kValidConfig = R"(<?xml version="1.0" encoding="utf-8" ?>
+<post-process xmlns="http://schemas.android.com/tools/aapt">
+ <groups>
+ <abi-group label="arm">
+ <abi>armeabi-v7a</abi>
+ <abi>arm64-v8a</abi>
+ </abi-group>
+ <abi-group label="other">
+ <abi>x86</abi>
+ <abi>mips</abi>
+ </abi-group>
+ <screen-density-group label="large">
+ <screen-density>xhdpi</screen-density>
+ <screen-density>xxhdpi</screen-density>
+ <screen-density>xxxhdpi</screen-density>
+ </screen-density-group>
+ <screen-density-group label="alldpi">
+ <screen-density>ldpi</screen-density>
+ <screen-density>mdpi</screen-density>
+ <screen-density>hdpi</screen-density>
+ <screen-density>xhdpi</screen-density>
+ <screen-density>xxhdpi</screen-density>
+ <screen-density>xxxhdpi</screen-density>
+ </screen-density-group>
+ <locale-group label="europe">
+ <locale lang="en"/>
+ <locale lang="es"/>
+ <locale lang="fr"/>
+ <locale lang="de"/>
+ </locale-group>
+ <locale-group label="north-america">
+ <locale lang="en"/>
+ <locale lang="es" region="MX"/>
+ <locale lang="fr" region="CA"/>
+ </locale-group>
+ <locale-group label="all">
+ <locale/>
+ </locale-group>
+ <android-sdk-group label="19">
+ <android-sdk
+ minSdkVersion="19"
+ targetSdkVersion="24"
+ maxSdkVersion="25">
+ <manifest>
+ <!--- manifest additions here XSLT? TODO -->
+ </manifest>
+ </android-sdk>
+ </android-sdk-group>
+ <gl-texture-group label="dxt1">
+ <gl-texture name="GL_EXT_texture_compression_dxt1">
+ <texture-path>assets/dxt1/*</texture-path>
+ </gl-texture>
+ </gl-texture-group>
+ <device-feature-group label="low-latency">
+ <supports-feature>android.hardware.audio.low_latency</supports-feature>
+ </device-feature-group>
+ </groups>
+ <artifacts>
+ <artifact-format>
+ ${base}.${abi}.${screen-density}.${locale}.${sdk}.${gl}.${feature}.release
+ </artifact-format>
+ <artifact
+ name="art1"
+ abi-group="arm"
+ screen-density-group="large"
+ locale-group="europe"
+ android-sdk-group="19"
+ gl-texture-group="dxt1"
+ device-feature-group="low-latency"/>
+ <artifact
+ name="art2"
+ abi-group="other"
+ screen-density-group="alldpi"
+ locale-group="north-america"
+ android-sdk-group="19"
+ gl-texture-group="dxt1"
+ device-feature-group="low-latency"/>
+ </artifacts>
+</post-process>
+)";
+
+class ConfigurationParserTest : public ConfigurationParser, public ::testing::Test {
+ public:
+ ConfigurationParserTest() : ConfigurationParser("") {}
+
+ protected:
+ StdErrDiagnostics diag_;
+};
+
+TEST_F(ConfigurationParserTest, ValidateFile) {
+ auto parser = ConfigurationParser::ForContents(kValidConfig).WithDiagnostics(&diag_);
+ auto result = parser.Parse();
+ ASSERT_TRUE(result);
+ Configuration& value = result.value();
+ EXPECT_EQ(2ul, value.artifacts.size());
+ ASSERT_TRUE(value.artifact_format);
+ EXPECT_EQ(
+ "${base}.${abi}.${screen-density}.${locale}.${sdk}.${gl}.${feature}.release",
+ value.artifact_format.value()
+ );
+
+ EXPECT_EQ(2ul, value.abi_groups.size());
+ EXPECT_EQ(2ul, value.abi_groups["arm"].size());
+ EXPECT_EQ(2ul, value.abi_groups["other"].size());
+
+ EXPECT_EQ(2ul, value.screen_density_groups.size());
+ EXPECT_EQ(3ul, value.screen_density_groups["large"].size());
+ EXPECT_EQ(6ul, value.screen_density_groups["alldpi"].size());
+
+ EXPECT_EQ(3ul, value.locale_groups.size());
+ EXPECT_EQ(4ul, value.locale_groups["europe"].size());
+ EXPECT_EQ(3ul, value.locale_groups["north-america"].size());
+ EXPECT_EQ(1ul, value.locale_groups["all"].size());
+
+ EXPECT_EQ(1ul, value.android_sdk_groups.size());
+ EXPECT_EQ(1ul, value.android_sdk_groups["19"].size());
+
+ EXPECT_EQ(1ul, value.gl_texture_groups.size());
+ EXPECT_EQ(1ul, value.gl_texture_groups["dxt1"].size());
+
+ EXPECT_EQ(1ul, value.device_feature_groups.size());
+ EXPECT_EQ(1ul, value.device_feature_groups["low-latency"].size());
+}
+
+TEST_F(ConfigurationParserTest, InvalidNamespace) {
+ constexpr const char* invalid_ns = R"(<?xml version="1.0" encoding="utf-8" ?>
+ <post-process xmlns="http://schemas.android.com/tools/another-unknown-tool" />)";
+
+ auto result = ConfigurationParser::ForContents(invalid_ns).Parse();
+ ASSERT_FALSE(result);
+}
+
+TEST_F(ConfigurationParserTest, ArtifactAction) {
+ static constexpr const char* xml = R"xml(
+ <artifact
+ abi-group="arm"
+ screen-density-group="large"
+ locale-group="europe"
+ android-sdk-group="19"
+ gl-texture-group="dxt1"
+ device-feature-group="low-latency"/>)xml";
+
+ auto doc = test::BuildXmlDom(xml);
+
+ Configuration config;
+ bool ok = artifact_handler_(&config, NodeCast<Element>(doc.get()->root.get()), &diag_);
+ ASSERT_TRUE(ok);
+
+ EXPECT_EQ(1ul, config.artifacts.size());
+
+ auto& artifact = config.artifacts.begin()->second;
+ EXPECT_EQ("", artifact.name); // TODO: make this fail.
+ EXPECT_EQ("arm", artifact.abi_group.value());
+ EXPECT_EQ("large", artifact.screen_density_group.value());
+ EXPECT_EQ("europe", artifact.locale_group.value());
+ EXPECT_EQ("19", artifact.android_sdk_group.value());
+ EXPECT_EQ("dxt1", artifact.gl_texture_group.value());
+ EXPECT_EQ("low-latency", artifact.device_feature_group.value());
+}
+
+TEST_F(ConfigurationParserTest, ArtifactFormatAction) {
+ static constexpr const char* xml = R"xml(
+ <artifact-format>
+ ${base}.${abi}.${screen-density}.${locale}.${sdk}.${gl}.${feature}.release
+ </artifact-format>)xml";
+
+ auto doc = test::BuildXmlDom(xml);
+
+ Configuration config;
+ bool ok = artifact_format_handler_(&config, NodeCast<Element>(doc.get()->root.get()), &diag_);
+ ASSERT_TRUE(ok);
+ ASSERT_TRUE(config.artifact_format);
+ EXPECT_EQ(
+ "${base}.${abi}.${screen-density}.${locale}.${sdk}.${gl}.${feature}.release",
+ static_cast<std::string>(config.artifact_format.value())
+ );
+}
+
+TEST_F(ConfigurationParserTest, AbiGroupAction) {
+ static constexpr const char* xml = R"xml(
+ <abi-group label="arm">
+ <!-- First comment. -->
+ <abi>
+ armeabi-v7a
+ </abi>
+ <!-- Another comment. -->
+ <abi>arm64-v8a</abi>
+ </abi-group>)xml";
+
+ auto doc = test::BuildXmlDom(xml);
+
+ Configuration config;
+ bool ok = abi_group_handler_(&config, NodeCast<Element>(doc.get()->root.get()), &diag_);
+ ASSERT_TRUE(ok);
+
+ EXPECT_EQ(1ul, config.abi_groups.size());
+ ASSERT_EQ(1u, config.abi_groups.count("arm"));
+
+ auto& out = config.abi_groups["arm"];
+ ASSERT_THAT(out, ElementsAre(Abi::kArmV7a, Abi::kArm64V8a));
+}
+
+TEST_F(ConfigurationParserTest, ScreenDensityGroupAction) {
+ static constexpr const char* xml = R"xml(
+ <screen-density-group label="large">
+ <screen-density>xhdpi</screen-density>
+ <screen-density>
+ xxhdpi
+ </screen-density>
+ <screen-density>xxxhdpi</screen-density>
+ </screen-density-group>)xml";
+
+ auto doc = test::BuildXmlDom(xml);
+
+ Configuration config;
+ bool ok =
+ screen_density_group_handler_(&config, NodeCast<Element>(doc.get()->root.get()), &diag_);
+ ASSERT_TRUE(ok);
+
+ EXPECT_EQ(1ul, config.screen_density_groups.size());
+ ASSERT_EQ(1u, config.screen_density_groups.count("large"));
+
+ ConfigDescription xhdpi;
+ xhdpi.density = ResTable_config::DENSITY_XHIGH;
+ ConfigDescription xxhdpi;
+ xxhdpi.density = ResTable_config::DENSITY_XXHIGH;
+ ConfigDescription xxxhdpi;
+ xxxhdpi.density = ResTable_config::DENSITY_XXXHIGH;
+
+ auto& out = config.screen_density_groups["large"];
+ ASSERT_THAT(out, ElementsAre(xhdpi, xxhdpi, xxxhdpi));
+}
+
+TEST_F(ConfigurationParserTest, LocaleGroupAction) {
+ static constexpr const char* xml = R"xml(
+ <locale-group label="europe">
+ <locale lang="en"/>
+ <locale lang="es"/>
+ <locale lang="fr"/>
+ <locale lang="de"/>
+ </locale-group>)xml";
+
+ auto doc = test::BuildXmlDom(xml);
+
+ Configuration config;
+ bool ok = locale_group_handler_(&config, NodeCast<Element>(doc.get()->root.get()), &diag_);
+ ASSERT_TRUE(ok);
+
+ ASSERT_EQ(1ul, config.locale_groups.size());
+ ASSERT_EQ(1u, config.locale_groups.count("europe"));
+
+ auto& out = config.locale_groups["europe"];
+
+ Locale en;
+ en.lang = std::string("en");
+ Locale es;
+ es.lang = std::string("es");
+ Locale fr;
+ fr.lang = std::string("fr");
+ Locale de;
+ de.lang = std::string("de");
+
+ ASSERT_THAT(out, ElementsAre(en, es, fr, de));
+}
+
+TEST_F(ConfigurationParserTest, AndroidSdkGroupAction) {
+ static constexpr const char* xml = R"xml(
+ <android-sdk-group label="19">
+ <android-sdk
+ minSdkVersion="19"
+ targetSdkVersion="24"
+ maxSdkVersion="25">
+ <manifest>
+ <!--- manifest additions here XSLT? TODO -->
+ </manifest>
+ </android-sdk>
+ </android-sdk-group>)xml";
+
+ auto doc = test::BuildXmlDom(xml);
+
+ Configuration config;
+ bool ok = android_sdk_group_handler_(&config, NodeCast<Element>(doc.get()->root.get()), &diag_);
+ ASSERT_TRUE(ok);
+
+ ASSERT_EQ(1ul, config.android_sdk_groups.size());
+ ASSERT_EQ(1u, config.android_sdk_groups.count("19"));
+
+ auto& out = config.android_sdk_groups["19"];
+
+ AndroidSdk sdk;
+ sdk.min_sdk_version = std::string("19");
+ sdk.target_sdk_version = std::string("24");
+ sdk.max_sdk_version = std::string("25");
+ sdk.manifest = AndroidManifest();
+
+ ASSERT_EQ(1ul, out.size());
+ ASSERT_EQ(sdk, out[0]);
+}
+
+TEST_F(ConfigurationParserTest, GlTextureGroupAction) {
+ static constexpr const char* xml = R"xml(
+ <gl-texture-group label="dxt1">
+ <gl-texture name="GL_EXT_texture_compression_dxt1">
+ <texture-path>assets/dxt1/main/*</texture-path>
+ <texture-path>
+ assets/dxt1/test/*
+ </texture-path>
+ </gl-texture>
+ </gl-texture-group>)xml";
+
+ auto doc = test::BuildXmlDom(xml);
+
+ Configuration config;
+ bool ok = gl_texture_group_handler_(&config, NodeCast<Element>(doc.get()->root.get()), &diag_);
+ ASSERT_TRUE(ok);
+
+ EXPECT_EQ(1ul, config.gl_texture_groups.size());
+ ASSERT_EQ(1u, config.gl_texture_groups.count("dxt1"));
+
+ auto& out = config.gl_texture_groups["dxt1"];
+
+ GlTexture texture{
+ std::string("GL_EXT_texture_compression_dxt1"),
+ {"assets/dxt1/main/*", "assets/dxt1/test/*"}
+ };
+
+ ASSERT_EQ(1ul, out.size());
+ ASSERT_EQ(texture, out[0]);
+}
+
+TEST_F(ConfigurationParserTest, DeviceFeatureGroupAction) {
+ static constexpr const char* xml = R"xml(
+ <device-feature-group label="low-latency">
+ <supports-feature>android.hardware.audio.low_latency</supports-feature>
+ <supports-feature>
+ android.hardware.audio.pro
+ </supports-feature>
+ </device-feature-group>)xml";
+
+ auto doc = test::BuildXmlDom(xml);
+
+ Configuration config;
+ bool ok
+ = device_feature_group_handler_(&config, NodeCast<Element>(doc.get()->root.get()), &diag_);
+ ASSERT_TRUE(ok);
+
+ EXPECT_EQ(1ul, config.device_feature_groups.size());
+ ASSERT_EQ(1u, config.device_feature_groups.count("low-latency"));
+
+ auto& out = config.device_feature_groups["low-latency"];
+
+ DeviceFeature low_latency = "android.hardware.audio.low_latency";
+ DeviceFeature pro = "android.hardware.audio.pro";
+ ASSERT_THAT(out, ElementsAre(low_latency, pro));
+}
+
+} // namespace
+} // namespace aapt