libs/androidfw/tests/Theme_test.cpp

/*
 * Copyright (C) 2016 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 "androidfw/AssetManager2.h"

#include "android-base/logging.h"

#include "TestHelpers.h"
#include "androidfw/ResourceUtils.h"
#include "data/lib_one/R.h"
#include "data/lib_two/R.h"
#include "data/libclient/R.h"
#include "data/styles/R.h"
#include "data/system/R.h"

namespace app = com::android::app;
namespace lib_one = com::android::lib_one;
namespace lib_two = com::android::lib_two;
namespace libclient = com::android::libclient;

namespace android {

class ThemeTest : public ::testing::Test {
 public:
  void SetUp() override {
    system_assets_ = ApkAssets::Load(GetTestDataPath() + "/system/system.apk", PROPERTY_SYSTEM);
    ASSERT_NE(nullptr, system_assets_);

    style_assets_ = ApkAssets::Load(GetTestDataPath() + "/styles/styles.apk");
    ASSERT_NE(nullptr, style_assets_);

    libclient_assets_ = ApkAssets::Load(GetTestDataPath() + "/libclient/libclient.apk");
    ASSERT_NE(nullptr, libclient_assets_);

    lib_one_assets_ = ApkAssets::Load(GetTestDataPath() + "/lib_one/lib_one.apk");
    ASSERT_NE(nullptr, lib_one_assets_);

    lib_two_assets_ = ApkAssets::Load(GetTestDataPath() + "/lib_two/lib_two.apk");
    ASSERT_NE(nullptr, lib_two_assets_);
  }

 protected:
  AssetManager2::ApkAssetsPtr system_assets_;
  AssetManager2::ApkAssetsPtr style_assets_;
  AssetManager2::ApkAssetsPtr libclient_assets_;
  AssetManager2::ApkAssetsPtr lib_one_assets_;
  AssetManager2::ApkAssetsPtr lib_two_assets_;
};

TEST_F(ThemeTest, EmptyTheme) {
  AssetManager2 assetmanager;
  assetmanager.SetApkAssets({style_assets_});

  std::unique_ptr<Theme> theme = assetmanager.NewTheme();
  EXPECT_EQ(0u, theme->GetChangingConfigurations());
  EXPECT_EQ(&assetmanager, theme->GetAssetManager());
  EXPECT_FALSE(theme->GetAttribute(app::R::attr::attr_one).has_value());
}

TEST_F(ThemeTest, SingleThemeNoParent) {
  AssetManager2 assetmanager;
  assetmanager.SetApkAssets({style_assets_});

  std::unique_ptr<Theme> theme = assetmanager.NewTheme();
  ASSERT_TRUE(theme->ApplyStyle(app::R::style::StyleOne).has_value());

  auto value = theme->GetAttribute(app::R::attr::attr_one);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(1u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  value = theme->GetAttribute(app::R::attr::attr_two);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(2u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);
}

TEST_F(ThemeTest, SingleThemeWithParent) {
  AssetManager2 assetmanager;
  assetmanager.SetApkAssets({style_assets_});

  std::unique_ptr<Theme> theme = assetmanager.NewTheme();
  ASSERT_TRUE(theme->ApplyStyle(app::R::style::StyleTwo).has_value());

  auto value = theme->GetAttribute(app::R::attr::attr_one);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(1u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  value = theme->GetAttribute(app::R::attr::attr_two);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_STRING, value->type);
  EXPECT_EQ(0, value->cookie);
  EXPECT_EQ(std::string("string"),
            GetStringFromPool(assetmanager.GetStringPoolForCookie(0), value->data));
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  // This attribute should point to an attr_indirect, so the result should be 3.
  value = theme->GetAttribute(app::R::attr::attr_three);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(3u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);
}

TEST_F(ThemeTest, TryToUseBadResourceId) {
  AssetManager2 assetmanager;
  assetmanager.SetApkAssets({style_assets_});

  std::unique_ptr<Theme> theme = assetmanager.NewTheme();
  ASSERT_TRUE(theme->ApplyStyle(app::R::style::StyleTwo).has_value());
  ASSERT_FALSE(theme->GetAttribute(0x7f000001));
}

TEST_F(ThemeTest, MultipleThemesOverlaidNotForce) {
  AssetManager2 assetmanager;
  assetmanager.SetApkAssets({style_assets_});

  std::unique_ptr<Theme> theme = assetmanager.NewTheme();
  ASSERT_TRUE(theme->ApplyStyle(app::R::style::StyleTwo).has_value());
  ASSERT_TRUE(theme->ApplyStyle(app::R::style::StyleThree).has_value());

  // attr_one is still here from the base.
  auto value = theme->GetAttribute(app::R::attr::attr_one);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(1u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  // check for the new attr_six
  value = theme->GetAttribute(app::R::attr::attr_six);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(6u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  // check for the old attr_five (force=true was not used).
  value = theme->GetAttribute(app::R::attr::attr_five);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_REFERENCE, value->type);
  EXPECT_EQ(app::R::string::string_one, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);
}

TEST_F(ThemeTest, MultipleThemesOverlaidForced) {
  AssetManager2 assetmanager;
  assetmanager.SetApkAssets({style_assets_});

  std::unique_ptr<Theme> theme = assetmanager.NewTheme();
  ASSERT_TRUE(theme->ApplyStyle(app::R::style::StyleTwo).has_value());
  ASSERT_TRUE(theme->ApplyStyle(app::R::style::StyleThree, true /* force */).has_value());

  // attr_one is still here from the base.
  auto value = theme->GetAttribute(app::R::attr::attr_one);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(1u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  // check for the new attr_six
  value = theme->GetAttribute(app::R::attr::attr_six);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(6u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  // check for the new attr_five (force=true was used).
  value = theme->GetAttribute(app::R::attr::attr_five);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(5u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);
}

TEST_F(ThemeTest, ResolveDynamicAttributesAndReferencesToSharedLibrary) {
  AssetManager2 assetmanager;
  assetmanager.SetApkAssets({lib_two_assets_, lib_one_assets_, libclient_assets_});

  std::unique_ptr<Theme> theme = assetmanager.NewTheme();
  ASSERT_TRUE(theme->ApplyStyle(libclient::R::style::Theme, false /*force*/).has_value());

  // The attribute should be resolved to the final value.
  auto value = theme->GetAttribute(libclient::R::attr::foo);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(700u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  // The reference should be resolved to a TYPE_REFERENCE.
  value = theme->GetAttribute(libclient::R::attr::bar);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_REFERENCE, value->type);

  // lib_one is assigned package ID 0x03.
  EXPECT_EQ(3u, get_package_id(value->data));
  EXPECT_EQ(get_type_id(lib_one::R::string::foo), get_type_id(value->data));
  EXPECT_EQ(get_entry_id(lib_one::R::string::foo), get_entry_id(value->data));
}

TEST_F(ThemeTest, CopyThemeSameAssetManager) {
  AssetManager2 assetmanager;
  assetmanager.SetApkAssets({style_assets_});

  std::unique_ptr<Theme> theme_one = assetmanager.NewTheme();
  ASSERT_TRUE(theme_one->ApplyStyle(app::R::style::StyleOne).has_value());

  // attr_one is still here from the base.
  auto value = theme_one->GetAttribute(app::R::attr::attr_one);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(1u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  // attr_six is not here.
  ASSERT_FALSE(theme_one->GetAttribute(app::R::attr::attr_six).has_value());

  std::unique_ptr<Theme> theme_two = assetmanager.NewTheme();
  ASSERT_TRUE(theme_two->ApplyStyle(app::R::style::StyleThree).has_value());

  // Copy the theme to theme_one.
  theme_one->SetTo(*theme_two);

  // Clear theme_two to make sure we test that there WAS a copy.
  theme_two->Clear();

  // attr_one is now not here.
  ASSERT_FALSE(theme_one->GetAttribute(app::R::attr::attr_one).has_value());

  // attr_six is now here because it was copied.
  value = theme_one->GetAttribute(app::R::attr::attr_six);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(6u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);
}

TEST_F(ThemeTest, ThemeRebase) {
  AssetManager2 am;
  am.SetApkAssets({style_assets_});

  AssetManager2 am_night;
  am_night.SetApkAssets({style_assets_});

  ResTable_config night{};
  night.uiMode = ResTable_config::UI_MODE_NIGHT_YES;
  night.version = 8u;
  am_night.SetConfigurations({night});

  auto theme = am.NewTheme();
  {
    const uint32_t styles[] = {app::R::style::StyleOne, app::R::style::StyleDayNight};
    const uint8_t force[] = {true, true};
    theme->Rebase(&am, styles, force, arraysize(styles));
  }

  // attr_one in StyleDayNight force overrides StyleOne. attr_one is defined in the StyleOne.
  auto value = theme->GetAttribute(app::R::attr::attr_one);
  ASSERT_TRUE(value);
  EXPECT_EQ(10u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC | ResTable_config::CONFIG_UI_MODE |
            ResTable_config::CONFIG_VERSION), value->flags);

  // attr_two is defined in the StyleOne.
  value = theme->GetAttribute(app::R::attr::attr_two);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(2u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  {
    const uint32_t styles[] = {app::R::style::StyleOne, app::R::style::StyleDayNight};
    const uint8_t force[] = {false, false};
    theme->Rebase(&am, styles, force, arraysize(styles));
  }

  // attr_one in StyleDayNight does not override StyleOne because `force` is false.
  value = theme->GetAttribute(app::R::attr::attr_one);
  ASSERT_TRUE(value);
  EXPECT_EQ(1u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  // attr_two is defined in the StyleOne.
  value = theme->GetAttribute(app::R::attr::attr_two);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(2u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);

  {
    const uint32_t styles[] = {app::R::style::StyleOne, app::R::style::StyleDayNight};
    const uint8_t force[] = {false, true};
    theme->Rebase(&am_night, styles, force, arraysize(styles));
  }

  // attr_one is defined in the StyleDayNight.
  value = theme->GetAttribute(app::R::attr::attr_one);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(100u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC | ResTable_config::CONFIG_UI_MODE |
            ResTable_config::CONFIG_VERSION), value->flags);

  // attr_two is now not here.
  value = theme->GetAttribute(app::R::attr::attr_two);
  ASSERT_TRUE(value);
  EXPECT_EQ(Res_value::TYPE_INT_DEC, value->type);
  EXPECT_EQ(2u, value->data);
  EXPECT_EQ(static_cast<uint32_t>(ResTable_typeSpec::SPEC_PUBLIC), value->flags);
}

TEST_F(ThemeTest, OnlyCopySameAssetsThemeWhenAssetManagersDiffer) {
  AssetManager2 assetmanager_dst;
  assetmanager_dst.SetApkAssets(
      {system_assets_, lib_one_assets_, style_assets_, libclient_assets_});

  AssetManager2 assetmanager_src;
  assetmanager_src.SetApkAssets({system_assets_, lib_two_assets_, lib_one_assets_, style_assets_});

  auto theme_dst = assetmanager_dst.NewTheme();
  ASSERT_TRUE(theme_dst->ApplyStyle(app::R::style::StyleOne).has_value());

  auto theme_src = assetmanager_src.NewTheme();
  ASSERT_TRUE(theme_src->ApplyStyle(R::style::Theme_One).has_value());
  ASSERT_TRUE(theme_src->ApplyStyle(app::R::style::StyleTwo).has_value());
  ASSERT_TRUE(theme_src->ApplyStyle(fix_package_id(lib_one::R::style::Theme, 0x03),
                                    false /*force*/).has_value());
  ASSERT_TRUE(theme_src->ApplyStyle(fix_package_id(lib_two::R::style::Theme, 0x02),
                                    false /*force*/).has_value());

  theme_dst->SetTo(*theme_src);

  // System resources (present in destination asset manager).
  auto value = theme_dst->GetAttribute(R::attr::foreground);
  ASSERT_TRUE(value.has_value());
  EXPECT_EQ(0, value->cookie);

  // The cookie of the style asset is 3 in the source and 2 in the destination.
  // Check that the cookie has been rewritten to the destination values.
  value = theme_dst->GetAttribute(app::R::attr::attr_one);
  ASSERT_TRUE(value.has_value());
  EXPECT_EQ(2, value->cookie);

  // The cookie of the lib_one asset is 2 in the source and 1 in the destination.
  // The package id of the lib_one package is 0x03 in the source and 0x02 in the destination
  // Check that the cookie and packages have been rewritten to the destination values.
  value = theme_dst->GetAttribute(fix_package_id(lib_one::R::attr::attr1, 0x02));
  ASSERT_TRUE(value.has_value());
  EXPECT_EQ(1, value->cookie);

  value = theme_dst->GetAttribute(fix_package_id(lib_one::R::attr::attr2, 0x02));
  ASSERT_TRUE(value.has_value());
  EXPECT_EQ(1, value->cookie);

  // attr2 references an attribute in lib_one. Check that the resolution of the attribute value is
  // correct after the value of attr2 had its package id rewritten to the destination package id.
  EXPECT_EQ(700, value->data);
}

TEST_F(ThemeTest, CopyNonReferencesWhenPackagesDiffer) {
  AssetManager2 assetmanager_dst;
  assetmanager_dst.SetApkAssets({system_assets_});

  AssetManager2 assetmanager_src;
  assetmanager_src.SetApkAssets({system_assets_, style_assets_});

  auto theme_dst = assetmanager_dst.NewTheme();
  auto theme_src = assetmanager_src.NewTheme();
  ASSERT_TRUE(theme_src->ApplyStyle(app::R::style::StyleSeven).has_value());
  theme_dst->SetTo(*theme_src);

  // Allow inline resource values to be copied even if the source apk asset is not present in the
  // destination.
  auto value = theme_dst->GetAttribute(0x0101021b /* android:versionCode */);
  ASSERT_TRUE(value.has_value());
  EXPECT_EQ(0, value->cookie);

  // Do not copy strings since the data is an index into the values string pool of the source apk
  // asset.
  EXPECT_FALSE(theme_dst->GetAttribute(0x01010001 /* android:label */).has_value());

  // Do not copy values that reference another resource if the resource is not present in the
  // destination.
  EXPECT_FALSE(theme_dst->GetAttribute(0x01010002 /* android:icon */).has_value());
  EXPECT_FALSE(theme_dst->GetAttribute(0x010100d1 /* android:tag */).has_value());

  // Allow @empty to and @null to be copied.
  value = theme_dst->GetAttribute(0x010100d0 /* android:id */);
  ASSERT_TRUE(value.has_value());
  EXPECT_EQ(0, value->cookie);

  value = theme_dst->GetAttribute(0x01010000 /* android:theme */);
  ASSERT_TRUE(value.has_value());
  EXPECT_EQ(0, value->cookie);
}

}  // namespace android