cd1b80f067
Bp2build currently supports building genrules for cc modules, but does not support building java_genrule* modules. This commit adds this functionality. Bug: 213480907 Test: go test ./bp2build Change-Id: I473196c5bcf5582ba0c8faa65b5005f81ac973a4
600 lines
14 KiB
Go
600 lines
14 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"
|
|
"android/soong/genrule"
|
|
"android/soong/java"
|
|
"fmt"
|
|
"testing"
|
|
)
|
|
|
|
func registerGenruleModuleTypes(ctx android.RegistrationContext) {
|
|
ctx.RegisterModuleType("genrule_defaults", func() android.Module { return genrule.DefaultsFactory() })
|
|
}
|
|
|
|
func runGenruleTestCase(t *testing.T, tc bp2buildTestCase) {
|
|
t.Helper()
|
|
(&tc).moduleTypeUnderTest = "genrule"
|
|
(&tc).moduleTypeUnderTestFactory = genrule.GenRuleFactory
|
|
runBp2BuildTestCase(t, registerGenruleModuleTypes, tc)
|
|
}
|
|
|
|
func otherGenruleBp(genruleTarget string) map[string]string {
|
|
return map[string]string{
|
|
"other/Android.bp": fmt.Sprintf(`%s {
|
|
name: "foo.tool",
|
|
out: ["foo_tool.out"],
|
|
srcs: ["foo_tool.in"],
|
|
cmd: "cp $(in) $(out)",
|
|
}
|
|
%s {
|
|
name: "other.tool",
|
|
out: ["other_tool.out"],
|
|
srcs: ["other_tool.in"],
|
|
cmd: "cp $(in) $(out)",
|
|
}`, genruleTarget, genruleTarget),
|
|
}
|
|
}
|
|
|
|
func TestGenruleCliVariableReplacement(t *testing.T) {
|
|
testCases := []struct {
|
|
moduleType string
|
|
factory android.ModuleFactory
|
|
genDir string
|
|
}{
|
|
{
|
|
moduleType: "genrule",
|
|
factory: genrule.GenRuleFactory,
|
|
genDir: "$(GENDIR)",
|
|
},
|
|
{
|
|
moduleType: "cc_genrule",
|
|
factory: cc.GenRuleFactory,
|
|
genDir: "$(RULEDIR)",
|
|
},
|
|
{
|
|
moduleType: "java_genrule",
|
|
factory: java.GenRuleFactory,
|
|
genDir: "$(RULEDIR)",
|
|
},
|
|
{
|
|
moduleType: "java_genrule_host",
|
|
factory: java.GenRuleFactoryHost,
|
|
genDir: "$(RULEDIR)",
|
|
},
|
|
}
|
|
|
|
bp := `%s {
|
|
name: "foo.tool",
|
|
out: ["foo_tool.out"],
|
|
srcs: ["foo_tool.in"],
|
|
cmd: "cp $(in) $(out)",
|
|
bazel_module: { bp2build_available: false },
|
|
}
|
|
|
|
%s {
|
|
name: "foo",
|
|
out: ["foo.out"],
|
|
srcs: ["foo.in"],
|
|
tools: [":foo.tool"],
|
|
cmd: "$(location :foo.tool) --genDir=$(genDir) arg $(in) $(out)",
|
|
bazel_module: { bp2build_available: true },
|
|
}`
|
|
|
|
for _, tc := range testCases {
|
|
expectedBazelTargets := []string{
|
|
makeBazelTarget("genrule", "foo", attrNameToString{
|
|
"cmd": fmt.Sprintf(`"$(location :foo.tool) --genDir=%s arg $(SRCS) $(OUTS)"`, tc.genDir),
|
|
"outs": `["foo.out"]`,
|
|
"srcs": `["foo.in"]`,
|
|
"tools": `[":foo.tool"]`,
|
|
}),
|
|
}
|
|
|
|
t.Run(tc.moduleType, func(t *testing.T) {
|
|
runBp2BuildTestCase(t, func(ctx android.RegistrationContext) {},
|
|
bp2buildTestCase{
|
|
moduleTypeUnderTest: tc.moduleType,
|
|
moduleTypeUnderTestFactory: tc.factory,
|
|
blueprint: fmt.Sprintf(bp, tc.moduleType, tc.moduleType),
|
|
expectedBazelTargets: expectedBazelTargets,
|
|
})
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGenruleLocationsLabel(t *testing.T) {
|
|
testCases := []struct {
|
|
moduleType string
|
|
factory android.ModuleFactory
|
|
}{
|
|
{
|
|
moduleType: "genrule",
|
|
factory: genrule.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "cc_genrule",
|
|
factory: cc.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule",
|
|
factory: java.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule_host",
|
|
factory: java.GenRuleFactoryHost,
|
|
},
|
|
}
|
|
|
|
bp := `%s {
|
|
name: "foo.tools",
|
|
out: ["foo_tool.out", "foo_tool2.out"],
|
|
srcs: ["foo_tool.in"],
|
|
cmd: "cp $(in) $(out)",
|
|
bazel_module: { bp2build_available: true },
|
|
}
|
|
|
|
%s {
|
|
name: "foo",
|
|
out: ["foo.out"],
|
|
srcs: ["foo.in"],
|
|
tools: [":foo.tools"],
|
|
cmd: "$(locations :foo.tools) -s $(out) $(in)",
|
|
bazel_module: { bp2build_available: true },
|
|
}`
|
|
|
|
expectedBazelTargets :=
|
|
[]string{
|
|
makeBazelTarget("genrule", "foo", attrNameToString{
|
|
"cmd": `"$(locations :foo.tools) -s $(OUTS) $(SRCS)"`,
|
|
"outs": `["foo.out"]`,
|
|
"srcs": `["foo.in"]`,
|
|
"tools": `[":foo.tools"]`,
|
|
}),
|
|
makeBazelTarget("genrule", "foo.tools", attrNameToString{
|
|
"cmd": `"cp $(SRCS) $(OUTS)"`,
|
|
"outs": `[
|
|
"foo_tool.out",
|
|
"foo_tool2.out",
|
|
]`,
|
|
"srcs": `["foo_tool.in"]`,
|
|
}),
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.moduleType, func(t *testing.T) {
|
|
runBp2BuildTestCase(t, func(ctx android.RegistrationContext) {},
|
|
bp2buildTestCase{
|
|
moduleTypeUnderTest: tc.moduleType,
|
|
moduleTypeUnderTestFactory: tc.factory,
|
|
blueprint: fmt.Sprintf(bp, tc.moduleType, tc.moduleType),
|
|
expectedBazelTargets: expectedBazelTargets,
|
|
})
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGenruleLocationsAbsoluteLabel(t *testing.T) {
|
|
testCases := []struct {
|
|
moduleType string
|
|
factory android.ModuleFactory
|
|
}{
|
|
{
|
|
moduleType: "genrule",
|
|
factory: genrule.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "cc_genrule",
|
|
factory: cc.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule",
|
|
factory: java.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule_host",
|
|
factory: java.GenRuleFactoryHost,
|
|
},
|
|
}
|
|
|
|
bp := `%s {
|
|
name: "foo",
|
|
out: ["foo.out"],
|
|
srcs: ["foo.in"],
|
|
tool_files: [":foo.tool"],
|
|
cmd: "$(locations :foo.tool) -s $(out) $(in)",
|
|
bazel_module: { bp2build_available: true },
|
|
}`
|
|
|
|
expectedBazelTargets := []string{
|
|
makeBazelTarget("genrule", "foo", attrNameToString{
|
|
"cmd": `"$(locations //other:foo.tool) -s $(OUTS) $(SRCS)"`,
|
|
"outs": `["foo.out"]`,
|
|
"srcs": `["foo.in"]`,
|
|
"tools": `["//other:foo.tool"]`,
|
|
}),
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.moduleType, func(t *testing.T) {
|
|
runBp2BuildTestCase(t, func(ctx android.RegistrationContext) {},
|
|
bp2buildTestCase{
|
|
moduleTypeUnderTest: tc.moduleType,
|
|
moduleTypeUnderTestFactory: tc.factory,
|
|
blueprint: fmt.Sprintf(bp, tc.moduleType),
|
|
expectedBazelTargets: expectedBazelTargets,
|
|
filesystem: otherGenruleBp(tc.moduleType),
|
|
})
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGenruleSrcsLocationsAbsoluteLabel(t *testing.T) {
|
|
testCases := []struct {
|
|
moduleType string
|
|
factory android.ModuleFactory
|
|
}{
|
|
{
|
|
moduleType: "genrule",
|
|
factory: genrule.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "cc_genrule",
|
|
factory: cc.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule",
|
|
factory: java.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule_host",
|
|
factory: java.GenRuleFactoryHost,
|
|
},
|
|
}
|
|
|
|
bp := `%s {
|
|
name: "foo",
|
|
out: ["foo.out"],
|
|
srcs: [":other.tool"],
|
|
tool_files: [":foo.tool"],
|
|
cmd: "$(locations :foo.tool) -s $(out) $(location :other.tool)",
|
|
bazel_module: { bp2build_available: true },
|
|
}`
|
|
|
|
expectedBazelTargets := []string{
|
|
makeBazelTarget("genrule", "foo", attrNameToString{
|
|
"cmd": `"$(locations //other:foo.tool) -s $(OUTS) $(location //other:other.tool)"`,
|
|
"outs": `["foo.out"]`,
|
|
"srcs": `["//other:other.tool"]`,
|
|
"tools": `["//other:foo.tool"]`,
|
|
}),
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.moduleType, func(t *testing.T) {
|
|
runBp2BuildTestCase(t, func(ctx android.RegistrationContext) {},
|
|
bp2buildTestCase{
|
|
moduleTypeUnderTest: tc.moduleType,
|
|
moduleTypeUnderTestFactory: tc.factory,
|
|
blueprint: fmt.Sprintf(bp, tc.moduleType),
|
|
expectedBazelTargets: expectedBazelTargets,
|
|
filesystem: otherGenruleBp(tc.moduleType),
|
|
})
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGenruleLocationLabelShouldSubstituteFirstToolLabel(t *testing.T) {
|
|
testCases := []struct {
|
|
moduleType string
|
|
factory android.ModuleFactory
|
|
}{
|
|
{
|
|
moduleType: "genrule",
|
|
factory: genrule.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "cc_genrule",
|
|
factory: cc.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule",
|
|
factory: java.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule_host",
|
|
factory: java.GenRuleFactoryHost,
|
|
},
|
|
}
|
|
|
|
bp := `%s {
|
|
name: "foo",
|
|
out: ["foo.out"],
|
|
srcs: ["foo.in"],
|
|
tool_files: [":foo.tool", ":other.tool"],
|
|
cmd: "$(location) -s $(out) $(in)",
|
|
bazel_module: { bp2build_available: true },
|
|
}`
|
|
|
|
expectedBazelTargets := []string{
|
|
makeBazelTarget("genrule", "foo", attrNameToString{
|
|
"cmd": `"$(location //other:foo.tool) -s $(OUTS) $(SRCS)"`,
|
|
"outs": `["foo.out"]`,
|
|
"srcs": `["foo.in"]`,
|
|
"tools": `[
|
|
"//other:foo.tool",
|
|
"//other:other.tool",
|
|
]`,
|
|
})}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.moduleType, func(t *testing.T) {
|
|
runBp2BuildTestCase(t, func(ctx android.RegistrationContext) {},
|
|
bp2buildTestCase{
|
|
moduleTypeUnderTest: tc.moduleType,
|
|
moduleTypeUnderTestFactory: tc.factory,
|
|
blueprint: fmt.Sprintf(bp, tc.moduleType),
|
|
expectedBazelTargets: expectedBazelTargets,
|
|
filesystem: otherGenruleBp(tc.moduleType),
|
|
})
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGenruleLocationsLabelShouldSubstituteFirstToolLabel(t *testing.T) {
|
|
testCases := []struct {
|
|
moduleType string
|
|
factory android.ModuleFactory
|
|
}{
|
|
{
|
|
moduleType: "genrule",
|
|
factory: genrule.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "cc_genrule",
|
|
factory: cc.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule",
|
|
factory: java.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule_host",
|
|
factory: java.GenRuleFactoryHost,
|
|
},
|
|
}
|
|
|
|
bp := `%s {
|
|
name: "foo",
|
|
out: ["foo.out"],
|
|
srcs: ["foo.in"],
|
|
tool_files: [":foo.tool", ":other.tool"],
|
|
cmd: "$(locations) -s $(out) $(in)",
|
|
bazel_module: { bp2build_available: true },
|
|
}`
|
|
|
|
expectedBazelTargets := []string{
|
|
makeBazelTarget("genrule", "foo", attrNameToString{
|
|
"cmd": `"$(locations //other:foo.tool) -s $(OUTS) $(SRCS)"`,
|
|
"outs": `["foo.out"]`,
|
|
"srcs": `["foo.in"]`,
|
|
"tools": `[
|
|
"//other:foo.tool",
|
|
"//other:other.tool",
|
|
]`,
|
|
})}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.moduleType, func(t *testing.T) {
|
|
runBp2BuildTestCase(t, func(ctx android.RegistrationContext) {},
|
|
bp2buildTestCase{
|
|
moduleTypeUnderTest: tc.moduleType,
|
|
moduleTypeUnderTestFactory: tc.factory,
|
|
blueprint: fmt.Sprintf(bp, tc.moduleType),
|
|
expectedBazelTargets: expectedBazelTargets,
|
|
filesystem: otherGenruleBp(tc.moduleType),
|
|
})
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGenruleWithoutToolsOrToolFiles(t *testing.T) {
|
|
testCases := []struct {
|
|
moduleType string
|
|
factory android.ModuleFactory
|
|
}{
|
|
{
|
|
moduleType: "genrule",
|
|
factory: genrule.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "cc_genrule",
|
|
factory: cc.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule",
|
|
factory: java.GenRuleFactory,
|
|
},
|
|
{
|
|
moduleType: "java_genrule_host",
|
|
factory: java.GenRuleFactoryHost,
|
|
},
|
|
}
|
|
|
|
bp := `%s {
|
|
name: "foo",
|
|
out: ["foo.out"],
|
|
srcs: ["foo.in"],
|
|
cmd: "cp $(in) $(out)",
|
|
bazel_module: { bp2build_available: true },
|
|
}`
|
|
|
|
expectedBazelTargets := []string{
|
|
makeBazelTarget("genrule", "foo", attrNameToString{
|
|
"cmd": `"cp $(SRCS) $(OUTS)"`,
|
|
"outs": `["foo.out"]`,
|
|
"srcs": `["foo.in"]`,
|
|
})}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.moduleType, func(t *testing.T) {
|
|
runBp2BuildTestCase(t, func(ctx android.RegistrationContext) {},
|
|
bp2buildTestCase{
|
|
moduleTypeUnderTest: tc.moduleType,
|
|
moduleTypeUnderTestFactory: tc.factory,
|
|
blueprint: fmt.Sprintf(bp, tc.moduleType),
|
|
expectedBazelTargets: expectedBazelTargets,
|
|
})
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestGenruleBp2BuildInlinesDefaults(t *testing.T) {
|
|
testCases := []bp2buildTestCase{
|
|
{
|
|
description: "genrule applies properties from a genrule_defaults dependency if not specified",
|
|
blueprint: `genrule_defaults {
|
|
name: "gen_defaults",
|
|
cmd: "do-something $(in) $(out)",
|
|
}
|
|
genrule {
|
|
name: "gen",
|
|
out: ["out"],
|
|
srcs: ["in1"],
|
|
defaults: ["gen_defaults"],
|
|
bazel_module: { bp2build_available: true },
|
|
}
|
|
`,
|
|
expectedBazelTargets: []string{
|
|
makeBazelTarget("genrule", "gen", attrNameToString{
|
|
"cmd": `"do-something $(SRCS) $(OUTS)"`,
|
|
"outs": `["out"]`,
|
|
"srcs": `["in1"]`,
|
|
}),
|
|
},
|
|
},
|
|
{
|
|
description: "genrule does merges properties from a genrule_defaults dependency, latest-first",
|
|
blueprint: `genrule_defaults {
|
|
name: "gen_defaults",
|
|
out: ["out-from-defaults"],
|
|
srcs: ["in-from-defaults"],
|
|
cmd: "cmd-from-defaults",
|
|
}
|
|
genrule {
|
|
name: "gen",
|
|
out: ["out"],
|
|
srcs: ["in1"],
|
|
defaults: ["gen_defaults"],
|
|
cmd: "do-something $(in) $(out)",
|
|
bazel_module: { bp2build_available: true },
|
|
}
|
|
`,
|
|
expectedBazelTargets: []string{
|
|
makeBazelTarget("genrule", "gen", attrNameToString{
|
|
"cmd": `"do-something $(SRCS) $(OUTS)"`,
|
|
"outs": `[
|
|
"out-from-defaults",
|
|
"out",
|
|
]`,
|
|
"srcs": `[
|
|
"in-from-defaults",
|
|
"in1",
|
|
]`,
|
|
}),
|
|
},
|
|
},
|
|
{
|
|
description: "genrule applies properties from list of genrule_defaults",
|
|
blueprint: `genrule_defaults {
|
|
name: "gen_defaults1",
|
|
cmd: "cp $(in) $(out)",
|
|
}
|
|
|
|
genrule_defaults {
|
|
name: "gen_defaults2",
|
|
srcs: ["in1"],
|
|
}
|
|
|
|
genrule {
|
|
name: "gen",
|
|
out: ["out"],
|
|
defaults: ["gen_defaults1", "gen_defaults2"],
|
|
bazel_module: { bp2build_available: true },
|
|
}
|
|
`,
|
|
expectedBazelTargets: []string{
|
|
makeBazelTarget("genrule", "gen", attrNameToString{
|
|
"cmd": `"cp $(SRCS) $(OUTS)"`,
|
|
"outs": `["out"]`,
|
|
"srcs": `["in1"]`,
|
|
}),
|
|
},
|
|
},
|
|
{
|
|
description: "genrule applies properties from genrule_defaults transitively",
|
|
blueprint: `genrule_defaults {
|
|
name: "gen_defaults1",
|
|
defaults: ["gen_defaults2"],
|
|
cmd: "cmd1 $(in) $(out)", // overrides gen_defaults2's cmd property value.
|
|
}
|
|
|
|
genrule_defaults {
|
|
name: "gen_defaults2",
|
|
defaults: ["gen_defaults3"],
|
|
cmd: "cmd2 $(in) $(out)",
|
|
out: ["out-from-2"],
|
|
srcs: ["in1"],
|
|
}
|
|
|
|
genrule_defaults {
|
|
name: "gen_defaults3",
|
|
out: ["out-from-3"],
|
|
srcs: ["srcs-from-3"],
|
|
}
|
|
|
|
genrule {
|
|
name: "gen",
|
|
out: ["out"],
|
|
defaults: ["gen_defaults1"],
|
|
bazel_module: { bp2build_available: true },
|
|
}
|
|
`,
|
|
expectedBazelTargets: []string{
|
|
makeBazelTarget("genrule", "gen", attrNameToString{
|
|
"cmd": `"cmd1 $(SRCS) $(OUTS)"`,
|
|
"outs": `[
|
|
"out-from-3",
|
|
"out-from-2",
|
|
"out",
|
|
]`,
|
|
"srcs": `[
|
|
"srcs-from-3",
|
|
"in1",
|
|
]`,
|
|
}),
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, testCase := range testCases {
|
|
t.Run(testCase.description, func(t *testing.T) {
|
|
runGenruleTestCase(t, testCase)
|
|
})
|
|
}
|
|
}
|