|  | // Copyright 2021 Google Inc. All rights reserved. | 
|  | // | 
|  | // 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. | 
|  |  | 
|  | package filesystem | 
|  |  | 
|  | import ( | 
|  | "os" | 
|  | "path/filepath" | 
|  | "testing" | 
|  |  | 
|  | "android/soong/android" | 
|  | "android/soong/bpf" | 
|  | "android/soong/cc" | 
|  | "android/soong/etc" | 
|  | "android/soong/java" | 
|  | "android/soong/phony" | 
|  |  | 
|  | "github.com/google/blueprint/proptools" | 
|  | ) | 
|  |  | 
|  | func TestMain(m *testing.M) { | 
|  | os.Exit(m.Run()) | 
|  | } | 
|  |  | 
|  | var fixture = android.GroupFixturePreparers( | 
|  | android.PrepareForIntegrationTestWithAndroid, | 
|  | android.PrepareForTestWithAndroidBuildComponents, | 
|  | bpf.PrepareForTestWithBpf, | 
|  | cc.PrepareForIntegrationTestWithCc, | 
|  | etc.PrepareForTestWithPrebuiltEtc, | 
|  | java.PrepareForTestWithJavaBuildComponents, | 
|  | java.PrepareForTestWithJavaDefaultModules, | 
|  | phony.PrepareForTestWithPhony, | 
|  | PrepareForTestWithFilesystemBuildComponents, | 
|  | ) | 
|  |  | 
|  | func TestFileSystemDeps(t *testing.T) { | 
|  | result := fixture.RunTestWithBp(t, ` | 
|  | android_filesystem { | 
|  | name: "myfilesystem", | 
|  | multilib: { | 
|  | common: { | 
|  | deps: [ | 
|  | "bpf.o", | 
|  | "phony", | 
|  | ], | 
|  | }, | 
|  | lib32: { | 
|  | deps: [ | 
|  | "foo", | 
|  | "libbar", | 
|  | ], | 
|  | }, | 
|  | lib64: { | 
|  | deps: [ | 
|  | "libbar", | 
|  | ], | 
|  | }, | 
|  | }, | 
|  | compile_multilib: "both", | 
|  | } | 
|  |  | 
|  | bpf { | 
|  | name: "bpf.o", | 
|  | srcs: ["bpf.c"], | 
|  | } | 
|  |  | 
|  | cc_binary { | 
|  | name: "foo", | 
|  | compile_multilib: "prefer32", | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libbar", | 
|  | required: ["libbaz"], | 
|  | target: { | 
|  | platform: { | 
|  | required: ["lib_platform_only"], | 
|  | }, | 
|  | }, | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libbaz", | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "lib_platform_only", | 
|  | } | 
|  |  | 
|  | phony { | 
|  | name: "phony", | 
|  | required: [ | 
|  | "libquz", | 
|  | "myapp", | 
|  | ], | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libquz", | 
|  | } | 
|  |  | 
|  | android_app { | 
|  | name: "myapp", | 
|  | platform_apis: true, | 
|  | installable: true, | 
|  | } | 
|  | `) | 
|  |  | 
|  | // produces "myfilesystem.img" | 
|  | result.ModuleForTests("myfilesystem", "android_common").Output("myfilesystem.img") | 
|  |  | 
|  | fs := result.ModuleForTests("myfilesystem", "android_common").Module().(*filesystem) | 
|  | expected := []string{ | 
|  | "app/myapp/myapp.apk", | 
|  | "bin/foo", | 
|  | "lib/libbar.so", | 
|  | "lib64/libbar.so", | 
|  | "lib64/libbaz.so", | 
|  | "lib64/libquz.so", | 
|  | "lib64/lib_platform_only.so", | 
|  | "etc/bpf/bpf.o", | 
|  | } | 
|  | for _, e := range expected { | 
|  | android.AssertStringListContains(t, "missing entry", fs.entries, e) | 
|  | } | 
|  | } | 
|  |  | 
|  | func TestIncludeMakeBuiltFiles(t *testing.T) { | 
|  | result := fixture.RunTestWithBp(t, ` | 
|  | android_filesystem { | 
|  | name: "myfilesystem", | 
|  | include_make_built_files: "system", | 
|  | } | 
|  | `) | 
|  |  | 
|  | output := result.ModuleForTests("myfilesystem", "android_common").Output("myfilesystem.img") | 
|  |  | 
|  | stampFile := filepath.Join(result.Config.OutDir(), "target/product/test_device/obj/PACKAGING/system_intermediates/staging_dir.stamp") | 
|  | fileListFile := filepath.Join(result.Config.OutDir(), "target/product/test_device/obj/PACKAGING/system_intermediates/file_list.txt") | 
|  | android.AssertStringListContains(t, "deps of filesystem must include the staging dir stamp file", output.Implicits.Strings(), stampFile) | 
|  | android.AssertStringListContains(t, "deps of filesystem must include the staging dir file list", output.Implicits.Strings(), fileListFile) | 
|  | } | 
|  |  | 
|  | func TestFileSystemFillsLinkerConfigWithStubLibs(t *testing.T) { | 
|  | result := fixture.RunTestWithBp(t, ` | 
|  | android_system_image { | 
|  | name: "myfilesystem", | 
|  | deps: [ | 
|  | "libfoo", | 
|  | "libbar", | 
|  | ], | 
|  | linker_config_src: "linker.config.json", | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libfoo", | 
|  | stubs: { | 
|  | symbol_file: "libfoo.map.txt", | 
|  | }, | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libbar", | 
|  | } | 
|  | `) | 
|  |  | 
|  | module := result.ModuleForTests("myfilesystem", "android_common") | 
|  | output := module.Output("system/etc/linker.config.pb") | 
|  |  | 
|  | android.AssertStringDoesContain(t, "linker.config.pb should have libfoo", | 
|  | output.RuleParams.Command, "libfoo.so") | 
|  | android.AssertStringDoesNotContain(t, "linker.config.pb should not have libbar", | 
|  | output.RuleParams.Command, "libbar.so") | 
|  | } | 
|  |  | 
|  | func registerComponent(ctx android.RegistrationContext) { | 
|  | ctx.RegisterModuleType("component", componentFactory) | 
|  | } | 
|  |  | 
|  | func componentFactory() android.Module { | 
|  | m := &component{} | 
|  | m.AddProperties(&m.properties) | 
|  | android.InitAndroidArchModule(m, android.DeviceSupported, android.MultilibCommon) | 
|  | return m | 
|  | } | 
|  |  | 
|  | type component struct { | 
|  | android.ModuleBase | 
|  | properties struct { | 
|  | Install_copy_in_data []string | 
|  | } | 
|  | } | 
|  |  | 
|  | func (c *component) GenerateAndroidBuildActions(ctx android.ModuleContext) { | 
|  | output := android.PathForModuleOut(ctx, c.Name()) | 
|  | dir := android.PathForModuleInstall(ctx, "components") | 
|  | ctx.InstallFile(dir, c.Name(), output) | 
|  |  | 
|  | dataDir := android.PathForModuleInPartitionInstall(ctx, "data", "components") | 
|  | for _, d := range c.properties.Install_copy_in_data { | 
|  | ctx.InstallFile(dataDir, d, output) | 
|  | } | 
|  | } | 
|  |  | 
|  | func TestFileSystemGathersItemsOnlyInSystemPartition(t *testing.T) { | 
|  | f := android.GroupFixturePreparers(fixture, android.FixtureRegisterWithContext(registerComponent)) | 
|  | result := f.RunTestWithBp(t, ` | 
|  | android_system_image { | 
|  | name: "myfilesystem", | 
|  | multilib: { | 
|  | common: { | 
|  | deps: ["foo"], | 
|  | }, | 
|  | }, | 
|  | linker_config_src: "linker.config.json", | 
|  | } | 
|  | component { | 
|  | name: "foo", | 
|  | install_copy_in_data: ["bar"], | 
|  | } | 
|  | `) | 
|  |  | 
|  | module := result.ModuleForTests("myfilesystem", "android_common").Module().(*systemImage) | 
|  | android.AssertDeepEquals(t, "entries should have foo only", []string{"components/foo"}, module.entries) | 
|  | } | 
|  |  | 
|  | func TestAvbGenVbmetaImage(t *testing.T) { | 
|  | result := fixture.RunTestWithBp(t, ` | 
|  | avb_gen_vbmeta_image { | 
|  | name: "input_hashdesc", | 
|  | src: "input.img", | 
|  | partition_name: "input_partition_name", | 
|  | salt: "2222", | 
|  | }`) | 
|  | cmd := result.ModuleForTests("input_hashdesc", "android_arm64_armv8-a").Rule("avbGenVbmetaImage").RuleParams.Command | 
|  | android.AssertStringDoesContain(t, "Can't find correct --partition_name argument", | 
|  | cmd, "--partition_name input_partition_name") | 
|  | android.AssertStringDoesContain(t, "Can't find --do_not_append_vbmeta_image", | 
|  | cmd, "--do_not_append_vbmeta_image") | 
|  | android.AssertStringDoesContain(t, "Can't find --output_vbmeta_image", | 
|  | cmd, "--output_vbmeta_image ") | 
|  | android.AssertStringDoesContain(t, "Can't find --salt argument", | 
|  | cmd, "--salt 2222") | 
|  | } | 
|  |  | 
|  | func TestAvbAddHashFooter(t *testing.T) { | 
|  | result := fixture.RunTestWithBp(t, ` | 
|  | avb_gen_vbmeta_image { | 
|  | name: "input_hashdesc", | 
|  | src: "input.img", | 
|  | partition_name: "input", | 
|  | salt: "2222", | 
|  | } | 
|  |  | 
|  | avb_add_hash_footer { | 
|  | name: "myfooter", | 
|  | src: "input.img", | 
|  | filename: "output.img", | 
|  | partition_name: "mypartition", | 
|  | private_key: "mykey", | 
|  | salt: "1111", | 
|  | props: [ | 
|  | { | 
|  | name: "prop1", | 
|  | value: "value1", | 
|  | }, | 
|  | { | 
|  | name: "prop2", | 
|  | file: "value_file", | 
|  | }, | 
|  | ], | 
|  | include_descriptors_from_images: ["input_hashdesc"], | 
|  | } | 
|  | `) | 
|  | cmd := result.ModuleForTests("myfooter", "android_arm64_armv8-a").Rule("avbAddHashFooter").RuleParams.Command | 
|  | android.AssertStringDoesContain(t, "Can't find correct --partition_name argument", | 
|  | cmd, "--partition_name mypartition") | 
|  | android.AssertStringDoesContain(t, "Can't find correct --key argument", | 
|  | cmd, "--key mykey") | 
|  | android.AssertStringDoesContain(t, "Can't find --salt argument", | 
|  | cmd, "--salt 1111") | 
|  | android.AssertStringDoesContain(t, "Can't find --prop argument", | 
|  | cmd, "--prop 'prop1:value1'") | 
|  | android.AssertStringDoesContain(t, "Can't find --prop_from_file argument", | 
|  | cmd, "--prop_from_file 'prop2:value_file'") | 
|  | android.AssertStringDoesContain(t, "Can't find --include_descriptors_from_image", | 
|  | cmd, "--include_descriptors_from_image ") | 
|  | } | 
|  |  | 
|  | func TestFileSystemWithCoverageVariants(t *testing.T) { | 
|  | context := android.GroupFixturePreparers( | 
|  | fixture, | 
|  | android.FixtureModifyProductVariables(func(variables android.FixtureProductVariables) { | 
|  | variables.GcovCoverage = proptools.BoolPtr(true) | 
|  | variables.Native_coverage = proptools.BoolPtr(true) | 
|  | }), | 
|  | ) | 
|  |  | 
|  | result := context.RunTestWithBp(t, ` | 
|  | prebuilt_etc { | 
|  | name: "prebuilt", | 
|  | src: ":myfilesystem", | 
|  | } | 
|  |  | 
|  | android_system_image { | 
|  | name: "myfilesystem", | 
|  | deps: [ | 
|  | "libfoo", | 
|  | ], | 
|  | linker_config_src: "linker.config.json", | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libfoo", | 
|  | shared_libs: [ | 
|  | "libbar", | 
|  | ], | 
|  | stl: "none", | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libbar", | 
|  | stl: "none", | 
|  | } | 
|  | `) | 
|  |  | 
|  | filesystem := result.ModuleForTests("myfilesystem", "android_common_cov") | 
|  | inputs := filesystem.Output("myfilesystem.img").Implicits | 
|  | android.AssertStringListContains(t, "filesystem should have libfoo(cov)", | 
|  | inputs.Strings(), | 
|  | "out/soong/.intermediates/libfoo/android_arm64_armv8-a_shared_cov/libfoo.so") | 
|  | android.AssertStringListContains(t, "filesystem should have libbar(cov)", | 
|  | inputs.Strings(), | 
|  | "out/soong/.intermediates/libbar/android_arm64_armv8-a_shared_cov/libbar.so") | 
|  |  | 
|  | filesystemOutput := filesystem.Output("myfilesystem.img").Output | 
|  | prebuiltInput := result.ModuleForTests("prebuilt", "android_arm64_armv8-a").Rule("Cp").Input | 
|  | if filesystemOutput != prebuiltInput { | 
|  | t.Error("prebuilt should use cov variant of filesystem") | 
|  | } | 
|  | } | 
|  |  | 
|  | func TestSystemImageDefaults(t *testing.T) { | 
|  | result := fixture.RunTestWithBp(t, ` | 
|  | android_filesystem_defaults { | 
|  | name: "defaults", | 
|  | multilib: { | 
|  | common: { | 
|  | deps: [ | 
|  | "phony", | 
|  | ], | 
|  | }, | 
|  | lib64: { | 
|  | deps: [ | 
|  | "libbar", | 
|  | ], | 
|  | }, | 
|  | }, | 
|  | compile_multilib: "both", | 
|  | } | 
|  |  | 
|  | android_system_image { | 
|  | name: "system", | 
|  | defaults: ["defaults"], | 
|  | multilib: { | 
|  | lib32: { | 
|  | deps: [ | 
|  | "foo", | 
|  | "libbar", | 
|  | ], | 
|  | }, | 
|  | }, | 
|  | } | 
|  |  | 
|  | cc_binary { | 
|  | name: "foo", | 
|  | compile_multilib: "prefer32", | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libbar", | 
|  | required: ["libbaz"], | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libbaz", | 
|  | } | 
|  |  | 
|  | phony { | 
|  | name: "phony", | 
|  | required: ["libquz"], | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libquz", | 
|  | } | 
|  | `) | 
|  |  | 
|  | fs := result.ModuleForTests("system", "android_common").Module().(*systemImage) | 
|  | expected := []string{ | 
|  | "bin/foo", | 
|  | "lib/libbar.so", | 
|  | "lib64/libbar.so", | 
|  | "lib64/libbaz.so", | 
|  | "lib64/libquz.so", | 
|  | } | 
|  | for _, e := range expected { | 
|  | android.AssertStringListContains(t, "missing entry", fs.entries, e) | 
|  | } | 
|  | } | 
|  |  | 
|  | func TestInconsistentPartitionTypesInDefaults(t *testing.T) { | 
|  | fixture.ExtendWithErrorHandler(android.FixtureExpectsOneErrorPattern( | 
|  | "doesn't match with the partition type")). | 
|  | RunTestWithBp(t, ` | 
|  | android_filesystem_defaults { | 
|  | name: "system_ext_def", | 
|  | partition_type: "system_ext", | 
|  | } | 
|  |  | 
|  | android_filesystem_defaults { | 
|  | name: "system_def", | 
|  | partition_type: "system", | 
|  | defaults: ["system_ext_def"], | 
|  | } | 
|  |  | 
|  | android_system_image { | 
|  | name: "system", | 
|  | defaults: ["system_def"], | 
|  | } | 
|  | `) | 
|  | } | 
|  |  | 
|  | func TestPreventDuplicatedEntries(t *testing.T) { | 
|  | fixture.ExtendWithErrorHandler(android.FixtureExpectsOneErrorPattern( | 
|  | "packaging conflict at")). | 
|  | RunTestWithBp(t, ` | 
|  | android_filesystem { | 
|  | name: "fs", | 
|  | deps: [ | 
|  | "foo", | 
|  | "foo_dup", | 
|  | ], | 
|  | } | 
|  |  | 
|  | cc_binary { | 
|  | name: "foo", | 
|  | } | 
|  |  | 
|  | cc_binary { | 
|  | name: "foo_dup", | 
|  | stem: "foo", | 
|  | } | 
|  | `) | 
|  | } | 
|  |  | 
|  | func TestTrackPhonyAsRequiredDep(t *testing.T) { | 
|  | result := fixture.RunTestWithBp(t, ` | 
|  | android_filesystem { | 
|  | name: "fs", | 
|  | deps: ["foo"], | 
|  | } | 
|  |  | 
|  | cc_binary { | 
|  | name: "foo", | 
|  | required: ["phony"], | 
|  | } | 
|  |  | 
|  | phony { | 
|  | name: "phony", | 
|  | required: ["libbar"], | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libbar", | 
|  | } | 
|  | `) | 
|  |  | 
|  | fs := result.ModuleForTests("fs", "android_common").Module().(*filesystem) | 
|  | expected := []string{ | 
|  | "bin/foo", | 
|  | "lib64/libbar.so", | 
|  | } | 
|  | for _, e := range expected { | 
|  | android.AssertStringListContains(t, "missing entry", fs.entries, e) | 
|  | } | 
|  | } | 
|  |  | 
|  | func TestFilterOutUnsupportedArches(t *testing.T) { | 
|  | result := fixture.RunTestWithBp(t, ` | 
|  | android_filesystem { | 
|  | name: "fs_64_only", | 
|  | deps: ["foo"], | 
|  | } | 
|  |  | 
|  | android_filesystem { | 
|  | name: "fs_64_32", | 
|  | compile_multilib: "both", | 
|  | deps: ["foo"], | 
|  | } | 
|  |  | 
|  | cc_binary { | 
|  | name: "foo", | 
|  | required: ["phony"], | 
|  | } | 
|  |  | 
|  | phony { | 
|  | name: "phony", | 
|  | required: [ | 
|  | "libbar", | 
|  | "app", | 
|  | ], | 
|  | } | 
|  |  | 
|  | cc_library { | 
|  | name: "libbar", | 
|  | } | 
|  |  | 
|  | android_app { | 
|  | name: "app", | 
|  | srcs: ["a.java"], | 
|  | platform_apis: true, | 
|  | } | 
|  | `) | 
|  | testcases := []struct { | 
|  | fsName     string | 
|  | expected   []string | 
|  | unexpected []string | 
|  | }{ | 
|  | { | 
|  | fsName:     "fs_64_only", | 
|  | expected:   []string{"app/app/app.apk", "bin/foo", "lib64/libbar.so"}, | 
|  | unexpected: []string{"lib/libbar.so"}, | 
|  | }, | 
|  | { | 
|  | fsName:     "fs_64_32", | 
|  | expected:   []string{"app/app/app.apk", "bin/foo", "lib64/libbar.so", "lib/libbar.so"}, | 
|  | unexpected: []string{}, | 
|  | }, | 
|  | } | 
|  | for _, c := range testcases { | 
|  | fs := result.ModuleForTests(c.fsName, "android_common").Module().(*filesystem) | 
|  | for _, e := range c.expected { | 
|  | android.AssertStringListContains(t, "missing entry", fs.entries, e) | 
|  | } | 
|  | for _, e := range c.unexpected { | 
|  | android.AssertStringListDoesNotContain(t, "unexpected entry", fs.entries, e) | 
|  | } | 
|  | } | 
|  | } |