tools/aapt2/link/TableMerger_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/TableMerger.h"
#include "filter/ConfigFilter.h"
#include "io/FileSystem.h"
#include "test/Builders.h"
#include "test/Context.h"

#include <gtest/gtest.h>

namespace aapt {

struct TableMergerTest : public ::testing::Test {
  std::unique_ptr<IAaptContext> mContext;

  void SetUp() override {
    mContext =
        test::ContextBuilder()
            // We are compiling this package.
            .setCompilationPackage("com.app.a")

            // Merge all packages that have this package ID.
            .setPackageId(0x7f)

            // Mangle all packages that do not have this package name.
            .setNameManglerPolicy(NameManglerPolicy{"com.app.a", {"com.app.b"}})

            .build();
  }
};

TEST_F(TableMergerTest, SimpleMerge) {
  std::unique_ptr<ResourceTable> tableA =
      test::ResourceTableBuilder()
          .setPackageId("com.app.a", 0x7f)
          .addReference("com.app.a:id/foo", "com.app.a:id/bar")
          .addReference("com.app.a:id/bar", "com.app.b:id/foo")
          .addValue(
              "com.app.a:styleable/view",
              test::StyleableBuilder().addItem("com.app.b:id/foo").build())
          .build();

  std::unique_ptr<ResourceTable> tableB = test::ResourceTableBuilder()
                                              .setPackageId("com.app.b", 0x7f)
                                              .addSimple("com.app.b:id/foo")
                                              .build();

  ResourceTable finalTable;
  TableMerger merger(mContext.get(), &finalTable, TableMergerOptions{});
  io::FileCollection collection;

  ASSERT_TRUE(merger.merge({}, tableA.get()));
  ASSERT_TRUE(
      merger.mergeAndMangle({}, "com.app.b", tableB.get(), &collection));

  EXPECT_TRUE(merger.getMergedPackages().count("com.app.b") != 0);

  // Entries from com.app.a should not be mangled.
  AAPT_EXPECT_TRUE(
      finalTable.findResource(test::parseNameOrDie("com.app.a:id/foo")));
  AAPT_EXPECT_TRUE(
      finalTable.findResource(test::parseNameOrDie("com.app.a:id/bar")));
  AAPT_EXPECT_TRUE(finalTable.findResource(
      test::parseNameOrDie("com.app.a:styleable/view")));

  // The unmangled name should not be present.
  AAPT_EXPECT_FALSE(
      finalTable.findResource(test::parseNameOrDie("com.app.b:id/foo")));

  // Look for the mangled name.
  AAPT_EXPECT_TRUE(finalTable.findResource(
      test::parseNameOrDie("com.app.a:id/com.app.b$foo")));
}

TEST_F(TableMergerTest, MergeFile) {
  ResourceTable finalTable;
  TableMergerOptions options;
  options.autoAddOverlay = false;
  TableMerger merger(mContext.get(), &finalTable, options);

  ResourceFile fileDesc;
  fileDesc.config = test::parseConfigOrDie("hdpi-v4");
  fileDesc.name = test::parseNameOrDie("layout/main");
  fileDesc.source = Source("res/layout-hdpi/main.xml");
  test::TestFile testFile("path/to/res/layout-hdpi/main.xml.flat");

  ASSERT_TRUE(merger.mergeFile(fileDesc, &testFile));

  FileReference* file = test::getValueForConfig<FileReference>(
      &finalTable, "com.app.a:layout/main", test::parseConfigOrDie("hdpi-v4"));
  ASSERT_NE(nullptr, file);
  EXPECT_EQ(std::string("res/layout-hdpi-v4/main.xml"), *file->path);
}

TEST_F(TableMergerTest, MergeFileOverlay) {
  ResourceTable finalTable;
  TableMergerOptions tableMergerOptions;
  tableMergerOptions.autoAddOverlay = false;
  TableMerger merger(mContext.get(), &finalTable, tableMergerOptions);

  ResourceFile fileDesc;
  fileDesc.name = test::parseNameOrDie("xml/foo");
  test::TestFile fileA("path/to/fileA.xml.flat");
  test::TestFile fileB("path/to/fileB.xml.flat");

  ASSERT_TRUE(merger.mergeFile(fileDesc, &fileA));
  ASSERT_TRUE(merger.mergeFileOverlay(fileDesc, &fileB));
}

TEST_F(TableMergerTest, MergeFileReferences) {
  std::unique_ptr<ResourceTable> tableA =
      test::ResourceTableBuilder()
          .setPackageId("com.app.a", 0x7f)
          .addFileReference("com.app.a:xml/file", "res/xml/file.xml")
          .build();
  std::unique_ptr<ResourceTable> tableB =
      test::ResourceTableBuilder()
          .setPackageId("com.app.b", 0x7f)
          .addFileReference("com.app.b:xml/file", "res/xml/file.xml")
          .build();

  ResourceTable finalTable;
  TableMerger merger(mContext.get(), &finalTable, TableMergerOptions{});
  io::FileCollection collection;
  collection.insertFile("res/xml/file.xml");

  ASSERT_TRUE(merger.merge({}, tableA.get()));
  ASSERT_TRUE(
      merger.mergeAndMangle({}, "com.app.b", tableB.get(), &collection));

  FileReference* f =
      test::getValue<FileReference>(&finalTable, "com.app.a:xml/file");
  ASSERT_NE(f, nullptr);
  EXPECT_EQ(std::string("res/xml/file.xml"), *f->path);

  f = test::getValue<FileReference>(&finalTable,
                                    "com.app.a:xml/com.app.b$file");
  ASSERT_NE(f, nullptr);
  EXPECT_EQ(std::string("res/xml/com.app.b$file.xml"), *f->path);
}

TEST_F(TableMergerTest, OverrideResourceWithOverlay) {
  std::unique_ptr<ResourceTable> base =
      test::ResourceTableBuilder()
          .setPackageId("", 0x00)
          .addValue("bool/foo", ResourceUtils::tryParseBool("true"))
          .build();
  std::unique_ptr<ResourceTable> overlay =
      test::ResourceTableBuilder()
          .setPackageId("", 0x00)
          .addValue("bool/foo", ResourceUtils::tryParseBool("false"))
          .build();

  ResourceTable finalTable;
  TableMergerOptions tableMergerOptions;
  tableMergerOptions.autoAddOverlay = false;
  TableMerger merger(mContext.get(), &finalTable, tableMergerOptions);

  ASSERT_TRUE(merger.merge({}, base.get()));
  ASSERT_TRUE(merger.mergeOverlay({}, overlay.get()));

  BinaryPrimitive* foo =
      test::getValue<BinaryPrimitive>(&finalTable, "com.app.a:bool/foo");
  ASSERT_NE(nullptr, foo);
  EXPECT_EQ(0x0u, foo->value.data);
}

TEST_F(TableMergerTest, OverrideSameResourceIdsWithOverlay) {
  std::unique_ptr<ResourceTable> base =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .setSymbolState("bool/foo", ResourceId(0x7f, 0x01, 0x0001),
                          SymbolState::kPublic)
          .build();
  std::unique_ptr<ResourceTable> overlay =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .setSymbolState("bool/foo", ResourceId(0x7f, 0x01, 0x0001),
                          SymbolState::kPublic)
          .build();

  ResourceTable finalTable;
  TableMergerOptions tableMergerOptions;
  tableMergerOptions.autoAddOverlay = false;
  TableMerger merger(mContext.get(), &finalTable, tableMergerOptions);

  ASSERT_TRUE(merger.merge({}, base.get()));
  ASSERT_TRUE(merger.mergeOverlay({}, overlay.get()));
}

TEST_F(TableMergerTest, FailToOverrideConflictingTypeIdsWithOverlay) {
  std::unique_ptr<ResourceTable> base =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .setSymbolState("bool/foo", ResourceId(0x7f, 0x01, 0x0001),
                          SymbolState::kPublic)
          .build();
  std::unique_ptr<ResourceTable> overlay =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .setSymbolState("bool/foo", ResourceId(0x7f, 0x02, 0x0001),
                          SymbolState::kPublic)
          .build();

  ResourceTable finalTable;
  TableMergerOptions tableMergerOptions;
  tableMergerOptions.autoAddOverlay = false;
  TableMerger merger(mContext.get(), &finalTable, tableMergerOptions);

  ASSERT_TRUE(merger.merge({}, base.get()));
  ASSERT_FALSE(merger.mergeOverlay({}, overlay.get()));
}

TEST_F(TableMergerTest, FailToOverrideConflictingEntryIdsWithOverlay) {
  std::unique_ptr<ResourceTable> base =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .setSymbolState("bool/foo", ResourceId(0x7f, 0x01, 0x0001),
                          SymbolState::kPublic)
          .build();
  std::unique_ptr<ResourceTable> overlay =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .setSymbolState("bool/foo", ResourceId(0x7f, 0x01, 0x0002),
                          SymbolState::kPublic)
          .build();

  ResourceTable finalTable;
  TableMergerOptions tableMergerOptions;
  tableMergerOptions.autoAddOverlay = false;
  TableMerger merger(mContext.get(), &finalTable, tableMergerOptions);

  ASSERT_TRUE(merger.merge({}, base.get()));
  ASSERT_FALSE(merger.mergeOverlay({}, overlay.get()));
}

TEST_F(TableMergerTest, MergeAddResourceFromOverlay) {
  std::unique_ptr<ResourceTable> tableA =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .setSymbolState("bool/foo", {}, SymbolState::kUndefined)
          .build();
  std::unique_ptr<ResourceTable> tableB =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .addValue("bool/foo", ResourceUtils::tryParseBool("true"))
          .build();

  ResourceTable finalTable;
  TableMerger merger(mContext.get(), &finalTable, TableMergerOptions{});

  ASSERT_TRUE(merger.merge({}, tableA.get()));
  ASSERT_TRUE(merger.mergeOverlay({}, tableB.get()));
}

TEST_F(TableMergerTest, MergeAddResourceFromOverlayWithAutoAddOverlay) {
  std::unique_ptr<ResourceTable> tableA =
      test::ResourceTableBuilder().setPackageId("", 0x7f).build();
  std::unique_ptr<ResourceTable> tableB =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .addValue("bool/foo", ResourceUtils::tryParseBool("true"))
          .build();

  ResourceTable finalTable;
  TableMergerOptions options;
  options.autoAddOverlay = true;
  TableMerger merger(mContext.get(), &finalTable, options);

  ASSERT_TRUE(merger.merge({}, tableA.get()));
  ASSERT_TRUE(merger.mergeOverlay({}, tableB.get()));
}

TEST_F(TableMergerTest, FailToMergeNewResourceWithoutAutoAddOverlay) {
  std::unique_ptr<ResourceTable> tableA =
      test::ResourceTableBuilder().setPackageId("", 0x7f).build();
  std::unique_ptr<ResourceTable> tableB =
      test::ResourceTableBuilder()
          .setPackageId("", 0x7f)
          .addValue("bool/foo", ResourceUtils::tryParseBool("true"))
          .build();

  ResourceTable finalTable;
  TableMergerOptions options;
  options.autoAddOverlay = false;
  TableMerger merger(mContext.get(), &finalTable, options);

  ASSERT_TRUE(merger.merge({}, tableA.get()));
  ASSERT_FALSE(merger.mergeOverlay({}, tableB.get()));
}

TEST_F(TableMergerTest, OverlaidStyleablesShouldBeMerged) {
  std::unique_ptr<ResourceTable> tableA =
      test::ResourceTableBuilder()
          .setPackageId("com.app.a", 0x7f)
          .addValue("com.app.a:styleable/Foo",
                    test::StyleableBuilder()
                        .addItem("com.app.a:attr/bar")
                        .addItem("com.app.a:attr/foo", ResourceId(0x01010000))
                        .build())
          .build();

  std::unique_ptr<ResourceTable> tableB =
      test::ResourceTableBuilder()
          .setPackageId("com.app.a", 0x7f)
          .addValue("com.app.a:styleable/Foo",
                    test::StyleableBuilder()
                        .addItem("com.app.a:attr/bat")
                        .addItem("com.app.a:attr/foo")
                        .build())
          .build();

  ResourceTable finalTable;
  TableMergerOptions options;
  options.autoAddOverlay = true;
  TableMerger merger(mContext.get(), &finalTable, options);

  ASSERT_TRUE(merger.merge({}, tableA.get()));
  ASSERT_TRUE(merger.mergeOverlay({}, tableB.get()));

  Debug::printTable(&finalTable, {});

  Styleable* styleable =
      test::getValue<Styleable>(&finalTable, "com.app.a:styleable/Foo");
  ASSERT_NE(nullptr, styleable);

  std::vector<Reference> expectedRefs = {
      Reference(test::parseNameOrDie("com.app.a:attr/bar")),
      Reference(test::parseNameOrDie("com.app.a:attr/bat")),
      Reference(test::parseNameOrDie("com.app.a:attr/foo"),
                ResourceId(0x01010000)),
  };

  EXPECT_EQ(expectedRefs, styleable->entries);
}

}  // namespace aapt