Revert^2 "Build license metadata files in Soong"
b3264f2090
Change-Id: I5ea5f7e29eb1dbc72b8b30f010006a25f5f72facThis commit is contained in:
Colin Cross
231
android/license_metadata.go
Normal file
231
android/license_metadata.go
Normal file
@@ -0,0 +1,231 @@
|
||||
// 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 android
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/google/blueprint"
|
||||
"github.com/google/blueprint/proptools"
|
||||
)
|
||||
|
||||
var (
|
||||
_ = pctx.HostBinToolVariable("licenseMetadataCmd", "build_license_metadata")
|
||||
|
||||
licenseMetadataRule = pctx.AndroidStaticRule("licenseMetadataRule", blueprint.RuleParams{
|
||||
Command: "${licenseMetadataCmd} -o $out @${out}.rsp",
|
||||
CommandDeps: []string{"${licenseMetadataCmd}"},
|
||||
Rspfile: "${out}.rsp",
|
||||
RspfileContent: "${args}",
|
||||
}, "args")
|
||||
)
|
||||
|
||||
func buildLicenseMetadata(ctx ModuleContext) {
|
||||
base := ctx.Module().base()
|
||||
|
||||
if !base.Enabled() {
|
||||
return
|
||||
}
|
||||
|
||||
if exemptFromRequiredApplicableLicensesProperty(ctx.Module()) {
|
||||
return
|
||||
}
|
||||
|
||||
var allDepMetadataFiles Paths
|
||||
var allDepMetadataArgs []string
|
||||
var allDepOutputFiles Paths
|
||||
|
||||
ctx.VisitDirectDepsBlueprint(func(bpdep blueprint.Module) {
|
||||
dep, _ := bpdep.(Module)
|
||||
if dep == nil {
|
||||
return
|
||||
}
|
||||
if !dep.Enabled() {
|
||||
return
|
||||
}
|
||||
|
||||
if ctx.OtherModuleHasProvider(dep, LicenseMetadataProvider) {
|
||||
info := ctx.OtherModuleProvider(dep, LicenseMetadataProvider).(*LicenseMetadataInfo)
|
||||
allDepMetadataFiles = append(allDepMetadataFiles, info.LicenseMetadataPath)
|
||||
|
||||
depAnnotations := licenseAnnotationsFromTag(ctx.OtherModuleDependencyTag(dep))
|
||||
|
||||
allDepMetadataArgs = append(allDepMetadataArgs, info.LicenseMetadataPath.String()+depAnnotations)
|
||||
|
||||
if depInstallFiles := dep.base().installFiles; len(depInstallFiles) > 0 {
|
||||
allDepOutputFiles = append(allDepOutputFiles, depInstallFiles.Paths()...)
|
||||
} else if depOutputFiles, err := outputFilesForModule(ctx, dep, ""); err == nil {
|
||||
depOutputFiles = PathsIfNonNil(depOutputFiles...)
|
||||
allDepOutputFiles = append(allDepOutputFiles, depOutputFiles...)
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
allDepMetadataFiles = SortedUniquePaths(allDepMetadataFiles)
|
||||
sort.Strings(allDepMetadataArgs)
|
||||
allDepOutputFiles = SortedUniquePaths(allDepOutputFiles)
|
||||
|
||||
var orderOnlyDeps Paths
|
||||
var args []string
|
||||
|
||||
if t := ctx.ModuleType(); t != "" {
|
||||
args = append(args,
|
||||
"-mt "+proptools.NinjaAndShellEscape(t))
|
||||
}
|
||||
|
||||
args = append(args,
|
||||
"-r "+proptools.NinjaAndShellEscape(ctx.ModuleDir()),
|
||||
"-mc UNKNOWN")
|
||||
|
||||
if p := base.commonProperties.Effective_package_name; p != nil {
|
||||
args = append(args,
|
||||
"-p "+proptools.NinjaAndShellEscape(*p))
|
||||
}
|
||||
|
||||
args = append(args,
|
||||
JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(base.commonProperties.Effective_license_kinds), "-k "))
|
||||
|
||||
args = append(args,
|
||||
JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(base.commonProperties.Effective_license_conditions), "-c "))
|
||||
|
||||
args = append(args,
|
||||
JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(base.commonProperties.Effective_license_text.Strings()), "-n "))
|
||||
|
||||
args = append(args,
|
||||
JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(allDepMetadataArgs), "-d "))
|
||||
orderOnlyDeps = append(orderOnlyDeps, allDepMetadataFiles...)
|
||||
|
||||
args = append(args,
|
||||
JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(allDepOutputFiles.Strings()), "-s "))
|
||||
|
||||
// Install map
|
||||
args = append(args,
|
||||
JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(base.licenseInstallMap), "-m "))
|
||||
|
||||
// Built files
|
||||
var outputFiles Paths
|
||||
if outputFileProducer, ok := ctx.Module().(OutputFileProducer); ok {
|
||||
outputFiles, _ = outputFileProducer.OutputFiles("")
|
||||
outputFiles = PathsIfNonNil(outputFiles...)
|
||||
}
|
||||
|
||||
if len(outputFiles) > 0 {
|
||||
args = append(args,
|
||||
JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(outputFiles.Strings()), "-t "))
|
||||
} else {
|
||||
args = append(args, fmt.Sprintf("-t //%s:%s", ctx.ModuleDir(), ctx.ModuleName()))
|
||||
}
|
||||
|
||||
// Installed files
|
||||
args = append(args,
|
||||
JoinWithPrefix(proptools.NinjaAndShellEscapeListIncludingSpaces(base.installFiles.Strings()), "-i "))
|
||||
|
||||
isContainer := isContainerFromFileExtensions(base.installFiles, outputFiles)
|
||||
if isContainer {
|
||||
args = append(args, "--is_container")
|
||||
}
|
||||
|
||||
licenseMetadataFile := PathForModuleOut(ctx, "meta_lic")
|
||||
|
||||
ctx.Build(pctx, BuildParams{
|
||||
Rule: licenseMetadataRule,
|
||||
Output: licenseMetadataFile,
|
||||
OrderOnly: orderOnlyDeps,
|
||||
Description: "license metadata",
|
||||
Args: map[string]string{
|
||||
"args": strings.Join(args, " "),
|
||||
},
|
||||
})
|
||||
|
||||
ctx.SetProvider(LicenseMetadataProvider, &LicenseMetadataInfo{
|
||||
LicenseMetadataPath: licenseMetadataFile,
|
||||
})
|
||||
}
|
||||
|
||||
func isContainerFromFileExtensions(installPaths InstallPaths, builtPaths Paths) bool {
|
||||
var paths Paths
|
||||
if len(installPaths) > 0 {
|
||||
paths = installPaths.Paths()
|
||||
} else {
|
||||
paths = builtPaths
|
||||
}
|
||||
|
||||
for _, path := range paths {
|
||||
switch path.Ext() {
|
||||
case ".zip", ".tar", ".tgz", ".tar.gz", ".img", ".srcszip", ".apex":
|
||||
return true
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
// LicenseMetadataProvider is used to propagate license metadata paths between modules.
|
||||
var LicenseMetadataProvider = blueprint.NewProvider(&LicenseMetadataInfo{})
|
||||
|
||||
// LicenseMetadataInfo stores the license metadata path for a module.
|
||||
type LicenseMetadataInfo struct {
|
||||
LicenseMetadataPath Path
|
||||
}
|
||||
|
||||
// licenseAnnotationsFromTag returns the LicenseAnnotations for a tag (if any) converted into
|
||||
// a string, or an empty string if there are none.
|
||||
func licenseAnnotationsFromTag(tag blueprint.DependencyTag) string {
|
||||
if annoTag, ok := tag.(LicenseAnnotationsDependencyTag); ok {
|
||||
annos := annoTag.LicenseAnnotations()
|
||||
if len(annos) > 0 {
|
||||
annoStrings := make([]string, len(annos))
|
||||
for i, s := range annos {
|
||||
annoStrings[i] = string(s)
|
||||
}
|
||||
return ":" + strings.Join(annoStrings, ",")
|
||||
}
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
// LicenseAnnotationsDependencyTag is implemented by dependency tags in order to provide a
|
||||
// list of license dependency annotations.
|
||||
type LicenseAnnotationsDependencyTag interface {
|
||||
LicenseAnnotations() []LicenseAnnotation
|
||||
}
|
||||
|
||||
// LicenseAnnotation is an enum of annotations that can be applied to dependencies for propagating
|
||||
// license information.
|
||||
type LicenseAnnotation string
|
||||
|
||||
const (
|
||||
// LicenseAnnotationSharedDependency should be returned by LicenseAnnotations implementations
|
||||
// of dependency tags when the usage of the dependency is dynamic, for example a shared library
|
||||
// linkage for native modules or as a classpath library for java modules.
|
||||
LicenseAnnotationSharedDependency LicenseAnnotation = "dynamic"
|
||||
|
||||
// LicenseAnnotationToolchain should be returned by LicenseAnnotations implementations of
|
||||
// dependency tags when the dependency is used as a toolchain.
|
||||
//
|
||||
// Dependency tags that need to always return LicenseAnnotationToolchain
|
||||
// can embed LicenseAnnotationToolchainDependencyTag to implement LicenseAnnotations.
|
||||
LicenseAnnotationToolchain LicenseAnnotation = "toolchain"
|
||||
)
|
||||
|
||||
// LicenseAnnotationToolchainDependencyTag can be embedded in a dependency tag to implement
|
||||
// LicenseAnnotations that always returns LicenseAnnotationToolchain.
|
||||
type LicenseAnnotationToolchainDependencyTag struct{}
|
||||
|
||||
func (LicenseAnnotationToolchainDependencyTag) LicenseAnnotations() []LicenseAnnotation {
|
||||
return []LicenseAnnotation{LicenseAnnotationToolchain}
|
||||
}
|
||||
Reference in New Issue
Block a user