| // 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 bp2build |
| |
| import ( |
| "android/soong/android" |
| "android/soong/cc" |
| "strings" |
| "testing" |
| ) |
| |
| const ( |
| // See cc/testing.go for more context |
| soongCcLibraryPreamble = ` |
| cc_defaults { |
| name: "linux_bionic_supported", |
| } |
| |
| toolchain_library { |
| name: "libclang_rt.builtins-x86_64-android", |
| defaults: ["linux_bionic_supported"], |
| vendor_available: true, |
| vendor_ramdisk_available: true, |
| product_available: true, |
| recovery_available: true, |
| native_bridge_supported: true, |
| src: "", |
| }` |
| ) |
| |
| func TestCcLibraryBp2Build(t *testing.T) { |
| // b/191166471 disabled in sc-dev |
| t.Skip() |
| testCases := []struct { |
| description string |
| moduleTypeUnderTest string |
| moduleTypeUnderTestFactory android.ModuleFactory |
| moduleTypeUnderTestBp2BuildMutator func(android.TopDownMutatorContext) |
| bp string |
| expectedBazelTargets []string |
| filesystem map[string]string |
| dir string |
| depsMutators []android.RegisterMutatorFunc |
| }{ |
| { |
| description: "cc_library - simple example", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| filesystem: map[string]string{ |
| "android.cpp": "", |
| "darwin.cpp": "", |
| // Refer to cc.headerExts for the supported header extensions in Soong. |
| "header.h": "", |
| "header.hh": "", |
| "header.hpp": "", |
| "header.hxx": "", |
| "header.h++": "", |
| "header.inl": "", |
| "header.inc": "", |
| "header.ipp": "", |
| "header.h.generic": "", |
| "impl.cpp": "", |
| "linux.cpp": "", |
| "x86.cpp": "", |
| "x86_64.cpp": "", |
| "foo-dir/a.h": "", |
| }, |
| bp: soongCcLibraryPreamble + ` |
| cc_library_headers { name: "some-headers" } |
| cc_library { |
| name: "foo-lib", |
| srcs: ["impl.cpp"], |
| cflags: ["-Wall"], |
| header_libs: ["some-headers"], |
| export_include_dirs: ["foo-dir"], |
| ldflags: ["-Wl,--exclude-libs=bar.a"], |
| arch: { |
| x86: { |
| ldflags: ["-Wl,--exclude-libs=baz.a"], |
| srcs: ["x86.cpp"], |
| }, |
| x86_64: { |
| ldflags: ["-Wl,--exclude-libs=qux.a"], |
| srcs: ["x86_64.cpp"], |
| }, |
| }, |
| target: { |
| android: { |
| srcs: ["android.cpp"], |
| }, |
| linux_glibc: { |
| srcs: ["linux.cpp"], |
| }, |
| darwin: { |
| srcs: ["darwin.cpp"], |
| }, |
| }, |
| } |
| `, |
| expectedBazelTargets: []string{`cc_library( |
| name = "foo-lib", |
| copts = [ |
| "-Wall", |
| "-I.", |
| ], |
| deps = [":some-headers"], |
| includes = ["foo-dir"], |
| linkopts = ["-Wl,--exclude-libs=bar.a"] + select({ |
| "//build/bazel/platforms/arch:x86": ["-Wl,--exclude-libs=baz.a"], |
| "//build/bazel/platforms/arch:x86_64": ["-Wl,--exclude-libs=qux.a"], |
| "//conditions:default": [], |
| }), |
| srcs = ["impl.cpp"] + select({ |
| "//build/bazel/platforms/arch:x86": ["x86.cpp"], |
| "//build/bazel/platforms/arch:x86_64": ["x86_64.cpp"], |
| "//conditions:default": [], |
| }) + select({ |
| "//build/bazel/platforms/os:android": ["android.cpp"], |
| "//build/bazel/platforms/os:darwin": ["darwin.cpp"], |
| "//build/bazel/platforms/os:linux": ["linux.cpp"], |
| "//conditions:default": [], |
| }), |
| )`}, |
| }, |
| { |
| description: "cc_library - trimmed example of //bionic/linker:ld-android", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| filesystem: map[string]string{ |
| "ld-android.cpp": "", |
| "linked_list.h": "", |
| "linker.h": "", |
| "linker_block_allocator.h": "", |
| "linker_cfi.h": "", |
| }, |
| bp: soongCcLibraryPreamble + ` |
| cc_library_headers { name: "libc_headers" } |
| cc_library { |
| name: "fake-ld-android", |
| srcs: ["ld_android.cpp"], |
| cflags: [ |
| "-Wall", |
| "-Wextra", |
| "-Wunused", |
| "-Werror", |
| ], |
| header_libs: ["libc_headers"], |
| ldflags: [ |
| "-Wl,--exclude-libs=libgcc.a", |
| "-Wl,--exclude-libs=libgcc_stripped.a", |
| "-Wl,--exclude-libs=libclang_rt.builtins-arm-android.a", |
| "-Wl,--exclude-libs=libclang_rt.builtins-aarch64-android.a", |
| "-Wl,--exclude-libs=libclang_rt.builtins-i686-android.a", |
| "-Wl,--exclude-libs=libclang_rt.builtins-x86_64-android.a", |
| ], |
| arch: { |
| x86: { |
| ldflags: ["-Wl,--exclude-libs=libgcc_eh.a"], |
| }, |
| x86_64: { |
| ldflags: ["-Wl,--exclude-libs=libgcc_eh.a"], |
| }, |
| }, |
| } |
| `, |
| expectedBazelTargets: []string{`cc_library( |
| name = "fake-ld-android", |
| copts = [ |
| "-Wall", |
| "-Wextra", |
| "-Wunused", |
| "-Werror", |
| "-I.", |
| ], |
| deps = [":libc_headers"], |
| linkopts = [ |
| "-Wl,--exclude-libs=libgcc.a", |
| "-Wl,--exclude-libs=libgcc_stripped.a", |
| "-Wl,--exclude-libs=libclang_rt.builtins-arm-android.a", |
| "-Wl,--exclude-libs=libclang_rt.builtins-aarch64-android.a", |
| "-Wl,--exclude-libs=libclang_rt.builtins-i686-android.a", |
| "-Wl,--exclude-libs=libclang_rt.builtins-x86_64-android.a", |
| ] + select({ |
| "//build/bazel/platforms/arch:x86": ["-Wl,--exclude-libs=libgcc_eh.a"], |
| "//build/bazel/platforms/arch:x86_64": ["-Wl,--exclude-libs=libgcc_eh.a"], |
| "//conditions:default": [], |
| }), |
| srcs = ["ld_android.cpp"], |
| )`}, |
| }, |
| { |
| description: "cc_library exclude_srcs - trimmed example of //external/arm-optimized-routines:libarm-optimized-routines-math", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| dir: "external", |
| filesystem: map[string]string{ |
| "external/math/cosf.c": "", |
| "external/math/erf.c": "", |
| "external/math/erf_data.c": "", |
| "external/math/erff.c": "", |
| "external/math/erff_data.c": "", |
| "external/Android.bp": ` |
| cc_library { |
| name: "fake-libarm-optimized-routines-math", |
| exclude_srcs: [ |
| // Provided by: |
| // bionic/libm/upstream-freebsd/lib/msun/src/s_erf.c |
| // bionic/libm/upstream-freebsd/lib/msun/src/s_erff.c |
| "math/erf.c", |
| "math/erf_data.c", |
| "math/erff.c", |
| "math/erff_data.c", |
| ], |
| srcs: [ |
| "math/*.c", |
| ], |
| // arch-specific settings |
| arch: { |
| arm64: { |
| cflags: [ |
| "-DHAVE_FAST_FMA=1", |
| ], |
| }, |
| }, |
| bazel_module: { bp2build_available: true }, |
| } |
| `, |
| }, |
| bp: soongCcLibraryPreamble, |
| expectedBazelTargets: []string{`cc_library( |
| name = "fake-libarm-optimized-routines-math", |
| copts = ["-Iexternal"] + select({ |
| "//build/bazel/platforms/arch:arm64": ["-DHAVE_FAST_FMA=1"], |
| "//conditions:default": [], |
| }), |
| srcs = ["math/cosf.c"], |
| )`}, |
| }, |
| { |
| description: "cc_library shared/static props", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build}, |
| dir: "foo/bar", |
| filesystem: map[string]string{ |
| "foo/bar/both.cpp": "", |
| "foo/bar/sharedonly.cpp": "", |
| "foo/bar/staticonly.cpp": "", |
| "foo/bar/Android.bp": ` |
| cc_library { |
| name: "a", |
| srcs: ["both.cpp"], |
| cflags: ["bothflag"], |
| shared_libs: ["shared_dep_for_both"], |
| static_libs: ["static_dep_for_both"], |
| whole_static_libs: ["whole_static_lib_for_both"], |
| static: { |
| srcs: ["staticonly.cpp"], |
| cflags: ["staticflag"], |
| shared_libs: ["shared_dep_for_static"], |
| static_libs: ["static_dep_for_static"], |
| whole_static_libs: ["whole_static_lib_for_static"], |
| }, |
| shared: { |
| srcs: ["sharedonly.cpp"], |
| cflags: ["sharedflag"], |
| shared_libs: ["shared_dep_for_shared"], |
| static_libs: ["static_dep_for_shared"], |
| whole_static_libs: ["whole_static_lib_for_shared"], |
| }, |
| bazel_module: { bp2build_available: true }, |
| } |
| |
| cc_library_static { name: "static_dep_for_shared" } |
| |
| cc_library_static { name: "static_dep_for_static" } |
| |
| cc_library_static { name: "static_dep_for_both" } |
| |
| cc_library_static { name: "whole_static_lib_for_shared" } |
| |
| cc_library_static { name: "whole_static_lib_for_static" } |
| |
| cc_library_static { name: "whole_static_lib_for_both" } |
| |
| cc_library { name: "shared_dep_for_shared" } |
| |
| cc_library { name: "shared_dep_for_static" } |
| |
| cc_library { name: "shared_dep_for_both" } |
| `, |
| }, |
| bp: soongCcLibraryPreamble, |
| expectedBazelTargets: []string{`cc_library( |
| name = "a", |
| copts = [ |
| "bothflag", |
| "-Ifoo/bar", |
| ], |
| deps = [":static_dep_for_both"], |
| dynamic_deps = [":shared_dep_for_both"], |
| dynamic_deps_for_shared = [":shared_dep_for_shared"], |
| dynamic_deps_for_static = [":shared_dep_for_static"], |
| shared_copts = ["sharedflag"], |
| shared_srcs = ["sharedonly.cpp"], |
| srcs = ["both.cpp"], |
| static_copts = ["staticflag"], |
| static_deps_for_shared = [":static_dep_for_shared"], |
| static_deps_for_static = [":static_dep_for_static"], |
| static_srcs = ["staticonly.cpp"], |
| whole_archive_deps = [":whole_static_lib_for_both"], |
| whole_archive_deps_for_shared = [":whole_static_lib_for_shared"], |
| whole_archive_deps_for_static = [":whole_static_lib_for_static"], |
| )`}, |
| }, |
| { |
| description: "cc_library non-configured version script", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build}, |
| dir: "foo/bar", |
| filesystem: map[string]string{ |
| "foo/bar/Android.bp": ` |
| cc_library { |
| name: "a", |
| srcs: ["a.cpp"], |
| version_script: "v.map", |
| bazel_module: { bp2build_available: true }, |
| } |
| `, |
| }, |
| bp: soongCcLibraryPreamble, |
| expectedBazelTargets: []string{`cc_library( |
| name = "a", |
| copts = ["-Ifoo/bar"], |
| srcs = ["a.cpp"], |
| version_script = "v.map", |
| )`}, |
| }, |
| { |
| description: "cc_library configured version script", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build}, |
| dir: "foo/bar", |
| filesystem: map[string]string{ |
| "foo/bar/Android.bp": ` |
| cc_library { |
| name: "a", |
| srcs: ["a.cpp"], |
| arch: { |
| arm: { |
| version_script: "arm.map", |
| }, |
| arm64: { |
| version_script: "arm64.map", |
| }, |
| }, |
| |
| bazel_module: { bp2build_available: true }, |
| } |
| `, |
| }, |
| bp: soongCcLibraryPreamble, |
| expectedBazelTargets: []string{`cc_library( |
| name = "a", |
| copts = ["-Ifoo/bar"], |
| srcs = ["a.cpp"], |
| version_script = select({ |
| "//build/bazel/platforms/arch:arm": "arm.map", |
| "//build/bazel/platforms/arch:arm64": "arm64.map", |
| "//conditions:default": None, |
| }), |
| )`}, |
| }, |
| { |
| description: "cc_library shared_libs", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build}, |
| dir: "foo/bar", |
| filesystem: map[string]string{ |
| "foo/bar/Android.bp": ` |
| cc_library { |
| name: "mylib", |
| bazel_module: { bp2build_available: true }, |
| } |
| |
| cc_library { |
| name: "a", |
| shared_libs: ["mylib",], |
| bazel_module: { bp2build_available: true }, |
| } |
| `, |
| }, |
| bp: soongCcLibraryPreamble, |
| expectedBazelTargets: []string{`cc_library( |
| name = "a", |
| copts = ["-Ifoo/bar"], |
| dynamic_deps = [":mylib"], |
| )`, `cc_library( |
| name = "mylib", |
| copts = ["-Ifoo/bar"], |
| )`}, |
| }, |
| { |
| description: "cc_library pack_relocations test", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build}, |
| dir: "foo/bar", |
| filesystem: map[string]string{ |
| "foo/bar/Android.bp": ` |
| cc_library { |
| name: "a", |
| srcs: ["a.cpp"], |
| pack_relocations: false, |
| bazel_module: { bp2build_available: true }, |
| } |
| |
| cc_library { |
| name: "b", |
| srcs: ["b.cpp"], |
| arch: { |
| x86_64: { |
| pack_relocations: false, |
| }, |
| }, |
| bazel_module: { bp2build_available: true }, |
| } |
| |
| cc_library { |
| name: "c", |
| srcs: ["c.cpp"], |
| target: { |
| darwin: { |
| pack_relocations: false, |
| }, |
| }, |
| bazel_module: { bp2build_available: true }, |
| }`, |
| }, |
| bp: soongCcLibraryPreamble, |
| expectedBazelTargets: []string{`cc_library( |
| name = "a", |
| copts = ["-Ifoo/bar"], |
| linkopts = ["-Wl,--pack-dyn-relocs=none"], |
| srcs = ["a.cpp"], |
| )`, `cc_library( |
| name = "b", |
| copts = ["-Ifoo/bar"], |
| linkopts = select({ |
| "//build/bazel/platforms/arch:x86_64": ["-Wl,--pack-dyn-relocs=none"], |
| "//conditions:default": [], |
| }), |
| srcs = ["b.cpp"], |
| )`, `cc_library( |
| name = "c", |
| copts = ["-Ifoo/bar"], |
| linkopts = select({ |
| "//build/bazel/platforms/os:darwin": ["-Wl,--pack-dyn-relocs=none"], |
| "//conditions:default": [], |
| }), |
| srcs = ["c.cpp"], |
| )`}, |
| }, |
| { |
| description: "cc_library spaces in copts", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build}, |
| dir: "foo/bar", |
| filesystem: map[string]string{ |
| "foo/bar/Android.bp": ` |
| cc_library { |
| name: "a", |
| cflags: ["-include header.h",], |
| bazel_module: { bp2build_available: true }, |
| } |
| `, |
| }, |
| bp: soongCcLibraryPreamble, |
| expectedBazelTargets: []string{`cc_library( |
| name = "a", |
| copts = [ |
| "-include", |
| "header.h", |
| "-Ifoo/bar", |
| ], |
| )`}, |
| }, |
| { |
| description: "cc_library cppflags goes into copts", |
| moduleTypeUnderTest: "cc_library", |
| moduleTypeUnderTestFactory: cc.LibraryFactory, |
| moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryBp2Build, |
| depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build}, |
| dir: "foo/bar", |
| filesystem: map[string]string{ |
| "foo/bar/Android.bp": `cc_library { |
| name: "a", |
| srcs: ["a.cpp"], |
| cflags: [ |
| "-Wall", |
| ], |
| cppflags: [ |
| "-fsigned-char", |
| "-pedantic", |
| ], |
| arch: { |
| arm64: { |
| cppflags: ["-DARM64=1"], |
| }, |
| }, |
| target: { |
| android: { |
| cppflags: ["-DANDROID=1"], |
| }, |
| }, |
| bazel_module: { bp2build_available: true }, |
| } |
| `, |
| }, |
| bp: soongCcLibraryPreamble, |
| expectedBazelTargets: []string{`cc_library( |
| name = "a", |
| copts = [ |
| "-Wall", |
| "-fsigned-char", |
| "-pedantic", |
| "-Ifoo/bar", |
| ] + select({ |
| "//build/bazel/platforms/arch:arm64": ["-DARM64=1"], |
| "//conditions:default": [], |
| }) + select({ |
| "//build/bazel/platforms/os:android": ["-DANDROID=1"], |
| "//conditions:default": [], |
| }), |
| srcs = ["a.cpp"], |
| )`}, |
| }, |
| } |
| |
| dir := "." |
| for _, testCase := range testCases { |
| filesystem := make(map[string][]byte) |
| toParse := []string{ |
| "Android.bp", |
| } |
| for f, content := range testCase.filesystem { |
| if strings.HasSuffix(f, "Android.bp") { |
| toParse = append(toParse, f) |
| } |
| filesystem[f] = []byte(content) |
| } |
| config := android.TestConfig(buildDir, nil, testCase.bp, filesystem) |
| ctx := android.NewTestContext(config) |
| |
| cc.RegisterCCBuildComponents(ctx) |
| ctx.RegisterModuleType("cc_library_static", cc.LibraryStaticFactory) |
| ctx.RegisterModuleType("toolchain_library", cc.ToolchainLibraryFactory) |
| ctx.RegisterModuleType("cc_library_headers", cc.LibraryHeaderFactory) |
| ctx.RegisterModuleType(testCase.moduleTypeUnderTest, testCase.moduleTypeUnderTestFactory) |
| ctx.RegisterBp2BuildMutator(testCase.moduleTypeUnderTest, testCase.moduleTypeUnderTestBp2BuildMutator) |
| ctx.RegisterBp2BuildConfig(bp2buildConfig) // TODO(jingwen): make this the default for all tests |
| for _, m := range testCase.depsMutators { |
| ctx.DepsBp2BuildMutators(m) |
| } |
| ctx.RegisterForBazelConversion() |
| |
| _, errs := ctx.ParseFileList(dir, toParse) |
| if Errored(t, testCase.description, errs) { |
| continue |
| } |
| _, errs = ctx.ResolveDependencies(config) |
| if Errored(t, testCase.description, errs) { |
| continue |
| } |
| |
| checkDir := dir |
| if testCase.dir != "" { |
| checkDir = testCase.dir |
| } |
| codegenCtx := NewCodegenContext(config, *ctx.Context, Bp2Build) |
| bazelTargets := generateBazelTargetsForDir(codegenCtx, checkDir) |
| if actualCount, expectedCount := len(bazelTargets), len(testCase.expectedBazelTargets); actualCount != expectedCount { |
| t.Errorf("%s: Expected %d bazel target, got %d", testCase.description, expectedCount, actualCount) |
| } else { |
| for i, target := range bazelTargets { |
| if w, g := testCase.expectedBazelTargets[i], target.content; w != g { |
| t.Errorf( |
| "%s: Expected generated Bazel target to be '%s', got '%s'", |
| testCase.description, |
| w, |
| g, |
| ) |
| } |
| } |
| } |
| } |
| } |
