Merge "Add tidy-soong, tidy-dir-path, module-tidy targets"
diff --git a/README.md b/README.md
index e92349e..a67c393 100644
--- a/README.md
+++ b/README.md
@@ -33,8 +33,9 @@
Every module must have a `name` property, and the value must be unique across
all Android.bp files.
-For a list of valid module types and their properties see
-[$OUT_DIR/soong/docs/soong_build.html](https://ci.android.com/builds/latest/branches/aosp-build-tools/targets/linux/view/soong_build.html).
+The list of valid module types and their properties can be generated by calling
+`m soong_docs`. It will be written to `$OUT_DIR/soong/docs/soong_build.html`.
+This list for the current version of Soong can be found [here](https://ci.android.com/builds/latest/branches/aosp-build-tools/targets/linux/view/soong_build.html).
### File lists
diff --git a/android/Android.bp b/android/Android.bp
index 1bccd7b..f3a3850 100644
--- a/android/Android.bp
+++ b/android/Android.bp
@@ -66,7 +66,6 @@
"prebuilt.go",
"prebuilt_build_tool.go",
"proto.go",
- "queryview.go",
"register.go",
"rule_builder.go",
"sandbox.go",
@@ -81,7 +80,6 @@
"util.go",
"variable.go",
"visibility.go",
- "writedocs.go",
],
testSrcs: [
"android_test.go",
diff --git a/android/config.go b/android/config.go
index e0fc266..af1e6c8 100644
--- a/android/config.go
+++ b/android/config.go
@@ -157,8 +157,6 @@
captureBuild bool // true for tests, saves build parameters for each module
ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
- stopBefore bootstrap.StopBefore
-
fs pathtools.FileSystem
mockBpList string
@@ -420,8 +418,8 @@
// bootstrap run. Only per-run data is reset. Data which needs to persist across
// multiple runs in the same program execution is carried over (such as Bazel
// context or environment deps).
-func ConfigForAdditionalRun(cmdlineArgs bootstrap.Args, c Config) (Config, error) {
- newConfig, err := NewConfig(cmdlineArgs, c.soongOutDir, c.env)
+func ConfigForAdditionalRun(c Config) (Config, error) {
+ newConfig, err := NewConfig(c.moduleListFile, c.runGoTests, c.outDir, c.soongOutDir, c.env)
if err != nil {
return Config{}, err
}
@@ -432,20 +430,20 @@
// NewConfig creates a new Config object. The srcDir argument specifies the path
// to the root source directory. It also loads the config file, if found.
-func NewConfig(cmdlineArgs bootstrap.Args, soongOutDir string, availableEnv map[string]string) (Config, error) {
+func NewConfig(moduleListFile string, runGoTests bool, outDir, soongOutDir string, availableEnv map[string]string) (Config, error) {
// Make a config with default options.
config := &config{
ProductVariablesFileName: filepath.Join(soongOutDir, productVariablesFileName),
env: availableEnv,
- outDir: cmdlineArgs.OutDir,
+ outDir: outDir,
soongOutDir: soongOutDir,
- runGoTests: cmdlineArgs.RunGoTests,
- useValidationsForGoTests: cmdlineArgs.UseValidations,
+ runGoTests: runGoTests,
+ useValidationsForGoTests: runGoTests,
multilibConflicts: make(map[ArchType]bool),
- moduleListFile: cmdlineArgs.ModuleListFile,
+ moduleListFile: moduleListFile,
fs: pathtools.NewOsFs(absSrcDir),
}
@@ -565,21 +563,10 @@
c.mockBpList = blueprint.MockModuleListFile
}
-func (c *config) StopBefore() bootstrap.StopBefore {
- return c.stopBefore
-}
-
-// SetStopBefore configures soong_build to exit earlier at a specific point.
-func (c *config) SetStopBefore(stopBefore bootstrap.StopBefore) {
- c.stopBefore = stopBefore
-}
-
func (c *config) SetAllowMissingDependencies() {
c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
}
-var _ bootstrap.ConfigStopBefore = (*config)(nil)
-
// BlueprintToolLocation returns the directory containing build system tools
// from Blueprint, like soong_zip and merge_zips.
func (c *config) HostToolDir() string {
diff --git a/android/queryview.go b/android/queryview.go
deleted file mode 100644
index 224652e..0000000
--- a/android/queryview.go
+++ /dev/null
@@ -1,112 +0,0 @@
-// Copyright 2020 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"
- "os"
- "strings"
-
- "github.com/google/blueprint"
-)
-
-// The Bazel QueryView singleton is responsible for generating the Ninja actions
-// for calling the soong_build primary builder in the main build.ninja file.
-func init() {
- RegisterSingletonType("bazel_queryview", BazelQueryViewSingleton)
-}
-
-// BazelQueryViewSingleton is the singleton responsible for registering the
-// soong_build build statement that will convert the Soong module graph after
-// applying *all* mutators, enabing the feature to query the final state of the
-// Soong graph. This mode is meant for querying the build graph state, and not meant
-// for generating BUILD files to be checked in.
-func BazelQueryViewSingleton() Singleton {
- return &bazelQueryViewSingleton{}
-}
-
-// BazelConverterSingleton is the singleton responsible for registering the soong_build
-// build statement that will convert the Soong module graph by applying an alternate
-// pipeline of mutators, with the goal of reaching semantic equivalence between the original
-// Blueprint and final BUILD files. Using this mode, the goal is to be able to
-// build with these BUILD files directly in the source tree.
-func BazelConverterSingleton() Singleton {
- return &bazelConverterSingleton{}
-}
-
-type bazelQueryViewSingleton struct{}
-type bazelConverterSingleton struct{}
-
-func generateBuildActionsForBazelConversion(ctx SingletonContext, converterMode bool) {
- name := "queryview"
- descriptionTemplate := "[EXPERIMENTAL, PRE-PRODUCTION] Creating the Bazel QueryView workspace with %s at $outDir"
-
- // Create a build and rule statement, using the Bazel QueryView's WORKSPACE
- // file as the output file marker.
- var deps Paths
- moduleListFilePath := pathForBuildToolDep(ctx, ctx.Config().moduleListFile)
- deps = append(deps, moduleListFilePath)
- deps = append(deps, pathForBuildToolDep(ctx, ctx.Config().ProductVariablesFileName))
-
- bazelQueryViewDirectory := PathForOutput(ctx, name)
- bazelQueryViewWorkspaceFile := bazelQueryViewDirectory.Join(ctx, "WORKSPACE")
- primaryBuilder := primaryBuilderPath(ctx)
- bazelQueryView := ctx.Rule(pctx, "bazelQueryView",
- blueprint.RuleParams{
- Command: fmt.Sprintf(
- `rm -rf "${outDir}/"* && `+
- `mkdir -p "${outDir}" && `+
- `echo WORKSPACE: $$(cat "%s") > "${outDir}/.queryview-depfile.d" && `+
- `BUILDER="%s" && `+
- `echo BUILDER=$$BUILDER && `+
- `cd "$$(dirname "$$BUILDER")" && `+
- `echo PWD=$$PWD && `+
- `ABSBUILDER="$$PWD/$$(basename "$$BUILDER")" && `+
- `echo ABSBUILDER=$$ABSBUILDER && `+
- `cd / && `+
- `env -i "$$ABSBUILDER" --bazel_queryview_dir "${outDir}" "%s"`,
- moduleListFilePath.String(), // Use the contents of Android.bp.list as the depfile.
- primaryBuilder.String(),
- strings.Join(os.Args[1:], "\" \""),
- ),
- CommandDeps: []string{primaryBuilder.String()},
- Description: fmt.Sprintf(
- descriptionTemplate,
- primaryBuilder.Base()),
- Deps: blueprint.DepsGCC,
- Depfile: "${outDir}/.queryview-depfile.d",
- },
- "outDir")
-
- ctx.Build(pctx, BuildParams{
- Rule: bazelQueryView,
- Output: bazelQueryViewWorkspaceFile,
- Inputs: deps,
- Args: map[string]string{
- "outDir": bazelQueryViewDirectory.String(),
- },
- })
-
- // Add a phony target for generating the workspace
- ctx.Phony(name, bazelQueryViewWorkspaceFile)
-}
-
-func (c *bazelQueryViewSingleton) GenerateBuildActions(ctx SingletonContext) {
- generateBuildActionsForBazelConversion(ctx, false)
-}
-
-func (c *bazelConverterSingleton) GenerateBuildActions(ctx SingletonContext) {
- generateBuildActionsForBazelConversion(ctx, true)
-}
diff --git a/android/writedocs.go b/android/writedocs.go
deleted file mode 100644
index c380a3d..0000000
--- a/android/writedocs.go
+++ /dev/null
@@ -1,89 +0,0 @@
-// Copyright 2015 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"
- "os"
- "path/filepath"
- "strings"
-
- "github.com/google/blueprint"
-)
-
-func init() {
- RegisterSingletonType("writedocs", DocsSingleton)
-}
-
-func DocsSingleton() Singleton {
- return &docsSingleton{}
-}
-
-type docsSingleton struct{}
-
-func primaryBuilderPath(ctx SingletonContext) Path {
- soongOutDir := absolutePath(ctx.Config().SoongOutDir())
- binary := absolutePath(os.Args[0])
- primaryBuilder, err := filepath.Rel(soongOutDir, binary)
- if err != nil {
- ctx.Errorf("path to primary builder %q is not in build dir %q (%q)",
- os.Args[0], ctx.Config().SoongOutDir(), err)
- }
-
- return PathForOutput(ctx, primaryBuilder)
-}
-
-func (c *docsSingleton) GenerateBuildActions(ctx SingletonContext) {
- var deps Paths
- deps = append(deps, pathForBuildToolDep(ctx, ctx.Config().moduleListFile))
- deps = append(deps, pathForBuildToolDep(ctx, ctx.Config().ProductVariablesFileName))
-
- // The dexpreopt configuration may not exist, but if it does, it's a dependency
- // of soong_build.
- dexpreoptConfigPath := ctx.Config().DexpreoptGlobalConfigPath(ctx)
- if dexpreoptConfigPath.Valid() {
- deps = append(deps, dexpreoptConfigPath.Path())
- }
-
- // Generate build system docs for the primary builder. Generating docs reads the source
- // files used to build the primary builder, but that dependency will be picked up through
- // the dependency on the primary builder itself. There are no dependencies on the
- // Blueprints files, as any relevant changes to the Blueprints files would have caused
- // a rebuild of the primary builder.
- docsFile := PathForOutput(ctx, "docs", "soong_build.html")
- primaryBuilder := primaryBuilderPath(ctx)
- soongDocs := ctx.Rule(pctx, "soongDocs",
- blueprint.RuleParams{
- Command: fmt.Sprintf("rm -f ${outDir}/* && %s --soong_docs %s %s",
- primaryBuilder.String(),
- docsFile.String(),
- "\""+strings.Join(os.Args[1:], "\" \"")+"\""),
- CommandDeps: []string{primaryBuilder.String()},
- Description: fmt.Sprintf("%s docs $out", primaryBuilder.Base()),
- },
- "outDir")
-
- ctx.Build(pctx, BuildParams{
- Rule: soongDocs,
- Output: docsFile,
- Inputs: deps,
- Args: map[string]string{
- "outDir": PathForOutput(ctx, "docs").String(),
- },
- })
-
- // Add a phony target for building the documentation
- ctx.Phony("soong_docs", docsFile)
-}
diff --git a/androidmk/androidmk/android.go b/androidmk/androidmk/android.go
index 08616a9..80801b2 100644
--- a/androidmk/androidmk/android.go
+++ b/androidmk/androidmk/android.go
@@ -201,6 +201,7 @@
"LOCAL_VENDOR_MODULE": "vendor",
"LOCAL_ODM_MODULE": "device_specific",
"LOCAL_PRODUCT_MODULE": "product_specific",
+ "LOCAL_PRODUCT_SERVICES_MODULE": "product_specific",
"LOCAL_SYSTEM_EXT_MODULE": "system_ext_specific",
"LOCAL_EXPORT_PACKAGE_RESOURCES": "export_package_resources",
"LOCAL_PRIVILEGED_MODULE": "privileged",
diff --git a/cc/config/OWNERS b/cc/config/OWNERS
index 701db92..580f215 100644
--- a/cc/config/OWNERS
+++ b/cc/config/OWNERS
@@ -1,3 +1,3 @@
per-file vndk.go = smoreland@google.com, victoryang@google.com
-per-file clang.go,global.go = srhines@google.com, chh@google.com, pirama@google.com, yikong@google.com
+per-file clang.go,global.go,tidy.go = srhines@google.com, chh@google.com, pirama@google.com, yikong@google.com
diff --git a/cc/config/tidy.go b/cc/config/tidy.go
index cf13503..8682502 100644
--- a/cc/config/tidy.go
+++ b/cc/config/tidy.go
@@ -115,6 +115,7 @@
{"external/", tidyExternalVendor},
{"external/google", tidyDefault},
{"external/webrtc", tidyDefault},
+ {"external/googletest/", tidyExternalVendor},
{"frameworks/compile/mclinker/", tidyExternalVendor},
{"hardware/qcom", tidyExternalVendor},
{"vendor/", tidyExternalVendor},
@@ -133,6 +134,7 @@
}
func TidyChecksForDir(dir string) string {
+ dir = dir + "/"
for _, pathCheck := range reversedDefaultLocalTidyChecks {
if strings.HasPrefix(dir, pathCheck.PathPrefix) {
return pathCheck.Checks
diff --git a/cc/config/vndk.go b/cc/config/vndk.go
index 24e8fa4..2e53b63 100644
--- a/cc/config/vndk.go
+++ b/cc/config/vndk.go
@@ -74,6 +74,8 @@
"android.hardware.weaver-ndk_platform",
"android.hardware.weaver-unstable-ndk_platform",
"android.system.keystore2-V1-ndk",
+ "android.hardware.wifi.hostapd-V1-ndk",
+ "android.hardware.wifi.hostapd-V1-ndk_platform",
"android.system.keystore2-V1-ndk_platform",
"android.system.keystore2-ndk_platform",
"android.system.keystore2-unstable-ndk_platform",
diff --git a/cmd/soong_build/main.go b/cmd/soong_build/main.go
index 3e724ee..09a2234 100644
--- a/cmd/soong_build/main.go
+++ b/cmd/soong_build/main.go
@@ -35,10 +35,13 @@
var (
topDir string
+ outDir string
soongOutDir string
availableEnvFile string
usedEnvFile string
+ runGoTests bool
+
globFile string
globListDir string
delveListen string
@@ -60,7 +63,7 @@
flag.StringVar(&usedEnvFile, "used_env", "", "File containing used environment variables")
flag.StringVar(&globFile, "globFile", "build-globs.ninja", "the Ninja file of globs to output")
flag.StringVar(&globListDir, "globListDir", "", "the directory containing the glob list files")
- flag.StringVar(&cmdlineArgs.OutDir, "out", "", "the ninja builddir directory")
+ flag.StringVar(&outDir, "out", "", "the ninja builddir directory")
flag.StringVar(&cmdlineArgs.ModuleListFile, "l", "", "file that lists filepaths to parse")
// Debug flags
@@ -81,8 +84,7 @@
// Flags that probably shouldn't be flags of soong_build but we haven't found
// the time to remove them yet
- flag.BoolVar(&cmdlineArgs.RunGoTests, "t", false, "build and run go tests during bootstrap")
- flag.BoolVar(&cmdlineArgs.UseValidations, "use-validations", false, "use validations to depend on go tests")
+ flag.BoolVar(&runGoTests, "t", false, "build and run go tests during bootstrap")
}
func newNameResolver(config android.Config) *android.NameResolver {
@@ -101,19 +103,16 @@
return android.NewNameResolver(exportFilter)
}
-func newContext(configuration android.Config, prepareBuildActions bool) *android.Context {
+func newContext(configuration android.Config) *android.Context {
ctx := android.NewContext(configuration)
ctx.Register()
- if !prepareBuildActions {
- configuration.SetStopBefore(bootstrap.StopBeforePrepareBuildActions)
- }
ctx.SetNameInterface(newNameResolver(configuration))
ctx.SetAllowMissingDependencies(configuration.AllowMissingDependencies())
return ctx
}
-func newConfig(cmdlineArgs bootstrap.Args, outDir string, availableEnv map[string]string) android.Config {
- configuration, err := android.NewConfig(cmdlineArgs, outDir, availableEnv)
+func newConfig(availableEnv map[string]string) android.Config {
+ configuration, err := android.NewConfig(cmdlineArgs.ModuleListFile, runGoTests, outDir, soongOutDir, availableEnv)
if err != nil {
fmt.Fprintf(os.Stderr, "%s", err)
os.Exit(1)
@@ -127,11 +126,7 @@
// TODO(cparsons): Don't output any ninja file, as the second pass will overwrite
// the incorrect results from the first pass, and file I/O is expensive.
func runMixedModeBuild(configuration android.Config, firstCtx *android.Context, extraNinjaDeps []string) {
- var firstArgs, secondArgs bootstrap.Args
-
- firstArgs = cmdlineArgs
- configuration.SetStopBefore(bootstrap.StopBeforeWriteNinja)
- bootstrap.RunBlueprint(firstArgs, firstCtx.Context, configuration)
+ bootstrap.RunBlueprint(cmdlineArgs, bootstrap.StopBeforeWriteNinja, firstCtx.Context, configuration)
// Invoke bazel commands and save results for second pass.
if err := configuration.BazelContext.InvokeBazel(); err != nil {
@@ -139,40 +134,31 @@
os.Exit(1)
}
// Second pass: Full analysis, using the bazel command results. Output ninja file.
- secondArgs = cmdlineArgs
- secondConfig, err := android.ConfigForAdditionalRun(secondArgs, configuration)
+ secondConfig, err := android.ConfigForAdditionalRun(configuration)
if err != nil {
fmt.Fprintf(os.Stderr, "%s", err)
os.Exit(1)
}
- secondCtx := newContext(secondConfig, true)
- ninjaDeps := bootstrap.RunBlueprint(secondArgs, secondCtx.Context, secondConfig)
+ secondCtx := newContext(secondConfig)
+ ninjaDeps := bootstrap.RunBlueprint(cmdlineArgs, bootstrap.DoEverything, secondCtx.Context, secondConfig)
ninjaDeps = append(ninjaDeps, extraNinjaDeps...)
globListFiles := writeBuildGlobsNinjaFile(secondCtx.SrcDir(), configuration.SoongOutDir(), secondCtx.Globs, configuration)
ninjaDeps = append(ninjaDeps, globListFiles...)
- writeDepFile(secondArgs.OutFile, ninjaDeps)
+ writeDepFile(cmdlineArgs.OutFile, ninjaDeps)
}
// Run the code-generation phase to convert BazelTargetModules to BUILD files.
-func runQueryView(configuration android.Config, ctx *android.Context) {
+func runQueryView(queryviewDir, queryviewMarker string, configuration android.Config, ctx *android.Context) {
codegenContext := bp2build.NewCodegenContext(configuration, *ctx, bp2build.QueryView)
- absoluteQueryViewDir := shared.JoinPath(topDir, bazelQueryViewDir)
+ absoluteQueryViewDir := shared.JoinPath(topDir, queryviewDir)
if err := createBazelQueryView(codegenContext, absoluteQueryViewDir); err != nil {
fmt.Fprintf(os.Stderr, "%s", err)
os.Exit(1)
}
-}
-func runSoongDocs(configuration android.Config) {
- ctx := newContext(configuration, false)
- soongDocsArgs := cmdlineArgs
- bootstrap.RunBlueprint(soongDocsArgs, ctx.Context, configuration)
- if err := writeDocs(ctx, configuration, docFile); err != nil {
- fmt.Fprintf(os.Stderr, "%s", err)
- os.Exit(1)
- }
+ touch(shared.JoinPath(topDir, queryviewMarker))
}
func writeMetrics(configuration android.Config) {
@@ -219,24 +205,33 @@
// or the actual Soong build for the build.ninja file. Returns the top level
// output file of the specific activity.
func doChosenActivity(configuration android.Config, extraNinjaDeps []string) string {
- bazelConversionRequested := bp2buildMarker != ""
mixedModeBuild := configuration.BazelContext.BazelEnabled()
+ generateBazelWorkspace := bp2buildMarker != ""
generateQueryView := bazelQueryViewDir != ""
+ generateModuleGraphFile := moduleGraphFile != ""
+ generateDocFile := docFile != ""
blueprintArgs := cmdlineArgs
- prepareBuildActions := !generateQueryView && moduleGraphFile == ""
- if bazelConversionRequested {
+
+ var stopBefore bootstrap.StopBefore
+ if !generateModuleGraphFile && !generateQueryView && !generateDocFile {
+ stopBefore = bootstrap.DoEverything
+ } else {
+ stopBefore = bootstrap.StopBeforePrepareBuildActions
+ }
+
+ if generateBazelWorkspace {
// Run the alternate pipeline of bp2build mutators and singleton to convert
// Blueprint to BUILD files before everything else.
runBp2Build(configuration, extraNinjaDeps)
return bp2buildMarker
}
- ctx := newContext(configuration, prepareBuildActions)
+ ctx := newContext(configuration)
if mixedModeBuild {
runMixedModeBuild(configuration, ctx, extraNinjaDeps)
} else {
- ninjaDeps := bootstrap.RunBlueprint(blueprintArgs, ctx.Context, configuration)
+ ninjaDeps := bootstrap.RunBlueprint(blueprintArgs, stopBefore, ctx.Context, configuration)
ninjaDeps = append(ninjaDeps, extraNinjaDeps...)
globListFiles := writeBuildGlobsNinjaFile(ctx.SrcDir(), configuration.SoongOutDir(), ctx.Globs, configuration)
@@ -244,12 +239,24 @@
// Convert the Soong module graph into Bazel BUILD files.
if generateQueryView {
- runQueryView(configuration, ctx)
- return cmdlineArgs.OutFile // TODO: This is a lie
- } else if moduleGraphFile != "" {
+ queryviewMarkerFile := bazelQueryViewDir + ".marker"
+ runQueryView(bazelQueryViewDir, queryviewMarkerFile, configuration, ctx)
+ writeDepFile(queryviewMarkerFile, ninjaDeps)
+ return queryviewMarkerFile
+ } else if generateModuleGraphFile {
writeJsonModuleGraph(ctx, moduleGraphFile)
writeDepFile(moduleGraphFile, ninjaDeps)
return moduleGraphFile
+ } else if generateDocFile {
+ // TODO: we could make writeDocs() return the list of documentation files
+ // written and add them to the .d file. Then soong_docs would be re-run
+ // whenever one is deleted.
+ if err := writeDocs(ctx, shared.JoinPath(topDir, docFile)); err != nil {
+ fmt.Fprintf(os.Stderr, "error building Soong documentation: %s\n", err)
+ os.Exit(1)
+ }
+ writeDepFile(docFile, ninjaDeps)
+ return docFile
} else {
// The actual output (build.ninja) was written in the RunBlueprint() call
// above
@@ -297,7 +304,7 @@
availableEnv := parseAvailableEnv()
- configuration := newConfig(cmdlineArgs, soongOutDir, availableEnv)
+ configuration := newConfig(availableEnv)
extraNinjaDeps := []string{
configuration.ProductVariablesFileName,
usedEnvFile,
@@ -313,16 +320,6 @@
extraNinjaDeps = append(extraNinjaDeps, filepath.Join(configuration.SoongOutDir(), "always_rerun_for_delve"))
}
- if docFile != "" {
- // We don't write an used variables file when generating documentation
- // because that is done from within the actual builds as a Ninja action and
- // thus it would overwrite the actual used variables file so this is
- // special-cased.
- // TODO: Fix this by not passing --used_env to the soong_docs invocation
- runSoongDocs(configuration)
- return
- }
-
finalOutputFile := doChosenActivity(configuration, extraNinjaDeps)
writeUsedEnvironmentFile(configuration, finalOutputFile)
}
@@ -475,14 +472,11 @@
extraNinjaDeps = append(extraNinjaDeps, modulePaths...)
- // No need to generate Ninja build rules/statements from Modules and Singletons.
- configuration.SetStopBefore(bootstrap.StopBeforePrepareBuildActions)
-
// Run the loading and analysis pipeline to prepare the graph of regular
// Modules parsed from Android.bp files, and the BazelTargetModules mapped
// from the regular Modules.
blueprintArgs := cmdlineArgs
- ninjaDeps := bootstrap.RunBlueprint(blueprintArgs, bp2buildCtx.Context, configuration)
+ ninjaDeps := bootstrap.RunBlueprint(blueprintArgs, bootstrap.StopBeforePrepareBuildActions, bp2buildCtx.Context, configuration)
ninjaDeps = append(ninjaDeps, extraNinjaDeps...)
globListFiles := writeBuildGlobsNinjaFile(bp2buildCtx.SrcDir(), configuration.SoongOutDir(), bp2buildCtx.Globs, configuration)
@@ -504,8 +498,8 @@
"bazel-" + filepath.Base(topDir),
}
- if cmdlineArgs.OutDir[0] != '/' {
- excludes = append(excludes, cmdlineArgs.OutDir)
+ if outDir[0] != '/' {
+ excludes = append(excludes, outDir)
}
existingBazelRelatedFiles, err := getExistingBazelRelatedFiles(topDir)
diff --git a/cmd/soong_build/queryview.go b/cmd/soong_build/queryview.go
index a8602de..98e27c6 100644
--- a/cmd/soong_build/queryview.go
+++ b/cmd/soong_build/queryview.go
@@ -15,14 +15,16 @@
package main
import (
- "android/soong/android"
- "android/soong/bp2build"
"io/ioutil"
"os"
"path/filepath"
+
+ "android/soong/android"
+ "android/soong/bp2build"
)
func createBazelQueryView(ctx *bp2build.CodegenContext, bazelQueryViewDir string) error {
+ os.RemoveAll(bazelQueryViewDir)
ruleShims := bp2build.CreateRuleShims(android.ModuleTypeFactories())
// Ignore metrics reporting and compat layers for queryview, since queryview
diff --git a/cmd/soong_build/writedocs.go b/cmd/soong_build/writedocs.go
index b7c260c..8d8f37f 100644
--- a/cmd/soong_build/writedocs.go
+++ b/cmd/soong_build/writedocs.go
@@ -15,13 +15,14 @@
package main
import (
- "android/soong/android"
"bytes"
"html/template"
"io/ioutil"
"path/filepath"
"sort"
+ "android/soong/android"
+
"github.com/google/blueprint/bootstrap"
"github.com/google/blueprint/bootstrap/bpdoc"
)
@@ -95,13 +96,13 @@
return result
}
-func getPackages(ctx *android.Context, config interface{}) ([]*bpdoc.Package, error) {
+func getPackages(ctx *android.Context) ([]*bpdoc.Package, error) {
moduleTypeFactories := android.ModuleTypeFactoriesForDocs()
- return bootstrap.ModuleTypeDocs(ctx.Context, config, moduleTypeFactories)
+ return bootstrap.ModuleTypeDocs(ctx.Context, moduleTypeFactories)
}
-func writeDocs(ctx *android.Context, config interface{}, filename string) error {
- packages, err := getPackages(ctx, config)
+func writeDocs(ctx *android.Context, filename string) error {
+ packages, err := getPackages(ctx)
if err != nil {
return err
}
diff --git a/mk2rbc/cmd/mk2rbc.go b/mk2rbc/cmd/mk2rbc.go
index 72525c4..209e82b 100644
--- a/mk2rbc/cmd/mk2rbc.go
+++ b/mk2rbc/cmd/mk2rbc.go
@@ -202,8 +202,7 @@
func buildProductConfigMap() map[string]string {
const androidProductsMk = "AndroidProducts.mk"
// Build the list of AndroidProducts.mk files: it's
- // build/make/target/product/AndroidProducts.mk plus
- // device/**/AndroidProducts.mk
+ // build/make/target/product/AndroidProducts.mk + device/**/AndroidProducts.mk plus + vendor/**/AndroidProducts.mk
targetAndroidProductsFile := filepath.Join(*rootDir, "build", "make", "target", "product", androidProductsMk)
if _, err := os.Stat(targetAndroidProductsFile); err != nil {
fmt.Fprintf(os.Stderr, "%s: %s\n(hint: %s is not a source tree root)\n",
@@ -213,17 +212,19 @@
if err := mk2rbc.UpdateProductConfigMap(productConfigMap, targetAndroidProductsFile); err != nil {
fmt.Fprintf(os.Stderr, "%s: %s\n", targetAndroidProductsFile, err)
}
- _ = filepath.Walk(filepath.Join(*rootDir, "device"),
- func(path string, info os.FileInfo, err error) error {
- if info.IsDir() || filepath.Base(path) != androidProductsMk {
+ for _, t := range []string{"device", "vendor"} {
+ _ = filepath.WalkDir(filepath.Join(*rootDir, t),
+ func(path string, d os.DirEntry, err error) error {
+ if err != nil || d.IsDir() || filepath.Base(path) != androidProductsMk {
+ return nil
+ }
+ if err2 := mk2rbc.UpdateProductConfigMap(productConfigMap, path); err2 != nil {
+ fmt.Fprintf(os.Stderr, "%s: %s\n", path, err)
+ // Keep going, we want to find all such errors in a single run
+ }
return nil
- }
- if err2 := mk2rbc.UpdateProductConfigMap(productConfigMap, path); err2 != nil {
- fmt.Fprintf(os.Stderr, "%s: %s\n", path, err)
- // Keep going, we want to find all such errors in a single run
- }
- return nil
- })
+ })
+ }
return productConfigMap
}
diff --git a/scripts/check_boot_jars/check_boot_jars.py b/scripts/check_boot_jars/check_boot_jars.py
index c271211..b711f9d 100755
--- a/scripts/check_boot_jars/check_boot_jars.py
+++ b/scripts/check_boot_jars/check_boot_jars.py
@@ -1,101 +1,102 @@
#!/usr/bin/env python
+"""Check boot jars.
+Usage: check_boot_jars.py <dexdump_path> <package_allow_list_file> <jar1> \
+<jar2> ...
"""
-Check boot jars.
-
-Usage: check_boot_jars.py <dexdump_path> <package_allow_list_file> <jar1> <jar2> ...
-"""
+from __future__ import print_function
import logging
-import os.path
import re
import subprocess
import sys
import xml.etree.ElementTree
-
# The compiled allow list RE.
allow_list_re = None
def LoadAllowList(filename):
- """ Load and compile allow list regular expressions from filename.
- """
- lines = []
- with open(filename, 'r') as f:
- for line in f:
- line = line.strip()
- if not line or line.startswith('#'):
- continue
- lines.append(line)
- combined_re = r'^(%s)$' % '|'.join(lines)
- global allow_list_re
- try:
- allow_list_re = re.compile(combined_re)
- except re.error:
- logging.exception(
- 'Cannot compile package allow list regular expression: %r',
- combined_re)
- allow_list_re = None
- return False
- return True
+ """ Load and compile allow list regular expressions from filename."""
+ lines = []
+ with open(filename, 'r') as f:
+ for line in f:
+ line = line.strip()
+ if not line or line.startswith('#'):
+ continue
+ lines.append(line)
+ combined_re = r'^(%s)$' % '|'.join(lines)
+ global allow_list_re #pylint: disable=global-statement
+ try:
+ allow_list_re = re.compile(combined_re)
+ except re.error:
+ logging.exception(
+ 'Cannot compile package allow list regular expression: %r',
+ combined_re)
+ allow_list_re = None
+ return False
+ return True
def CheckDexJar(dexdump_path, allow_list_path, jar):
- """Check a dex jar file.
- """
- # Use dexdump to generate the XML representation of the dex jar file.
- p = subprocess.Popen(args='%s -l xml %s' % (dexdump_path, jar),
- stdout=subprocess.PIPE, shell=True)
- stdout, _ = p.communicate()
- if p.returncode != 0:
- return False
+ """Check a dex jar file."""
+ # Use dexdump to generate the XML representation of the dex jar file.
+ p = subprocess.Popen(
+ args='%s -l xml %s' % (dexdump_path, jar),
+ stdout=subprocess.PIPE,
+ shell=True)
+ stdout, _ = p.communicate()
+ if p.returncode != 0:
+ return False
- packages = 0
- try:
- # TODO(b/172063475) - improve performance
- root = xml.etree.ElementTree.fromstring(stdout)
- except xml.etree.ElementTree.ParseError as e:
- print >> sys.stderr, 'Error processing jar %s - %s' % (jar, e)
- print >> sys.stderr, stdout
- return False
- for package_elt in root.iterfind('package'):
- packages += 1
- package_name = package_elt.get('name')
- if not package_name or not allow_list_re.match(package_name):
- # Report the name of a class in the package as it is easier to navigate to
- # the source of a concrete class than to a package which is often required
- # to investigate this failure.
- class_name = package_elt[0].get('name')
- if package_name != "":
- class_name = package_name + "." + class_name
- print >> sys.stderr, ('Error: %s contains class file %s, whose package name "%s" is empty or'
- ' not in the allow list %s of packages allowed on the bootclasspath.'
- % (jar, class_name, package_name, allow_list_path))
- return False
- if packages == 0:
- print >> sys.stderr, ('Error: %s does not contain any packages.' % jar)
- return False
- return True
-
+ packages = 0
+ try:
+ # TODO(b/172063475) - improve performance
+ root = xml.etree.ElementTree.fromstring(stdout)
+ except xml.etree.ElementTree.ParseError as e:
+ print('Error processing jar %s - %s' % (jar, e), file=sys.stderr)
+ print(stdout, file=sys.stderr)
+ return False
+ for package_elt in root.iterfind('package'):
+ packages += 1
+ package_name = package_elt.get('name')
+ if not package_name or not allow_list_re.match(package_name):
+ # Report the name of a class in the package as it is easier to
+ # navigate to the source of a concrete class than to a package
+ # which is often required to investigate this failure.
+ class_name = package_elt[0].get('name')
+ if package_name:
+ class_name = package_name + '.' + class_name
+ print((
+ 'Error: %s contains class file %s, whose package name "%s" is '
+ 'empty or not in the allow list %s of packages allowed on the '
+ 'bootclasspath.'
+ % (jar, class_name, package_name, allow_list_path)),
+ file=sys.stderr)
+ return False
+ if packages == 0:
+ print(('Error: %s does not contain any packages.' % jar),
+ file=sys.stderr)
+ return False
+ return True
def main(argv):
- if len(argv) < 3:
- print __doc__
- return 1
- dexdump_path = argv[0]
- allow_list_path = argv[1]
+ if len(argv) < 3:
+ print(__doc__)
+ return 1
+ dexdump_path = argv[0]
+ allow_list_path = argv[1]
- if not LoadAllowList(allow_list_path):
- return 1
+ if not LoadAllowList(allow_list_path):
+ return 1
- passed = True
- for jar in argv[2:]:
- if not CheckDexJar(dexdump_path, allow_list_path, jar):
- passed = False
- if not passed:
- return 1
+ passed = True
+ for jar in argv[2:]:
+ if not CheckDexJar(dexdump_path, allow_list_path, jar):
+ passed = False
+ if not passed:
+ return 1
- return 0
+ return 0
if __name__ == '__main__':
- sys.exit(main(sys.argv[1:]))
+ sys.exit(main(sys.argv[1:]))
diff --git a/scripts/check_boot_jars/package_allowed_list.txt b/scripts/check_boot_jars/package_allowed_list.txt
index 18ab427..942f26a 100644
--- a/scripts/check_boot_jars/package_allowed_list.txt
+++ b/scripts/check_boot_jars/package_allowed_list.txt
@@ -69,6 +69,7 @@
javax\.xml\.transform\.stream
javax\.xml\.validation
javax\.xml\.xpath
+jdk\.internal\.math
jdk\.internal\.util
jdk\.internal\.vm\.annotation
jdk\.net
diff --git a/scripts/manifest_check.py b/scripts/manifest_check.py
index 4ef4399..71fe358 100755
--- a/scripts/manifest_check.py
+++ b/scripts/manifest_check.py
@@ -25,7 +25,6 @@
import sys
from xml.dom import minidom
-
from manifest import android_ns
from manifest import get_children_with_tag
from manifest import parse_manifest
@@ -33,49 +32,61 @@
class ManifestMismatchError(Exception):
- pass
+ pass
def parse_args():
- """Parse commandline arguments."""
+ """Parse commandline arguments."""
- parser = argparse.ArgumentParser()
- parser.add_argument('--uses-library', dest='uses_libraries',
- action='append',
- help='specify uses-library entries known to the build system')
- parser.add_argument('--optional-uses-library',
- dest='optional_uses_libraries',
- action='append',
- help='specify uses-library entries known to the build system with required:false')
- parser.add_argument('--enforce-uses-libraries',
- dest='enforce_uses_libraries',
- action='store_true',
- help='check the uses-library entries known to the build system against the manifest')
- parser.add_argument('--enforce-uses-libraries-relax',
- dest='enforce_uses_libraries_relax',
- action='store_true',
- help='do not fail immediately, just save the error message to file')
- parser.add_argument('--enforce-uses-libraries-status',
- dest='enforce_uses_libraries_status',
- help='output file to store check status (error message)')
- parser.add_argument('--extract-target-sdk-version',
- dest='extract_target_sdk_version',
- action='store_true',
- help='print the targetSdkVersion from the manifest')
- parser.add_argument('--dexpreopt-config',
- dest='dexpreopt_configs',
- action='append',
- help='a paths to a dexpreopt.config of some library')
- parser.add_argument('--aapt',
- dest='aapt',
- help='path to aapt executable')
- parser.add_argument('--output', '-o', dest='output', help='output AndroidManifest.xml file')
- parser.add_argument('input', help='input AndroidManifest.xml file')
- return parser.parse_args()
+ parser = argparse.ArgumentParser()
+ parser.add_argument(
+ '--uses-library',
+ dest='uses_libraries',
+ action='append',
+ help='specify uses-library entries known to the build system')
+ parser.add_argument(
+ '--optional-uses-library',
+ dest='optional_uses_libraries',
+ action='append',
+ help='specify uses-library entries known to the build system with '
+ 'required:false'
+ )
+ parser.add_argument(
+ '--enforce-uses-libraries',
+ dest='enforce_uses_libraries',
+ action='store_true',
+ help='check the uses-library entries known to the build system against '
+ 'the manifest'
+ )
+ parser.add_argument(
+ '--enforce-uses-libraries-relax',
+ dest='enforce_uses_libraries_relax',
+ action='store_true',
+ help='do not fail immediately, just save the error message to file')
+ parser.add_argument(
+ '--enforce-uses-libraries-status',
+ dest='enforce_uses_libraries_status',
+ help='output file to store check status (error message)')
+ parser.add_argument(
+ '--extract-target-sdk-version',
+ dest='extract_target_sdk_version',
+ action='store_true',
+ help='print the targetSdkVersion from the manifest')
+ parser.add_argument(
+ '--dexpreopt-config',
+ dest='dexpreopt_configs',
+ action='append',
+ help='a paths to a dexpreopt.config of some library')
+ parser.add_argument('--aapt', dest='aapt', help='path to aapt executable')
+ parser.add_argument(
+ '--output', '-o', dest='output', help='output AndroidManifest.xml file')
+ parser.add_argument('input', help='input AndroidManifest.xml file')
+ return parser.parse_args()
def enforce_uses_libraries(manifest, required, optional, relax, is_apk, path):
- """Verify that the <uses-library> tags in the manifest match those provided
+ """Verify that the <uses-library> tags in the manifest match those provided
+
by the build system.
Args:
@@ -84,274 +95,294 @@
optional: optional libs known to the build system
relax: if true, suppress error on mismatch and just write it to file
is_apk: if the manifest comes from an APK or an XML file
- """
- if is_apk:
- manifest_required, manifest_optional, tags = extract_uses_libs_apk(manifest)
- else:
- manifest_required, manifest_optional, tags = extract_uses_libs_xml(manifest)
+ """
+ if is_apk:
+ manifest_required, manifest_optional, tags = extract_uses_libs_apk(
+ manifest)
+ else:
+ manifest_required, manifest_optional, tags = extract_uses_libs_xml(
+ manifest)
- # Trim namespace component. Normally Soong does that automatically when it
- # handles module names specified in Android.bp properties. However not all
- # <uses-library> entries in the manifest correspond to real modules: some of
- # the optional libraries may be missing at build time. Therefor this script
- # accepts raw module names as spelled in Android.bp/Amdroid.mk and trims the
- # optional namespace part manually.
- required = trim_namespace_parts(required)
- optional = trim_namespace_parts(optional)
+ # Trim namespace component. Normally Soong does that automatically when it
+ # handles module names specified in Android.bp properties. However not all
+ # <uses-library> entries in the manifest correspond to real modules: some of
+ # the optional libraries may be missing at build time. Therefor this script
+ # accepts raw module names as spelled in Android.bp/Amdroid.mk and trims the
+ # optional namespace part manually.
+ required = trim_namespace_parts(required)
+ optional = trim_namespace_parts(optional)
- if manifest_required == required and manifest_optional == optional:
- return None
+ if manifest_required == required and manifest_optional == optional:
+ return None
- errmsg = ''.join([
- 'mismatch in the <uses-library> tags between the build system and the '
- 'manifest:\n',
- '\t- required libraries in build system: [%s]\n' % ', '.join(required),
- '\t vs. in the manifest: [%s]\n' % ', '.join(manifest_required),
- '\t- optional libraries in build system: [%s]\n' % ', '.join(optional),
- '\t vs. in the manifest: [%s]\n' % ', '.join(manifest_optional),
- '\t- tags in the manifest (%s):\n' % path,
- '\t\t%s\n' % '\t\t'.join(tags),
- 'note: the following options are available:\n',
- '\t- to temporarily disable the check on command line, rebuild with ',
- 'RELAX_USES_LIBRARY_CHECK=true (this will set compiler filter "verify" ',
- 'and disable AOT-compilation in dexpreopt)\n',
- '\t- to temporarily disable the check for the whole product, set ',
- 'PRODUCT_BROKEN_VERIFY_USES_LIBRARIES := true in the product makefiles\n',
- '\t- to fix the check, make build system properties coherent with the '
- 'manifest\n',
- '\t- see build/make/Changes.md for details\n'])
+ #pylint: disable=line-too-long
+ errmsg = ''.join([
+ 'mismatch in the <uses-library> tags between the build system and the '
+ 'manifest:\n',
+ '\t- required libraries in build system: [%s]\n' % ', '.join(required),
+ '\t vs. in the manifest: [%s]\n' %
+ ', '.join(manifest_required),
+ '\t- optional libraries in build system: [%s]\n' % ', '.join(optional),
+ '\t vs. in the manifest: [%s]\n' %
+ ', '.join(manifest_optional),
+ '\t- tags in the manifest (%s):\n' % path,
+ '\t\t%s\n' % '\t\t'.join(tags),
+ 'note: the following options are available:\n',
+ '\t- to temporarily disable the check on command line, rebuild with ',
+ 'RELAX_USES_LIBRARY_CHECK=true (this will set compiler filter "verify" ',
+ 'and disable AOT-compilation in dexpreopt)\n',
+ '\t- to temporarily disable the check for the whole product, set ',
+ 'PRODUCT_BROKEN_VERIFY_USES_LIBRARIES := true in the product makefiles\n',
+ '\t- to fix the check, make build system properties coherent with the '
+ 'manifest\n', '\t- see build/make/Changes.md for details\n'
+ ])
+ #pylint: enable=line-too-long
- if not relax:
- raise ManifestMismatchError(errmsg)
+ if not relax:
+ raise ManifestMismatchError(errmsg)
- return errmsg
+ return errmsg
-MODULE_NAMESPACE = re.compile("^//[^:]+:")
+MODULE_NAMESPACE = re.compile('^//[^:]+:')
+
def trim_namespace_parts(modules):
- """Trim the namespace part of each module, if present. Leave only the name."""
+ """Trim the namespace part of each module, if present.
- trimmed = []
- for module in modules:
- trimmed.append(MODULE_NAMESPACE.sub('', module))
- return trimmed
+ Leave only the name.
+ """
+
+ trimmed = []
+ for module in modules:
+ trimmed.append(MODULE_NAMESPACE.sub('', module))
+ return trimmed
def extract_uses_libs_apk(badging):
- """Extract <uses-library> tags from the manifest of an APK."""
+ """Extract <uses-library> tags from the manifest of an APK."""
- pattern = re.compile("^uses-library(-not-required)?:'(.*)'$", re.MULTILINE)
+ pattern = re.compile("^uses-library(-not-required)?:'(.*)'$", re.MULTILINE)
- required = []
- optional = []
- lines = []
- for match in re.finditer(pattern, badging):
- lines.append(match.group(0))
- libname = match.group(2)
- if match.group(1) == None:
- required.append(libname)
- else:
- optional.append(libname)
+ required = []
+ optional = []
+ lines = []
+ for match in re.finditer(pattern, badging):
+ lines.append(match.group(0))
+ libname = match.group(2)
+ if match.group(1) is None:
+ required.append(libname)
+ else:
+ optional.append(libname)
- required = first_unique_elements(required)
- optional = first_unique_elements(optional)
- tags = first_unique_elements(lines)
- return required, optional, tags
+ required = first_unique_elements(required)
+ optional = first_unique_elements(optional)
+ tags = first_unique_elements(lines)
+ return required, optional, tags
-def extract_uses_libs_xml(xml):
- """Extract <uses-library> tags from the manifest."""
+def extract_uses_libs_xml(xml): #pylint: disable=inconsistent-return-statements
+ """Extract <uses-library> tags from the manifest."""
- manifest = parse_manifest(xml)
- elems = get_children_with_tag(manifest, 'application')
- application = elems[0] if len(elems) == 1 else None
- if len(elems) > 1:
- raise RuntimeError('found multiple <application> tags')
- elif not elems:
- if uses_libraries or optional_uses_libraries:
- raise ManifestMismatchError('no <application> tag found')
- return
+ manifest = parse_manifest(xml)
+ elems = get_children_with_tag(manifest, 'application')
+ application = elems[0] if len(elems) == 1 else None
+ if len(elems) > 1: #pylint: disable=no-else-raise
+ raise RuntimeError('found multiple <application> tags')
+ elif not elems:
+ if uses_libraries or optional_uses_libraries: #pylint: disable=undefined-variable
+ raise ManifestMismatchError('no <application> tag found')
+ return
- libs = get_children_with_tag(application, 'uses-library')
+ libs = get_children_with_tag(application, 'uses-library')
- required = [uses_library_name(x) for x in libs if uses_library_required(x)]
- optional = [uses_library_name(x) for x in libs if not uses_library_required(x)]
+ required = [uses_library_name(x) for x in libs if uses_library_required(x)]
+ optional = [
+ uses_library_name(x) for x in libs if not uses_library_required(x)
+ ]
- # render <uses-library> tags as XML for a pretty error message
- tags = []
- for lib in libs:
- tags.append(lib.toprettyxml())
+ # render <uses-library> tags as XML for a pretty error message
+ tags = []
+ for lib in libs:
+ tags.append(lib.toprettyxml())
- required = first_unique_elements(required)
- optional = first_unique_elements(optional)
- tags = first_unique_elements(tags)
- return required, optional, tags
+ required = first_unique_elements(required)
+ optional = first_unique_elements(optional)
+ tags = first_unique_elements(tags)
+ return required, optional, tags
def first_unique_elements(l):
- result = []
- [result.append(x) for x in l if x not in result]
- return result
+ result = []
+ for x in l:
+ if x not in result:
+ result.append(x)
+ return result
def uses_library_name(lib):
- """Extract the name attribute of a uses-library tag.
+ """Extract the name attribute of a uses-library tag.
Args:
lib: a <uses-library> tag.
- """
- name = lib.getAttributeNodeNS(android_ns, 'name')
- return name.value if name is not None else ""
+ """
+ name = lib.getAttributeNodeNS(android_ns, 'name')
+ return name.value if name is not None else ''
def uses_library_required(lib):
- """Extract the required attribute of a uses-library tag.
+ """Extract the required attribute of a uses-library tag.
Args:
lib: a <uses-library> tag.
- """
- required = lib.getAttributeNodeNS(android_ns, 'required')
- return (required.value == 'true') if required is not None else True
+ """
+ required = lib.getAttributeNodeNS(android_ns, 'required')
+ return (required.value == 'true') if required is not None else True
-def extract_target_sdk_version(manifest, is_apk = False):
- """Returns the targetSdkVersion from the manifest.
+def extract_target_sdk_version(manifest, is_apk=False):
+ """Returns the targetSdkVersion from the manifest.
Args:
manifest: manifest (either parsed XML or aapt dump of APK)
is_apk: if the manifest comes from an APK or an XML file
- """
- if is_apk:
- return extract_target_sdk_version_apk(manifest)
- else:
- return extract_target_sdk_version_xml(manifest)
+ """
+ if is_apk: #pylint: disable=no-else-return
+ return extract_target_sdk_version_apk(manifest)
+ else:
+ return extract_target_sdk_version_xml(manifest)
def extract_target_sdk_version_apk(badging):
- """Extract targetSdkVersion tags from the manifest of an APK."""
+ """Extract targetSdkVersion tags from the manifest of an APK."""
- pattern = re.compile("^targetSdkVersion?:'(.*)'$", re.MULTILINE)
+ pattern = re.compile("^targetSdkVersion?:'(.*)'$", re.MULTILINE)
- for match in re.finditer(pattern, badging):
- return match.group(1)
+ for match in re.finditer(pattern, badging):
+ return match.group(1)
- raise RuntimeError('cannot find targetSdkVersion in the manifest')
+ raise RuntimeError('cannot find targetSdkVersion in the manifest')
def extract_target_sdk_version_xml(xml):
- """Extract targetSdkVersion tags from the manifest."""
+ """Extract targetSdkVersion tags from the manifest."""
- manifest = parse_manifest(xml)
+ manifest = parse_manifest(xml)
- # Get or insert the uses-sdk element
- uses_sdk = get_children_with_tag(manifest, 'uses-sdk')
- if len(uses_sdk) > 1:
- raise RuntimeError('found multiple uses-sdk elements')
- elif len(uses_sdk) == 0:
- raise RuntimeError('missing uses-sdk element')
+ # Get or insert the uses-sdk element
+ uses_sdk = get_children_with_tag(manifest, 'uses-sdk')
+ if len(uses_sdk) > 1: #pylint: disable=no-else-raise
+ raise RuntimeError('found multiple uses-sdk elements')
+ elif len(uses_sdk) == 0:
+ raise RuntimeError('missing uses-sdk element')
- uses_sdk = uses_sdk[0]
+ uses_sdk = uses_sdk[0]
- min_attr = uses_sdk.getAttributeNodeNS(android_ns, 'minSdkVersion')
- if min_attr is None:
- raise RuntimeError('minSdkVersion is not specified')
+ min_attr = uses_sdk.getAttributeNodeNS(android_ns, 'minSdkVersion')
+ if min_attr is None:
+ raise RuntimeError('minSdkVersion is not specified')
- target_attr = uses_sdk.getAttributeNodeNS(android_ns, 'targetSdkVersion')
- if target_attr is None:
- target_attr = min_attr
+ target_attr = uses_sdk.getAttributeNodeNS(android_ns, 'targetSdkVersion')
+ if target_attr is None:
+ target_attr = min_attr
- return target_attr.value
+ return target_attr.value
def load_dexpreopt_configs(configs):
- """Load dexpreopt.config files and map module names to library names."""
- module_to_libname = {}
+ """Load dexpreopt.config files and map module names to library names."""
+ module_to_libname = {}
- if configs is None:
- configs = []
+ if configs is None:
+ configs = []
- for config in configs:
- with open(config, 'r') as f:
- contents = json.load(f)
- module_to_libname[contents['Name']] = contents['ProvidesUsesLibrary']
+ for config in configs:
+ with open(config, 'r') as f:
+ contents = json.load(f)
+ module_to_libname[contents['Name']] = contents['ProvidesUsesLibrary']
- return module_to_libname
+ return module_to_libname
def translate_libnames(modules, module_to_libname):
- """Translate module names into library names using the mapping."""
- if modules is None:
- modules = []
+ """Translate module names into library names using the mapping."""
+ if modules is None:
+ modules = []
- libnames = []
- for name in modules:
- if name in module_to_libname:
- name = module_to_libname[name]
- libnames.append(name)
+ libnames = []
+ for name in modules:
+ if name in module_to_libname:
+ name = module_to_libname[name]
+ libnames.append(name)
- return libnames
+ return libnames
def main():
- """Program entry point."""
- try:
- args = parse_args()
+ """Program entry point."""
+ try:
+ args = parse_args()
- # The input can be either an XML manifest or an APK, they are parsed and
- # processed in different ways.
- is_apk = args.input.endswith('.apk')
- if is_apk:
- aapt = args.aapt if args.aapt != None else "aapt"
- manifest = subprocess.check_output([aapt, "dump", "badging", args.input])
- else:
- manifest = minidom.parse(args.input)
+ # The input can be either an XML manifest or an APK, they are parsed and
+ # processed in different ways.
+ is_apk = args.input.endswith('.apk')
+ if is_apk:
+ aapt = args.aapt if args.aapt is not None else 'aapt'
+ manifest = subprocess.check_output(
+ [aapt, 'dump', 'badging', args.input])
+ else:
+ manifest = minidom.parse(args.input)
- if args.enforce_uses_libraries:
- # Load dexpreopt.config files and build a mapping from module names to
- # library names. This is necessary because build system addresses
- # libraries by their module name (`uses_libs`, `optional_uses_libs`,
- # `LOCAL_USES_LIBRARIES`, `LOCAL_OPTIONAL_LIBRARY_NAMES` all contain
- # module names), while the manifest addresses libraries by their name.
- mod_to_lib = load_dexpreopt_configs(args.dexpreopt_configs)
- required = translate_libnames(args.uses_libraries, mod_to_lib)
- optional = translate_libnames(args.optional_uses_libraries, mod_to_lib)
+ if args.enforce_uses_libraries:
+ # Load dexpreopt.config files and build a mapping from module
+ # names to library names. This is necessary because build system
+ # addresses libraries by their module name (`uses_libs`,
+ # `optional_uses_libs`, `LOCAL_USES_LIBRARIES`,
+ # `LOCAL_OPTIONAL_LIBRARY_NAMES` all contain module names), while
+ # the manifest addresses libraries by their name.
+ mod_to_lib = load_dexpreopt_configs(args.dexpreopt_configs)
+ required = translate_libnames(args.uses_libraries, mod_to_lib)
+ optional = translate_libnames(args.optional_uses_libraries,
+ mod_to_lib)
- # Check if the <uses-library> lists in the build system agree with those
- # in the manifest. Raise an exception on mismatch, unless the script was
- # passed a special parameter to suppress exceptions.
- errmsg = enforce_uses_libraries(manifest, required, optional,
- args.enforce_uses_libraries_relax, is_apk, args.input)
+ # Check if the <uses-library> lists in the build system agree with
+ # those in the manifest. Raise an exception on mismatch, unless the
+ # script was passed a special parameter to suppress exceptions.
+ errmsg = enforce_uses_libraries(manifest, required, optional,
+ args.enforce_uses_libraries_relax,
+ is_apk, args.input)
- # Create a status file that is empty on success, or contains an error
- # message on failure. When exceptions are suppressed, dexpreopt command
- # command will check file size to determine if the check has failed.
- if args.enforce_uses_libraries_status:
- with open(args.enforce_uses_libraries_status, 'w') as f:
- if not errmsg == None:
- f.write("%s\n" % errmsg)
+ # Create a status file that is empty on success, or contains an
+ # error message on failure. When exceptions are suppressed,
+ # dexpreopt command command will check file size to determine if
+ # the check has failed.
+ if args.enforce_uses_libraries_status:
+ with open(args.enforce_uses_libraries_status, 'w') as f:
+ if not errmsg is not None:
+ f.write('%s\n' % errmsg)
- if args.extract_target_sdk_version:
- try:
- print(extract_target_sdk_version(manifest, is_apk))
- except:
- # Failed; don't crash, return "any" SDK version. This will result in
- # dexpreopt not adding any compatibility libraries.
- print(10000)
+ if args.extract_target_sdk_version:
+ try:
+ print(extract_target_sdk_version(manifest, is_apk))
+ except: #pylint: disable=bare-except
+ # Failed; don't crash, return "any" SDK version. This will
+ # result in dexpreopt not adding any compatibility libraries.
+ print(10000)
- if args.output:
- # XML output is supposed to be written only when this script is invoked
- # with XML input manifest, not with an APK.
- if is_apk:
- raise RuntimeError('cannot save APK manifest as XML')
+ if args.output:
+ # XML output is supposed to be written only when this script is
+ # invoked with XML input manifest, not with an APK.
+ if is_apk:
+ raise RuntimeError('cannot save APK manifest as XML')
- with open(args.output, 'wb') as f:
- write_xml(f, manifest)
+ with open(args.output, 'wb') as f:
+ write_xml(f, manifest)
- # pylint: disable=broad-except
- except Exception as err:
- print('error: ' + str(err), file=sys.stderr)
- sys.exit(-1)
+ # pylint: disable=broad-except
+ except Exception as err:
+ print('error: ' + str(err), file=sys.stderr)
+ sys.exit(-1)
+
if __name__ == '__main__':
- main()
+ main()
diff --git a/scripts/manifest_check_test.py b/scripts/manifest_check_test.py
index e3e8ac4..3be7a30 100755
--- a/scripts/manifest_check_test.py
+++ b/scripts/manifest_check_test.py
@@ -26,202 +26,235 @@
def uses_library_xml(name, attr=''):
- return '<uses-library android:name="%s"%s />' % (name, attr)
+ return '<uses-library android:name="%s"%s />' % (name, attr)
def required_xml(value):
- return ' android:required="%s"' % ('true' if value else 'false')
+ return ' android:required="%s"' % ('true' if value else 'false')
def uses_library_apk(name, sfx=''):
- return "uses-library%s:'%s'" % (sfx, name)
+ return "uses-library%s:'%s'" % (sfx, name)
def required_apk(value):
- return '' if value else '-not-required'
+ return '' if value else '-not-required'
class EnforceUsesLibrariesTest(unittest.TestCase):
- """Unit tests for add_extract_native_libs function."""
+ """Unit tests for add_extract_native_libs function."""
- def run_test(self, xml, apk, uses_libraries=[], optional_uses_libraries=[]):
- doc = minidom.parseString(xml)
- try:
- relax = False
- manifest_check.enforce_uses_libraries(doc, uses_libraries,
- optional_uses_libraries, relax, False, 'path/to/X/AndroidManifest.xml')
- manifest_check.enforce_uses_libraries(apk, uses_libraries,
- optional_uses_libraries, relax, True, 'path/to/X/X.apk')
- return True
- except manifest_check.ManifestMismatchError:
- return False
+ def run_test(self, xml, apk, uses_libraries=[], optional_uses_libraries=[]): #pylint: disable=dangerous-default-value
+ doc = minidom.parseString(xml)
+ try:
+ relax = False
+ manifest_check.enforce_uses_libraries(
+ doc, uses_libraries, optional_uses_libraries, relax, False,
+ 'path/to/X/AndroidManifest.xml')
+ manifest_check.enforce_uses_libraries(apk, uses_libraries,
+ optional_uses_libraries,
+ relax, True,
+ 'path/to/X/X.apk')
+ return True
+ except manifest_check.ManifestMismatchError:
+ return False
- xml_tmpl = (
- '<?xml version="1.0" encoding="utf-8"?>\n'
- '<manifest xmlns:android="http://schemas.android.com/apk/res/android">\n'
- ' <application>\n'
- ' %s\n'
- ' </application>\n'
- '</manifest>\n')
+ xml_tmpl = (
+ '<?xml version="1.0" encoding="utf-8"?>\n<manifest '
+ 'xmlns:android="http://schemas.android.com/apk/res/android">\n '
+ '<application>\n %s\n </application>\n</manifest>\n')
- apk_tmpl = (
- "package: name='com.google.android.something' versionCode='100'\n"
- "sdkVersion:'29'\n"
- "targetSdkVersion:'29'\n"
- "uses-permission: name='android.permission.ACCESS_NETWORK_STATE'\n"
- "%s\n"
- "densities: '160' '240' '320' '480' '640' '65534")
+ apk_tmpl = (
+ "package: name='com.google.android.something' versionCode='100'\n"
+ "sdkVersion:'29'\n"
+ "targetSdkVersion:'29'\n"
+ "uses-permission: name='android.permission.ACCESS_NETWORK_STATE'\n"
+ '%s\n'
+ "densities: '160' '240' '320' '480' '640' '65534")
- def test_uses_library(self):
- xml = self.xml_tmpl % (uses_library_xml('foo'))
- apk = self.apk_tmpl % (uses_library_apk('foo'))
- matches = self.run_test(xml, apk, uses_libraries=['foo'])
- self.assertTrue(matches)
+ def test_uses_library(self):
+ xml = self.xml_tmpl % (uses_library_xml('foo'))
+ apk = self.apk_tmpl % (uses_library_apk('foo'))
+ matches = self.run_test(xml, apk, uses_libraries=['foo'])
+ self.assertTrue(matches)
- def test_uses_library_required(self):
- xml = self.xml_tmpl % (uses_library_xml('foo', required_xml(True)))
- apk = self.apk_tmpl % (uses_library_apk('foo', required_apk(True)))
- matches = self.run_test(xml, apk, uses_libraries=['foo'])
- self.assertTrue(matches)
+ def test_uses_library_required(self):
+ xml = self.xml_tmpl % (uses_library_xml('foo', required_xml(True)))
+ apk = self.apk_tmpl % (uses_library_apk('foo', required_apk(True)))
+ matches = self.run_test(xml, apk, uses_libraries=['foo'])
+ self.assertTrue(matches)
- def test_optional_uses_library(self):
- xml = self.xml_tmpl % (uses_library_xml('foo', required_xml(False)))
- apk = self.apk_tmpl % (uses_library_apk('foo', required_apk(False)))
- matches = self.run_test(xml, apk, optional_uses_libraries=['foo'])
- self.assertTrue(matches)
+ def test_optional_uses_library(self):
+ xml = self.xml_tmpl % (uses_library_xml('foo', required_xml(False)))
+ apk = self.apk_tmpl % (uses_library_apk('foo', required_apk(False)))
+ matches = self.run_test(xml, apk, optional_uses_libraries=['foo'])
+ self.assertTrue(matches)
- def test_expected_uses_library(self):
- xml = self.xml_tmpl % (uses_library_xml('foo', required_xml(False)))
- apk = self.apk_tmpl % (uses_library_apk('foo', required_apk(False)))
- matches = self.run_test(xml, apk, uses_libraries=['foo'])
- self.assertFalse(matches)
+ def test_expected_uses_library(self):
+ xml = self.xml_tmpl % (uses_library_xml('foo', required_xml(False)))
+ apk = self.apk_tmpl % (uses_library_apk('foo', required_apk(False)))
+ matches = self.run_test(xml, apk, uses_libraries=['foo'])
+ self.assertFalse(matches)
- def test_expected_optional_uses_library(self):
- xml = self.xml_tmpl % (uses_library_xml('foo'))
- apk = self.apk_tmpl % (uses_library_apk('foo'))
- matches = self.run_test(xml, apk, optional_uses_libraries=['foo'])
- self.assertFalse(matches)
+ def test_expected_optional_uses_library(self):
+ xml = self.xml_tmpl % (uses_library_xml('foo'))
+ apk = self.apk_tmpl % (uses_library_apk('foo'))
+ matches = self.run_test(xml, apk, optional_uses_libraries=['foo'])
+ self.assertFalse(matches)
- def test_missing_uses_library(self):
- xml = self.xml_tmpl % ('')
- apk = self.apk_tmpl % ('')
- matches = self.run_test(xml, apk, uses_libraries=['foo'])
- self.assertFalse(matches)
+ def test_missing_uses_library(self):
+ xml = self.xml_tmpl % ('')
+ apk = self.apk_tmpl % ('')
+ matches = self.run_test(xml, apk, uses_libraries=['foo'])
+ self.assertFalse(matches)
- def test_missing_optional_uses_library(self):
- xml = self.xml_tmpl % ('')
- apk = self.apk_tmpl % ('')
- matches = self.run_test(xml, apk, optional_uses_libraries=['foo'])
- self.assertFalse(matches)
+ def test_missing_optional_uses_library(self):
+ xml = self.xml_tmpl % ('')
+ apk = self.apk_tmpl % ('')
+ matches = self.run_test(xml, apk, optional_uses_libraries=['foo'])
+ self.assertFalse(matches)
- def test_extra_uses_library(self):
- xml = self.xml_tmpl % (uses_library_xml('foo'))
- apk = self.apk_tmpl % (uses_library_xml('foo'))
- matches = self.run_test(xml, apk)
- self.assertFalse(matches)
+ def test_extra_uses_library(self):
+ xml = self.xml_tmpl % (uses_library_xml('foo'))
+ apk = self.apk_tmpl % (uses_library_xml('foo'))
+ matches = self.run_test(xml, apk)
+ self.assertFalse(matches)
- def test_extra_optional_uses_library(self):
- xml = self.xml_tmpl % (uses_library_xml('foo', required_xml(False)))
- apk = self.apk_tmpl % (uses_library_apk('foo', required_apk(False)))
- matches = self.run_test(xml, apk)
- self.assertFalse(matches)
+ def test_extra_optional_uses_library(self):
+ xml = self.xml_tmpl % (uses_library_xml('foo', required_xml(False)))
+ apk = self.apk_tmpl % (uses_library_apk('foo', required_apk(False)))
+ matches = self.run_test(xml, apk)
+ self.assertFalse(matches)
- def test_multiple_uses_library(self):
- xml = self.xml_tmpl % ('\n'.join([uses_library_xml('foo'),
- uses_library_xml('bar')]))
- apk = self.apk_tmpl % ('\n'.join([uses_library_apk('foo'),
- uses_library_apk('bar')]))
- matches = self.run_test(xml, apk, uses_libraries=['foo', 'bar'])
- self.assertTrue(matches)
+ def test_multiple_uses_library(self):
+ xml = self.xml_tmpl % ('\n'.join(
+ [uses_library_xml('foo'),
+ uses_library_xml('bar')]))
+ apk = self.apk_tmpl % ('\n'.join(
+ [uses_library_apk('foo'),
+ uses_library_apk('bar')]))
+ matches = self.run_test(xml, apk, uses_libraries=['foo', 'bar'])
+ self.assertTrue(matches)
- def test_multiple_optional_uses_library(self):
- xml = self.xml_tmpl % ('\n'.join([uses_library_xml('foo', required_xml(False)),
- uses_library_xml('bar', required_xml(False))]))
- apk = self.apk_tmpl % ('\n'.join([uses_library_apk('foo', required_apk(False)),
- uses_library_apk('bar', required_apk(False))]))
- matches = self.run_test(xml, apk, optional_uses_libraries=['foo', 'bar'])
- self.assertTrue(matches)
+ def test_multiple_optional_uses_library(self):
+ xml = self.xml_tmpl % ('\n'.join([
+ uses_library_xml('foo', required_xml(False)),
+ uses_library_xml('bar', required_xml(False))
+ ]))
+ apk = self.apk_tmpl % ('\n'.join([
+ uses_library_apk('foo', required_apk(False)),
+ uses_library_apk('bar', required_apk(False))
+ ]))
+ matches = self.run_test(
+ xml, apk, optional_uses_libraries=['foo', 'bar'])
+ self.assertTrue(matches)
- def test_order_uses_library(self):
- xml = self.xml_tmpl % ('\n'.join([uses_library_xml('foo'),
- uses_library_xml('bar')]))
- apk = self.apk_tmpl % ('\n'.join([uses_library_apk('foo'),
- uses_library_apk('bar')]))
- matches = self.run_test(xml, apk, uses_libraries=['bar', 'foo'])
- self.assertFalse(matches)
+ def test_order_uses_library(self):
+ xml = self.xml_tmpl % ('\n'.join(
+ [uses_library_xml('foo'),
+ uses_library_xml('bar')]))
+ apk = self.apk_tmpl % ('\n'.join(
+ [uses_library_apk('foo'),
+ uses_library_apk('bar')]))
+ matches = self.run_test(xml, apk, uses_libraries=['bar', 'foo'])
+ self.assertFalse(matches)
- def test_order_optional_uses_library(self):
- xml = self.xml_tmpl % ('\n'.join([uses_library_xml('foo', required_xml(False)),
- uses_library_xml('bar', required_xml(False))]))
- apk = self.apk_tmpl % ('\n'.join([uses_library_apk('foo', required_apk(False)),
- uses_library_apk('bar', required_apk(False))]))
- matches = self.run_test(xml, apk, optional_uses_libraries=['bar', 'foo'])
- self.assertFalse(matches)
+ def test_order_optional_uses_library(self):
+ xml = self.xml_tmpl % ('\n'.join([
+ uses_library_xml('foo', required_xml(False)),
+ uses_library_xml('bar', required_xml(False))
+ ]))
+ apk = self.apk_tmpl % ('\n'.join([
+ uses_library_apk('foo', required_apk(False)),
+ uses_library_apk('bar', required_apk(False))
+ ]))
+ matches = self.run_test(
+ xml, apk, optional_uses_libraries=['bar', 'foo'])
+ self.assertFalse(matches)
- def test_duplicate_uses_library(self):
- xml = self.xml_tmpl % ('\n'.join([uses_library_xml('foo'),
- uses_library_xml('foo')]))
- apk = self.apk_tmpl % ('\n'.join([uses_library_apk('foo'),
- uses_library_apk('foo')]))
- matches = self.run_test(xml, apk, uses_libraries=['foo'])
- self.assertTrue(matches)
+ def test_duplicate_uses_library(self):
+ xml = self.xml_tmpl % ('\n'.join(
+ [uses_library_xml('foo'),
+ uses_library_xml('foo')]))
+ apk = self.apk_tmpl % ('\n'.join(
+ [uses_library_apk('foo'),
+ uses_library_apk('foo')]))
+ matches = self.run_test(xml, apk, uses_libraries=['foo'])
+ self.assertTrue(matches)
- def test_duplicate_optional_uses_library(self):
- xml = self.xml_tmpl % ('\n'.join([uses_library_xml('foo', required_xml(False)),
- uses_library_xml('foo', required_xml(False))]))
- apk = self.apk_tmpl % ('\n'.join([uses_library_apk('foo', required_apk(False)),
- uses_library_apk('foo', required_apk(False))]))
- matches = self.run_test(xml, apk, optional_uses_libraries=['foo'])
- self.assertTrue(matches)
+ def test_duplicate_optional_uses_library(self):
+ xml = self.xml_tmpl % ('\n'.join([
+ uses_library_xml('foo', required_xml(False)),
+ uses_library_xml('foo', required_xml(False))
+ ]))
+ apk = self.apk_tmpl % ('\n'.join([
+ uses_library_apk('foo', required_apk(False)),
+ uses_library_apk('foo', required_apk(False))
+ ]))
+ matches = self.run_test(xml, apk, optional_uses_libraries=['foo'])
+ self.assertTrue(matches)
- def test_mixed(self):
- xml = self.xml_tmpl % ('\n'.join([uses_library_xml('foo'),
- uses_library_xml('bar', required_xml(False))]))
- apk = self.apk_tmpl % ('\n'.join([uses_library_apk('foo'),
- uses_library_apk('bar', required_apk(False))]))
- matches = self.run_test(xml, apk, uses_libraries=['foo'],
- optional_uses_libraries=['bar'])
- self.assertTrue(matches)
+ def test_mixed(self):
+ xml = self.xml_tmpl % ('\n'.join([
+ uses_library_xml('foo'),
+ uses_library_xml('bar', required_xml(False))
+ ]))
+ apk = self.apk_tmpl % ('\n'.join([
+ uses_library_apk('foo'),
+ uses_library_apk('bar', required_apk(False))
+ ]))
+ matches = self.run_test(
+ xml, apk, uses_libraries=['foo'], optional_uses_libraries=['bar'])
+ self.assertTrue(matches)
- def test_mixed_with_namespace(self):
- xml = self.xml_tmpl % ('\n'.join([uses_library_xml('foo'),
- uses_library_xml('bar', required_xml(False))]))
- apk = self.apk_tmpl % ('\n'.join([uses_library_apk('foo'),
- uses_library_apk('bar', required_apk(False))]))
- matches = self.run_test(xml, apk, uses_libraries=['//x/y/z:foo'],
- optional_uses_libraries=['//x/y/z:bar'])
- self.assertTrue(matches)
+ def test_mixed_with_namespace(self):
+ xml = self.xml_tmpl % ('\n'.join([
+ uses_library_xml('foo'),
+ uses_library_xml('bar', required_xml(False))
+ ]))
+ apk = self.apk_tmpl % ('\n'.join([
+ uses_library_apk('foo'),
+ uses_library_apk('bar', required_apk(False))
+ ]))
+ matches = self.run_test(
+ xml,
+ apk,
+ uses_libraries=['//x/y/z:foo'],
+ optional_uses_libraries=['//x/y/z:bar'])
+ self.assertTrue(matches)
class ExtractTargetSdkVersionTest(unittest.TestCase):
- def run_test(self, xml, apk, version):
- doc = minidom.parseString(xml)
- v = manifest_check.extract_target_sdk_version(doc, is_apk=False)
- self.assertEqual(v, version)
- v = manifest_check.extract_target_sdk_version(apk, is_apk=True)
- self.assertEqual(v, version)
- xml_tmpl = (
- '<?xml version="1.0" encoding="utf-8"?>\n'
- '<manifest xmlns:android="http://schemas.android.com/apk/res/android">\n'
- ' <uses-sdk android:minSdkVersion="28" android:targetSdkVersion="%s" />\n'
- '</manifest>\n')
+ def run_test(self, xml, apk, version):
+ doc = minidom.parseString(xml)
+ v = manifest_check.extract_target_sdk_version(doc, is_apk=False)
+ self.assertEqual(v, version)
+ v = manifest_check.extract_target_sdk_version(apk, is_apk=True)
+ self.assertEqual(v, version)
- apk_tmpl = (
- "package: name='com.google.android.something' versionCode='100'\n"
- "sdkVersion:'28'\n"
- "targetSdkVersion:'%s'\n"
- "uses-permission: name='android.permission.ACCESS_NETWORK_STATE'\n")
+ xml_tmpl = (
+ '<?xml version="1.0" encoding="utf-8"?>\n<manifest '
+ 'xmlns:android="http://schemas.android.com/apk/res/android">\n '
+ '<uses-sdk android:minSdkVersion="28" android:targetSdkVersion="%s" '
+ '/>\n</manifest>\n')
- def test_targert_sdk_version_28(self):
- xml = self.xml_tmpl % "28"
- apk = self.apk_tmpl % "28"
- self.run_test(xml, apk, "28")
+ apk_tmpl = (
+ "package: name='com.google.android.something' versionCode='100'\n"
+ "sdkVersion:'28'\n"
+ "targetSdkVersion:'%s'\n"
+ "uses-permission: name='android.permission.ACCESS_NETWORK_STATE'\n")
- def test_targert_sdk_version_29(self):
- xml = self.xml_tmpl % "29"
- apk = self.apk_tmpl % "29"
- self.run_test(xml, apk, "29")
+ def test_targert_sdk_version_28(self):
+ xml = self.xml_tmpl % '28'
+ apk = self.apk_tmpl % '28'
+ self.run_test(xml, apk, '28')
+
+ def test_targert_sdk_version_29(self):
+ xml = self.xml_tmpl % '29'
+ apk = self.apk_tmpl % '29'
+ self.run_test(xml, apk, '29')
+
if __name__ == '__main__':
- unittest.main(verbosity=2)
+ unittest.main(verbosity=2)
diff --git a/tests/bootstrap_test.sh b/tests/bootstrap_test.sh
index b37a7f8..a22adc5 100755
--- a/tests/bootstrap_test.sh
+++ b/tests/bootstrap_test.sh
@@ -472,17 +472,35 @@
fi
}
-function test_null_build_after_docs {
+function test_soong_docs_smoke() {
setup
- run_soong
- local mtime1=$(stat -c "%y" out/soong/build.ninja)
- prebuilts/build-tools/linux-x86/bin/ninja -f out/combined.ninja soong_docs
+ run_soong soong_docs
+
+ [[ -e "out/soong/docs/soong_build.html" ]] || fail "Documentation for main page not created"
+ [[ -e "out/soong/docs/cc.html" ]] || fail "Documentation for C++ modules not created"
+}
+
+function test_null_build_after_soong_docs() {
+ setup
run_soong
- local mtime2=$(stat -c "%y" out/soong/build.ninja)
+ local ninja_mtime1=$(stat -c "%y" out/soong/build.ninja)
- if [[ "$mtime1" != "$mtime2" ]]; then
+ run_soong soong_docs
+ local docs_mtime1=$(stat -c "%y" out/soong/docs/soong_build.html)
+
+ run_soong soong_docs
+ local docs_mtime2=$(stat -c "%y" out/soong/docs/soong_build.html)
+
+ if [[ "$docs_mtime1" != "$docs_mtime2" ]]; then
+ fail "Output Ninja file changed on null build"
+ fi
+
+ run_soong
+ local ninja_mtime2=$(stat -c "%y" out/soong/build.ninja)
+
+ if [[ "$ninja_mtime1" != "$ninja_mtime2" ]]; then
fail "Output Ninja file changed on null build"
fi
}
@@ -522,7 +540,7 @@
function test_bp2build_smoke {
setup
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
[[ -e out/soong/.bootstrap/bp2build_workspace_marker ]] || fail "bp2build marker file not created"
[[ -e out/soong/workspace ]] || fail "Bazel workspace not created"
}
@@ -531,7 +549,7 @@
setup
create_mock_bazel
- run_bp2build
+ run_soong bp2build
if [[ ! -f "./out/soong/.bootstrap/bp2build_workspace_marker" ]]; then
fail "Marker file was not generated"
@@ -551,7 +569,7 @@
}
EOF
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
[[ -e out/soong/bp2build/a/${GENERATED_BUILD_FILE_NAME} ]] || fail "a/${GENERATED_BUILD_FILE_NAME} not created"
[[ -L out/soong/workspace/a/${GENERATED_BUILD_FILE_NAME} ]] || fail "a/${GENERATED_BUILD_FILE_NAME} not symlinked"
@@ -565,7 +583,7 @@
}
EOF
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
[[ -e out/soong/bp2build/b/${GENERATED_BUILD_FILE_NAME} ]] || fail "a/${GENERATED_BUILD_FILE_NAME} not created"
[[ -L out/soong/workspace/b/${GENERATED_BUILD_FILE_NAME} ]] || fail "a/${GENERATED_BUILD_FILE_NAME} not symlinked"
}
@@ -573,10 +591,10 @@
function test_bp2build_null_build {
setup
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
local mtime1=$(stat -c "%y" out/soong/.bootstrap/bp2build_workspace_marker)
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
local mtime2=$(stat -c "%y" out/soong/.bootstrap/bp2build_workspace_marker)
if [[ "$mtime1" != "$mtime2" ]]; then
@@ -597,18 +615,35 @@
}
EOF
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
grep -q a1.txt "out/soong/bp2build/a/${GENERATED_BUILD_FILE_NAME}" || fail "a1.txt not in ${GENERATED_BUILD_FILE_NAME} file"
touch a/a2.txt
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
grep -q a2.txt "out/soong/bp2build/a/${GENERATED_BUILD_FILE_NAME}" || fail "a2.txt not in ${GENERATED_BUILD_FILE_NAME} file"
}
+function test_multiple_soong_build_modes() {
+ setup
+ run_soong json-module-graph bp2build nothing
+ if [[ ! -f "out/soong/.bootstrap/bp2build_workspace_marker" ]]; then
+ fail "bp2build marker file was not generated"
+ fi
+
+
+ if [[ ! -f "out/soong/module-graph.json" ]]; then
+ fail "JSON file was not created"
+ fi
+
+ if [[ ! -f "out/soong/build.ninja" ]]; then
+ fail "Main build.ninja file was not created"
+ fi
+}
+
function test_dump_json_module_graph() {
setup
- GENERATE_JSON_MODULE_GRAPH=1 run_soong
- if [[ ! -r "out/soong//module-graph.json" ]]; then
+ run_soong json-module-graph
+ if [[ ! -r "out/soong/module-graph.json" ]]; then
fail "JSON file was not created"
fi
}
@@ -619,7 +654,7 @@
run_soong
local ninja_mtime1=$(stat -c "%y" out/soong/build.ninja)
- GENERATE_JSON_MODULE_GRAPH=1 run_soong
+ run_soong json-module-graph
local json_mtime1=$(stat -c "%y" out/soong/module-graph.json)
run_soong
@@ -628,7 +663,7 @@
fail "Output Ninja file changed after writing JSON module graph"
fi
- GENERATE_JSON_MODULE_GRAPH=1 run_soong
+ run_soong json-module-graph
local json_mtime2=$(stat -c "%y" out/soong/module-graph.json)
if [[ "$json_mtime1" != "$json_mtime2" ]]; then
fail "JSON module graph file changed after writing Ninja file"
@@ -651,7 +686,7 @@
}
EOF
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
[[ -e out/soong/workspace ]] || fail "Bazel workspace not created"
[[ -d out/soong/workspace/a/b ]] || fail "module directory not a directory"
[[ -L "out/soong/workspace/a/b/${GENERATED_BUILD_FILE_NAME}" ]] || fail "${GENERATED_BUILD_FILE_NAME} file not symlinked"
@@ -675,10 +710,10 @@
}
EOF
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
touch a/a2.txt # No reference in the .bp file needed
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
[[ -L out/soong/workspace/a/a2.txt ]] || fail "a/a2.txt not symlinked"
}
@@ -696,7 +731,7 @@
}
EOF
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
[[ -L "out/soong/workspace/a/${GENERATED_BUILD_FILE_NAME}" ]] || fail "${GENERATED_BUILD_FILE_NAME} file not symlinked"
[[ "$(readlink -f out/soong/workspace/a/${GENERATED_BUILD_FILE_NAME})" =~ "bp2build/a/${GENERATED_BUILD_FILE_NAME}"$ ]] \
|| fail "${GENERATED_BUILD_FILE_NAME} files symlinked to the wrong place"
@@ -725,7 +760,7 @@
}
EOF
- if GENERATE_BAZEL_FILES=1 run_soong >& "$MOCK_TOP/errors"; then
+ if run_soong bp2build >& "$MOCK_TOP/errors"; then
fail "Build should have failed"
fi
@@ -739,7 +774,7 @@
run_soong
local output_mtime1=$(stat -c "%y" out/soong/build.ninja)
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
local output_mtime2=$(stat -c "%y" out/soong/build.ninja)
if [[ "$output_mtime1" != "$output_mtime2" ]]; then
fail "Output Ninja file changed when switching to bp2build"
@@ -757,7 +792,7 @@
fail "bp2build marker file changed when switching to regular build from bp2build"
fi
- GENERATE_BAZEL_FILES=1 run_soong
+ run_soong bp2build
local output_mtime4=$(stat -c "%y" out/soong/build.ninja)
local marker_mtime3=$(stat -c "%y" out/soong/.bootstrap/bp2build_workspace_marker)
if [[ "$output_mtime1" != "$output_mtime4" ]]; then
@@ -768,9 +803,32 @@
fi
}
+function test_queryview_smoke() {
+ setup
+
+ run_soong queryview
+ [[ -e out/soong/queryview/WORKSPACE ]] || fail "queryview WORKSPACE file not created"
+
+}
+
+function test_queryview_null_build() {
+ setup
+
+ run_soong queryview
+ local output_mtime1=$(stat -c "%y" out/soong/queryview.marker)
+
+ run_soong queryview
+ local output_mtime2=$(stat -c "%y" out/soong/queryview.marker)
+
+ if [[ "$output_mtime1" != "$output_mtime2" ]]; then
+ fail "Queryview marker file changed on null build"
+ fi
+}
+
test_smoke
test_null_build
-test_null_build_after_docs
+test_soong_docs_smoke
+test_null_build_after_soong_docs
test_soong_build_rebuilt_if_blueprint_changes
test_glob_noop_incremental
test_add_file_to_glob
@@ -780,9 +838,12 @@
test_add_file_to_soong_build
test_glob_during_bootstrapping
test_soong_build_rerun_iff_environment_changes
+test_multiple_soong_build_modes
test_dump_json_module_graph
test_json_module_graph_back_and_forth_null_build
test_write_to_source_tree
+test_queryview_smoke
+test_queryview_null_build
test_bp2build_smoke
test_bp2build_generates_marker_file
test_bp2build_null_build
diff --git a/tests/bp2build_bazel_test.sh b/tests/bp2build_bazel_test.sh
index 9bd85a4..379eb65 100755
--- a/tests/bp2build_bazel_test.sh
+++ b/tests/bp2build_bazel_test.sh
@@ -10,10 +10,10 @@
function test_bp2build_null_build() {
setup
- run_bp2build
+ run_soong bp2build
local output_mtime1=$(stat -c "%y" out/soong/.bootstrap/bp2build_workspace_marker)
- run_bp2build
+ run_soong bp2build
local output_mtime2=$(stat -c "%y" out/soong/.bootstrap/bp2build_workspace_marker)
if [[ "$output_mtime1" != "$output_mtime2" ]]; then
@@ -35,10 +35,10 @@
EOF
touch foo/bar/a.txt foo/bar/b.txt
- run_bp2build
+ run_soong bp2build
local output_mtime1=$(stat -c "%y" out/soong/.bootstrap/bp2build_workspace_marker)
- run_bp2build
+ run_soong bp2build
local output_mtime2=$(stat -c "%y" out/soong/.bootstrap/bp2build_workspace_marker)
if [[ "$output_mtime1" != "$output_mtime2" ]]; then
@@ -80,7 +80,7 @@
}
EOF
- run_bp2build
+ run_soong bp2build
if [[ ! -f "./out/soong/workspace/foo/convertible_soong_module/${GENERATED_BUILD_FILE_NAME}" ]]; then
fail "./out/soong/workspace/foo/convertible_soong_module/${GENERATED_BUILD_FILE_NAME} was not generated"
diff --git a/tests/lib.sh b/tests/lib.sh
index 813a9dd..e777820 100644
--- a/tests/lib.sh
+++ b/tests/lib.sh
@@ -124,10 +124,6 @@
tools/bazel "$@"
}
-run_bp2build() {
- GENERATE_BAZEL_FILES=true build/soong/soong_ui.bash --make-mode --skip-ninja --skip-make --skip-soong-tests nothing
-}
-
run_ninja() {
build/soong/soong_ui.bash --make-mode --skip-make --skip-soong-tests "$@"
}
diff --git a/ui/build/build.go b/ui/build/build.go
index d869bf0..2e44aaa 100644
--- a/ui/build/build.go
+++ b/ui/build/build.go
@@ -248,6 +248,16 @@
what = what &^ RunNinja
}
+ if !config.SoongBuildInvocationNeeded() {
+ // This means that the output of soong_build is not needed and thus it would
+ // run unnecessarily. In addition, if this code wasn't there invocations
+ // with only special-cased target names like "m bp2build" would result in
+ // passing Ninja the empty target list and it would then build the default
+ // targets which is not what the user asked for.
+ what = what &^ RunNinja
+ what = what &^ RunKati
+ }
+
if config.StartGoma() {
startGoma(ctx, config)
}
@@ -278,16 +288,6 @@
if what&RunSoong != 0 {
runSoong(ctx, config)
-
- if config.bazelBuildMode() == generateBuildFiles {
- // Return early, if we're using Soong as solely the generator of BUILD files.
- return
- }
-
- if config.bazelBuildMode() == generateJsonModuleGraph {
- // Return early, if we're using Soong as solely the generator of the JSON module graph
- return
- }
}
if what&RunKati != 0 {
diff --git a/ui/build/config.go b/ui/build/config.go
index 6de7a05..126a8d4 100644
--- a/ui/build/config.go
+++ b/ui/build/config.go
@@ -33,7 +33,8 @@
type Config struct{ *configImpl }
type configImpl struct {
- // From the environment
+ // Some targets that are implemented in soong_build
+ // (bp2build, json-module-graph) are not here and have their own bits below.
arguments []string
goma bool
environ *Environment
@@ -41,17 +42,21 @@
buildDateTime string
// From the arguments
- parallel int
- keepGoing int
- verbose bool
- checkbuild bool
- dist bool
- skipConfig bool
- skipKati bool
- skipKatiNinja bool
- skipSoong bool
- skipNinja bool
- skipSoongTests bool
+ parallel int
+ keepGoing int
+ verbose bool
+ checkbuild bool
+ dist bool
+ jsonModuleGraph bool
+ bp2build bool
+ queryview bool
+ soongDocs bool
+ skipConfig bool
+ skipKati bool
+ skipKatiNinja bool
+ skipSoong bool
+ skipNinja bool
+ skipSoongTests bool
// From the product config
katiArgs []string
@@ -106,12 +111,6 @@
// Don't use bazel at all.
noBazel bazelBuildMode = iota
- // Only generate build files (in a subdirectory of the out directory) and exit.
- generateBuildFiles
-
- // Only generate the Soong json module graph for use with jq, and exit.
- generateJsonModuleGraph
-
// Generate synthetic build files and incorporate these files into a build which
// partially uses Bazel. Build metadata may come from Android.bp or BUILD files.
mixedBuild
@@ -639,6 +638,14 @@
c.environ.Set(k, v)
} else if arg == "dist" {
c.dist = true
+ } else if arg == "json-module-graph" {
+ c.jsonModuleGraph = true
+ } else if arg == "bp2build" {
+ c.bp2build = true
+ } else if arg == "queryview" {
+ c.queryview = true
+ } else if arg == "soong_docs" {
+ c.soongDocs = true
} else {
if arg == "checkbuild" {
c.checkbuild = true
@@ -705,6 +712,26 @@
return c.arguments
}
+func (c *configImpl) SoongBuildInvocationNeeded() bool {
+ if c.Dist() {
+ return true
+ }
+
+ if len(c.Arguments()) > 0 {
+ // Explicit targets requested that are not special targets like b2pbuild
+ // or the JSON module graph
+ return true
+ }
+
+ if !c.JsonModuleGraph() && !c.Bp2Build() && !c.Queryview() && !c.SoongDocs() {
+ // Command line was empty, the default Ninja target is built
+ return true
+ }
+
+ // build.ninja doesn't need to be generated
+ return false
+}
+
func (c *configImpl) OutDir() string {
if outDir, ok := c.environ.Get("OUT_DIR"); ok {
return outDir
@@ -753,6 +780,10 @@
return filepath.Join(c.SoongOutDir(), "host", c.PrebuiltOS(), "bin")
}
+func (c *configImpl) NamedGlobFile(name string) string {
+ return shared.JoinPath(c.SoongOutDir(), ".bootstrap/build-globs."+name+".ninja")
+}
+
func (c *configImpl) MainNinjaFile() string {
return shared.JoinPath(c.SoongOutDir(), "build.ninja")
}
@@ -761,6 +792,14 @@
return shared.JoinPath(c.SoongOutDir(), ".bootstrap/bp2build_workspace_marker")
}
+func (c *configImpl) SoongDocsHtml() string {
+ return shared.JoinPath(c.SoongOutDir(), "docs/soong_build.html")
+}
+
+func (c *configImpl) QueryviewMarkerFile() string {
+ return shared.JoinPath(c.SoongOutDir(), "queryview.marker")
+}
+
func (c *configImpl) ModuleGraphFile() string {
return shared.JoinPath(c.SoongOutDir(), "module-graph.json")
}
@@ -790,6 +829,22 @@
return c.dist
}
+func (c *configImpl) JsonModuleGraph() bool {
+ return c.jsonModuleGraph
+}
+
+func (c *configImpl) Bp2Build() bool {
+ return c.bp2build
+}
+
+func (c *configImpl) Queryview() bool {
+ return c.queryview
+}
+
+func (c *configImpl) SoongDocs() bool {
+ return c.soongDocs
+}
+
func (c *configImpl) IsVerbose() bool {
return c.verbose
}
@@ -935,10 +990,6 @@
func (c *configImpl) bazelBuildMode() bazelBuildMode {
if c.Environment().IsEnvTrue("USE_BAZEL_ANALYSIS") {
return mixedBuild
- } else if c.Environment().IsEnvTrue("GENERATE_BAZEL_FILES") {
- return generateBuildFiles
- } else if c.Environment().IsEnvTrue("GENERATE_JSON_MODULE_GRAPH") {
- return generateJsonModuleGraph
} else {
return noBazel
}
diff --git a/ui/build/soong.go b/ui/build/soong.go
index d4f6f2f..9aa4810 100644
--- a/ui/build/soong.go
+++ b/ui/build/soong.go
@@ -37,6 +37,12 @@
const (
availableEnvFile = "soong.environment.available"
usedEnvFile = "soong.environment.used"
+
+ soongBuildTag = "build"
+ bp2buildTag = "bp2build"
+ jsonModuleGraphTag = "modulegraph"
+ queryviewTag = "queryview"
+ soongDocsTag = "soong_docs"
)
func writeEnvironmentFile(ctx Context, envFile string, envDeps map[string]string) error {
@@ -116,7 +122,7 @@
func environmentArgs(config Config, suffix string) []string {
return []string{
"--available_env", shared.JoinPath(config.SoongOutDir(), availableEnvFile),
- "--used_env", shared.JoinPath(config.SoongOutDir(), usedEnvFile+suffix),
+ "--used_env", shared.JoinPath(config.SoongOutDir(), usedEnvFile+"."+suffix),
}
}
@@ -134,116 +140,135 @@
}
}
+func primaryBuilderInvocation(config Config, name string, output string, specificArgs []string) bootstrap.PrimaryBuilderInvocation {
+ commonArgs := make([]string, 0, 0)
+
+ if !config.skipSoongTests {
+ commonArgs = append(commonArgs, "-t")
+ }
+
+ commonArgs = append(commonArgs, "-l", filepath.Join(config.FileListDir(), "Android.bp.list"))
+
+ if os.Getenv("SOONG_DELVE") != "" {
+ commonArgs = append(commonArgs, "--delve_listen", os.Getenv("SOONG_DELVE"))
+ commonArgs = append(commonArgs, "--delve_path", shared.ResolveDelveBinary())
+ }
+
+ allArgs := make([]string, 0, 0)
+ allArgs = append(allArgs, specificArgs...)
+ allArgs = append(allArgs,
+ "--globListDir", name,
+ "--globFile", config.NamedGlobFile(name))
+
+ allArgs = append(allArgs, commonArgs...)
+ allArgs = append(allArgs, environmentArgs(config, name)...)
+ allArgs = append(allArgs, "Android.bp")
+
+ return bootstrap.PrimaryBuilderInvocation{
+ Inputs: []string{"Android.bp"},
+ Outputs: []string{output},
+ Args: allArgs,
+ }
+}
+
func bootstrapBlueprint(ctx Context, config Config) {
ctx.BeginTrace(metrics.RunSoong, "blueprint bootstrap")
defer ctx.EndTrace()
- var args bootstrap.Args
-
- bootstrapGlobFile := shared.JoinPath(config.SoongOutDir(), ".bootstrap/build-globs.ninja")
- bp2buildGlobFile := shared.JoinPath(config.SoongOutDir(), ".bootstrap/build-globs.bp2build.ninja")
- moduleGraphGlobFile := shared.JoinPath(config.SoongOutDir(), ".bootstrap/build-globs.modulegraph.ninja")
-
- // The glob .ninja files are subninja'd. However, they are generated during
- // the build itself so we write an empty file so that the subninja doesn't
- // fail on clean builds
- writeEmptyGlobFile(ctx, bootstrapGlobFile)
- writeEmptyGlobFile(ctx, bp2buildGlobFile)
- bootstrapDepFile := shared.JoinPath(config.SoongOutDir(), ".bootstrap/build.ninja.d")
-
- args.RunGoTests = !config.skipSoongTests
- args.UseValidations = true // Use validations to depend on tests
- args.SoongOutDir = config.SoongOutDir()
- args.OutDir = config.OutDir()
- args.ModuleListFile = filepath.Join(config.FileListDir(), "Android.bp.list")
- args.OutFile = shared.JoinPath(config.SoongOutDir(), ".bootstrap/build.ninja")
- // The primary builder (aka soong_build) will use bootstrapGlobFile as the globFile to generate build.ninja(.d)
- // Building soong_build does not require a glob file
- // Using "" instead of "<soong_build_glob>.ninja" will ensure that an unused glob file is not written to out/soong/.bootstrap during StagePrimary
- args.Subninjas = []string{bootstrapGlobFile, bp2buildGlobFile}
- args.EmptyNinjaFile = config.EmptyNinjaFile()
-
- args.DelveListen = os.Getenv("SOONG_DELVE")
- if args.DelveListen != "" {
- args.DelvePath = shared.ResolveDelveBinary()
+ mainSoongBuildExtraArgs := []string{"-o", config.MainNinjaFile()}
+ if config.EmptyNinjaFile() {
+ mainSoongBuildExtraArgs = append(mainSoongBuildExtraArgs, "--empty-ninja-file")
}
- commonArgs := bootstrap.PrimaryBuilderExtraFlags(args, config.MainNinjaFile())
- mainSoongBuildInputs := []string{"Android.bp"}
+ mainSoongBuildInvocation := primaryBuilderInvocation(
+ config,
+ soongBuildTag,
+ config.MainNinjaFile(),
+ mainSoongBuildExtraArgs)
if config.bazelBuildMode() == mixedBuild {
- mainSoongBuildInputs = append(mainSoongBuildInputs, config.Bp2BuildMarkerFile())
+ // Mixed builds call Bazel from soong_build and they therefore need the
+ // Bazel workspace to be available. Make that so by adding a dependency on
+ // the bp2build marker file to the action that invokes soong_build .
+ mainSoongBuildInvocation.Inputs = append(mainSoongBuildInvocation.Inputs,
+ config.Bp2BuildMarkerFile())
}
- soongBuildArgs := []string{
- "--globListDir", "build",
- "--globFile", bootstrapGlobFile,
+ bp2buildInvocation := primaryBuilderInvocation(
+ config,
+ bp2buildTag,
+ config.Bp2BuildMarkerFile(),
+ []string{
+ "--bp2build_marker", config.Bp2BuildMarkerFile(),
+ })
+
+ jsonModuleGraphInvocation := primaryBuilderInvocation(
+ config,
+ jsonModuleGraphTag,
+ config.ModuleGraphFile(),
+ []string{
+ "--module_graph_file", config.ModuleGraphFile(),
+ })
+
+ queryviewInvocation := primaryBuilderInvocation(
+ config,
+ queryviewTag,
+ config.QueryviewMarkerFile(),
+ []string{
+ "--bazel_queryview_dir", filepath.Join(config.SoongOutDir(), "queryview"),
+ })
+
+ soongDocsInvocation := primaryBuilderInvocation(
+ config,
+ soongDocsTag,
+ config.SoongDocsHtml(),
+ []string{
+ "--soong_docs", config.SoongDocsHtml(),
+ })
+
+ globFiles := []string{
+ config.NamedGlobFile(soongBuildTag),
+ config.NamedGlobFile(bp2buildTag),
+ config.NamedGlobFile(jsonModuleGraphTag),
+ config.NamedGlobFile(queryviewTag),
+ config.NamedGlobFile(soongDocsTag),
}
- soongBuildArgs = append(soongBuildArgs, commonArgs...)
- soongBuildArgs = append(soongBuildArgs, environmentArgs(config, "")...)
- soongBuildArgs = append(soongBuildArgs, "Android.bp")
-
- mainSoongBuildInvocation := bootstrap.PrimaryBuilderInvocation{
- Inputs: mainSoongBuildInputs,
- Outputs: []string{config.MainNinjaFile()},
- Args: soongBuildArgs,
+ // The glob .ninja files are subninja'd. However, they are generated during
+ // the build itself so we write an empty file if the file does not exist yet
+ // so that the subninja doesn't fail on clean builds
+ for _, globFile := range globFiles {
+ writeEmptyGlobFile(ctx, globFile)
}
- bp2buildArgs := []string{
- "--bp2build_marker", config.Bp2BuildMarkerFile(),
- "--globListDir", "bp2build",
- "--globFile", bp2buildGlobFile,
- }
+ var blueprintArgs bootstrap.Args
- bp2buildArgs = append(bp2buildArgs, commonArgs...)
- bp2buildArgs = append(bp2buildArgs, environmentArgs(config, ".bp2build")...)
- bp2buildArgs = append(bp2buildArgs, "Android.bp")
-
- bp2buildInvocation := bootstrap.PrimaryBuilderInvocation{
- Inputs: []string{"Android.bp"},
- Outputs: []string{config.Bp2BuildMarkerFile()},
- Args: bp2buildArgs,
- }
-
- moduleGraphArgs := []string{
- "--module_graph_file", config.ModuleGraphFile(),
- "--globListDir", "modulegraph",
- "--globFile", moduleGraphGlobFile,
- }
-
- moduleGraphArgs = append(moduleGraphArgs, commonArgs...)
- moduleGraphArgs = append(moduleGraphArgs, environmentArgs(config, ".modulegraph")...)
- moduleGraphArgs = append(moduleGraphArgs, "Android.bp")
-
- moduleGraphInvocation := bootstrap.PrimaryBuilderInvocation{
- Inputs: []string{"Android.bp"},
- Outputs: []string{config.ModuleGraphFile()},
- Args: moduleGraphArgs,
- }
-
- args.PrimaryBuilderInvocations = []bootstrap.PrimaryBuilderInvocation{
- bp2buildInvocation,
- mainSoongBuildInvocation,
- moduleGraphInvocation,
- }
+ blueprintArgs.ModuleListFile = filepath.Join(config.FileListDir(), "Android.bp.list")
+ blueprintArgs.OutFile = shared.JoinPath(config.SoongOutDir(), ".bootstrap/build.ninja")
+ blueprintArgs.EmptyNinjaFile = false
blueprintCtx := blueprint.NewContext()
blueprintCtx.SetIgnoreUnknownModuleTypes(true)
blueprintConfig := BlueprintConfig{
- soongOutDir: config.SoongOutDir(),
- toolDir: config.HostToolDir(),
- outDir: config.OutDir(),
- runGoTests: !config.skipSoongTests,
- useValidations: true,
- debugCompilation: os.Getenv("SOONG_DELVE") != "",
- subninjas: args.Subninjas,
- primaryBuilderInvocations: args.PrimaryBuilderInvocations,
+ soongOutDir: config.SoongOutDir(),
+ toolDir: config.HostToolDir(),
+ outDir: config.OutDir(),
+ runGoTests: !config.skipSoongTests,
+ useValidations: !config.skipSoongTests,
+ // If we want to debug soong_build, we need to compile it for debugging
+ debugCompilation: os.Getenv("SOONG_DELVE") != "",
+ subninjas: globFiles,
+ primaryBuilderInvocations: []bootstrap.PrimaryBuilderInvocation{
+ mainSoongBuildInvocation,
+ bp2buildInvocation,
+ jsonModuleGraphInvocation,
+ queryviewInvocation,
+ soongDocsInvocation},
}
- args.EmptyNinjaFile = false
- bootstrapDeps := bootstrap.RunBlueprint(args, blueprintCtx, blueprintConfig)
- err := deptools.WriteDepFile(bootstrapDepFile, args.OutFile, bootstrapDeps)
+ bootstrapDeps := bootstrap.RunBlueprint(blueprintArgs, bootstrap.DoEverything, blueprintCtx, blueprintConfig)
+ bootstrapDepFile := shared.JoinPath(config.SoongOutDir(), ".bootstrap/build.ninja.d")
+ err := deptools.WriteDepFile(bootstrapDepFile, blueprintArgs.OutFile, bootstrapDeps)
if err != nil {
ctx.Fatalf("Error writing depfile '%s': %s", bootstrapDepFile, err)
}
@@ -275,7 +300,7 @@
}
buildMode := config.bazelBuildMode()
- integratedBp2Build := (buildMode == mixedBuild) || (buildMode == generateBuildFiles)
+ integratedBp2Build := buildMode == mixedBuild
// This is done unconditionally, but does not take a measurable amount of time
bootstrapBlueprint(ctx, config)
@@ -303,12 +328,22 @@
ctx.BeginTrace(metrics.RunSoong, "environment check")
defer ctx.EndTrace()
- soongBuildEnvFile := filepath.Join(config.SoongOutDir(), usedEnvFile)
- checkEnvironmentFile(soongBuildEnv, soongBuildEnvFile)
+ checkEnvironmentFile(soongBuildEnv, filepath.Join(config.SoongOutDir(), usedEnvFile+".build"))
- if integratedBp2Build {
- bp2buildEnvFile := filepath.Join(config.SoongOutDir(), usedEnvFile+".bp2build")
- checkEnvironmentFile(soongBuildEnv, bp2buildEnvFile)
+ if integratedBp2Build || config.Bp2Build() {
+ checkEnvironmentFile(soongBuildEnv, filepath.Join(config.SoongOutDir(), usedEnvFile+".bp2build"))
+ }
+
+ if config.JsonModuleGraph() {
+ checkEnvironmentFile(soongBuildEnv, filepath.Join(config.SoongOutDir(), usedEnvFile+".modulegraph"))
+ }
+
+ if config.Queryview() {
+ checkEnvironmentFile(soongBuildEnv, filepath.Join(config.SoongOutDir(), usedEnvFile+".queryview"))
+ }
+
+ if config.SoongDocs() {
+ checkEnvironmentFile(soongBuildEnv, filepath.Join(config.SoongOutDir(), usedEnvFile+".soong_docs"))
}
}()
@@ -351,18 +386,30 @@
cmd.RunAndStreamOrFatal()
}
- var target string
+ targets := make([]string, 0, 0)
- if config.bazelBuildMode() == generateBuildFiles {
- target = config.Bp2BuildMarkerFile()
- } else if config.bazelBuildMode() == generateJsonModuleGraph {
- target = config.ModuleGraphFile()
- } else {
- // This build generates <builddir>/build.ninja, which is used later by build/soong/ui/build/build.go#Build().
- target = config.MainNinjaFile()
+ if config.JsonModuleGraph() {
+ targets = append(targets, config.ModuleGraphFile())
}
- ninja("bootstrap", ".bootstrap/build.ninja", target)
+ if config.Bp2Build() {
+ targets = append(targets, config.Bp2BuildMarkerFile())
+ }
+
+ if config.Queryview() {
+ targets = append(targets, config.QueryviewMarkerFile())
+ }
+
+ if config.SoongDocs() {
+ targets = append(targets, config.SoongDocsHtml())
+ }
+
+ if config.SoongBuildInvocationNeeded() {
+ // This build generates <builddir>/build.ninja, which is used later by build/soong/ui/build/build.go#Build().
+ targets = append(targets, config.MainNinjaFile())
+ }
+
+ ninja("bootstrap", ".bootstrap/build.ninja", targets...)
var soongBuildMetrics *soong_metrics_proto.SoongBuildMetrics
if shouldCollectBuildSoongMetrics(config) {
@@ -404,7 +451,7 @@
func shouldCollectBuildSoongMetrics(config Config) bool {
// Do not collect metrics protobuf if the soong_build binary ran as the
// bp2build converter or the JSON graph dump.
- return config.bazelBuildMode() != generateBuildFiles && config.bazelBuildMode() != generateJsonModuleGraph
+ return config.SoongBuildInvocationNeeded()
}
func loadSoongBuildMetrics(ctx Context, config Config) *soong_metrics_proto.SoongBuildMetrics {