You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
371 lines
12 KiB
371 lines
12 KiB
// Copyright 2017 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" |
|
"path/filepath" |
|
"regexp" |
|
"strings" |
|
"testing" |
|
|
|
"github.com/google/blueprint" |
|
) |
|
|
|
func NewTestContext() *TestContext { |
|
namespaceExportFilter := func(namespace *Namespace) bool { |
|
return true |
|
} |
|
|
|
nameResolver := NewNameResolver(namespaceExportFilter) |
|
ctx := &TestContext{ |
|
Context: &Context{blueprint.NewContext()}, |
|
NameResolver: nameResolver, |
|
} |
|
|
|
ctx.SetNameInterface(nameResolver) |
|
|
|
ctx.postDeps = append(ctx.postDeps, registerPathDepsMutator) |
|
|
|
return ctx |
|
} |
|
|
|
func NewTestArchContext() *TestContext { |
|
ctx := NewTestContext() |
|
ctx.preDeps = append(ctx.preDeps, registerArchMutator) |
|
return ctx |
|
} |
|
|
|
type TestContext struct { |
|
*Context |
|
preArch, preDeps, postDeps []RegisterMutatorFunc |
|
NameResolver *NameResolver |
|
} |
|
|
|
func (ctx *TestContext) PreArchMutators(f RegisterMutatorFunc) { |
|
ctx.preArch = append(ctx.preArch, f) |
|
} |
|
|
|
func (ctx *TestContext) PreDepsMutators(f RegisterMutatorFunc) { |
|
ctx.preDeps = append(ctx.preDeps, f) |
|
} |
|
|
|
func (ctx *TestContext) PostDepsMutators(f RegisterMutatorFunc) { |
|
ctx.postDeps = append(ctx.postDeps, f) |
|
} |
|
|
|
func (ctx *TestContext) Register() { |
|
registerMutators(ctx.Context.Context, ctx.preArch, ctx.preDeps, ctx.postDeps) |
|
|
|
ctx.RegisterSingletonType("env", SingletonFactoryAdaptor(EnvSingleton)) |
|
} |
|
|
|
func (ctx *TestContext) ModuleForTests(name, variant string) TestingModule { |
|
var module Module |
|
ctx.VisitAllModules(func(m blueprint.Module) { |
|
if ctx.ModuleName(m) == name && ctx.ModuleSubDir(m) == variant { |
|
module = m.(Module) |
|
} |
|
}) |
|
|
|
if module == nil { |
|
// find all the modules that do exist |
|
allModuleNames := []string{} |
|
ctx.VisitAllModules(func(m blueprint.Module) { |
|
allModuleNames = append(allModuleNames, m.(Module).Name()+"("+ctx.ModuleSubDir(m)+")") |
|
}) |
|
|
|
panic(fmt.Errorf("failed to find module %q variant %q."+ |
|
"\nall modules: %v", name, variant, allModuleNames)) |
|
} |
|
|
|
return TestingModule{module} |
|
} |
|
|
|
func (ctx *TestContext) ModuleVariantsForTests(name string) []string { |
|
var variants []string |
|
ctx.VisitAllModules(func(m blueprint.Module) { |
|
if ctx.ModuleName(m) == name { |
|
variants = append(variants, ctx.ModuleSubDir(m)) |
|
} |
|
}) |
|
return variants |
|
} |
|
|
|
// SingletonForTests returns a TestingSingleton for the singleton registered with the given name. |
|
func (ctx *TestContext) SingletonForTests(name string) TestingSingleton { |
|
allSingletonNames := []string{} |
|
for _, s := range ctx.Singletons() { |
|
n := ctx.SingletonName(s) |
|
if n == name { |
|
return TestingSingleton{ |
|
singleton: s.(*singletonAdaptor).Singleton, |
|
provider: s.(testBuildProvider), |
|
} |
|
} |
|
allSingletonNames = append(allSingletonNames, n) |
|
} |
|
|
|
panic(fmt.Errorf("failed to find singleton %q."+ |
|
"\nall singletons: %v", name, allSingletonNames)) |
|
} |
|
|
|
// MockFileSystem causes the Context to replace all reads with accesses to the provided map of |
|
// filenames to contents stored as a byte slice. |
|
func (ctx *TestContext) MockFileSystem(files map[string][]byte) { |
|
// no module list file specified; find every file named Blueprints or Android.bp |
|
pathsToParse := []string{} |
|
for candidate := range files { |
|
base := filepath.Base(candidate) |
|
if base == "Blueprints" || base == "Android.bp" { |
|
pathsToParse = append(pathsToParse, candidate) |
|
} |
|
} |
|
if len(pathsToParse) < 1 { |
|
panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", files)) |
|
} |
|
files[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n")) |
|
|
|
ctx.Context.MockFileSystem(files) |
|
} |
|
|
|
type testBuildProvider interface { |
|
BuildParamsForTests() []BuildParams |
|
RuleParamsForTests() map[blueprint.Rule]blueprint.RuleParams |
|
} |
|
|
|
type TestingBuildParams struct { |
|
BuildParams |
|
RuleParams blueprint.RuleParams |
|
} |
|
|
|
func newTestingBuildParams(provider testBuildProvider, bparams BuildParams) TestingBuildParams { |
|
return TestingBuildParams{ |
|
BuildParams: bparams, |
|
RuleParams: provider.RuleParamsForTests()[bparams.Rule], |
|
} |
|
} |
|
|
|
func maybeBuildParamsFromRule(provider testBuildProvider, rule string) TestingBuildParams { |
|
for _, p := range provider.BuildParamsForTests() { |
|
if strings.Contains(p.Rule.String(), rule) { |
|
return newTestingBuildParams(provider, p) |
|
} |
|
} |
|
return TestingBuildParams{} |
|
} |
|
|
|
func buildParamsFromRule(provider testBuildProvider, rule string) TestingBuildParams { |
|
p := maybeBuildParamsFromRule(provider, rule) |
|
if p.Rule == nil { |
|
panic(fmt.Errorf("couldn't find rule %q", rule)) |
|
} |
|
return p |
|
} |
|
|
|
func maybeBuildParamsFromDescription(provider testBuildProvider, desc string) TestingBuildParams { |
|
for _, p := range provider.BuildParamsForTests() { |
|
if p.Description == desc { |
|
return newTestingBuildParams(provider, p) |
|
} |
|
} |
|
return TestingBuildParams{} |
|
} |
|
|
|
func buildParamsFromDescription(provider testBuildProvider, desc string) TestingBuildParams { |
|
p := maybeBuildParamsFromDescription(provider, desc) |
|
if p.Rule == nil { |
|
panic(fmt.Errorf("couldn't find description %q", desc)) |
|
} |
|
return p |
|
} |
|
|
|
func maybeBuildParamsFromOutput(provider testBuildProvider, file string) (TestingBuildParams, []string) { |
|
var searchedOutputs []string |
|
for _, p := range provider.BuildParamsForTests() { |
|
outputs := append(WritablePaths(nil), p.Outputs...) |
|
outputs = append(outputs, p.ImplicitOutputs...) |
|
if p.Output != nil { |
|
outputs = append(outputs, p.Output) |
|
} |
|
for _, f := range outputs { |
|
if f.String() == file || f.Rel() == file { |
|
return newTestingBuildParams(provider, p), nil |
|
} |
|
searchedOutputs = append(searchedOutputs, f.Rel()) |
|
} |
|
} |
|
return TestingBuildParams{}, searchedOutputs |
|
} |
|
|
|
func buildParamsFromOutput(provider testBuildProvider, file string) TestingBuildParams { |
|
p, searchedOutputs := maybeBuildParamsFromOutput(provider, file) |
|
if p.Rule == nil { |
|
panic(fmt.Errorf("couldn't find output %q.\nall outputs: %v", |
|
file, searchedOutputs)) |
|
} |
|
return p |
|
} |
|
|
|
func allOutputs(provider testBuildProvider) []string { |
|
var outputFullPaths []string |
|
for _, p := range provider.BuildParamsForTests() { |
|
outputs := append(WritablePaths(nil), p.Outputs...) |
|
outputs = append(outputs, p.ImplicitOutputs...) |
|
if p.Output != nil { |
|
outputs = append(outputs, p.Output) |
|
} |
|
outputFullPaths = append(outputFullPaths, outputs.Strings()...) |
|
} |
|
return outputFullPaths |
|
} |
|
|
|
// TestingModule is wrapper around an android.Module that provides methods to find information about individual |
|
// ctx.Build parameters for verification in tests. |
|
type TestingModule struct { |
|
module Module |
|
} |
|
|
|
// Module returns the Module wrapped by the TestingModule. |
|
func (m TestingModule) Module() Module { |
|
return m.module |
|
} |
|
|
|
// MaybeRule finds a call to ctx.Build with BuildParams.Rule set to a rule with the given name. Returns an empty |
|
// BuildParams if no rule is found. |
|
func (m TestingModule) MaybeRule(rule string) TestingBuildParams { |
|
return maybeBuildParamsFromRule(m.module, rule) |
|
} |
|
|
|
// Rule finds a call to ctx.Build with BuildParams.Rule set to a rule with the given name. Panics if no rule is found. |
|
func (m TestingModule) Rule(rule string) TestingBuildParams { |
|
return buildParamsFromRule(m.module, rule) |
|
} |
|
|
|
// MaybeDescription finds a call to ctx.Build with BuildParams.Description set to a the given string. Returns an empty |
|
// BuildParams if no rule is found. |
|
func (m TestingModule) MaybeDescription(desc string) TestingBuildParams { |
|
return maybeBuildParamsFromDescription(m.module, desc) |
|
} |
|
|
|
// Description finds a call to ctx.Build with BuildParams.Description set to a the given string. Panics if no rule is |
|
// found. |
|
func (m TestingModule) Description(desc string) TestingBuildParams { |
|
return buildParamsFromDescription(m.module, desc) |
|
} |
|
|
|
// MaybeOutput finds a call to ctx.Build with a BuildParams.Output or BuildParams.Outputs whose String() or Rel() |
|
// value matches the provided string. Returns an empty BuildParams if no rule is found. |
|
func (m TestingModule) MaybeOutput(file string) TestingBuildParams { |
|
p, _ := maybeBuildParamsFromOutput(m.module, file) |
|
return p |
|
} |
|
|
|
// Output finds a call to ctx.Build with a BuildParams.Output or BuildParams.Outputs whose String() or Rel() |
|
// value matches the provided string. Panics if no rule is found. |
|
func (m TestingModule) Output(file string) TestingBuildParams { |
|
return buildParamsFromOutput(m.module, file) |
|
} |
|
|
|
// AllOutputs returns all 'BuildParams.Output's and 'BuildParams.Outputs's in their full path string forms. |
|
func (m TestingModule) AllOutputs() []string { |
|
return allOutputs(m.module) |
|
} |
|
|
|
// TestingSingleton is wrapper around an android.Singleton that provides methods to find information about individual |
|
// ctx.Build parameters for verification in tests. |
|
type TestingSingleton struct { |
|
singleton Singleton |
|
provider testBuildProvider |
|
} |
|
|
|
// Singleton returns the Singleton wrapped by the TestingSingleton. |
|
func (s TestingSingleton) Singleton() Singleton { |
|
return s.singleton |
|
} |
|
|
|
// MaybeRule finds a call to ctx.Build with BuildParams.Rule set to a rule with the given name. Returns an empty |
|
// BuildParams if no rule is found. |
|
func (s TestingSingleton) MaybeRule(rule string) TestingBuildParams { |
|
return maybeBuildParamsFromRule(s.provider, rule) |
|
} |
|
|
|
// Rule finds a call to ctx.Build with BuildParams.Rule set to a rule with the given name. Panics if no rule is found. |
|
func (s TestingSingleton) Rule(rule string) TestingBuildParams { |
|
return buildParamsFromRule(s.provider, rule) |
|
} |
|
|
|
// MaybeDescription finds a call to ctx.Build with BuildParams.Description set to a the given string. Returns an empty |
|
// BuildParams if no rule is found. |
|
func (s TestingSingleton) MaybeDescription(desc string) TestingBuildParams { |
|
return maybeBuildParamsFromDescription(s.provider, desc) |
|
} |
|
|
|
// Description finds a call to ctx.Build with BuildParams.Description set to a the given string. Panics if no rule is |
|
// found. |
|
func (s TestingSingleton) Description(desc string) TestingBuildParams { |
|
return buildParamsFromDescription(s.provider, desc) |
|
} |
|
|
|
// MaybeOutput finds a call to ctx.Build with a BuildParams.Output or BuildParams.Outputs whose String() or Rel() |
|
// value matches the provided string. Returns an empty BuildParams if no rule is found. |
|
func (s TestingSingleton) MaybeOutput(file string) TestingBuildParams { |
|
p, _ := maybeBuildParamsFromOutput(s.provider, file) |
|
return p |
|
} |
|
|
|
// Output finds a call to ctx.Build with a BuildParams.Output or BuildParams.Outputs whose String() or Rel() |
|
// value matches the provided string. Panics if no rule is found. |
|
func (s TestingSingleton) Output(file string) TestingBuildParams { |
|
return buildParamsFromOutput(s.provider, file) |
|
} |
|
|
|
// AllOutputs returns all 'BuildParams.Output's and 'BuildParams.Outputs's in their full path string forms. |
|
func (s TestingSingleton) AllOutputs() []string { |
|
return allOutputs(s.provider) |
|
} |
|
|
|
func FailIfErrored(t *testing.T, errs []error) { |
|
t.Helper() |
|
if len(errs) > 0 { |
|
for _, err := range errs { |
|
t.Error(err) |
|
} |
|
t.FailNow() |
|
} |
|
} |
|
|
|
func FailIfNoMatchingErrors(t *testing.T, pattern string, errs []error) { |
|
t.Helper() |
|
|
|
matcher, err := regexp.Compile(pattern) |
|
if err != nil { |
|
t.Errorf("failed to compile regular expression %q because %s", pattern, err) |
|
} |
|
|
|
found := false |
|
for _, err := range errs { |
|
if matcher.FindStringIndex(err.Error()) != nil { |
|
found = true |
|
break |
|
} |
|
} |
|
if !found { |
|
t.Errorf("missing the expected error %q (checked %d error(s))", pattern, len(errs)) |
|
for i, err := range errs { |
|
t.Errorf("errs[%d] = %s", i, err) |
|
} |
|
} |
|
}
|
|
|