123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490 |
- // 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"
- "sort"
- "strings"
- "testing"
- "github.com/google/blueprint"
- )
- func NewTestContext(config Config) *TestContext {
- namespaceExportFilter := func(namespace *Namespace) bool {
- return true
- }
- nameResolver := NewNameResolver(namespaceExportFilter)
- ctx := &TestContext{
- Context: &Context{blueprint.NewContext(), config},
- NameResolver: nameResolver,
- }
- ctx.SetNameInterface(nameResolver)
- ctx.postDeps = append(ctx.postDeps, registerPathDepsMutator)
- ctx.SetFs(ctx.config.fs)
- if ctx.config.mockBpList != "" {
- ctx.SetModuleListFile(ctx.config.mockBpList)
- }
- return ctx
- }
- func NewTestArchContext(config Config) *TestContext {
- ctx := NewTestContext(config)
- ctx.preDeps = append(ctx.preDeps, registerArchMutator)
- return ctx
- }
- type TestContext struct {
- *Context
- preArch, preDeps, postDeps, finalDeps []RegisterMutatorFunc
- NameResolver *NameResolver
- }
- func (ctx *TestContext) PreArchMutators(f RegisterMutatorFunc) {
- ctx.preArch = append(ctx.preArch, f)
- }
- func (ctx *TestContext) HardCodedPreArchMutators(f RegisterMutatorFunc) {
- // Register mutator function as normal for testing.
- ctx.PreArchMutators(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) FinalDepsMutators(f RegisterMutatorFunc) {
- ctx.finalDeps = append(ctx.finalDeps, f)
- }
- func (ctx *TestContext) Register() {
- registerMutators(ctx.Context.Context, ctx.preArch, ctx.preDeps, ctx.postDeps, ctx.finalDeps)
- ctx.RegisterSingletonType("env", EnvSingleton)
- }
- func (ctx *TestContext) ParseFileList(rootDir string, filePaths []string) (deps []string, errs []error) {
- // This function adapts the old style ParseFileList calls that are spread throughout the tests
- // to the new style that takes a config.
- return ctx.Context.ParseFileList(rootDir, filePaths, ctx.config)
- }
- func (ctx *TestContext) ParseBlueprintsFiles(rootDir string) (deps []string, errs []error) {
- // This function adapts the old style ParseBlueprintsFiles calls that are spread throughout the
- // tests to the new style that takes a config.
- return ctx.Context.ParseBlueprintsFiles(rootDir, ctx.config)
- }
- func (ctx *TestContext) RegisterModuleType(name string, factory ModuleFactory) {
- ctx.Context.RegisterModuleType(name, ModuleFactoryAdaptor(factory))
- }
- func (ctx *TestContext) RegisterSingletonModuleType(name string, factory SingletonModuleFactory) {
- s, m := SingletonModuleFactoryAdaptor(name, factory)
- ctx.RegisterSingletonType(name, s)
- ctx.RegisterModuleType(name, m)
- }
- func (ctx *TestContext) RegisterSingletonType(name string, factory SingletonFactory) {
- ctx.Context.RegisterSingletonType(name, SingletonFactoryAdaptor(ctx.Context, factory))
- }
- 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
- var allModuleNames []string
- var allVariants []string
- ctx.VisitAllModules(func(m blueprint.Module) {
- allModuleNames = append(allModuleNames, ctx.ModuleName(m))
- if ctx.ModuleName(m) == name {
- allVariants = append(allVariants, ctx.ModuleSubDir(m))
- }
- })
- sort.Strings(allModuleNames)
- sort.Strings(allVariants)
- if len(allVariants) == 0 {
- panic(fmt.Errorf("failed to find module %q. All modules:\n %s",
- name, strings.Join(allModuleNames, "\n ")))
- } else {
- panic(fmt.Errorf("failed to find module %q variant %q. All variants:\n %s",
- name, variant, strings.Join(allVariants, "\n ")))
- }
- }
- 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))
- }
- 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, []string) {
- var searchedRules []string
- for _, p := range provider.BuildParamsForTests() {
- searchedRules = append(searchedRules, p.Rule.String())
- if strings.Contains(p.Rule.String(), rule) {
- return newTestingBuildParams(provider, p), searchedRules
- }
- }
- return TestingBuildParams{}, searchedRules
- }
- func buildParamsFromRule(provider testBuildProvider, rule string) TestingBuildParams {
- p, searchRules := maybeBuildParamsFromRule(provider, rule)
- if p.Rule == nil {
- panic(fmt.Errorf("couldn't find rule %q.\nall rules: %v", rule, searchRules))
- }
- return p
- }
- func maybeBuildParamsFromDescription(provider testBuildProvider, desc string) TestingBuildParams {
- for _, p := range provider.BuildParamsForTests() {
- if strings.Contains(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 {
- r, _ := maybeBuildParamsFromRule(m.module, rule)
- return r
- }
- // 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 {
- r, _ := maybeBuildParamsFromRule(s.provider, rule)
- return r
- }
- // 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] = %q", i, err)
- }
- }
- }
- func CheckErrorsAgainstExpectations(t *testing.T, errs []error, expectedErrorPatterns []string) {
- t.Helper()
- if expectedErrorPatterns == nil {
- FailIfErrored(t, errs)
- } else {
- for _, expectedError := range expectedErrorPatterns {
- FailIfNoMatchingErrors(t, expectedError, errs)
- }
- if len(errs) > len(expectedErrorPatterns) {
- t.Errorf("additional errors found, expected %d, found %d",
- len(expectedErrorPatterns), len(errs))
- for i, expectedError := range expectedErrorPatterns {
- t.Errorf("expectedErrors[%d] = %s", i, expectedError)
- }
- for i, err := range errs {
- t.Errorf("errs[%d] = %s", i, err)
- }
- }
- }
- }
- func SetKatiEnabledForTests(config Config) {
- config.katiEnabled = true
- }
- func AndroidMkEntriesForTest(t *testing.T, config Config, bpPath string, mod blueprint.Module) []AndroidMkEntries {
- var p AndroidMkEntriesProvider
- var ok bool
- if p, ok = mod.(AndroidMkEntriesProvider); !ok {
- t.Errorf("module does not implement AndroidMkEntriesProvider: " + mod.Name())
- }
- entriesList := p.AndroidMkEntries()
- for i, _ := range entriesList {
- entriesList[i].fillInEntries(config, bpPath, mod)
- }
- return entriesList
- }
- func AndroidMkDataForTest(t *testing.T, config Config, bpPath string, mod blueprint.Module) AndroidMkData {
- var p AndroidMkDataProvider
- var ok bool
- if p, ok = mod.(AndroidMkDataProvider); !ok {
- t.Errorf("module does not implement AndroidMkDataProvider: " + mod.Name())
- }
- data := p.AndroidMk()
- data.fillInData(config, bpPath, mod)
- return data
- }
- // Normalize the path for testing.
- //
- // If the path is relative to the build directory then return the relative path
- // to avoid tests having to deal with the dynamically generated build directory.
- //
- // Otherwise, return the supplied path as it is almost certainly a source path
- // that is relative to the root of the source tree.
- //
- // The build and source paths should be distinguishable based on their contents.
- func NormalizePathForTesting(path Path) string {
- p := path.String()
- if w, ok := path.(WritablePath); ok {
- rel, err := filepath.Rel(w.buildDir(), p)
- if err != nil {
- panic(err)
- }
- return rel
- }
- return p
- }
- func NormalizePathsForTesting(paths Paths) []string {
- var result []string
- for _, path := range paths {
- relative := NormalizePathForTesting(path)
- result = append(result, relative)
- }
- return result
- }
|