tools/aapt2/compile/IdAssigner_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 "compile/IdAssigner.h"

#include "test/Test.h"

namespace aapt {

::testing::AssertionResult VerifyIds(ResourceTable* table);

TEST(IdAssignerTest, AssignIds) {
  std::unique_ptr<ResourceTable> table = test::ResourceTableBuilder()
                                             .AddSimple("android:attr/foo")
                                             .AddSimple("android:attr/bar")
                                             .AddSimple("android:id/foo")
                                             .SetPackageId("android", 0x01)
                                             .Build();

  std::unique_ptr<IAaptContext> context = test::ContextBuilder().Build();
  IdAssigner assigner;

  ASSERT_TRUE(assigner.Consume(context.get(), table.get()));
  ASSERT_TRUE(VerifyIds(table.get()));
}

TEST(IdAssignerTest, AssignIdsWithReservedIds) {
  std::unique_ptr<ResourceTable> table =
      test::ResourceTableBuilder()
          .AddSimple("android:id/foo", ResourceId(0x01010000))
          .AddSimple("android:dimen/two")
          .AddSimple("android:integer/three")
          .AddSimple("android:string/five")
          .AddSimple("android:attr/fun", ResourceId(0x01040000))
          .AddSimple("android:attr/foo", ResourceId(0x01040006))
          .AddSimple("android:attr/bar")
          .AddSimple("android:attr/baz")
          .AddSimple("app:id/biz")
          .SetPackageId("android", 0x01)
          .SetPackageId("app", 0x7f)
          .Build();

  std::unique_ptr<IAaptContext> context = test::ContextBuilder().Build();
  IdAssigner assigner;

  ASSERT_TRUE(assigner.Consume(context.get(), table.get()));
  ASSERT_TRUE(VerifyIds(table.get()));

  Maybe<ResourceTable::SearchResult> maybe_result;

  // Expect to fill in the gaps between 0x0101XXXX and 0x0104XXXX.

  maybe_result = table->FindResource(test::ParseNameOrDie("android:dimen/two"));
  ASSERT_TRUE(maybe_result);
  EXPECT_EQ(make_value<uint8_t>(2), maybe_result.value().type->id);

  maybe_result =
      table->FindResource(test::ParseNameOrDie("android:integer/three"));
  ASSERT_TRUE(maybe_result);
  EXPECT_EQ(make_value<uint8_t>(3), maybe_result.value().type->id);

  // Expect to bypass the reserved 0x0104XXXX IDs and use the next 0x0105XXXX
  // IDs.

  maybe_result =
      table->FindResource(test::ParseNameOrDie("android:string/five"));
  ASSERT_TRUE(maybe_result);
  EXPECT_EQ(make_value<uint8_t>(5), maybe_result.value().type->id);

  // Expect to fill in the gaps between 0x01040000 and 0x01040006.

  maybe_result = table->FindResource(test::ParseNameOrDie("android:attr/bar"));
  ASSERT_TRUE(maybe_result);
  EXPECT_EQ(make_value<uint16_t>(1), maybe_result.value().entry->id);

  maybe_result = table->FindResource(test::ParseNameOrDie("android:attr/baz"));
  ASSERT_TRUE(maybe_result);
  EXPECT_EQ(make_value<uint16_t>(2), maybe_result.value().entry->id);
}

TEST(IdAssignerTest, FailWhenNonUniqueIdsAssigned) {
  std::unique_ptr<ResourceTable> table =
      test::ResourceTableBuilder()
          .AddSimple("android:attr/foo", ResourceId(0x01040006))
          .AddSimple("android:attr/bar", ResourceId(0x01040006))
          .SetPackageId("android", 0x01)
          .SetPackageId("app", 0x7f)
          .Build();

  std::unique_ptr<IAaptContext> context = test::ContextBuilder().Build();
  IdAssigner assigner;

  ASSERT_FALSE(assigner.Consume(context.get(), table.get()));
}

TEST(IdAssignerTest, AssignIdsWithIdMap) {
  std::unique_ptr<ResourceTable> table = test::ResourceTableBuilder()
                                             .AddSimple("android:attr/foo")
                                             .AddSimple("android:attr/bar")
                                             .SetPackageId("android", 0x01)
                                             .Build();

  std::unique_ptr<IAaptContext> context = test::ContextBuilder().Build();
  std::unordered_map<ResourceName, ResourceId> id_map = {
      {test::ParseNameOrDie("android:attr/foo"), ResourceId(0x01010002)}};
  IdAssigner assigner(&id_map);
  ASSERT_TRUE(assigner.Consume(context.get(), table.get()));
  ASSERT_TRUE(VerifyIds(table.get()));
  Maybe<ResourceTable::SearchResult> result =
      table->FindResource(test::ParseNameOrDie("android:attr/foo"));
  ASSERT_TRUE(result);

  const ResourceTable::SearchResult& search_result = result.value();
  EXPECT_EQ(make_value<uint8_t>(0x01), search_result.package->id);
  EXPECT_EQ(make_value<uint8_t>(0x01), search_result.type->id);
  EXPECT_EQ(make_value<uint16_t>(0x0002), search_result.entry->id);
}

::testing::AssertionResult VerifyIds(ResourceTable* table) {
  std::set<uint8_t> package_ids;
  for (auto& package : table->packages) {
    if (!package->id) {
      return ::testing::AssertionFailure() << "package " << package->name
                                           << " has no ID";
    }

    if (!package_ids.insert(package->id.value()).second) {
      return ::testing::AssertionFailure()
             << "package " << package->name << " has non-unique ID " << std::hex
             << (int)package->id.value() << std::dec;
    }
  }

  for (auto& package : table->packages) {
    std::set<uint8_t> type_ids;
    for (auto& type : package->types) {
      if (!type->id) {
        return ::testing::AssertionFailure() << "type " << type->type
                                             << " of package " << package->name
                                             << " has no ID";
      }

      if (!type_ids.insert(type->id.value()).second) {
        return ::testing::AssertionFailure()
               << "type " << type->type << " of package " << package->name
               << " has non-unique ID " << std::hex << (int)type->id.value()
               << std::dec;
      }
    }

    for (auto& type : package->types) {
      std::set<uint16_t> entry_ids;
      for (auto& entry : type->entries) {
        if (!entry->id) {
          return ::testing::AssertionFailure()
                 << "entry " << entry->name << " of type " << type->type
                 << " of package " << package->name << " has no ID";
        }

        if (!entry_ids.insert(entry->id.value()).second) {
          return ::testing::AssertionFailure()
                 << "entry " << entry->name << " of type " << type->type
                 << " of package " << package->name << " has non-unique ID "
                 << std::hex << (int)entry->id.value() << std::dec;
        }
      }
    }
  }
  return ::testing::AssertionSuccess() << "all IDs are unique and assigned";
}

}  // namespace aapt