Add visibility support
Implementation uploaded for review. Includes unit tests but does not yet handle prebuilts, that will come in a future change once some more general issues with prebuilts and namespaces is resolved. See README.md#Visibility for details of what this does and how to use it. Bug: 112158820 Test: add visibility rules for core library modules, make core-tests Change-Id: I8ec980554398ad6f2d42043ce518f811a35da679
This commit is contained in:
Paul Duffin
474
android/visibility_test.go
Normal file
474
android/visibility_test.go
Normal file
@@ -0,0 +1,474 @@
|
||||
package android
|
||||
|
||||
import (
|
||||
"github.com/google/blueprint"
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"testing"
|
||||
)
|
||||
|
||||
var visibilityTests = []struct {
|
||||
name string
|
||||
fs map[string][]byte
|
||||
expectedErrors []string
|
||||
}{
|
||||
{
|
||||
name: "invalid visibility: empty list",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: [],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{`visibility: must contain at least one visibility rule`},
|
||||
},
|
||||
{
|
||||
name: "invalid visibility: empty rule",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: [""],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{`visibility: invalid visibility pattern ""`},
|
||||
},
|
||||
{
|
||||
name: "invalid visibility: unqualified",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["target"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{`visibility: invalid visibility pattern "target"`},
|
||||
},
|
||||
{
|
||||
name: "invalid visibility: empty namespace",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{`visibility: invalid visibility pattern "//"`},
|
||||
},
|
||||
{
|
||||
name: "invalid visibility: empty module",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: [":"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{`visibility: invalid visibility pattern ":"`},
|
||||
},
|
||||
{
|
||||
name: "invalid visibility: empty namespace and module",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//:"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{`visibility: invalid visibility pattern "//:"`},
|
||||
},
|
||||
{
|
||||
name: "//visibility:unknown",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//visibility:unknown"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{`unrecognized visibility rule "//visibility:unknown"`},
|
||||
},
|
||||
{
|
||||
name: "//visibility:public mixed",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//visibility:public", "//namespace"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libother",
|
||||
visibility: ["//visibility:private", "//namespace"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{
|
||||
`module "libother" variant "android_common": visibility: cannot mix "//visibility:private"` +
|
||||
` with any other visibility rules`,
|
||||
`module "libexample" variant "android_common": visibility: cannot mix` +
|
||||
` "//visibility:public" with any other visibility rules`,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "//visibility:legacy_public",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//visibility:legacy_public"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{
|
||||
`module "libexample" variant "android_common": visibility: //visibility:legacy_public must` +
|
||||
` not be used`,
|
||||
},
|
||||
},
|
||||
{
|
||||
// Verify that //visibility:public will allow the module to be referenced from anywhere, e.g.
|
||||
// the current directory, a nested directory and a directory in a separate tree.
|
||||
name: "//visibility:public",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//visibility:public"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libsamepackage",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/nested/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libnested",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"other/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libother",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
},
|
||||
},
|
||||
{
|
||||
// Verify that //visibility:public will allow the module to be referenced from anywhere, e.g.
|
||||
// the current directory, a nested directory and a directory in a separate tree.
|
||||
name: "//visibility:public",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//visibility:public"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libsamepackage",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/nested/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libnested",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"other/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libother",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
},
|
||||
},
|
||||
{
|
||||
// Verify that //visibility:private allows the module to be referenced from the current
|
||||
// directory only.
|
||||
name: "//visibility:private",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//visibility:private"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libsamepackage",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/nested/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libnested",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{
|
||||
`module "libnested" variant "android_common": depends on //top:libexample which is not` +
|
||||
` visible to this module; //top:libexample is only visible to \[//top:__pkg__\]`,
|
||||
},
|
||||
},
|
||||
{
|
||||
// Verify that :__pkg__ allows the module to be referenced from the current directory only.
|
||||
name: ":__pkg__",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: [":__pkg__"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libsamepackage",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/nested/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libnested",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{
|
||||
`module "libnested" variant "android_common": depends on //top:libexample which is not` +
|
||||
` visible to this module; //top:libexample is only visible to \[//top:__pkg__\]`,
|
||||
},
|
||||
},
|
||||
{
|
||||
// Verify that //top/nested allows the module to be referenced from the current directory and
|
||||
// the top/nested directory only, not a subdirectory of top/nested and not peak directory.
|
||||
name: "//top/nested",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//top/nested"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libsamepackage",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/nested/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libnested",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/nested/again/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libnestedagain",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"peak/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libother",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{
|
||||
`module "libother" variant "android_common": depends on //top:libexample which is not` +
|
||||
` visible to this module; //top:libexample is only visible to \[//top/nested:__pkg__\]`,
|
||||
`module "libnestedagain" variant "android_common": depends on //top:libexample which is not` +
|
||||
` visible to this module; //top:libexample is only visible to \[//top/nested:__pkg__\]`,
|
||||
},
|
||||
},
|
||||
{
|
||||
// Verify that :__subpackages__ allows the module to be referenced from the current directory
|
||||
// and sub directories but nowhere else.
|
||||
name: ":__subpackages__",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: [":__subpackages__"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libsamepackage",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/nested/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libnested",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"peak/other/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libother",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{
|
||||
`module "libother" variant "android_common": depends on //top:libexample which is not` +
|
||||
` visible to this module; //top:libexample is only visible to \[//top:__subpackages__\]`,
|
||||
},
|
||||
},
|
||||
{
|
||||
// Verify that //top/nested:__subpackages__ allows the module to be referenced from the current
|
||||
// directory and sub directories but nowhere else.
|
||||
name: "//top/nested:__subpackages__",
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//top/nested:__subpackages__", "//other"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libsamepackage",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/nested/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libnested",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/other/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libother",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{
|
||||
`module "libother" variant "android_common": depends on //top:libexample which is not` +
|
||||
` visible to this module; //top:libexample is only visible to` +
|
||||
` \[//top/nested:__subpackages__, //other:__pkg__\]`,
|
||||
},
|
||||
},
|
||||
{
|
||||
// Verify that ["//top/nested", "//peak:__subpackages"] allows the module to be referenced from
|
||||
// the current directory, top/nested and peak and all its subpackages.
|
||||
name: `["//top/nested", "//peak:__subpackages__"]`,
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//top/nested", "//peak:__subpackages__"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libsamepackage",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"top/nested/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libnested",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
"peak/other/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libother",
|
||||
deps: ["libexample"],
|
||||
}`),
|
||||
},
|
||||
},
|
||||
{
|
||||
// Verify that //vendor... cannot be used outside vendor apart from //vendor:__subpackages__
|
||||
name: `//vendor`,
|
||||
fs: map[string][]byte{
|
||||
"top/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libexample",
|
||||
visibility: ["//vendor:__subpackages__"],
|
||||
}
|
||||
|
||||
mock_library {
|
||||
name: "libsamepackage",
|
||||
visibility: ["//vendor/apps/AcmeSettings"],
|
||||
}`),
|
||||
"vendor/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libvendorexample",
|
||||
deps: ["libexample"],
|
||||
visibility: ["//vendor/nested"],
|
||||
}`),
|
||||
"vendor/nested/Blueprints": []byte(`
|
||||
mock_library {
|
||||
name: "libvendornested",
|
||||
deps: ["libexample", "libvendorexample"],
|
||||
}`),
|
||||
},
|
||||
expectedErrors: []string{
|
||||
`module "libsamepackage" variant "android_common": visibility: "//vendor/apps/AcmeSettings"` +
|
||||
` is not allowed. Packages outside //vendor cannot make themselves visible to specific` +
|
||||
` targets within //vendor, they can only use //vendor:__subpackages__.`,
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
func TestVisibility(t *testing.T) {
|
||||
buildDir, err := ioutil.TempDir("", "soong_neverallow_test")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
defer os.RemoveAll(buildDir)
|
||||
|
||||
for _, test := range visibilityTests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
_, errs := testVisibility(buildDir, test.fs)
|
||||
|
||||
expectedErrors := test.expectedErrors
|
||||
if expectedErrors == nil {
|
||||
FailIfErrored(t, errs)
|
||||
} else {
|
||||
for _, expectedError := range expectedErrors {
|
||||
FailIfNoMatchingErrors(t, expectedError, errs)
|
||||
}
|
||||
if len(errs) > len(expectedErrors) {
|
||||
t.Errorf("additional errors found, expected %d, found %d", len(expectedErrors), len(errs))
|
||||
for i, expectedError := range expectedErrors {
|
||||
t.Errorf("expectedErrors[%d] = %s", i, expectedError)
|
||||
}
|
||||
for i, err := range errs {
|
||||
t.Errorf("errs[%d] = %s", i, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func testVisibility(buildDir string, fs map[string][]byte) (*TestContext, []error) {
|
||||
|
||||
// Create a new config per test as visibility information is stored in the config.
|
||||
config := TestArchConfig(buildDir, nil)
|
||||
|
||||
ctx := NewTestArchContext()
|
||||
ctx.RegisterModuleType("mock_library", ModuleFactoryAdaptor(newMockLibraryModule))
|
||||
ctx.PreDepsMutators(registerVisibilityRuleGatherer)
|
||||
ctx.PostDepsMutators(registerVisibilityRuleEnforcer)
|
||||
ctx.Register()
|
||||
|
||||
ctx.MockFileSystem(fs)
|
||||
|
||||
_, errs := ctx.ParseBlueprintsFiles(".")
|
||||
if len(errs) > 0 {
|
||||
return ctx, errs
|
||||
}
|
||||
|
||||
_, errs = ctx.PrepareBuildActions(config)
|
||||
return ctx, errs
|
||||
}
|
||||
|
||||
type mockLibraryProperties struct {
|
||||
Deps []string
|
||||
}
|
||||
|
||||
type mockLibraryModule struct {
|
||||
ModuleBase
|
||||
properties mockLibraryProperties
|
||||
}
|
||||
|
||||
func newMockLibraryModule() Module {
|
||||
m := &mockLibraryModule{}
|
||||
m.AddProperties(&m.properties)
|
||||
InitAndroidArchModule(m, HostAndDeviceSupported, MultilibCommon)
|
||||
return m
|
||||
}
|
||||
|
||||
type dependencyTag struct {
|
||||
blueprint.BaseDependencyTag
|
||||
name string
|
||||
}
|
||||
|
||||
func (j *mockLibraryModule) DepsMutator(ctx BottomUpMutatorContext) {
|
||||
ctx.AddVariationDependencies(nil, dependencyTag{name: "mockdeps"}, j.properties.Deps...)
|
||||
}
|
||||
|
||||
func (p *mockLibraryModule) GenerateAndroidBuildActions(ModuleContext) {
|
||||
}
|
||||
Reference in New Issue
Block a user