Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 58ea4517 authored by Trevor Radcliffe's avatar Trevor Radcliffe
Browse files

bp2build support for cc_prebuilt_library 

while cc_prebuilt_library_(shared|static) were already supported,
the raw cc_prebuilt_library module type was not supported by
bp2build. This CL provides that functionality.

Also did a little bit of refactoring and cleaning.

Bug: 225938765
Test: Confirm output BUILD.bazel files look as expected. Confirm
      that build succeeds.
Change-Id: Ic004f88febc0e5b527f2ef420dbd96ecc55d2e09
parent d5aa2e0d

bp2build/cc_prebuilt_library_conversion_test.go

0 → 100644
+250 −0
Original line number Diff line number Diff line 
// Copyright 2022 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 (

	"fmt"

	"testing"



	"android/soong/cc"

)



func TestPrebuiltLibraryStaticAndSharedSimple(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library static and shared simple",

			moduleTypeUnderTest:        "cc_prebuilt_library",

			moduleTypeUnderTestFactory: cc.PrebuiltLibraryFactory,

			filesystem: map[string]string{

				"libf.so": "",

			},

			blueprint: `

cc_prebuilt_library {

	name: "libtest",

	srcs: ["libf.so"],

	bazel_module: { bp2build_available: true },

}`,

			expectedBazelTargets: []string{

				makeBazelTarget("prebuilt_library_static", "libtest_bp2build_cc_library_static", attrNameToString{

					"static_library": `"libf.so"`,

				}),

				makeBazelTarget("prebuilt_library_shared", "libtest", attrNameToString{

					"shared_library": `"libf.so"`,

				}),

			},

		})

}



func TestPrebuiltLibraryWithArchVariance(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library with arch variance",

			moduleTypeUnderTest:        "cc_prebuilt_library",

			moduleTypeUnderTestFactory: cc.PrebuiltLibraryFactory,

			filesystem: map[string]string{

				"libf.so": "",

				"libg.so": "",

			},

			blueprint: `

cc_prebuilt_library {

	name: "libtest",

	arch: {

		arm64: { srcs: ["libf.so"], },

		arm: { srcs: ["libg.so"], },

	},

	bazel_module: { bp2build_available: true },

}`,

			expectedBazelTargets: []string{

				makeBazelTarget("prebuilt_library_static", "libtest_bp2build_cc_library_static", attrNameToString{

					"static_library": `select({

        "//build/bazel/platforms/arch:arm": "libg.so",

        "//build/bazel/platforms/arch:arm64": "libf.so",

        "//conditions:default": None,

    })`,

				}),

				makeBazelTarget("prebuilt_library_shared", "libtest", attrNameToString{

					"shared_library": `select({

        "//build/bazel/platforms/arch:arm": "libg.so",

        "//build/bazel/platforms/arch:arm64": "libf.so",

        "//conditions:default": None,

    })`,

				}),

			},

		})

}



func TestPrebuiltLibraryAdditionalAttrs(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library additional attributes",

			moduleTypeUnderTest:        "cc_prebuilt_library",

			moduleTypeUnderTestFactory: cc.PrebuiltLibraryFactory,

			filesystem: map[string]string{

				"libf.so":    "",

				"testdir/1/": "",

				"testdir/2/": "",

			},

			blueprint: `

cc_prebuilt_library {

	name: "libtest",

	srcs: ["libf.so"],

	export_include_dirs: ["testdir/1/"],

	export_system_include_dirs: ["testdir/2/"],

	bazel_module: { bp2build_available: true },

}`,

			expectedBazelTargets: []string{

				makeBazelTarget("prebuilt_library_static", "libtest_bp2build_cc_library_static", attrNameToString{

					"static_library":         `"libf.so"`,

					"export_includes":        `["testdir/1/"]`,

					"export_system_includes": `["testdir/2/"]`,

				}),

				// TODO(b/229374533): When fixed, update this test

				makeBazelTarget("prebuilt_library_shared", "libtest", attrNameToString{

					"shared_library": `"libf.so"`,

				}),

			},

		})

}



func TestPrebuiltLibrarySharedStanzaFails(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library with shared stanza fails because multiple sources",

			moduleTypeUnderTest:        "cc_prebuilt_library",

			moduleTypeUnderTestFactory: cc.PrebuiltLibraryFactory,

			filesystem: map[string]string{

				"libf.so": "",

				"libg.so": "",

			},

			blueprint: `

cc_prebuilt_library {

	name: "libtest",

	srcs: ["libf.so"],

	shared: {

		srcs: ["libg.so"],

	},

	bazel_module: { bp2build_available: true },

}`,

			expectedErr: fmt.Errorf("Expected at most once source file"),

		})

}



func TestPrebuiltLibraryStaticStanzaFails(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library with static stanza fails because multiple sources",

			moduleTypeUnderTest:        "cc_prebuilt_library",

			moduleTypeUnderTestFactory: cc.PrebuiltLibraryFactory,

			filesystem: map[string]string{

				"libf.so": "",

				"libg.so": "",

			},

			blueprint: `

cc_prebuilt_library {

	name: "libtest",

	srcs: ["libf.so"],

	static: {

		srcs: ["libg.so"],

	},

	bazel_module: { bp2build_available: true },

}`,

			expectedErr: fmt.Errorf("Expected at most once source file"),

		})

}



func TestPrebuiltLibrarySharedAndStaticStanzas(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library with both shared and static stanzas",

			moduleTypeUnderTest:        "cc_prebuilt_library",

			moduleTypeUnderTestFactory: cc.PrebuiltLibraryFactory,

			filesystem: map[string]string{

				"libf.so": "",

				"libg.so": "",

			},

			blueprint: `

cc_prebuilt_library {

	name: "libtest",

	static: {

		srcs: ["libf.so"],

	},

	shared: {

		srcs: ["libg.so"],

	},

	bazel_module: { bp2build_available: true },

}`,

			expectedBazelTargets: []string{

				makeBazelTarget("prebuilt_library_static", "libtest_bp2build_cc_library_static", attrNameToString{

					"static_library": `"libf.so"`,

				}),

				makeBazelTarget("prebuilt_library_shared", "libtest", attrNameToString{

					"shared_library": `"libg.so"`,

				}),

			},

		})

}



// TODO(b/228623543): When this bug is fixed, enable this test

//func TestPrebuiltLibraryOnlyShared(t *testing.T) {

//	runBp2BuildTestCaseSimple(t,

//		bp2buildTestCase{

//			description:                "prebuilt library shared only",

//			moduleTypeUnderTest:        "cc_prebuilt_library",

//			moduleTypeUnderTestFactory: cc.PrebuiltLibraryFactory,

//			filesystem: map[string]string{

//				"libf.so": "",

//			},

//			blueprint: `

//cc_prebuilt_library {

//	name: "libtest",

//	srcs: ["libf.so"],

//	static: {

//		enabled: false,

//	},

//	bazel_module: { bp2build_available: true },

//}`,

//			expectedBazelTargets: []string{

//				makeBazelTarget("prebuilt_library_shared", "libtest", attrNameToString{

//					"shared_library": `"libf.so"`,

//				}),

//			},

//		})

//}



// TODO(b/228623543): When this bug is fixed, enable this test

//func TestPrebuiltLibraryOnlyStatic(t *testing.T) {

//	runBp2BuildTestCaseSimple(t,

//		bp2buildTestCase{

//			description:                "prebuilt library static only",

//			moduleTypeUnderTest:        "cc_prebuilt_library",

//			moduleTypeUnderTestFactory: cc.PrebuiltLibraryFactory,

//			filesystem: map[string]string{

//				"libf.so": "",

//			},

//			blueprint: `

//cc_prebuilt_library {

//	name: "libtest",

//	srcs: ["libf.so"],

//	shared: {

//		enabled: false,

//	},

//	bazel_module: { bp2build_available: true },

//}`,

//			expectedBazelTargets: []string{

//				makeBazelTarget("prebuilt_library_static", "libtest_bp2build_cc_library_static", attrNameToString{

//					"static_library": `"libf.so"`,

//				}),

//			},

//		})

//}

bp2build/cc_prebuilt_library_shared_test.go

+24 −0
Original line number Diff line number Diff line 
package bp2build



import (

	"fmt"

	"testing"



	"android/soong/cc"
@@ -59,3 +60,26 @@ cc_prebuilt_library_shared { 
			},

		})

}



func TestSharedPrebuiltLibrarySharedStanzaFails(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library shared with shared stanza fails because multiple sources",

			moduleTypeUnderTest:        "cc_prebuilt_library_shared",

			moduleTypeUnderTestFactory: cc.PrebuiltSharedLibraryFactory,

			filesystem: map[string]string{

				"libf.so": "",

				"libg.so": "",

			},

			blueprint: `

cc_prebuilt_library_shared {

	name: "libtest",

	srcs: ["libf.so"],

	shared: {

		srcs: ["libg.so"],

	},

	bazel_module: { bp2build_available: true},

}`,

			expectedErr: fmt.Errorf("Expected at most one source file"),

		})

}

bp2build/cc_prebuilt_library_static_test.go

0 → 100644
+98 −0
Original line number Diff line number Diff line 
// Copyright 2022 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 (

	"fmt"

	"testing"



	"android/soong/cc"

)



func TestStaticPrebuiltLibrary(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library static simple",

			moduleTypeUnderTest:        "cc_prebuilt_library_static",

			moduleTypeUnderTestFactory: cc.PrebuiltStaticLibraryFactory,

			filesystem: map[string]string{

				"libf.so": "",

			},

			blueprint: `

cc_prebuilt_library_static {

	name: "libtest",

	srcs: ["libf.so"],

	bazel_module: { bp2build_available: true },

}`,

			expectedBazelTargets: []string{

				makeBazelTarget("prebuilt_library_static", "libtest", attrNameToString{

					"static_library": `"libf.so"`,

				}),

			},

		})

}



func TestStaticPrebuiltLibraryWithArchVariance(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library static with arch variance",

			moduleTypeUnderTest:        "cc_prebuilt_library_static",

			moduleTypeUnderTestFactory: cc.PrebuiltStaticLibraryFactory,

			filesystem: map[string]string{

				"libf.so": "",

				"libg.so": "",

			},

			blueprint: `

cc_prebuilt_library_static {

	name: "libtest",

	arch: {

		arm64: { srcs: ["libf.so"], },

		arm: { srcs: ["libg.so"], },

	},

	bazel_module: { bp2build_available: true },

}`,

			expectedBazelTargets: []string{

				makeBazelTarget("prebuilt_library_static", "libtest", attrNameToString{

					"static_library": `select({

        "//build/bazel/platforms/arch:arm": "libg.so",

        "//build/bazel/platforms/arch:arm64": "libf.so",

        "//conditions:default": None,

    })`,

				}),

			},

		})

}



func TestStaticPrebuiltLibraryStaticStanzaFails(t *testing.T) {

	runBp2BuildTestCaseSimple(t,

		bp2buildTestCase{

			description:                "prebuilt library with static stanza fails because multiple sources",

			moduleTypeUnderTest:        "cc_prebuilt_library_static",

			moduleTypeUnderTestFactory: cc.PrebuiltStaticLibraryFactory,

			filesystem: map[string]string{

				"libf.so": "",

				"libg.so": "",

			},

			blueprint: `

cc_prebuilt_library_static {

	name: "libtest",

	srcs: ["libf.so"],

	static: {

		srcs: ["libg.so"],

	},

	bazel_module: { bp2build_available: true },

}`,

			expectedErr: fmt.Errorf("Expected at most one source file"),

		})

}

bp2build/testing.go

+3 −2
Original line number Diff line number Diff line
@@ -84,6 +84,7 @@ type bp2buildTestCase struct { 
	expectedBazelTargets       []string

	filesystem                 map[string]string

	dir                        string

	// An error with a string contained within the string of the expected error

	expectedErr         error

	unconvertedDepsMode unconvertedDepsMode

}

cc/bp2build.go

+60 −17
Original line number Diff line number Diff line
@@ -141,6 +141,7 @@ func maybePartitionExportedAndImplementationsDepsExcludes(ctx android.BazelConve 
	}

}



// Parses properties common to static and shared libraries. Also used for prebuilt libraries.

func bp2buildParseStaticOrSharedProps(ctx android.BazelConversionPathContext, module *Module, lib *libraryDecorator, isStatic bool) staticOrSharedAttributes {

	attrs := staticOrSharedAttributes{}
@@ -199,29 +200,71 @@ func bp2buildParseStaticOrSharedProps(ctx android.BazelConversionPathContext, mo 
// Convenience struct to hold all attributes parsed from prebuilt properties.

type prebuiltAttributes struct {

	Src     bazel.LabelAttribute

	Enabled bazel.BoolAttribute

}



// NOTE: Used outside of Soong repo project, in the clangprebuilts.go bootstrap_go_package

func Bp2BuildParsePrebuiltLibraryProps(ctx android.BazelConversionPathContext, module *Module) prebuiltAttributes {

func Bp2BuildParsePrebuiltLibraryProps(ctx android.BazelConversionPathContext, module *Module, isStatic bool) prebuiltAttributes {

	manySourceFileError := func(axis bazel.ConfigurationAxis, config string) {

		ctx.ModuleErrorf("Bp2BuildParsePrebuiltLibraryProps: Expected at most one source file for %s %s\n", axis, config)

	}

	var srcLabelAttribute bazel.LabelAttribute



	for axis, configToProps := range module.GetArchVariantProperties(ctx, &prebuiltLinkerProperties{}) {

		for config, props := range configToProps {

			if prebuiltLinkerProperties, ok := props.(*prebuiltLinkerProperties); ok {

				if len(prebuiltLinkerProperties.Srcs) > 1 {

					ctx.ModuleErrorf("Bp2BuildParsePrebuiltLibraryProps: Expected at most once source file for %s %s\n", axis, config)

					continue

				} else if len(prebuiltLinkerProperties.Srcs) == 0 {

					continue

	parseSrcs := func(ctx android.BazelConversionPathContext, axis bazel.ConfigurationAxis, config string, srcs []string) {

		if len(srcs) > 1 {

			manySourceFileError(axis, config)

			return

		} else if len(srcs) == 0 {

			return

		}

		if srcLabelAttribute.SelectValue(axis, config) != nil {

			manySourceFileError(axis, config)

			return

		}

				src := android.BazelLabelForModuleSrcSingle(ctx, prebuiltLinkerProperties.Srcs[0])



		src := android.BazelLabelForModuleSrcSingle(ctx, srcs[0])

		srcLabelAttribute.SetSelectValue(axis, config, src)

	}



	bp2BuildPropParseHelper(ctx, module, &prebuiltLinkerProperties{}, func(axis bazel.ConfigurationAxis, config string, props interface{}) {

		if prebuiltLinkerProperties, ok := props.(*prebuiltLinkerProperties); ok {

			parseSrcs(ctx, axis, config, prebuiltLinkerProperties.Srcs)

		}

	})



	var enabledLabelAttribute bazel.BoolAttribute

	parseAttrs := func(axis bazel.ConfigurationAxis, config string, props StaticOrSharedProperties) {

		if props.Enabled != nil {

			enabledLabelAttribute.SetSelectValue(axis, config, props.Enabled)

		}

		parseSrcs(ctx, axis, config, props.Srcs)

	}



	if isStatic {

		bp2BuildPropParseHelper(ctx, module, &StaticProperties{}, func(axis bazel.ConfigurationAxis, config string, props interface{}) {

			if staticProperties, ok := props.(*StaticProperties); ok {

				parseAttrs(axis, config, staticProperties.Static)

			}

		})

	} else {

		bp2BuildPropParseHelper(ctx, module, &SharedProperties{}, func(axis bazel.ConfigurationAxis, config string, props interface{}) {

			if sharedProperties, ok := props.(*SharedProperties); ok {

				parseAttrs(axis, config, sharedProperties.Shared)

			}

		})

	}



	return prebuiltAttributes{

		Src:     srcLabelAttribute,

		Enabled: enabledLabelAttribute,

	}

}



func bp2BuildPropParseHelper(ctx android.ArchVariantContext, module *Module, propsType interface{}, parseFunc func(axis bazel.ConfigurationAxis, config string, props interface{})) {

	for axis, configToProps := range module.GetArchVariantProperties(ctx, propsType) {

		for config, props := range configToProps {

			parseFunc(axis, config, props)

		}

	}

}