tools/aapt2/link/XmlReferenceLinker_test.cpp

/*
 * Copyright (C) 2015 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 "link/Linkers.h"

#include "test/Test.h"

namespace aapt {

class XmlReferenceLinkerTest : public ::testing::Test {
 public:
  void SetUp() override {
    context_ =
        test::ContextBuilder()
            .SetCompilationPackage("com.app.test")
            .SetNameManglerPolicy(
                NameManglerPolicy{"com.app.test", {"com.android.support"}})
            .AddSymbolSource(
                test::StaticSymbolSourceBuilder()
                    .AddPublicSymbol(
                        "android:attr/layout_width", ResourceId(0x01010000),
                        test::AttributeBuilder()
                            .SetTypeMask(android::ResTable_map::TYPE_ENUM |
                                         android::ResTable_map::TYPE_DIMENSION)
                            .AddItem("match_parent", 0xffffffff)
                            .Build())
                    .AddPublicSymbol(
                        "android:attr/background", ResourceId(0x01010001),
                        test::AttributeBuilder()
                            .SetTypeMask(android::ResTable_map::TYPE_COLOR)
                            .Build())
                    .AddPublicSymbol("android:attr/attr",
                                     ResourceId(0x01010002),
                                     test::AttributeBuilder().Build())
                    .AddPublicSymbol(
                        "android:attr/text", ResourceId(0x01010003),
                        test::AttributeBuilder()
                            .SetTypeMask(android::ResTable_map::TYPE_STRING)
                            .Build())

                    // Add one real symbol that was introduces in v21
                    .AddPublicSymbol("android:attr/colorAccent",
                                     ResourceId(0x01010435),
                                     test::AttributeBuilder().Build())

                    // Private symbol.
                    .AddSymbol("android:color/hidden", ResourceId(0x01020001))

                    .AddPublicSymbol("android:id/id", ResourceId(0x01030000))
                    .AddSymbol("com.app.test:id/id", ResourceId(0x7f030000))
                    .AddSymbol("com.app.test:color/green",
                               ResourceId(0x7f020000))
                    .AddSymbol("com.app.test:color/red", ResourceId(0x7f020001))
                    .AddSymbol(
                        "com.app.test:attr/colorAccent", ResourceId(0x7f010000),
                        test::AttributeBuilder()
                            .SetTypeMask(android::ResTable_map::TYPE_COLOR)
                            .Build())
                    .AddPublicSymbol(
                        "com.app.test:attr/com.android.support$colorAccent",
                        ResourceId(0x7f010001),
                        test::AttributeBuilder()
                            .SetTypeMask(android::ResTable_map::TYPE_COLOR)
                            .Build())
                    .AddPublicSymbol("com.app.test:attr/attr",
                                     ResourceId(0x7f010002),
                                     test::AttributeBuilder().Build())
                    .Build())
            .Build();
  }

 protected:
  std::unique_ptr<IAaptContext> context_;
};

TEST_F(XmlReferenceLinkerTest, LinkBasicAttributes) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDomForPackageName(context_.get(), R"EOF(
        <View xmlns:android="http://schemas.android.com/apk/res/android"
              android:layout_width="match_parent"
              android:background="@color/green"
              android:text="hello"
              class="hello" />)EOF");

  XmlReferenceLinker linker;
  ASSERT_TRUE(linker.Consume(context_.get(), doc.get()));

  xml::Element* view_el = xml::FindRootElement(doc.get());
  ASSERT_NE(view_el, nullptr);

  xml::Attribute* xml_attr =
      view_el->FindAttribute(xml::kSchemaAndroid, "layout_width");
  ASSERT_NE(xml_attr, nullptr);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute.value().id);
  EXPECT_EQ(xml_attr->compiled_attribute.value().id.value(),
            ResourceId(0x01010000));
  ASSERT_NE(xml_attr->compiled_value, nullptr);
  ASSERT_NE(ValueCast<BinaryPrimitive>(xml_attr->compiled_value.get()),
            nullptr);

  xml_attr = view_el->FindAttribute(xml::kSchemaAndroid, "background");
  ASSERT_NE(xml_attr, nullptr);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute.value().id);
  EXPECT_EQ(xml_attr->compiled_attribute.value().id.value(),
            ResourceId(0x01010001));
  ASSERT_NE(xml_attr->compiled_value, nullptr);
  Reference* ref = ValueCast<Reference>(xml_attr->compiled_value.get());
  ASSERT_NE(ref, nullptr);
  AAPT_ASSERT_TRUE(ref->name);
  EXPECT_EQ(ref->name.value(),
            test::ParseNameOrDie("color/green"));  // Make sure the name
                                                   // didn't change.
  AAPT_ASSERT_TRUE(ref->id);
  EXPECT_EQ(ref->id.value(), ResourceId(0x7f020000));

  xml_attr = view_el->FindAttribute(xml::kSchemaAndroid, "text");
  ASSERT_NE(xml_attr, nullptr);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute);
  ASSERT_FALSE(
      xml_attr->compiled_value);  // Strings don't get compiled for memory sake.

  xml_attr = view_el->FindAttribute("", "class");
  ASSERT_NE(xml_attr, nullptr);
  AAPT_ASSERT_FALSE(xml_attr->compiled_attribute);
  ASSERT_EQ(xml_attr->compiled_value, nullptr);
}

TEST_F(XmlReferenceLinkerTest, PrivateSymbolsAreNotLinked) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDomForPackageName(context_.get(), R"EOF(
        <View xmlns:android="http://schemas.android.com/apk/res/android"
              android:colorAccent="@android:color/hidden" />)EOF");

  XmlReferenceLinker linker;
  ASSERT_FALSE(linker.Consume(context_.get(), doc.get()));
}

TEST_F(XmlReferenceLinkerTest,
       PrivateSymbolsAreLinkedWhenReferenceHasStarPrefix) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDomForPackageName(context_.get(), R"EOF(
    <View xmlns:android="http://schemas.android.com/apk/res/android"
          android:colorAccent="@*android:color/hidden" />)EOF");

  XmlReferenceLinker linker;
  ASSERT_TRUE(linker.Consume(context_.get(), doc.get()));
}

TEST_F(XmlReferenceLinkerTest, SdkLevelsAreRecorded) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDomForPackageName(context_.get(), R"EOF(
        <View xmlns:android="http://schemas.android.com/apk/res/android"
              android:colorAccent="#ffffff" />)EOF");

  XmlReferenceLinker linker;
  ASSERT_TRUE(linker.Consume(context_.get(), doc.get()));
  EXPECT_TRUE(linker.sdk_levels().count(21) == 1);
}

TEST_F(XmlReferenceLinkerTest, LinkMangledAttributes) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDomForPackageName(context_.get(), R"EOF(
            <View xmlns:support="http://schemas.android.com/apk/res/com.android.support"
                  support:colorAccent="#ff0000" />)EOF");

  XmlReferenceLinker linker;
  ASSERT_TRUE(linker.Consume(context_.get(), doc.get()));

  xml::Element* view_el = xml::FindRootElement(doc.get());
  ASSERT_NE(view_el, nullptr);

  xml::Attribute* xml_attr = view_el->FindAttribute(
      xml::BuildPackageNamespace("com.android.support"), "colorAccent");
  ASSERT_NE(xml_attr, nullptr);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute.value().id);
  EXPECT_EQ(xml_attr->compiled_attribute.value().id.value(),
            ResourceId(0x7f010001));
  ASSERT_NE(ValueCast<BinaryPrimitive>(xml_attr->compiled_value.get()),
            nullptr);
}

TEST_F(XmlReferenceLinkerTest, LinkAutoResReference) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDomForPackageName(context_.get(), R"EOF(
            <View xmlns:app="http://schemas.android.com/apk/res-auto"
                  app:colorAccent="@app:color/red" />)EOF");

  XmlReferenceLinker linker;
  ASSERT_TRUE(linker.Consume(context_.get(), doc.get()));

  xml::Element* view_el = xml::FindRootElement(doc.get());
  ASSERT_NE(view_el, nullptr);

  xml::Attribute* xml_attr =
      view_el->FindAttribute(xml::kSchemaAuto, "colorAccent");
  ASSERT_NE(xml_attr, nullptr);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute.value().id);
  EXPECT_EQ(xml_attr->compiled_attribute.value().id.value(),
            ResourceId(0x7f010000));
  Reference* ref = ValueCast<Reference>(xml_attr->compiled_value.get());
  ASSERT_NE(ref, nullptr);
  AAPT_ASSERT_TRUE(ref->name);
  AAPT_ASSERT_TRUE(ref->id);
  EXPECT_EQ(ref->id.value(), ResourceId(0x7f020001));
}

TEST_F(XmlReferenceLinkerTest, LinkViewWithShadowedPackageAlias) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDomForPackageName(context_.get(), R"EOF(
            <View xmlns:app="http://schemas.android.com/apk/res/android"
                  app:attr="@app:id/id">
              <View xmlns:app="http://schemas.android.com/apk/res/com.app.test"
                    app:attr="@app:id/id"/>
            </View>)EOF");

  XmlReferenceLinker linker;
  ASSERT_TRUE(linker.Consume(context_.get(), doc.get()));

  xml::Element* view_el = xml::FindRootElement(doc.get());
  ASSERT_NE(view_el, nullptr);

  // All attributes and references in this element should be referring to
  // "android" (0x01).
  xml::Attribute* xml_attr =
      view_el->FindAttribute(xml::kSchemaAndroid, "attr");
  ASSERT_NE(xml_attr, nullptr);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute.value().id);
  EXPECT_EQ(xml_attr->compiled_attribute.value().id.value(),
            ResourceId(0x01010002));
  Reference* ref = ValueCast<Reference>(xml_attr->compiled_value.get());
  ASSERT_NE(ref, nullptr);
  AAPT_ASSERT_TRUE(ref->id);
  EXPECT_EQ(ref->id.value(), ResourceId(0x01030000));

  ASSERT_FALSE(view_el->GetChildElements().empty());
  view_el = view_el->GetChildElements().front();
  ASSERT_NE(view_el, nullptr);

  // All attributes and references in this element should be referring to
  // "com.app.test" (0x7f).
  xml_attr = view_el->FindAttribute(xml::BuildPackageNamespace("com.app.test"),
                                    "attr");
  ASSERT_NE(xml_attr, nullptr);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute.value().id);
  EXPECT_EQ(xml_attr->compiled_attribute.value().id.value(),
            ResourceId(0x7f010002));
  ref = ValueCast<Reference>(xml_attr->compiled_value.get());
  ASSERT_NE(ref, nullptr);
  AAPT_ASSERT_TRUE(ref->id);
  EXPECT_EQ(ref->id.value(), ResourceId(0x7f030000));
}

TEST_F(XmlReferenceLinkerTest, LinkViewWithLocalPackageAndAliasOfTheSameName) {
  std::unique_ptr<xml::XmlResource> doc =
      test::BuildXmlDomForPackageName(context_.get(), R"EOF(
            <View xmlns:android="http://schemas.android.com/apk/res/com.app.test"
                  android:attr="@id/id"/>)EOF");

  XmlReferenceLinker linker;
  ASSERT_TRUE(linker.Consume(context_.get(), doc.get()));

  xml::Element* view_el = xml::FindRootElement(doc.get());
  ASSERT_NE(view_el, nullptr);

  // All attributes and references in this element should be referring to
  // "com.app.test" (0x7f).
  xml::Attribute* xml_attr = view_el->FindAttribute(
      xml::BuildPackageNamespace("com.app.test"), "attr");
  ASSERT_NE(xml_attr, nullptr);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute);
  AAPT_ASSERT_TRUE(xml_attr->compiled_attribute.value().id);
  EXPECT_EQ(xml_attr->compiled_attribute.value().id.value(),
            ResourceId(0x7f010002));
  Reference* ref = ValueCast<Reference>(xml_attr->compiled_value.get());
  ASSERT_NE(ref, nullptr);
  AAPT_ASSERT_TRUE(ref->id);
  EXPECT_EQ(ref->id.value(), ResourceId(0x7f030000));
}

}  // namespace aapt