tequilaOS/platform_build_soong
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Revert "Restrict plugins to an existing allowlist"

Browse source 
This reverts commit 09ddb3a73e.

Reason for revert: breaks branches without vendor

Change-Id: I2de95d7b99e4e5fd3d696f51d5b4d6a68a298365
This commit is contained in:
Liz Kammer 2023-05-17 22:51:43 +00:00 committed by Android (Google) Code Review
parent 09ddb3a73e
commit b20a12553e
5 changed files with 12 additions and 157 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
android/Android.bp
View file

@ -77,7 +77,6 @@ bootstrap_go_package {
"path_properties.go",
"paths.go",
"phony.go",
"plugin.go",
"prebuilt.go",
"prebuilt_build_tool.go",
"proto.go",

4
android/config.go
View file

@ -1819,10 +1819,6 @@ func (c *deviceConfig) ShippingApiLevel() ApiLevel {
return uncheckedFinalApiLevel(apiLevel)
}
func (c *deviceConfig) BuildBrokenPluginValidation() []string {
return c.config.productVariables.BuildBrokenPluginValidation
}
func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
return c.config.productVariables.BuildBrokenClangAsFlags
}

139
android/plugin.go
View file

@ -1,139 +0,0 @@
// Copyright 2022 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package android
import (
"encoding/json"
"fmt"
"io/ioutil"
"os"
"strings"
"github.com/google/blueprint"
)
func init() {
RegisterPluginSingletonBuildComponents(InitRegistrationContext)
}
func RegisterPluginSingletonBuildComponents(ctx RegistrationContext) {
ctx.RegisterSingletonType("plugins", pluginSingletonFactory)
}
// pluginSingleton is a singleton to handle allowlisting of the final Android-<product_name>.mk file
// output.
func pluginSingletonFactory() Singleton {
return &pluginSingleton{}
}
type pluginSingleton struct{}
var allowedPluginsByName = map[string]bool{
"aidl-soong-rules": true,
"arm_compute_library_nn_driver": true,
"cuttlefish-soong-rules": true,
"gki-soong-rules": true,
"hidl-soong-rules": true,
"kernel-config-soong-rules": true,
"soong-angle-codegen": true,
"soong-api": true,
"soong-art": true,
"soong-ca-certificates": true,
"soong-clang": true,
"soong-clang-prebuilts": true,
"soong-csuite": true,
"soong-fluoride": true,
"soong-fs_config": true,
"soong-icu": true,
"soong-java-config-error_prone": true,
"soong-libchrome": true,
"soong-llvm": true,
"soong-robolectric": true,
"soong-rust-prebuilts": true,
"soong-selinux": true,
"soong-wayland-protocol-codegen": true,
"treble_report_app": true,
"treble_report_local": true,
"treble_report_module": true,
"vintf-compatibility-matrix-soong-rules": true,
"xsdc-soong-rules": true,
}
const (
internalPluginsPath = "vendor/google/build/soong/internal_plugins.json"
)
type pluginProvider interface {
IsPluginFor(string) bool
}
func maybeAddInternalPluginsToAllowlist(ctx SingletonContext) {
if path := ExistentPathForSource(ctx, internalPluginsPath); path.Valid() {
ctx.AddNinjaFileDeps(path.String())
absPath := absolutePath(path.String())
var moreAllowed map[string]bool
data, err := ioutil.ReadFile(absPath)
if err != nil {
ctx.Errorf("Failed to open internal plugins path %q %q", internalPluginsPath, err)
}
if err := json.Unmarshal(data, &moreAllowed); err != nil {
fmt.Fprintf(os.Stderr, "Internal plugins file %q did not parse correctly: %q", data, err)
}
for k, v := range moreAllowed {
allowedPluginsByName[k] = v
}
}
}
func (p *pluginSingleton) GenerateBuildActions(ctx SingletonContext) {
for _, p := range ctx.DeviceConfig().BuildBrokenPluginValidation() {
allowedPluginsByName[p] = true
}
maybeAddInternalPluginsToAllowlist(ctx)
disallowedPlugins := map[string]bool{}
ctx.VisitAllModulesBlueprint(func(module blueprint.Module) {
if ctx.ModuleType(module) != "bootstrap_go_package" {
return
}
p, ok := module.(pluginProvider)
if !ok || !p.IsPluginFor("soong_build") {
return
}
name := ctx.ModuleName(module)
if _, ok := allowedPluginsByName[name]; ok {
return
}
dir := ctx.ModuleDir(module)
// allow use of plugins within Soong to not allowlist everything
if strings.HasPrefix(dir, "build/soong") {
return
}
// allow third party users outside of external to create new plugins, i.e. non-google paths
// under vendor or hardware
if !strings.HasPrefix(dir, "external/") && IsThirdPartyPath(dir) {
return
}
disallowedPlugins[name] = true
})
if len(disallowedPlugins) > 0 {
ctx.Errorf("New plugins are not supported; however %q were found. Please reach out to the build team or use BUILD_BROKEN_PLUGIN_VALIDATION (see Changes.md for more info).", SortedStringKeys(disallowedPlugins))
}
}

1
android/variable.go
View file

@ -437,7 +437,6 @@ type productVariables struct {
ShippingApiLevel *string `json:",omitempty"`
BuildBrokenPluginValidation []string `json:",omitempty"`
BuildBrokenClangAsFlags bool `json:",omitempty"`
BuildBrokenClangCFlags bool `json:",omitempty"`
BuildBrokenClangProperty bool `json:",omitempty"`

24
tests/bootstrap_test.sh
View file

@ -207,8 +207,8 @@ EOF
function test_soong_build_rerun_iff_environment_changes() {
setup
mkdir -p build/soong/cherry
cat > build/soong/cherry/Android.bp <<'EOF'
mkdir -p cherry
cat > cherry/Android.bp <<'EOF'
bootstrap_go_package {
name: "cherry",
pkgPath: "android/soong/cherry",
@ -224,7 +224,7 @@ bootstrap_go_package {
}
EOF
cat > build/soong/cherry/cherry.go <<'EOF'
cat > cherry/cherry.go <<'EOF'
package cherry
import (
@ -317,8 +317,8 @@ function test_add_file_to_soong_build() {
run_soong
local -r mtime1=$(stat -c "%y" out/soong/build.ninja)
mkdir -p vendor/foo/picard
cat > vendor/foo/picard/Android.bp <<'EOF'
mkdir -p a
cat > a/Android.bp <<'EOF'
bootstrap_go_package {
name: "picard-soong-rules",
pkgPath: "android/soong/picard",
@ -334,7 +334,7 @@ bootstrap_go_package {
}
EOF
cat > vendor/foo/picard/picard.go <<'EOF'
cat > a/picard.go <<'EOF'
package picard
import (
@ -390,11 +390,11 @@ EOF
function test_glob_during_bootstrapping() {
setup
mkdir -p build/soong/picard
cat > build/soong/picard/Android.bp <<'EOF'
mkdir -p a
cat > a/Android.bp <<'EOF'
build=["foo*.bp"]
EOF
cat > build/soong/picard/fooa.bp <<'EOF'
cat > a/fooa.bp <<'EOF'
bootstrap_go_package {
name: "picard-soong-rules",
pkgPath: "android/soong/picard",
@ -410,7 +410,7 @@ bootstrap_go_package {
}
EOF
cat > build/soong/picard/picard.go <<'EOF'
cat > a/picard.go <<'EOF'
package picard
import (
@ -459,7 +459,7 @@ EOF
grep -q "Make it so" out/soong/build.ninja || fail "Original action not present"
cat > build/soong/picard/foob.bp <<'EOF'
cat > a/foob.bp <<'EOF'
bootstrap_go_package {
name: "worf-soong-rules",
pkgPath: "android/soong/worf",
@ -476,7 +476,7 @@ bootstrap_go_package {
}
EOF
cat > build/soong/picard/worf.go <<'EOF'
cat > a/worf.go <<'EOF'
package worf
import "android/soong/picard"