Partial bp2build conversion of bootstratp_go_package
This module type does not implement android.Module, and therefore we
cannot write a conventional bp2build converter for this module type.
Instead this has been special-cased inside bp2build/build_conversion.go.
Because of the above, we also do not have access to useful functions
available in the ctx object of ConvertWithBp2build. This includes
1. Finding the package (directory) of a dep. This requires getting a
handle of the underlying module from its name (string). To solve, we
do a pre-visit to collect this information. This did not increase the
wall time. On my machine, `m bp2build --skip-soong-tests` takes ~14s
before and after this CL
2. Converting srcs to labels. This requires glob and package boundary
resolution. This CL introduces a partial implementation for this
function. (glob patterns are not used in go tools)
For (1), I considered creating a `ModuleFromName` on
`blueprint.Context` instead of a pre-run, but this increased the time to ~27s.
Test: unit tests
Test: TH
Bug: 284483729
Change-Id: Ifeb029103d14947352556dba295591dd7038b090
diff --git a/bp2build/Android.bp b/bp2build/Android.bp
index 782a88c..f889693 100644
--- a/bp2build/Android.bp
+++ b/bp2build/Android.bp
@@ -19,6 +19,7 @@
"testing.go",
],
deps: [
+ "blueprint-bootstrap",
"soong-aidl-library",
"soong-android",
"soong-android-allowlists",
@@ -37,6 +38,7 @@
"soong-ui-metrics",
],
testSrcs: [
+ "go_conversion_test.go",
"aar_conversion_test.go",
"aidl_library_conversion_test.go",
"android_app_certificate_conversion_test.go",
diff --git a/bp2build/build_conversion.go b/bp2build/build_conversion.go
index 46a5bd8..e1252b2 100644
--- a/bp2build/build_conversion.go
+++ b/bp2build/build_conversion.go
@@ -30,6 +30,7 @@
"android/soong/starlark_fmt"
"android/soong/ui/metrics/bp2build_metrics_proto"
"github.com/google/blueprint"
+ "github.com/google/blueprint/bootstrap"
"github.com/google/blueprint/proptools"
)
@@ -252,6 +253,157 @@
return r.buildFileToTargets
}
+// struct to store state of go bazel targets
+// this implements bp2buildModule interface and is passed to generateBazelTargets
+type goBazelTarget struct {
+ targetName string
+ targetPackage string
+ bazelRuleClass string
+ bazelRuleLoadLocation string
+ bazelAttributes []interface{}
+}
+
+var _ bp2buildModule = (*goBazelTarget)(nil)
+
+func (g goBazelTarget) TargetName() string {
+ return g.targetName
+}
+
+func (g goBazelTarget) TargetPackage() string {
+ return g.targetPackage
+}
+
+func (g goBazelTarget) BazelRuleClass() string {
+ return g.bazelRuleClass
+}
+
+func (g goBazelTarget) BazelRuleLoadLocation() string {
+ return g.bazelRuleLoadLocation
+}
+
+func (g goBazelTarget) BazelAttributes() []interface{} {
+ return g.bazelAttributes
+}
+
+// Creates a target_compatible_with entry that is *not* compatible with android
+func targetNotCompatibleWithAndroid() bazel.LabelListAttribute {
+ ret := bazel.LabelListAttribute{}
+ ret.SetSelectValue(bazel.OsConfigurationAxis, bazel.OsAndroid,
+ bazel.MakeLabelList(
+ []bazel.Label{
+ bazel.Label{
+ Label: "@platforms//:incompatible",
+ },
+ },
+ ),
+ )
+ return ret
+}
+
+// helper function to return labels for srcs used in bootstrap_go_package and bootstrap_go_binary
+// this function has the following limitations which make it unsuitable for widespread use
+// 1. wildcard patterns in srcs
+// 2. package boundary violations
+// (1) is ok for go since build/blueprint does not support it. (2) _might_ be ok too.
+//
+// Prefer to use `BazelLabelForModuleSrc` instead
+func goSrcLabels(srcs []string, linuxSrcs, darwinSrcs []string) bazel.LabelListAttribute {
+ labels := func(srcs []string) bazel.LabelList {
+ ret := []bazel.Label{}
+ for _, src := range srcs {
+ srcLabel := bazel.Label{
+ Label: ":" + src, // TODO - b/284483729: Fix for possible package boundary violations
+ }
+ ret = append(ret, srcLabel)
+ }
+ return bazel.MakeLabelList(ret)
+ }
+
+ ret := bazel.LabelListAttribute{}
+ // common
+ ret.SetSelectValue(bazel.NoConfigAxis, "", labels(srcs))
+ // linux
+ ret.SetSelectValue(bazel.OsConfigurationAxis, bazel.OsLinux, labels(linuxSrcs))
+ // darwin
+ ret.SetSelectValue(bazel.OsConfigurationAxis, bazel.OsDarwin, labels(darwinSrcs))
+ return ret
+}
+
+func goDepLabels(deps []string, goModulesMap nameToGoLibraryModule) bazel.LabelListAttribute {
+ labels := []bazel.Label{}
+ for _, dep := range deps {
+ moduleDir := goModulesMap[dep].Dir
+ if moduleDir == "." {
+ moduleDir = ""
+ }
+ label := bazel.Label{
+ Label: fmt.Sprintf("//%s:%s", moduleDir, dep),
+ }
+ labels = append(labels, label)
+ }
+ return bazel.MakeLabelListAttribute(bazel.MakeLabelList(labels))
+}
+
+// attributes common to blueprint_go_binary and bootstap_go_package
+type goAttributes struct {
+ Importpath bazel.StringAttribute
+ Srcs bazel.LabelListAttribute
+ Deps bazel.LabelListAttribute
+ Target_compatible_with bazel.LabelListAttribute
+}
+
+func generateBazelTargetsGoPackage(ctx *android.Context, g *bootstrap.GoPackage, goModulesMap nameToGoLibraryModule) ([]BazelTarget, []error) {
+ ca := android.CommonAttributes{
+ Name: g.Name(),
+ }
+ ga := goAttributes{
+ Importpath: bazel.StringAttribute{
+ Value: proptools.StringPtr(g.GoPkgPath()),
+ },
+ Srcs: goSrcLabels(g.Srcs(), g.LinuxSrcs(), g.DarwinSrcs()),
+ Deps: goDepLabels(g.Deps(), goModulesMap),
+ Target_compatible_with: targetNotCompatibleWithAndroid(),
+ }
+
+ lib := goBazelTarget{
+ targetName: g.Name(),
+ targetPackage: ctx.ModuleDir(g),
+ bazelRuleClass: "go_library",
+ bazelRuleLoadLocation: "@io_bazel_rules_go//go:def.bzl",
+ bazelAttributes: []interface{}{&ca, &ga},
+ }
+ // TODO - b/284483729: Create go_test target from testSrcs
+ libTarget, err := generateBazelTarget(ctx, lib)
+ if err != nil {
+ return []BazelTarget{}, []error{err}
+ }
+ return []BazelTarget{libTarget}, nil
+}
+
+type goLibraryModule struct {
+ Dir string
+ Deps []string
+}
+
+type nameToGoLibraryModule map[string]goLibraryModule
+
+// Visit each module in the graph
+// If a module is of type `bootstrap_go_package`, return a map containing metadata like its dir and deps
+func createGoLibraryModuleMap(ctx *android.Context) nameToGoLibraryModule {
+ ret := nameToGoLibraryModule{}
+ ctx.VisitAllModules(func(m blueprint.Module) {
+ moduleType := ctx.ModuleType(m)
+ // We do not need to store information about blueprint_go_binary since it does not have any rdeps
+ if moduleType == "bootstrap_go_package" {
+ ret[m.Name()] = goLibraryModule{
+ Dir: ctx.ModuleDir(m),
+ Deps: m.(*bootstrap.GoPackage).Deps(),
+ }
+ }
+ })
+ return ret
+}
+
func GenerateBazelTargets(ctx *CodegenContext, generateFilegroups bool) (conversionResults, []error) {
buildFileToTargets := make(map[string]BazelTargets)
@@ -262,6 +414,10 @@
var errs []error
+ // Visit go libraries in a pre-run and store its state in a map
+ // The time complexity remains O(N), and this does not add significant wall time.
+ nameToGoLibMap := createGoLibraryModuleMap(ctx.Context())
+
bpCtx := ctx.Context()
bpCtx.VisitAllModules(func(m blueprint.Module) {
dir := bpCtx.ModuleDir(m)
@@ -269,6 +425,7 @@
dirs[dir] = true
var targets []BazelTarget
+ var targetErrs []error
switch ctx.Mode() {
case Bp2Build:
@@ -317,7 +474,6 @@
return
}
}
- var targetErrs []error
targets, targetErrs = generateBazelTargets(bpCtx, aModule)
errs = append(errs, targetErrs...)
for _, t := range targets {
@@ -336,6 +492,12 @@
metrics.AddUnconvertedModule(m, moduleType, dir, *reason)
}
return
+ } else if glib, ok := m.(*bootstrap.GoPackage); ok {
+ targets, targetErrs = generateBazelTargetsGoPackage(bpCtx, glib, nameToGoLibMap)
+ errs = append(errs, targetErrs...)
+ metrics.IncrementRuleClassCount("go_library")
+ } else if _, ok := m.(*bootstrap.GoBinary); ok {
+ // TODO - b/284483729: Create bazel targets for go binaries
} else {
metrics.AddUnconvertedModule(m, moduleType, dir, android.UnconvertedReason{
ReasonType: int(bp2build_metrics_proto.UnconvertedReasonType_TYPE_UNSUPPORTED),
diff --git a/bp2build/go_conversion_test.go b/bp2build/go_conversion_test.go
new file mode 100644
index 0000000..13d2513
--- /dev/null
+++ b/bp2build/go_conversion_test.go
@@ -0,0 +1,89 @@
+// Copyright 2023 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 (
+ "testing"
+
+ "github.com/google/blueprint/bootstrap"
+
+ "android/soong/android"
+)
+
+func runGoTests(t *testing.T, tc Bp2buildTestCase) {
+ RunBp2BuildTestCase(t, func(ctx android.RegistrationContext) {
+ tCtx := ctx.(*android.TestContext)
+ bootstrap.RegisterGoModuleTypes(tCtx.Context.Context) // android.TestContext --> android.Context --> blueprint.Context
+ }, tc)
+}
+
+func TestConvertGoPackage(t *testing.T) {
+ bp := `
+bootstrap_go_package {
+ name: "foo",
+ pkgPath: "android/foo",
+ deps: [
+ "bar",
+ ],
+ srcs: [
+ "foo1.go",
+ "foo2.go",
+ ],
+ linux: {
+ srcs: [
+ "foo_linux.go",
+ ],
+ },
+ darwin: {
+ srcs: [
+ "foo_darwin.go",
+ ],
+ },
+ testSrcs: [
+ "foo1_test.go",
+ "foo2_test.go",
+ ],
+}
+`
+ depBp := `
+bootstrap_go_package {
+ name: "bar",
+}
+`
+ t.Parallel()
+ runGoTests(t, Bp2buildTestCase{
+ Description: "Convert bootstrap_go_package to go_library",
+ ModuleTypeUnderTest: "bootrstap_go_package",
+ Blueprint: bp,
+ Filesystem: map[string]string{
+ "bar/Android.bp": depBp, // Put dep in Android.bp to reduce boilerplate in ExpectedBazelTargets
+ },
+ ExpectedBazelTargets: []string{makeBazelTargetHostOrDevice("go_library", "foo",
+ AttrNameToString{
+ "deps": `["//bar:bar"]`,
+ "importpath": `"android/foo"`,
+ "srcs": `[
+ ":foo1.go",
+ ":foo2.go",
+ ] + select({
+ "//build/bazel/platforms/os:darwin": [":foo_darwin.go"],
+ "//build/bazel/platforms/os:linux_glibc": [":foo_linux.go"],
+ "//conditions:default": [],
+ })`,
+ },
+ android.HostSupported,
+ )},
+ })
+}