Remove ConvertWithBp2build implementations
Remove the ConvertWithBp2build implementations from all the module types, along with the related code. Bug: 315353489 Test: m blueprint_tests Change-Id: I212672286686a318893bc7348ddd5a5ec51e77a7
This commit is contained in:
@@ -15,15 +15,9 @@
|
||||
package android
|
||||
|
||||
import (
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
"android/soong/bazel"
|
||||
"android/soong/bazel/cquery"
|
||||
"android/soong/ui/metrics/bp2build_metrics_proto"
|
||||
"github.com/google/blueprint"
|
||||
"github.com/google/blueprint/proptools"
|
||||
)
|
||||
|
||||
func init() {
|
||||
@@ -39,181 +33,6 @@ func RegisterFilegroupBuildComponents(ctx RegistrationContext) {
|
||||
ctx.RegisterModuleType("filegroup_defaults", FileGroupDefaultsFactory)
|
||||
}
|
||||
|
||||
var convertedProtoLibrarySuffix = "_bp2build_converted"
|
||||
|
||||
// IsFilegroup checks that a module is a filegroup type
|
||||
func IsFilegroup(ctx bazel.OtherModuleContext, m blueprint.Module) bool {
|
||||
return ctx.OtherModuleType(m) == "filegroup"
|
||||
}
|
||||
|
||||
var (
|
||||
// ignoring case, checks for proto or protos as an independent word in the name, whether at the
|
||||
// beginning, end, or middle. e.g. "proto.foo", "bar-protos", "baz_proto_srcs" would all match
|
||||
filegroupLikelyProtoPattern = regexp.MustCompile("(?i)(^|[^a-z])proto(s)?([^a-z]|$)")
|
||||
filegroupLikelyAidlPattern = regexp.MustCompile("(?i)(^|[^a-z])aidl(s)?([^a-z]|$)")
|
||||
|
||||
ProtoSrcLabelPartition = bazel.LabelPartition{
|
||||
Extensions: []string{".proto"},
|
||||
LabelMapper: isFilegroupWithPattern(filegroupLikelyProtoPattern),
|
||||
}
|
||||
AidlSrcLabelPartition = bazel.LabelPartition{
|
||||
Extensions: []string{".aidl"},
|
||||
LabelMapper: isFilegroupWithPattern(filegroupLikelyAidlPattern),
|
||||
}
|
||||
)
|
||||
|
||||
func isFilegroupWithPattern(pattern *regexp.Regexp) bazel.LabelMapper {
|
||||
return func(ctx bazel.OtherModuleContext, label bazel.Label) (string, bool) {
|
||||
m, exists := ctx.ModuleFromName(label.OriginalModuleName)
|
||||
labelStr := label.Label
|
||||
if !exists || !IsFilegroup(ctx, m) {
|
||||
return labelStr, false
|
||||
}
|
||||
likelyMatched := pattern.MatchString(label.OriginalModuleName)
|
||||
return labelStr, likelyMatched
|
||||
}
|
||||
}
|
||||
|
||||
// https://docs.bazel.build/versions/master/be/general.html#filegroup
|
||||
type bazelFilegroupAttributes struct {
|
||||
Srcs bazel.LabelListAttribute
|
||||
Applicable_licenses bazel.LabelListAttribute
|
||||
}
|
||||
|
||||
type bazelAidlLibraryAttributes struct {
|
||||
Srcs bazel.LabelListAttribute
|
||||
Strip_import_prefix *string
|
||||
}
|
||||
|
||||
// ConvertWithBp2build performs bp2build conversion of filegroup
|
||||
func (fg *fileGroup) ConvertWithBp2build(ctx Bp2buildMutatorContext) {
|
||||
srcs := bazel.MakeLabelListAttribute(
|
||||
BazelLabelForModuleSrcExcludes(ctx, fg.properties.Srcs, fg.properties.Exclude_srcs))
|
||||
|
||||
// For Bazel compatibility, don't generate the filegroup if there is only 1
|
||||
// source file, and that the source file is named the same as the module
|
||||
// itself. In Bazel, eponymous filegroups like this would be an error.
|
||||
//
|
||||
// Instead, dependents on this single-file filegroup can just depend
|
||||
// on the file target, instead of rule target, directly.
|
||||
//
|
||||
// You may ask: what if a filegroup has multiple files, and one of them
|
||||
// shares the name? The answer: we haven't seen that in the wild, and
|
||||
// should lock Soong itself down to prevent the behavior. For now,
|
||||
// we raise an error if bp2build sees this problem.
|
||||
for _, f := range srcs.Value.Includes {
|
||||
if f.Label == fg.Name() {
|
||||
if len(srcs.Value.Includes) > 1 {
|
||||
ctx.ModuleErrorf("filegroup '%s' cannot contain a file with the same name", fg.Name())
|
||||
ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_SRC_NAME_COLLISION, "")
|
||||
} else {
|
||||
panic("This situation should have been handled by FileGroupFactory's call to InitBazelModuleAsHandcrafted")
|
||||
}
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// Convert module that has only AIDL files to aidl_library
|
||||
// If the module has a mixed bag of AIDL and non-AIDL files, split the filegroup manually
|
||||
// and then convert
|
||||
if fg.ShouldConvertToAidlLibrary(ctx) {
|
||||
tags := []string{"apex_available=//apex_available:anyapex"}
|
||||
attrs := &bazelAidlLibraryAttributes{
|
||||
Srcs: srcs,
|
||||
Strip_import_prefix: fg.properties.Path,
|
||||
}
|
||||
|
||||
props := bazel.BazelTargetModuleProperties{
|
||||
Rule_class: "aidl_library",
|
||||
Bzl_load_location: "//build/bazel/rules/aidl:aidl_library.bzl",
|
||||
}
|
||||
|
||||
ctx.CreateBazelTargetModule(
|
||||
props,
|
||||
CommonAttributes{
|
||||
Name: fg.Name(),
|
||||
Tags: bazel.MakeStringListAttribute(tags),
|
||||
},
|
||||
attrs)
|
||||
} else {
|
||||
if fg.ShouldConvertToProtoLibrary(ctx) {
|
||||
pkgToSrcs := partitionSrcsByPackage(ctx.ModuleDir(), bazel.MakeLabelList(srcs.Value.Includes))
|
||||
if len(pkgToSrcs) > 1 {
|
||||
ctx.ModuleErrorf("TODO: Add bp2build support for multiple package .protosrcs in filegroup")
|
||||
return
|
||||
}
|
||||
pkg := SortedKeys(pkgToSrcs)[0]
|
||||
attrs := &ProtoAttrs{
|
||||
Srcs: bazel.MakeLabelListAttribute(pkgToSrcs[pkg]),
|
||||
Strip_import_prefix: fg.properties.Path,
|
||||
}
|
||||
|
||||
tags := []string{
|
||||
"apex_available=//apex_available:anyapex",
|
||||
// TODO(b/246997908): we can remove this tag if we could figure out a solution for this bug.
|
||||
"manual",
|
||||
}
|
||||
if pkg != ctx.ModuleDir() {
|
||||
// Since we are creating the proto_library in a subpackage, create an import_prefix relative to the current package
|
||||
if rel, err := filepath.Rel(ctx.ModuleDir(), pkg); err != nil {
|
||||
ctx.ModuleErrorf("Could not get relative path for %v %v", pkg, err)
|
||||
} else if rel != "." {
|
||||
attrs.Import_prefix = &rel
|
||||
// Strip the package prefix
|
||||
attrs.Strip_import_prefix = proptools.StringPtr("")
|
||||
}
|
||||
}
|
||||
|
||||
ctx.CreateBazelTargetModule(
|
||||
bazel.BazelTargetModuleProperties{Rule_class: "proto_library"},
|
||||
CommonAttributes{
|
||||
Name: fg.Name() + "_proto",
|
||||
Dir: proptools.StringPtr(pkg),
|
||||
Tags: bazel.MakeStringListAttribute(tags),
|
||||
},
|
||||
attrs)
|
||||
|
||||
// Create an alias in the current dir. The actual target might exist in a different package, but rdeps
|
||||
// can reliabily use this alias
|
||||
ctx.CreateBazelTargetModule(
|
||||
bazel.BazelTargetModuleProperties{Rule_class: "alias"},
|
||||
CommonAttributes{
|
||||
Name: fg.Name() + convertedProtoLibrarySuffix,
|
||||
// TODO(b/246997908): we can remove this tag if we could figure out a solution for this bug.
|
||||
Tags: bazel.MakeStringListAttribute(tags),
|
||||
},
|
||||
&bazelAliasAttributes{
|
||||
Actual: bazel.MakeLabelAttribute("//" + pkg + ":" + fg.Name() + "_proto"),
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
// TODO(b/242847534): Still convert to a filegroup because other unconverted
|
||||
// modules may depend on the filegroup
|
||||
attrs := &bazelFilegroupAttributes{
|
||||
Srcs: srcs,
|
||||
}
|
||||
|
||||
props := bazel.BazelTargetModuleProperties{
|
||||
Rule_class: "filegroup",
|
||||
Bzl_load_location: "//build/bazel/rules:filegroup.bzl",
|
||||
}
|
||||
|
||||
ctx.CreateBazelTargetModule(props, CommonAttributes{Name: fg.Name()}, attrs)
|
||||
}
|
||||
}
|
||||
|
||||
type FileGroupPath interface {
|
||||
GetPath(ctx Bp2buildMutatorContext) string
|
||||
}
|
||||
|
||||
func (fg *fileGroup) GetPath(ctx Bp2buildMutatorContext) string {
|
||||
if fg.properties.Path != nil {
|
||||
return *fg.properties.Path
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
type fileGroupProperties struct {
|
||||
// srcs lists files that will be included in this filegroup
|
||||
Srcs []string `android:"path"`
|
||||
@@ -233,18 +52,12 @@ type fileGroupProperties struct {
|
||||
|
||||
type fileGroup struct {
|
||||
ModuleBase
|
||||
BazelModuleBase
|
||||
DefaultableModuleBase
|
||||
FileGroupAsLibrary
|
||||
FileGroupPath
|
||||
properties fileGroupProperties
|
||||
srcs Paths
|
||||
}
|
||||
|
||||
var _ MixedBuildBuildable = (*fileGroup)(nil)
|
||||
var _ SourceFileProducer = (*fileGroup)(nil)
|
||||
var _ FileGroupAsLibrary = (*fileGroup)(nil)
|
||||
var _ FileGroupPath = (*fileGroup)(nil)
|
||||
|
||||
// filegroup contains a list of files that are referenced by other modules
|
||||
// properties (such as "srcs") using the syntax ":<name>". filegroup are
|
||||
@@ -253,17 +66,6 @@ func FileGroupFactory() Module {
|
||||
module := &fileGroup{}
|
||||
module.AddProperties(&module.properties)
|
||||
InitAndroidModule(module)
|
||||
InitBazelModule(module)
|
||||
AddBazelHandcraftedHook(module, func(ctx LoadHookContext) string {
|
||||
// If there is a single src with the same name as the filegroup module name,
|
||||
// then don't generate this filegroup. It will be OK for other targets
|
||||
// to depend on this source file by name directly.
|
||||
fg := ctx.Module().(*fileGroup)
|
||||
if len(fg.properties.Srcs) == 1 && fg.Name() == fg.properties.Srcs[0] {
|
||||
return fg.Name()
|
||||
}
|
||||
return ""
|
||||
})
|
||||
InitDefaultableModule(module)
|
||||
return module
|
||||
}
|
||||
@@ -303,101 +105,6 @@ func (fg *fileGroup) MakeVars(ctx MakeVarsModuleContext) {
|
||||
}
|
||||
}
|
||||
|
||||
func (fg *fileGroup) QueueBazelCall(ctx BaseModuleContext) {
|
||||
bazelCtx := ctx.Config().BazelContext
|
||||
|
||||
bazelCtx.QueueBazelRequest(
|
||||
fg.GetBazelLabel(ctx, fg),
|
||||
cquery.GetOutputFiles,
|
||||
configKey{arch: Common.String(), osType: CommonOS})
|
||||
}
|
||||
|
||||
func (fg *fileGroup) IsMixedBuildSupported(ctx BaseModuleContext) bool {
|
||||
// TODO(b/247782695), TODO(b/242847534) Fix mixed builds for filegroups
|
||||
return false
|
||||
}
|
||||
|
||||
func (fg *fileGroup) ProcessBazelQueryResponse(ctx ModuleContext) {
|
||||
bazelCtx := ctx.Config().BazelContext
|
||||
// This is a short-term solution because we rely on info from Android.bp to handle
|
||||
// a converted module. This will block when we want to remove Android.bp for all
|
||||
// converted modules at some point.
|
||||
// TODO(b/242847534): Implement a long-term solution in which we don't need to rely
|
||||
// on info form Android.bp for modules that are already converted to Bazel
|
||||
relativeRoot := ctx.ModuleDir()
|
||||
if fg.properties.Path != nil {
|
||||
relativeRoot = filepath.Join(relativeRoot, *fg.properties.Path)
|
||||
}
|
||||
|
||||
filePaths, err := bazelCtx.GetOutputFiles(fg.GetBazelLabel(ctx, fg), configKey{arch: Common.String(), osType: CommonOS})
|
||||
if err != nil {
|
||||
ctx.ModuleErrorf(err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
bazelOuts := make(Paths, 0, len(filePaths))
|
||||
for _, p := range filePaths {
|
||||
bazelOuts = append(bazelOuts, PathForBazelOutRelative(ctx, relativeRoot, p))
|
||||
}
|
||||
fg.srcs = bazelOuts
|
||||
}
|
||||
|
||||
func (fg *fileGroup) ShouldConvertToAidlLibrary(ctx BazelConversionPathContext) bool {
|
||||
return fg.shouldConvertToLibrary(ctx, ".aidl")
|
||||
}
|
||||
|
||||
func (fg *fileGroup) ShouldConvertToProtoLibrary(ctx BazelConversionPathContext) bool {
|
||||
return fg.shouldConvertToLibrary(ctx, ".proto")
|
||||
}
|
||||
|
||||
func (fg *fileGroup) shouldConvertToLibrary(ctx BazelConversionPathContext, suffix string) bool {
|
||||
if len(fg.properties.Srcs) == 0 || !fg.ShouldConvertWithBp2build(ctx) {
|
||||
return false
|
||||
}
|
||||
for _, src := range fg.properties.Srcs {
|
||||
if !strings.HasSuffix(src, suffix) {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
|
||||
func (fg *fileGroup) GetAidlLibraryLabel(ctx BazelConversionPathContext) string {
|
||||
return fg.getFileGroupAsLibraryLabel(ctx)
|
||||
}
|
||||
|
||||
func (fg *fileGroup) GetProtoLibraryLabel(ctx BazelConversionPathContext) string {
|
||||
return fg.getFileGroupAsLibraryLabel(ctx) + convertedProtoLibrarySuffix
|
||||
}
|
||||
|
||||
func (fg *fileGroup) getFileGroupAsLibraryLabel(ctx BazelConversionPathContext) string {
|
||||
if ctx.OtherModuleDir(fg.module) == ctx.ModuleDir() {
|
||||
return ":" + fg.Name()
|
||||
} else {
|
||||
return fg.GetBazelLabel(ctx, fg)
|
||||
}
|
||||
}
|
||||
|
||||
// Given a name in srcs prop, check to see if the name references a filegroup
|
||||
// and the filegroup is converted to aidl_library
|
||||
func IsConvertedToAidlLibrary(ctx BazelConversionPathContext, name string) bool {
|
||||
if fg, ok := ToFileGroupAsLibrary(ctx, name); ok {
|
||||
return fg.ShouldConvertToAidlLibrary(ctx)
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func ToFileGroupAsLibrary(ctx BazelConversionPathContext, name string) (FileGroupAsLibrary, bool) {
|
||||
if module, ok := ctx.ModuleFromName(name); ok {
|
||||
if IsFilegroup(ctx, module) {
|
||||
if fg, ok := module.(FileGroupAsLibrary); ok {
|
||||
return fg, true
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil, false
|
||||
}
|
||||
|
||||
// Defaults
|
||||
type FileGroupDefaults struct {
|
||||
ModuleBase
|
||||
|
Reference in New Issue
Block a user