b4628eb03f
This CL refactors the bp2build code generator to pretty print lists with a single element on one line, instead of taking up three lines, which can make BUILD files unnecessarily long. A single line singleton list is also more commonly used in BUILD files. Test: TH Change-Id: Ic9e44741bbb070c8f45925466b9ccdd0608498b2
320 lines
10 KiB
Go
320 lines
10 KiB
Go
// 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
|
|
soongCcLibraryHeadersPreamble = `
|
|
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 TestCcLibraryHeadersLoadStatement(t *testing.T) {
|
|
testCases := []struct {
|
|
bazelTargets BazelTargets
|
|
expectedLoadStatements string
|
|
}{
|
|
{
|
|
bazelTargets: BazelTargets{
|
|
BazelTarget{
|
|
name: "cc_library_headers_target",
|
|
ruleClass: "cc_library_headers",
|
|
// Note: no bzlLoadLocation for native rules
|
|
},
|
|
},
|
|
expectedLoadStatements: ``,
|
|
},
|
|
}
|
|
|
|
for _, testCase := range testCases {
|
|
actual := testCase.bazelTargets.LoadStatements()
|
|
expected := testCase.expectedLoadStatements
|
|
if actual != expected {
|
|
t.Fatalf("Expected load statements to be %s, got %s", expected, actual)
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
func TestCcLibraryHeadersBp2Build(t *testing.T) {
|
|
testCases := []struct {
|
|
description string
|
|
moduleTypeUnderTest string
|
|
moduleTypeUnderTestFactory android.ModuleFactory
|
|
moduleTypeUnderTestBp2BuildMutator func(android.TopDownMutatorContext)
|
|
preArchMutators []android.RegisterMutatorFunc
|
|
depsMutators []android.RegisterMutatorFunc
|
|
bp string
|
|
expectedBazelTargets []string
|
|
filesystem map[string]string
|
|
dir string
|
|
}{
|
|
{
|
|
description: "cc_library_headers test",
|
|
moduleTypeUnderTest: "cc_library_headers",
|
|
moduleTypeUnderTestFactory: cc.LibraryHeaderFactory,
|
|
moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryHeadersBp2Build,
|
|
filesystem: map[string]string{
|
|
"lib-1/lib1a.h": "",
|
|
"lib-1/lib1b.h": "",
|
|
"lib-2/lib2a.h": "",
|
|
"lib-2/lib2b.h": "",
|
|
"dir-1/dir1a.h": "",
|
|
"dir-1/dir1b.h": "",
|
|
"dir-2/dir2a.h": "",
|
|
"dir-2/dir2b.h": "",
|
|
"arch_arm64_exported_include_dir/a.h": "",
|
|
"arch_x86_exported_include_dir/b.h": "",
|
|
"arch_x86_64_exported_include_dir/c.h": "",
|
|
},
|
|
bp: soongCcLibraryHeadersPreamble + `
|
|
cc_library_headers {
|
|
name: "lib-1",
|
|
export_include_dirs: ["lib-1"],
|
|
}
|
|
|
|
cc_library_headers {
|
|
name: "lib-2",
|
|
export_include_dirs: ["lib-2"],
|
|
}
|
|
|
|
cc_library_headers {
|
|
name: "foo_headers",
|
|
export_include_dirs: ["dir-1", "dir-2"],
|
|
header_libs: ["lib-1", "lib-2"],
|
|
|
|
arch: {
|
|
arm64: {
|
|
// We expect dir-1 headers to be dropped, because dir-1 is already in export_include_dirs
|
|
export_include_dirs: ["arch_arm64_exported_include_dir", "dir-1"],
|
|
},
|
|
x86: {
|
|
export_include_dirs: ["arch_x86_exported_include_dir"],
|
|
},
|
|
x86_64: {
|
|
export_include_dirs: ["arch_x86_64_exported_include_dir"],
|
|
},
|
|
},
|
|
|
|
// TODO: Also support export_header_lib_headers
|
|
}`,
|
|
expectedBazelTargets: []string{`cc_library_headers(
|
|
name = "foo_headers",
|
|
deps = [
|
|
":lib-1",
|
|
":lib-2",
|
|
],
|
|
hdrs = [
|
|
"dir-1/dir1a.h",
|
|
"dir-1/dir1b.h",
|
|
"dir-2/dir2a.h",
|
|
"dir-2/dir2b.h",
|
|
] + select({
|
|
"//build/bazel/platforms/arch:arm64": ["arch_arm64_exported_include_dir/a.h"],
|
|
"//build/bazel/platforms/arch:x86": ["arch_x86_exported_include_dir/b.h"],
|
|
"//build/bazel/platforms/arch:x86_64": ["arch_x86_64_exported_include_dir/c.h"],
|
|
"//conditions:default": [],
|
|
}),
|
|
includes = [
|
|
"dir-1",
|
|
"dir-2",
|
|
] + select({
|
|
"//build/bazel/platforms/arch:arm64": ["arch_arm64_exported_include_dir"],
|
|
"//build/bazel/platforms/arch:x86": ["arch_x86_exported_include_dir"],
|
|
"//build/bazel/platforms/arch:x86_64": ["arch_x86_64_exported_include_dir"],
|
|
"//conditions:default": [],
|
|
}),
|
|
)`, `cc_library_headers(
|
|
name = "lib-1",
|
|
hdrs = [
|
|
"lib-1/lib1a.h",
|
|
"lib-1/lib1b.h",
|
|
],
|
|
includes = ["lib-1"],
|
|
)`, `cc_library_headers(
|
|
name = "lib-2",
|
|
hdrs = [
|
|
"lib-2/lib2a.h",
|
|
"lib-2/lib2b.h",
|
|
],
|
|
includes = ["lib-2"],
|
|
)`},
|
|
},
|
|
{
|
|
description: "cc_library_headers test with os-specific header_libs props",
|
|
moduleTypeUnderTest: "cc_library_headers",
|
|
moduleTypeUnderTestFactory: cc.LibraryHeaderFactory,
|
|
moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryHeadersBp2Build,
|
|
depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build},
|
|
filesystem: map[string]string{},
|
|
bp: soongCcLibraryPreamble + `
|
|
cc_library_headers { name: "android-lib" }
|
|
cc_library_headers { name: "base-lib" }
|
|
cc_library_headers { name: "darwin-lib" }
|
|
cc_library_headers { name: "fuchsia-lib" }
|
|
cc_library_headers { name: "linux-lib" }
|
|
cc_library_headers { name: "linux_bionic-lib" }
|
|
cc_library_headers { name: "windows-lib" }
|
|
cc_library_headers {
|
|
name: "foo_headers",
|
|
header_libs: ["base-lib"],
|
|
target: {
|
|
android: { header_libs: ["android-lib"] },
|
|
darwin: { header_libs: ["darwin-lib"] },
|
|
fuchsia: { header_libs: ["fuchsia-lib"] },
|
|
linux_bionic: { header_libs: ["linux_bionic-lib"] },
|
|
linux_glibc: { header_libs: ["linux-lib"] },
|
|
windows: { header_libs: ["windows-lib"] },
|
|
},
|
|
bazel_module: { bp2build_available: true },
|
|
}`,
|
|
expectedBazelTargets: []string{`cc_library_headers(
|
|
name = "android-lib",
|
|
)`, `cc_library_headers(
|
|
name = "base-lib",
|
|
)`, `cc_library_headers(
|
|
name = "darwin-lib",
|
|
)`, `cc_library_headers(
|
|
name = "foo_headers",
|
|
deps = [":base-lib"] + select({
|
|
"//build/bazel/platforms/os:android": [":android-lib"],
|
|
"//build/bazel/platforms/os:darwin": [":darwin-lib"],
|
|
"//build/bazel/platforms/os:fuchsia": [":fuchsia-lib"],
|
|
"//build/bazel/platforms/os:linux": [":linux-lib"],
|
|
"//build/bazel/platforms/os:linux_bionic": [":linux_bionic-lib"],
|
|
"//build/bazel/platforms/os:windows": [":windows-lib"],
|
|
"//conditions:default": [],
|
|
}),
|
|
)`, `cc_library_headers(
|
|
name = "fuchsia-lib",
|
|
)`, `cc_library_headers(
|
|
name = "linux-lib",
|
|
)`, `cc_library_headers(
|
|
name = "linux_bionic-lib",
|
|
)`, `cc_library_headers(
|
|
name = "windows-lib",
|
|
)`},
|
|
},
|
|
{
|
|
description: "cc_library_headers test with os-specific header_libs and export_header_lib_headers props",
|
|
moduleTypeUnderTest: "cc_library_headers",
|
|
moduleTypeUnderTestFactory: cc.LibraryHeaderFactory,
|
|
moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryHeadersBp2Build,
|
|
depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build},
|
|
filesystem: map[string]string{},
|
|
bp: soongCcLibraryPreamble + `
|
|
cc_library_headers { name: "android-lib" }
|
|
cc_library_headers { name: "exported-lib" }
|
|
cc_library_headers {
|
|
name: "foo_headers",
|
|
target: {
|
|
android: { header_libs: ["android-lib"], export_header_lib_headers: ["exported-lib"] },
|
|
},
|
|
}`,
|
|
expectedBazelTargets: []string{`cc_library_headers(
|
|
name = "android-lib",
|
|
)`, `cc_library_headers(
|
|
name = "exported-lib",
|
|
)`, `cc_library_headers(
|
|
name = "foo_headers",
|
|
deps = select({
|
|
"//build/bazel/platforms/os:android": [
|
|
":android-lib",
|
|
":exported-lib",
|
|
],
|
|
"//conditions:default": [],
|
|
}),
|
|
)`},
|
|
},
|
|
}
|
|
|
|
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)
|
|
|
|
// TODO(jingwen): make this default for all bp2build tests
|
|
ctx.RegisterBp2BuildConfig(bp2buildConfig)
|
|
|
|
cc.RegisterCCBuildComponents(ctx)
|
|
ctx.RegisterModuleType("toolchain_library", cc.ToolchainLibraryFactory)
|
|
|
|
ctx.RegisterModuleType(testCase.moduleTypeUnderTest, testCase.moduleTypeUnderTestFactory)
|
|
for _, m := range testCase.depsMutators {
|
|
ctx.DepsBp2BuildMutators(m)
|
|
}
|
|
ctx.RegisterBp2BuildMutator(testCase.moduleTypeUnderTest, testCase.moduleTypeUnderTestBp2BuildMutator)
|
|
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,
|
|
)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|