Support restrictions based on a module's dependencies (3578188f) · Commits · e / os / android_build_soong

android/neverallow.go

+35 −1

Original line number	Diff line number	Diff line
		@@ -189,6 +189,10 @@ func neverallowMutator(ctx BottomUpMutatorContext) {
		continue
		}

		if !n.appliesToDirectDeps(ctx) {
		continue
		}

		ctx.ModuleErrorf("violates " + n.String())
		}
		}
		@@ -246,6 +250,8 @@ type Rule interface {

		NotIn(path ...string) Rule

		InDirectDeps(deps ...string) Rule

		ModuleType(types ...string) Rule

		NotModuleType(types ...string) Rule
		@@ -268,6 +274,8 @@ type rule struct {
		paths []string
		unlessPaths []string

		directDeps map[string]bool

		moduleTypes []string
		unlessModuleTypes []string

		@@ -277,7 +285,7 @@ type rule struct {

		// Create a new NeverAllow rule.
		func NeverAllow() Rule {
		return &rule{}
		return &rule{directDeps: make(map[string]bool)}
		}

		func (r *rule) In(path ...string) Rule {
		@@ -290,6 +298,13 @@ func (r *rule) NotIn(path ...string) Rule {
		return r
		}

		func (r *rule) InDirectDeps(deps ...string) Rule {
		for _, d := range deps {
		r.directDeps[d] = true
		}
		return r
		}

		func (r *rule) ModuleType(types ...string) Rule {
		r.moduleTypes = append(r.moduleTypes, types...)
		return r
		@@ -356,6 +371,9 @@ func (r *rule) String() string {
		for _, v := range r.unlessProps {
		s += " -" + strings.Join(v.fields, ".") + v.matcher.String()
		}
		for k := range r.directDeps {
		s += " deps:" + k
		}
		if len(r.reason) != 0 {
		s += " which is restricted because " + r.reason
		}
		@@ -368,6 +386,22 @@ func (r *rule) appliesToPath(dir string) bool {
		return includePath && !excludePath
		}

		func (r *rule) appliesToDirectDeps(ctx BottomUpMutatorContext) bool {
		if len(r.directDeps) == 0 {
		return true
		}

		matches := false
		ctx.VisitDirectDeps(func(m Module) {
		if !matches {
		name := ctx.OtherModuleName(m)
		matches = r.directDeps[name]
		}
		})

		return matches
		}

		func (r *rule) appliesToModuleType(moduleType string) bool {
		return (len(r.moduleTypes) == 0 \|\| InList(moduleType, r.moduleTypes)) && !InList(moduleType, r.unlessModuleTypes)
		}

android/neverallow_test.go

+44 −0

Original line number	Diff line number	Diff line
		@@ -16,13 +16,43 @@ package android

		import (
		"testing"

		"github.com/google/blueprint"
		)

		func init() {
		// Add extra rules needed for testing.
		AddNeverAllowRules(
		NeverAllow().InDirectDeps("not_allowed_in_direct_deps"),
		)
		}

		var neverallowTests = []struct {
		name string
		fs map[string][]byte
		expectedError string
		}{
		// Test General Functionality

		// in direct deps tests
		{
		name: "not_allowed_in_direct_deps",
		fs: map[string][]byte{
		"top/Blueprints": []byte(`
		cc_library {
		name: "not_allowed_in_direct_deps",
		}`),
		"other/Blueprints": []byte(`
		cc_library {
		name: "libother",
		static_libs: ["not_allowed_in_direct_deps"],
		}`),
		},
		expectedError: `module "libother": violates neverallow deps:not_allowed_in_direct_deps`,
		},

		// Test specific rules

		// include_dir rule tests
		{
		name: "include_dir not allowed to reference art",
		@@ -242,6 +272,7 @@ func testNeverallow(t testing.T, config Config, fs map[string][]byte) (TestCon
		type mockCcLibraryProperties struct {
		Include_dirs []string
		Vendor_available *bool
		Static_libs []string

		Vndk struct {
		Enabled *bool
		@@ -272,6 +303,19 @@ func newMockCcLibraryModule() Module {
		return m
		}

		type neverallowTestDependencyTag struct {
		blueprint.BaseDependencyTag
		name string
		}

		var staticDepTag = neverallowTestDependencyTag{name: "static"}

		func (c *mockCcLibraryModule) DepsMutator(ctx BottomUpMutatorContext) {
		for _, lib := range c.properties.Static_libs {
		ctx.AddDependency(ctx.Module(), staticDepTag, lib)
		}
		}

		func (p *mockCcLibraryModule) GenerateAndroidBuildActions(ModuleContext) {
		}