| /* |
| * Copyright (C) 2011 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 "base/file_utils.h" |
| |
| #include <libgen.h> |
| #include <stdlib.h> |
| |
| #include <optional> |
| #include <vector> |
| |
| #include "base/stl_util.h" |
| #include "common_art_test.h" |
| |
| namespace art { |
| |
| static constexpr const char kAndroidWifiApexDefaultPath[] = "/apex/com.android.wifi"; |
| |
| namespace { |
| class ScopedOverrideDalvikCacheSubDirectory { |
| public: |
| explicit ScopedOverrideDalvikCacheSubDirectory(const char* override) { |
| OverrideDalvikCacheSubDirectory(override); |
| } |
| |
| ~ScopedOverrideDalvikCacheSubDirectory() { OverrideDalvikCacheSubDirectory("dalvik-cache"); } |
| |
| private: |
| DISALLOW_COPY_AND_ASSIGN(ScopedOverrideDalvikCacheSubDirectory); |
| }; |
| } // namespace |
| |
| class FileUtilsTest : public CommonArtTest {}; |
| |
| TEST_F(FileUtilsTest, GetDalvikCacheFilename) { |
| std::string name; |
| std::string error; |
| |
| EXPECT_TRUE(GetDalvikCacheFilename("/system/app/Foo.apk", "/foo", &name, &error)) << error; |
| EXPECT_EQ("/foo/system@app@Foo.apk@classes.dex", name); |
| |
| EXPECT_TRUE(GetDalvikCacheFilename("/data/app/foo-1.apk", "/foo", &name, &error)) << error; |
| EXPECT_EQ("/foo/data@app@foo-1.apk@classes.dex", name); |
| |
| EXPECT_TRUE(GetDalvikCacheFilename("/system/framework/core.jar", "/foo", &name, &error)) << error; |
| EXPECT_EQ("/foo/system@framework@core.jar@classes.dex", name); |
| |
| EXPECT_TRUE(GetDalvikCacheFilename("/system/framework/boot.art", "/foo", &name, &error)) << error; |
| EXPECT_EQ("/foo/system@framework@boot.art", name); |
| |
| EXPECT_TRUE(GetDalvikCacheFilename("/system/framework/boot.oat", "/foo", &name, &error)) << error; |
| EXPECT_EQ("/foo/system@framework@boot.oat", name); |
| } |
| |
| TEST_F(FileUtilsTest, GetSystemImageFilename) { |
| EXPECT_STREQ("/system/framework/arm/boot.art", |
| GetSystemImageFilename("/system/framework/boot.art", InstructionSet::kArm).c_str()); |
| } |
| |
| // TODO(dsrbecky): b/160885380: This test is failing in eng-prod because libartbase |
| // is loaded from different path (under testcases). |
| TEST_F(FileUtilsTest, DISABLED_GetAndroidRootSafe) { |
| std::string error_msg; |
| |
| // We don't expect null returns for most cases, so don't check and let std::string crash. |
| |
| // CommonArtTest sets ANDROID_ROOT, so expect this to be the same. |
| std::string android_root = GetAndroidRootSafe(&error_msg); |
| std::string android_root_env = getenv("ANDROID_ROOT"); |
| EXPECT_EQ(android_root, android_root_env) << error_msg; |
| |
| // Set ANDROID_ROOT to something else (but the directory must exist). So use dirname. |
| UniqueCPtr<char> root_dup(strdup(android_root_env.c_str())); |
| char* dir = dirname(root_dup.get()); |
| ASSERT_EQ(0, setenv("ANDROID_ROOT", dir, /* overwrite */ 1)); |
| std::string android_root2 = GetAndroidRootSafe(&error_msg); |
| EXPECT_STREQ(dir, android_root2.c_str()) << error_msg; |
| |
| // Set a bogus value for ANDROID_ROOT. This should be an error. |
| ASSERT_EQ(0, setenv("ANDROID_ROOT", "/this/is/obviously/bogus", /* overwrite */ 1)); |
| EXPECT_EQ(GetAndroidRootSafe(&error_msg), ""); |
| error_msg = ""; |
| |
| // Inferring the Android Root from the location of libartbase only works on host. |
| if (!kIsTargetBuild) { |
| // Unset ANDROID_ROOT and see that it still returns something (as libartbase code is running). |
| ASSERT_EQ(0, unsetenv("ANDROID_ROOT")); |
| std::string android_root3 = GetAndroidRootSafe(&error_msg); |
| // This should be the same as the other root (modulo realpath), otherwise the test setup is |
| // broken. On non-bionic. On bionic we can be running with a different libartbase that lives |
| // outside of ANDROID_ROOT. |
| UniqueCPtr<char> real_root3(realpath(android_root3.c_str(), nullptr)); |
| #if !defined(__BIONIC__) || defined(__ANDROID__) |
| UniqueCPtr<char> real_root(realpath(android_root.c_str(), nullptr)); |
| EXPECT_STREQ(real_root.get(), real_root3.get()) << error_msg; |
| #else |
| EXPECT_STRNE(real_root3.get(), "") << error_msg; |
| #endif |
| } |
| |
| // Reset ANDROID_ROOT, as other things may depend on it. |
| ASSERT_EQ(0, setenv("ANDROID_ROOT", android_root_env.c_str(), /* overwrite */ 1)); |
| } |
| |
| TEST_F(FileUtilsTest, GetArtRootSafe) { |
| std::string error_msg; |
| std::string android_art_root; |
| std::string android_art_root_env; |
| |
| // TODO(b/130295968): Re-enable this part when the directory exists on host |
| if (kIsTargetBuild) { |
| // We don't expect null returns for most cases, so don't check and let std::string crash. |
| |
| // CommonArtTest sets ANDROID_ART_ROOT, so expect this to be the same. |
| android_art_root = GetArtRootSafe(&error_msg); |
| android_art_root_env = getenv("ANDROID_ART_ROOT"); |
| EXPECT_EQ(android_art_root, android_art_root_env) << error_msg; |
| |
| // Set ANDROID_ART_ROOT to something else (but the directory must exist). So use dirname. |
| UniqueCPtr<char> root_dup(strdup(android_art_root_env.c_str())); |
| char* dir = dirname(root_dup.get()); |
| ASSERT_EQ(0, setenv("ANDROID_ART_ROOT", dir, /* overwrite */ 1)); |
| std::string android_art_root2 = GetArtRootSafe(&error_msg); |
| EXPECT_STREQ(dir, android_art_root2.c_str()) << error_msg; |
| } |
| |
| // Set a bogus value for ANDROID_ART_ROOT. This should be an error. |
| ASSERT_EQ(0, setenv("ANDROID_ART_ROOT", "/this/is/obviously/bogus", /* overwrite */ 1)); |
| EXPECT_EQ(GetArtRootSafe(&error_msg), ""); |
| |
| // Inferring the ART root from the location of libartbase only works on target. |
| if (kIsTargetBuild) { |
| // Disabled for now, as we cannot reliably use `GetRootContainingLibartbase` |
| // to find the ART root on target yet (see comment in `GetArtRootSafe`). |
| // |
| // TODO(b/129534335): Re-enable this part of the test on target when the |
| // only instance of libartbase is the one from the ART APEX. |
| if ((false)) { |
| // Unset ANDROID_ART_ROOT and see that it still returns something (as |
| // libartbase code is running). |
| ASSERT_EQ(0, unsetenv("ANDROID_ART_ROOT")); |
| std::string android_art_root3 = GetArtRootSafe(&error_msg); |
| // This should be the same as the other root (modulo realpath), otherwise |
| // the test setup is broken. On non-bionic. On bionic we can be running |
| // with a different libartbase that lives outside of ANDROID_ART_ROOT. |
| UniqueCPtr<char> real_root3(realpath(android_art_root3.c_str(), nullptr)); |
| #if !defined(__BIONIC__) || defined(__ANDROID__) |
| UniqueCPtr<char> real_root(realpath(android_art_root.c_str(), nullptr)); |
| EXPECT_STREQ(real_root.get(), real_root3.get()) << error_msg; |
| #else |
| EXPECT_STRNE(real_root3.get(), "") << error_msg; |
| #endif |
| } |
| } |
| |
| // Reset ANDROID_ART_ROOT, as other things may depend on it. |
| ASSERT_EQ(0, setenv("ANDROID_ART_ROOT", android_art_root_env.c_str(), /* overwrite */ 1)); |
| } |
| |
| TEST_F(FileUtilsTest, ReplaceFileExtension) { |
| EXPECT_EQ("/directory/file.vdex", ReplaceFileExtension("/directory/file.oat", "vdex")); |
| EXPECT_EQ("/.directory/file.vdex", ReplaceFileExtension("/.directory/file.oat", "vdex")); |
| EXPECT_EQ("/directory/file.vdex", ReplaceFileExtension("/directory/file", "vdex")); |
| EXPECT_EQ("/.directory/file.vdex", ReplaceFileExtension("/.directory/file", "vdex")); |
| } |
| |
| TEST_F(FileUtilsTest, ArtApexDataPath) { |
| ScopedUnsetEnvironmentVariable no_env("ART_APEX_DATA"); |
| EXPECT_EQ(kArtApexDataDefaultPath, GetArtApexData()); |
| |
| setenv("ART_APEX_DATA", "/path/from/env", /* overwrite */ 1); |
| EXPECT_EQ("/path/from/env", GetArtApexData()); |
| } |
| |
| TEST_F(FileUtilsTest, GetApexDataOatFilename) { |
| ScopedUnsetEnvironmentVariable android_root("ANDROID_ROOT"); |
| ScopedUnsetEnvironmentVariable i18n_root("ANDROID_I18N_ROOT"); |
| ScopedUnsetEnvironmentVariable art_apex_data("ART_APEX_DATA"); |
| |
| EXPECT_EQ(GetArtApexData() + "/dalvik-cache/arm/boot-beep.oat", |
| GetApexDataOatFilename("/product/javalib/beep.jar", InstructionSet::kArm)); |
| |
| const std::string art_apex_jar = std::string {kAndroidArtApexDefaultPath} + "/javalib/some.jar"; |
| EXPECT_EQ(std::string{}, GetApexDataOatFilename(art_apex_jar, InstructionSet::kArm)); |
| |
| const std::string i18n_jar = std::string{kAndroidI18nApexDefaultPath} + "/javalib/core-icu4j.jar"; |
| EXPECT_EQ(std::string{}, GetApexDataOatFilename(i18n_jar, InstructionSet::kArm)); |
| |
| const std::string system_jar_apexdata_oat = GetArtApexData() + "/dalvik-cache/x86/boot-lace.oat"; |
| EXPECT_EQ(system_jar_apexdata_oat, |
| GetApexDataOatFilename("/system/framework/lace.jar", InstructionSet::kX86)); |
| } |
| |
| TEST_F(FileUtilsTest, GetApexDataOdexFilename) { |
| ScopedUnsetEnvironmentVariable android_root("ANDROID_ROOT"); |
| ScopedUnsetEnvironmentVariable art_apex_data("ART_APEX_DATA"); |
| |
| EXPECT_EQ(GetArtApexData() + "/dalvik-cache/arm/data@some@code.odex", |
| GetApexDataOdexFilename("/data/some/code.dex", InstructionSet::kArm)); |
| |
| const std::string art_apex_jar = std::string {kAndroidArtApexDefaultPath} + "/javalib/some.jar"; |
| EXPECT_EQ( |
| GetArtApexData() + "/dalvik-cache/arm/apex@com.android.art@javalib@some.jar@classes.odex", |
| GetApexDataOdexFilename(art_apex_jar, InstructionSet::kArm)); |
| |
| const std::string i18n_jar = std::string{kAndroidI18nApexDefaultPath} + "/javalib/core-icu4j.jar"; |
| EXPECT_EQ(GetArtApexData() + |
| "/dalvik-cache/arm/apex@com.android.i18n@javalib@core-icu4j.jar@classes.odex", |
| GetApexDataOdexFilename(i18n_jar, InstructionSet::kArm)); |
| |
| const std::string system_jar_apexdata_odex = |
| GetArtApexData() + "/dalvik-cache/x86/system@framework@cookie.jar@classes.odex"; |
| EXPECT_EQ(system_jar_apexdata_odex, |
| GetApexDataOdexFilename("/system/framework/cookie.jar", InstructionSet::kX86)); |
| } |
| |
| TEST_F(FileUtilsTest, GetApexDataBootImage) { |
| ScopedUnsetEnvironmentVariable android_root("ANDROID_ROOT"); |
| ScopedUnsetEnvironmentVariable art_apex_data("ART_APEX_DATA"); |
| |
| EXPECT_EQ(std::string{}, |
| GetApexDataBootImage(std::string{kAndroidI18nApexDefaultPath} + "/javalib/bar.jar")); |
| |
| // Check image location has the prefix "boot-" in front of the basename of dex location and |
| // that image suffix is .art. |
| const std::string system_jar = "/system/framework/disk.jar"; |
| const std::string boot_image = GetApexDataBootImage(system_jar); |
| EXPECT_EQ(GetArtApexData() + "/dalvik-cache/boot-disk.art", boot_image); |
| |
| // Check the image filename corresponds to the oat file for the same system jar. |
| const InstructionSet isa = InstructionSet::kArm64; |
| const std::string boot_image_filename = GetSystemImageFilename(boot_image.c_str(), isa); |
| const std::string accompanying_oat_file = ReplaceFileExtension(boot_image_filename, "oat"); |
| EXPECT_EQ(accompanying_oat_file, GetApexDataOatFilename(system_jar, isa)); |
| } |
| |
| TEST_F(FileUtilsTest, GetApexDataImage) { |
| ScopedUnsetEnvironmentVariable android_root("ANDROID_ROOT"); |
| ScopedUnsetEnvironmentVariable art_apex_data("ART_APEX_DATA"); |
| |
| EXPECT_EQ( |
| GetArtApexData() + "/dalvik-cache/apex@com.android.wifi@lib@javalib@bar.jar@classes.art", |
| GetApexDataImage(std::string {kAndroidWifiApexDefaultPath} + "/lib/javalib/bar.jar")); |
| |
| // Check image has basename of dex location with the .art suffix. |
| const char* jar = "/system/framework/mcguffin/test.jar"; |
| const std::string image = GetApexDataImage(jar); |
| EXPECT_EQ(GetArtApexData() + "/dalvik-cache/system@framework@mcguffin@test.jar@classes.art", |
| image); |
| |
| // Check the image filename corresponds to the .odex file for the same system jar. |
| const InstructionSet isa = InstructionSet::kX86_64; |
| const std::string image_filename = GetSystemImageFilename(image.c_str(), isa); |
| const std::string accompanying_odex_file = ReplaceFileExtension(image_filename, "odex"); |
| EXPECT_EQ(accompanying_odex_file, GetApexDataOdexFilename(jar, isa)); |
| } |
| |
| TEST_F(FileUtilsTest, GetApexDataDalvikCacheFilename) { |
| const std::string apex_jar = std::string {kAndroidWifiApexDefaultPath} + "/lib/javalib/bar.jar"; |
| EXPECT_EQ(GetArtApexData() + |
| "/dalvik-cache/x86_64/apex@com.android.wifi@lib@javalib@bar.jar@classes.art", |
| GetApexDataDalvikCacheFilename(apex_jar, InstructionSet::kX86_64, "art")); |
| |
| // Check dalvik-cache filename follows convention. |
| const std::string non_apex_jar = "/vendor/javalib/test.jar"; |
| const std::string art_filename = |
| GetApexDataDalvikCacheFilename(non_apex_jar, InstructionSet::kArm, "art"); |
| CHECK_EQ(GetArtApexData() + "/dalvik-cache/arm/vendor@javalib@test.jar@classes.art", |
| art_filename); |
| |
| // Check ".art", ".odex" and ".vdex" filenames are the same with the appropriate extensions |
| // substituted. |
| const std::string odex_filename = |
| GetApexDataDalvikCacheFilename(non_apex_jar, InstructionSet::kArm, "odex"); |
| CHECK_EQ(odex_filename, ReplaceFileExtension(art_filename, "odex")); |
| const std::string vdex_filename = |
| GetApexDataDalvikCacheFilename(non_apex_jar, InstructionSet::kArm, "vdex"); |
| CHECK_EQ(vdex_filename, ReplaceFileExtension(art_filename, "vdex")); |
| } |
| |
| TEST_F(FileUtilsTest, OverrideDalvikCacheSubDirectory) { |
| ScopedUnsetEnvironmentVariable android_root("ANDROID_ROOT"); |
| ScopedUnsetEnvironmentVariable i18n_root("ANDROID_I18N_ROOT"); |
| ScopedUnsetEnvironmentVariable art_apex_data("ART_APEX_DATA"); |
| |
| ScopedOverrideDalvikCacheSubDirectory dalvik_cache("overridden-cache"); |
| |
| EXPECT_EQ(GetArtApexData() + "/overridden-cache/arm/boot-beep.oat", |
| GetApexDataOatFilename("/product/javalib/beep.jar", InstructionSet::kArm)); |
| |
| EXPECT_EQ(GetArtApexData() + "/overridden-cache/arm/data@some@code.odex", |
| GetApexDataOdexFilename("/data/some/code.dex", InstructionSet::kArm)); |
| |
| const std::string system_jar = "/system/framework/disk.jar"; |
| const std::string boot_image = GetApexDataBootImage(system_jar); |
| EXPECT_EQ(GetArtApexData() + "/overridden-cache/boot-disk.art", boot_image); |
| |
| EXPECT_EQ( |
| GetArtApexData() + "/overridden-cache/apex@com.android.wifi@lib@javalib@bar.jar@classes.art", |
| GetApexDataImage(std::string {kAndroidWifiApexDefaultPath} + "/lib/javalib/bar.jar")); |
| |
| const std::string apex_jar = std::string {kAndroidWifiApexDefaultPath} + "/lib/javalib/bar.jar"; |
| EXPECT_EQ(GetArtApexData() + |
| "/overridden-cache/x86_64/apex@com.android.wifi@lib@javalib@bar.jar@classes.art", |
| GetApexDataDalvikCacheFilename(apex_jar, InstructionSet::kX86_64, "art")); |
| } |
| |
| TEST_F(FileUtilsTest, GetSystemOdexFilenameForApex) { |
| ScopedUnsetEnvironmentVariable android_root("ANDROID_ROOT"); |
| |
| const std::string apex_jar = std::string {kAndroidArtApexDefaultPath} + "/javalib/some.jar"; |
| EXPECT_EQ( |
| GetAndroidRoot() + "/framework/oat/arm/apex@com.android.art@javalib@some.jar@classes.odex", |
| GetSystemOdexFilenameForApex(apex_jar, InstructionSet::kArm)); |
| } |
| |
| TEST_F(FileUtilsTest, ApexNameFromLocation) { |
| EXPECT_EQ("", ApexNameFromLocation("")); |
| EXPECT_EQ("", ApexNameFromLocation("/apex/com.android.foo")); |
| EXPECT_EQ("", ApexNameFromLocation("/apex//something")); |
| EXPECT_EQ("com.android.foo", ApexNameFromLocation("/apex/com.android.foo/")); |
| EXPECT_EQ("", ApexNameFromLocation("apex/com.android.foo/")); |
| EXPECT_EQ("foo", ApexNameFromLocation("/apex/foo/something.jar")); |
| EXPECT_EQ("", ApexNameFromLocation("/bar/foo/baz")); |
| EXPECT_EQ("", ApexNameFromLocation("/apexx/foo/baz")); |
| } |
| |
| } // namespace art |