123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050 |
- // Copyright 2021 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"
- "runtime"
- "strings"
- "testing"
- )
- // Provides support for creating test fixtures on which tests can be run. Reduces duplication
- // of test setup by allow tests to easily reuse setup code.
- //
- // Fixture
- // =======
- // These determine the environment within which a test can be run. Fixtures are mutable and are
- // created and mutated by FixturePreparer instances. They are created by first creating a base
- // Fixture (which is essentially empty) and then applying FixturePreparer instances to it to modify
- // the environment.
- //
- // FixturePreparer
- // ===============
- // These are responsible for modifying a Fixture in preparation for it to run a test. Preparers are
- // intended to be immutable and able to prepare multiple Fixture objects simultaneously without
- // them sharing any data.
- //
- // They provide the basic capabilities for running tests too.
- //
- // FixturePreparers are only ever applied once per test fixture. Prior to application the list of
- // FixturePreparers are flattened and deduped while preserving the order they first appear in the
- // list. This makes it easy to reuse, group and combine FixturePreparers together.
- //
- // Each small self contained piece of test setup should be their own FixturePreparer. e.g.
- // * A group of related modules.
- // * A group of related mutators.
- // * A combination of both.
- // * Configuration.
- //
- // They should not overlap, e.g. the same module type should not be registered by different
- // FixturePreparers as using them both would cause a build error. In that case the preparer should
- // be split into separate parts and combined together using FixturePreparers(...).
- //
- // e.g. attempting to use AllPreparers in preparing a Fixture would break as it would attempt to
- // register module bar twice:
- // var Preparer1 = FixtureRegisterWithContext(RegisterModuleFooAndBar)
- // var Preparer2 = FixtureRegisterWithContext(RegisterModuleBarAndBaz)
- // var AllPreparers = GroupFixturePreparers(Preparer1, Preparer2)
- //
- // However, when restructured like this it would work fine:
- // var PreparerFoo = FixtureRegisterWithContext(RegisterModuleFoo)
- // var PreparerBar = FixtureRegisterWithContext(RegisterModuleBar)
- // var PreparerBaz = FixtureRegisterWithContext(RegisterModuleBaz)
- // var Preparer1 = GroupFixturePreparers(RegisterModuleFoo, RegisterModuleBar)
- // var Preparer2 = GroupFixturePreparers(RegisterModuleBar, RegisterModuleBaz)
- // var AllPreparers = GroupFixturePreparers(Preparer1, Preparer2)
- //
- // As after deduping and flattening AllPreparers would result in the following preparers being
- // applied:
- // 1. PreparerFoo
- // 2. PreparerBar
- // 3. PreparerBaz
- //
- // Preparers can be used for both integration and unit tests.
- //
- // Integration tests typically use all the module types, mutators and singletons that are available
- // for that package to try and replicate the behavior of the runtime build as closely as possible.
- // However, that realism comes at a cost of increased fragility (as they can be broken by changes in
- // many different parts of the build) and also increased runtime, especially if they use lots of
- // singletons and mutators.
- //
- // Unit tests on the other hand try and minimize the amount of code being tested which makes them
- // less susceptible to changes elsewhere in the build and quick to run but at a cost of potentially
- // not testing realistic scenarios.
- //
- // Supporting unit tests effectively require that preparers are available at the lowest granularity
- // possible. Supporting integration tests effectively require that the preparers are organized into
- // groups that provide all the functionality available.
- //
- // At least in terms of tests that check the behavior of build components via processing
- // `Android.bp` there is no clear separation between a unit test and an integration test. Instead
- // they vary from one end that tests a single module (e.g. filegroup) to the other end that tests a
- // whole system of modules, mutators and singletons (e.g. apex + hiddenapi).
- //
- // TestResult
- // ==========
- // These are created by running tests in a Fixture and provide access to the Config and TestContext
- // in which the tests were run.
- //
- // Example
- // =======
- //
- // An exported preparer for use by other packages that need to use java modules.
- //
- // package java
- // var PrepareForIntegrationTestWithJava = GroupFixturePreparers(
- // android.PrepareForIntegrationTestWithAndroid,
- // FixtureRegisterWithContext(RegisterAGroupOfRelatedModulesMutatorsAndSingletons),
- // FixtureRegisterWithContext(RegisterAnotherGroupOfRelatedModulesMutatorsAndSingletons),
- // ...
- // )
- //
- // Some files to use in tests in the java package.
- //
- // var javaMockFS = android.MockFS{
- // "api/current.txt": nil,
- // "api/removed.txt": nil,
- // ...
- // }
- //
- // A package private preparer for use for testing java within the java package.
- //
- // var prepareForJavaTest = android.GroupFixturePreparers(
- // PrepareForIntegrationTestWithJava,
- // FixtureRegisterWithContext(func(ctx android.RegistrationContext) {
- // ctx.RegisterModuleType("test_module", testModule)
- // }),
- // javaMockFS.AddToFixture(),
- // ...
- // }
- //
- // func TestJavaStuff(t *testing.T) {
- // result := android.GroupFixturePreparers(
- // prepareForJavaTest,
- // android.FixtureWithRootAndroidBp(`java_library {....}`),
- // android.MockFS{...}.AddToFixture(),
- // ).RunTest(t)
- // ... test result ...
- // }
- //
- // package cc
- // var PrepareForTestWithCC = android.GroupFixturePreparers(
- // android.PrepareForArchMutator,
- // android.prepareForPrebuilts,
- // FixtureRegisterWithContext(RegisterRequiredBuildComponentsForTest),
- // ...
- // )
- //
- // package apex
- //
- // var PrepareForApex = GroupFixturePreparers(
- // ...
- // )
- //
- // Use modules and mutators from java, cc and apex. Any duplicate preparers (like
- // android.PrepareForArchMutator) will be automatically deduped.
- //
- // var prepareForApexTest = android.GroupFixturePreparers(
- // PrepareForJava,
- // PrepareForCC,
- // PrepareForApex,
- // )
- //
- // A set of mock files to add to the mock file system.
- type MockFS map[string][]byte
- // Merge adds the extra entries from the supplied map to this one.
- //
- // Fails if the supplied map files with the same paths are present in both of them.
- func (fs MockFS) Merge(extra map[string][]byte) {
- for p, c := range extra {
- validateFixtureMockFSPath(p)
- if _, ok := fs[p]; ok {
- panic(fmt.Errorf("attempted to add file %s to the mock filesystem but it already exists", p))
- }
- fs[p] = c
- }
- }
- // Ensure that tests cannot add paths into the mock file system which would not be allowed in the
- // runtime, e.g. absolute paths, paths relative to the 'out/' directory.
- func validateFixtureMockFSPath(path string) {
- // This uses validateSafePath rather than validatePath because the latter prevents adding files
- // that include a $ but there are tests that allow files with a $ to be used, albeit only by
- // globbing.
- validatedPath, err := validateSafePath(path)
- if err != nil {
- panic(err)
- }
- // Make sure that the path is canonical.
- if validatedPath != path {
- panic(fmt.Errorf("path %q is not a canonical path, use %q instead", path, validatedPath))
- }
- if path == "out" || strings.HasPrefix(path, "out/") {
- panic(fmt.Errorf("cannot add output path %q to the mock file system", path))
- }
- }
- func (fs MockFS) AddToFixture() FixturePreparer {
- return FixtureMergeMockFs(fs)
- }
- // FixtureCustomPreparer allows for the modification of any aspect of the fixture.
- //
- // This should only be used if one of the other more specific preparers are not suitable.
- func FixtureCustomPreparer(mutator func(fixture Fixture)) FixturePreparer {
- return newSimpleFixturePreparer(func(f *fixture) {
- mutator(f)
- })
- }
- // FixtureTestRunner determines the type of test to run.
- //
- // If no custom FixtureTestRunner is provided (using the FixtureSetTestRunner) then the default test
- // runner will run a standard Soong test that corresponds to what happens when Soong is run on the
- // command line.
- type FixtureTestRunner interface {
- // FinalPreparer is a function that is run immediately before parsing the blueprint files. It is
- // intended to perform the initialization needed by PostParseProcessor.
- //
- // It returns a CustomTestResult that is passed into PostParseProcessor and returned from
- // FixturePreparer.RunTestWithCustomResult. If it needs to return some custom data then it must
- // provide its own implementation of CustomTestResult and return an instance of that. Otherwise,
- // it can just return the supplied *TestResult.
- FinalPreparer(result *TestResult) CustomTestResult
- // PostParseProcessor is called after successfully parsing the blueprint files and can do further
- // work on the result of parsing the files.
- //
- // Successfully parsing simply means that no errors were encountered when parsing the blueprint
- // files.
- //
- // This must collate any information useful for testing, e.g. errs, ninja deps and custom data in
- // the supplied result.
- PostParseProcessor(result CustomTestResult)
- }
- // FixtureSetTestRunner sets the FixtureTestRunner in the fixture.
- //
- // It is an error if more than one of these is applied to a single fixture. If none of these are
- // applied then the fixture will use the defaultTestRunner which will run the test as if it was
- // being run in `m <target>`.
- func FixtureSetTestRunner(testRunner FixtureTestRunner) FixturePreparer {
- return newSimpleFixturePreparer(func(fixture *fixture) {
- if fixture.testRunner != nil {
- panic("fixture test runner has already been set")
- }
- fixture.testRunner = testRunner
- })
- }
- // Modify the config
- func FixtureModifyConfig(mutator func(config Config)) FixturePreparer {
- return newSimpleFixturePreparer(func(f *fixture) {
- mutator(f.config)
- })
- }
- // Modify the config and context
- func FixtureModifyConfigAndContext(mutator func(config Config, ctx *TestContext)) FixturePreparer {
- return newSimpleFixturePreparer(func(f *fixture) {
- mutator(f.config, f.ctx)
- })
- }
- // Modify the context
- func FixtureModifyContext(mutator func(ctx *TestContext)) FixturePreparer {
- return newSimpleFixturePreparer(func(f *fixture) {
- mutator(f.ctx)
- })
- }
- func FixtureRegisterWithContext(registeringFunc func(ctx RegistrationContext)) FixturePreparer {
- return FixtureModifyContext(func(ctx *TestContext) { registeringFunc(ctx) })
- }
- // Modify the mock filesystem
- func FixtureModifyMockFS(mutator func(fs MockFS)) FixturePreparer {
- return newSimpleFixturePreparer(func(f *fixture) {
- mutator(f.mockFS)
- // Make sure that invalid paths were not added to the mock filesystem.
- for p, _ := range f.mockFS {
- validateFixtureMockFSPath(p)
- }
- })
- }
- // Merge the supplied file system into the mock filesystem.
- //
- // Paths that already exist in the mock file system are overridden.
- func FixtureMergeMockFs(mockFS MockFS) FixturePreparer {
- return FixtureModifyMockFS(func(fs MockFS) {
- fs.Merge(mockFS)
- })
- }
- // Add a file to the mock filesystem
- //
- // Fail if the filesystem already contains a file with that path, use FixtureOverrideFile instead.
- func FixtureAddFile(path string, contents []byte) FixturePreparer {
- return FixtureModifyMockFS(func(fs MockFS) {
- validateFixtureMockFSPath(path)
- if _, ok := fs[path]; ok {
- panic(fmt.Errorf("attempted to add file %s to the mock filesystem but it already exists, use FixtureOverride*File instead", path))
- }
- fs[path] = contents
- })
- }
- // Add a text file to the mock filesystem
- //
- // Fail if the filesystem already contains a file with that path.
- func FixtureAddTextFile(path string, contents string) FixturePreparer {
- return FixtureAddFile(path, []byte(contents))
- }
- // Override a file in the mock filesystem
- //
- // If the file does not exist this behaves as FixtureAddFile.
- func FixtureOverrideFile(path string, contents []byte) FixturePreparer {
- return FixtureModifyMockFS(func(fs MockFS) {
- fs[path] = contents
- })
- }
- // Override a text file in the mock filesystem
- //
- // If the file does not exist this behaves as FixtureAddTextFile.
- func FixtureOverrideTextFile(path string, contents string) FixturePreparer {
- return FixtureOverrideFile(path, []byte(contents))
- }
- // Add the root Android.bp file with the supplied contents.
- func FixtureWithRootAndroidBp(contents string) FixturePreparer {
- return FixtureAddTextFile("Android.bp", contents)
- }
- // Merge some environment variables into the fixture.
- func FixtureMergeEnv(env map[string]string) FixturePreparer {
- return FixtureModifyConfig(func(config Config) {
- for k, v := range env {
- if k == "PATH" {
- panic("Cannot set PATH environment variable")
- }
- config.env[k] = v
- }
- })
- }
- // Modify the env.
- //
- // Will panic if the mutator changes the PATH environment variable.
- func FixtureModifyEnv(mutator func(env map[string]string)) FixturePreparer {
- return FixtureModifyConfig(func(config Config) {
- oldPath := config.env["PATH"]
- mutator(config.env)
- newPath := config.env["PATH"]
- if newPath != oldPath {
- panic(fmt.Errorf("Cannot change PATH environment variable from %q to %q", oldPath, newPath))
- }
- })
- }
- // Allow access to the product variables when preparing the fixture.
- type FixtureProductVariables struct {
- *productVariables
- }
- // Modify product variables.
- func FixtureModifyProductVariables(mutator func(variables FixtureProductVariables)) FixturePreparer {
- return FixtureModifyConfig(func(config Config) {
- productVariables := FixtureProductVariables{&config.productVariables}
- mutator(productVariables)
- })
- }
- var PrepareForSkipTestOnMac = newSimpleFixturePreparer(func(fixture *fixture) {
- if runtime.GOOS != "linux" {
- fixture.t.Skip("Test is only supported on linux.")
- }
- })
- // PrepareForDebug_DO_NOT_SUBMIT puts the fixture into debug which will cause it to output its
- // state before running the test.
- //
- // This must only be added temporarily to a test for local debugging and must be removed from the
- // test before submitting.
- var PrepareForDebug_DO_NOT_SUBMIT = newSimpleFixturePreparer(func(fixture *fixture) {
- fixture.debug = true
- })
- // GroupFixturePreparers creates a composite FixturePreparer that is equivalent to applying each of
- // the supplied FixturePreparer instances in order.
- //
- // Before preparing the fixture the list of preparers is flattened by replacing each
- // instance of GroupFixturePreparers with its contents.
- func GroupFixturePreparers(preparers ...FixturePreparer) FixturePreparer {
- all := dedupAndFlattenPreparers(nil, preparers)
- return newFixturePreparer(all)
- }
- // NullFixturePreparer is a preparer that does nothing.
- var NullFixturePreparer = GroupFixturePreparers()
- // OptionalFixturePreparer will return the supplied preparer if it is non-nil, otherwise it will
- // return the NullFixturePreparer
- func OptionalFixturePreparer(preparer FixturePreparer) FixturePreparer {
- if preparer == nil {
- return NullFixturePreparer
- } else {
- return preparer
- }
- }
- // FixturePreparer provides the ability to create, modify and then run tests within a fixture.
- type FixturePreparer interface {
- // Return the flattened and deduped list of simpleFixturePreparer pointers.
- list() []*simpleFixturePreparer
- // Create a Fixture.
- Fixture(t *testing.T) Fixture
- // ExtendWithErrorHandler creates a new FixturePreparer that will use the supplied error handler
- // to check the errors (may be 0) reported by the test.
- //
- // The default handlers is FixtureExpectsNoErrors which will fail the go test immediately if any
- // errors are reported.
- ExtendWithErrorHandler(errorHandler FixtureErrorHandler) FixturePreparer
- // Run the test, checking any errors reported and returning a TestResult instance.
- //
- // Shorthand for Fixture(t).RunTest()
- RunTest(t *testing.T) *TestResult
- // RunTestWithCustomResult runs the test just as RunTest(t) does but instead of returning a
- // *TestResult it returns the CustomTestResult that was returned by the custom
- // FixtureTestRunner.PostParseProcessor method that ran the test, or the *TestResult if that
- // method returned nil.
- //
- // This method must be used when needing to access custom data collected by the
- // FixtureTestRunner.PostParseProcessor method.
- //
- // e.g. something like this
- //
- // preparers := ...FixtureSetTestRunner(&myTestRunner)...
- // customResult := preparers.RunTestWithCustomResult(t).(*myCustomTestResult)
- // doSomething(customResult.data)
- RunTestWithCustomResult(t *testing.T) CustomTestResult
- // Run the test with the supplied Android.bp file.
- //
- // preparer.RunTestWithBp(t, bp) is shorthand for
- // android.GroupFixturePreparers(preparer, android.FixtureWithRootAndroidBp(bp)).RunTest(t)
- RunTestWithBp(t *testing.T, bp string) *TestResult
- // RunTestWithConfig is a temporary method added to help ease the migration of existing tests to
- // the test fixture.
- //
- // In order to allow the Config object to be customized separately to the TestContext a lot of
- // existing test code has `test...WithConfig` funcs that allow the Config object to be supplied
- // from the test and then have the TestContext created and configured automatically. e.g.
- // testCcWithConfig, testCcErrorWithConfig, testJavaWithConfig, etc.
- //
- // This method allows those methods to be migrated to use the test fixture pattern without
- // requiring that every test that uses those methods be migrated at the same time. That allows
- // those tests to benefit from correctness in the order of registration quickly.
- //
- // This method discards the config (along with its mock file system, product variables,
- // environment, etc.) that may have been set up by FixturePreparers.
- //
- // deprecated
- RunTestWithConfig(t *testing.T, config Config) *TestResult
- }
- // dedupAndFlattenPreparers removes any duplicates and flattens any composite FixturePreparer
- // instances.
- //
- // base - a list of already flattened and deduped preparers that will be applied first before
- //
- // the list of additional preparers. Any duplicates of these in the additional preparers
- // will be ignored.
- //
- // preparers - a list of additional unflattened, undeduped preparers that will be applied after the
- //
- // base preparers.
- //
- // Returns a deduped and flattened list of the preparers starting with the ones in base with any
- // additional ones from the preparers list added afterwards.
- func dedupAndFlattenPreparers(base []*simpleFixturePreparer, preparers []FixturePreparer) []*simpleFixturePreparer {
- if len(preparers) == 0 {
- return base
- }
- list := make([]*simpleFixturePreparer, len(base))
- visited := make(map[*simpleFixturePreparer]struct{})
- // Mark the already flattened and deduped preparers, if any, as having been seen so that
- // duplicates of these in the additional preparers will be discarded. Add them to the output
- // list.
- for i, s := range base {
- visited[s] = struct{}{}
- list[i] = s
- }
- for _, p := range preparers {
- for _, s := range p.list() {
- if _, seen := visited[s]; !seen {
- visited[s] = struct{}{}
- list = append(list, s)
- }
- }
- }
- return list
- }
- // compositeFixturePreparer is a FixturePreparer created from a list of fixture preparers.
- type compositeFixturePreparer struct {
- baseFixturePreparer
- // The flattened and deduped list of simpleFixturePreparer pointers encapsulated within this
- // composite preparer.
- preparers []*simpleFixturePreparer
- }
- func (c *compositeFixturePreparer) list() []*simpleFixturePreparer {
- return c.preparers
- }
- func newFixturePreparer(preparers []*simpleFixturePreparer) FixturePreparer {
- if len(preparers) == 1 {
- return preparers[0]
- }
- p := &compositeFixturePreparer{
- preparers: preparers,
- }
- p.initBaseFixturePreparer(p)
- return p
- }
- // simpleFixturePreparer is a FixturePreparer that applies a function to a fixture.
- type simpleFixturePreparer struct {
- baseFixturePreparer
- function func(fixture *fixture)
- }
- func (s *simpleFixturePreparer) list() []*simpleFixturePreparer {
- return []*simpleFixturePreparer{s}
- }
- func newSimpleFixturePreparer(preparer func(fixture *fixture)) FixturePreparer {
- p := &simpleFixturePreparer{function: preparer}
- p.initBaseFixturePreparer(p)
- return p
- }
- // FixtureErrorHandler determines how to respond to errors reported by the code under test.
- //
- // Some possible responses:
- // - Fail the test if any errors are reported, see FixtureExpectsNoErrors.
- // - Fail the test if at least one error that matches a pattern is not reported see
- // FixtureExpectsAtLeastOneErrorMatchingPattern
- // - Fail the test if any unexpected errors are reported.
- //
- // Although at the moment all the error handlers are implemented as simply a wrapper around a
- // function this is defined as an interface to allow future enhancements, e.g. provide different
- // ways other than patterns to match an error and to combine handlers together.
- type FixtureErrorHandler interface {
- // CheckErrors checks the errors reported.
- //
- // The supplied result can be used to access the state of the code under test just as the main
- // body of the test would but if any errors other than ones expected are reported the state may
- // be indeterminate.
- CheckErrors(t *testing.T, result *TestResult)
- }
- type simpleErrorHandler struct {
- function func(t *testing.T, result *TestResult)
- }
- func (h simpleErrorHandler) CheckErrors(t *testing.T, result *TestResult) {
- t.Helper()
- h.function(t, result)
- }
- // The default fixture error handler.
- //
- // Will fail the test immediately if any errors are reported.
- //
- // If the test fails this handler will call `result.FailNow()` which will exit the goroutine within
- // which the test is being run which means that the RunTest() method will not return.
- var FixtureExpectsNoErrors = FixtureCustomErrorHandler(
- func(t *testing.T, result *TestResult) {
- t.Helper()
- FailIfErrored(t, result.Errs)
- },
- )
- // FixtureIgnoreErrors ignores any errors.
- //
- // If this is used then it is the responsibility of the test to check the TestResult.Errs does not
- // contain any unexpected errors.
- var FixtureIgnoreErrors = FixtureCustomErrorHandler(func(t *testing.T, result *TestResult) {
- // Ignore the errors
- })
- // FixtureExpectsAtLeastOneMatchingError returns an error handler that will cause the test to fail
- // if at least one error that matches the regular expression is not found.
- //
- // The test will be failed if:
- // * No errors are reported.
- // * One or more errors are reported but none match the pattern.
- //
- // The test will not fail if:
- // * Multiple errors are reported that do not match the pattern as long as one does match.
- //
- // If the test fails this handler will call `result.FailNow()` which will exit the goroutine within
- // which the test is being run which means that the RunTest() method will not return.
- func FixtureExpectsAtLeastOneErrorMatchingPattern(pattern string) FixtureErrorHandler {
- return FixtureCustomErrorHandler(func(t *testing.T, result *TestResult) {
- t.Helper()
- if !FailIfNoMatchingErrors(t, pattern, result.Errs) {
- t.FailNow()
- }
- })
- }
- // FixtureExpectsOneErrorToMatchPerPattern returns an error handler that will cause the test to fail
- // if there are any unexpected errors.
- //
- // The test will be failed if:
- // * The number of errors reported does not exactly match the patterns.
- // * One or more of the reported errors do not match a pattern.
- // * No patterns are provided and one or more errors are reported.
- //
- // The test will not fail if:
- // * One or more of the patterns does not match an error.
- //
- // If the test fails this handler will call `result.FailNow()` which will exit the goroutine within
- // which the test is being run which means that the RunTest() method will not return.
- func FixtureExpectsAllErrorsToMatchAPattern(patterns []string) FixtureErrorHandler {
- return FixtureCustomErrorHandler(func(t *testing.T, result *TestResult) {
- t.Helper()
- CheckErrorsAgainstExpectations(t, result.Errs, patterns)
- })
- }
- // FixtureExpectsOneErrorPattern returns an error handler that will cause the test to fail
- // if there is more than one error or the error does not match the pattern.
- //
- // If the test fails this handler will call `result.FailNow()` which will exit the goroutine within
- // which the test is being run which means that the RunTest() method will not return.
- func FixtureExpectsOneErrorPattern(pattern string) FixtureErrorHandler {
- return FixtureCustomErrorHandler(func(t *testing.T, result *TestResult) {
- t.Helper()
- CheckErrorsAgainstExpectations(t, result.Errs, []string{pattern})
- })
- }
- // FixtureCustomErrorHandler creates a custom error handler
- func FixtureCustomErrorHandler(function func(t *testing.T, result *TestResult)) FixtureErrorHandler {
- return simpleErrorHandler{
- function: function,
- }
- }
- // Fixture defines the test environment.
- type Fixture interface {
- // Config returns the fixture's configuration.
- Config() Config
- // Context returns the fixture's test context.
- Context() *TestContext
- // MockFS returns the fixture's mock filesystem.
- MockFS() MockFS
- // Run the test, checking any errors reported and returning a TestResult instance.
- RunTest() CustomTestResult
- }
- // Struct to allow TestResult to embed a *TestContext and allow call forwarding to its methods.
- type testContext struct {
- *TestContext
- }
- // The result of running a test.
- type TestResult struct {
- testContext
- fixture *fixture
- Config Config
- // The errors that were reported during the test.
- Errs []error
- // The ninja deps is a list of the ninja files dependencies that were added by the modules and
- // singletons via the *.AddNinjaFileDeps() methods.
- NinjaDeps []string
- }
- func (r *TestResult) testResult() *TestResult { return r }
- // CustomTestResult is the interface that FixtureTestRunner implementations who wish to return
- // custom data must implement. It must embed *TestResult and initialize that to the value passed
- // into the method. It is returned from the FixtureTestRunner.FinalPreparer, passed into the
- // FixtureTestRunner.PostParseProcessor and returned from FixturePreparer.RunTestWithCustomResult.
- //
- // e.g. something like this:
- //
- // type myCustomTestResult struct {
- // *android.TestResult
- // data []string
- // }
- //
- // func (r *myTestRunner) FinalPreparer(result *TestResult) CustomTestResult {
- // ... do some final test preparation ...
- // return &myCustomTestResult{TestResult: result)
- // }
- //
- // func (r *myTestRunner) PostParseProcessor(result CustomTestResult) {
- // ...
- // myData := []string {....}
- // ...
- // customResult := result.(*myCustomTestResult)
- // customResult.data = myData
- // }
- type CustomTestResult interface {
- // testResult returns the embedded *TestResult.
- testResult() *TestResult
- }
- var _ CustomTestResult = (*TestResult)(nil)
- type TestPathContext struct {
- *TestResult
- }
- var _ PathContext = &TestPathContext{}
- func (t *TestPathContext) Config() Config {
- return t.TestResult.Config
- }
- func (t *TestPathContext) AddNinjaFileDeps(deps ...string) {
- panic("unimplemented")
- }
- func createFixture(t *testing.T, buildDir string, preparers []*simpleFixturePreparer) Fixture {
- config := TestConfig(buildDir, nil, "", nil)
- ctx := newTestContextForFixture(config)
- fixture := &fixture{
- preparers: preparers,
- t: t,
- config: config,
- ctx: ctx,
- mockFS: make(MockFS),
- // Set the default error handler.
- errorHandler: FixtureExpectsNoErrors,
- }
- for _, preparer := range preparers {
- preparer.function(fixture)
- }
- return fixture
- }
- type baseFixturePreparer struct {
- self FixturePreparer
- }
- func (b *baseFixturePreparer) initBaseFixturePreparer(self FixturePreparer) {
- b.self = self
- }
- func (b *baseFixturePreparer) Fixture(t *testing.T) Fixture {
- return createFixture(t, t.TempDir(), b.self.list())
- }
- func (b *baseFixturePreparer) ExtendWithErrorHandler(errorHandler FixtureErrorHandler) FixturePreparer {
- return GroupFixturePreparers(b.self, newSimpleFixturePreparer(func(fixture *fixture) {
- fixture.errorHandler = errorHandler
- }))
- }
- func (b *baseFixturePreparer) RunTest(t *testing.T) *TestResult {
- t.Helper()
- return b.RunTestWithCustomResult(t).testResult()
- }
- func (b *baseFixturePreparer) RunTestWithCustomResult(t *testing.T) CustomTestResult {
- t.Helper()
- fixture := b.self.Fixture(t)
- return fixture.RunTest()
- }
- func (b *baseFixturePreparer) RunTestWithBp(t *testing.T, bp string) *TestResult {
- t.Helper()
- return GroupFixturePreparers(b.self, FixtureWithRootAndroidBp(bp)).RunTest(t)
- }
- func (b *baseFixturePreparer) RunTestWithConfig(t *testing.T, config Config) *TestResult {
- t.Helper()
- // Create the fixture as normal.
- fixture := b.self.Fixture(t).(*fixture)
- // Discard the mock filesystem as otherwise that will override the one in the config.
- fixture.mockFS = nil
- // Replace the config with the supplied one in the fixture.
- fixture.config = config
- // Ditto with config derived information in the TestContext.
- ctx := fixture.ctx
- ctx.config = config
- ctx.SetFs(ctx.config.fs)
- if ctx.config.mockBpList != "" {
- ctx.SetModuleListFile(ctx.config.mockBpList)
- }
- return fixture.RunTest().testResult()
- }
- type fixture struct {
- // The preparers used to create this fixture.
- preparers []*simpleFixturePreparer
- // The test runner used in this fixture, defaults to defaultTestRunner if not set.
- testRunner FixtureTestRunner
- // The gotest state of the go test within which this was created.
- t *testing.T
- // The configuration prepared for this fixture.
- config Config
- // The test context prepared for this fixture.
- ctx *TestContext
- // The mock filesystem prepared for this fixture.
- mockFS MockFS
- // The error handler used to check the errors, if any, that are reported.
- errorHandler FixtureErrorHandler
- // Debug mode status
- debug bool
- }
- func (f *fixture) Config() Config {
- return f.config
- }
- func (f *fixture) Context() *TestContext {
- return f.ctx
- }
- func (f *fixture) MockFS() MockFS {
- return f.mockFS
- }
- func (f *fixture) RunTest() CustomTestResult {
- f.t.Helper()
- // If in debug mode output the state of the fixture before running the test.
- if f.debug {
- f.outputDebugState()
- }
- ctx := f.ctx
- // Do not use the fixture's mockFS to initialize the config's mock file system if it has been
- // cleared by RunTestWithConfig.
- if f.mockFS != nil {
- // The TestConfig() method assumes that the mock filesystem is available when creating so
- // creates the mock file system immediately. Similarly, the NewTestContext(Config) method
- // assumes that the supplied Config's FileSystem has been properly initialized before it is
- // called and so it takes its own reference to the filesystem. However, fixtures create the
- // Config and TestContext early so they can be modified by preparers at which time the mockFS
- // has not been populated (because it too is modified by preparers). So, this reinitializes the
- // Config and TestContext's FileSystem using the now populated mockFS.
- f.config.mockFileSystem("", f.mockFS)
- ctx.SetFs(ctx.config.fs)
- if ctx.config.mockBpList != "" {
- ctx.SetModuleListFile(ctx.config.mockBpList)
- }
- }
- // Create and set the Context's NameInterface. It needs to be created here as it depends on the
- // configuration that has been prepared for this fixture.
- resolver := NewNameResolver(ctx.config)
- // Set the NameInterface in the main Context.
- ctx.SetNameInterface(resolver)
- // Set the NameResolver in the TestContext.
- ctx.NameResolver = resolver
- // If test runner has not been set then use the default runner.
- if f.testRunner == nil {
- f.testRunner = defaultTestRunner
- }
- // Create the result to collate result information.
- result := &TestResult{
- testContext: testContext{ctx},
- fixture: f,
- Config: f.config,
- }
- // Do any last minute preparation before parsing the blueprint files.
- customResult := f.testRunner.FinalPreparer(result)
- // Parse the blueprint files adding the information to the result.
- extraNinjaDeps, errs := ctx.ParseBlueprintsFiles("ignored")
- result.NinjaDeps = append(result.NinjaDeps, extraNinjaDeps...)
- result.Errs = append(result.Errs, errs...)
- if len(result.Errs) == 0 {
- // If parsing the blueprint files was successful then perform any additional processing.
- f.testRunner.PostParseProcessor(customResult)
- }
- f.errorHandler.CheckErrors(f.t, result)
- return customResult
- }
- // standardTestRunner is the implementation of the default test runner
- type standardTestRunner struct{}
- func (s *standardTestRunner) FinalPreparer(result *TestResult) CustomTestResult {
- // Register the hard coded mutators and singletons used by the standard Soong build as well as
- // any additional instances that have been registered with this fixture.
- result.TestContext.Register()
- return result
- }
- func (s *standardTestRunner) PostParseProcessor(customResult CustomTestResult) {
- result := customResult.(*TestResult)
- ctx := result.TestContext
- cfg := result.Config
- // Prepare the build actions, i.e. run all the mutators, singletons and then invoke the
- // GenerateAndroidBuildActions methods on all the modules.
- extraNinjaDeps, errs := ctx.PrepareBuildActions(cfg)
- result.NinjaDeps = append(result.NinjaDeps, extraNinjaDeps...)
- result.CollateErrs(errs)
- }
- var defaultTestRunner FixtureTestRunner = &standardTestRunner{}
- func (f *fixture) outputDebugState() {
- fmt.Printf("Begin Fixture State for %s\n", f.t.Name())
- if len(f.config.env) == 0 {
- fmt.Printf(" Fixture Env is empty\n")
- } else {
- fmt.Printf(" Begin Env\n")
- for k, v := range f.config.env {
- fmt.Printf(" - %s=%s\n", k, v)
- }
- fmt.Printf(" End Env\n")
- }
- if len(f.mockFS) == 0 {
- fmt.Printf(" Mock FS is empty\n")
- } else {
- fmt.Printf(" Begin Mock FS Contents\n")
- for p, c := range f.mockFS {
- if c == nil {
- fmt.Printf("\n - %s: nil\n", p)
- } else {
- contents := string(c)
- separator := " ========================================================================"
- fmt.Printf(" - %s\n%s\n", p, separator)
- for i, line := range strings.Split(contents, "\n") {
- fmt.Printf(" %6d: %s\n", i+1, line)
- }
- fmt.Printf("%s\n", separator)
- }
- }
- fmt.Printf(" End Mock FS Contents\n")
- }
- fmt.Printf("End Fixture State for %s\n", f.t.Name())
- }
- // NormalizePathForTesting removes the test invocation specific build directory from the supplied
- // path.
- //
- // If the path is within the build directory (e.g. an OutputPath) then this returns the relative
- // path to avoid tests having to deal with the dynamically generated build directory.
- //
- // Otherwise, this returns the supplied path as it is almost certainly a source path that is
- // relative to the root of the source tree.
- //
- // Even though some information is removed from some paths and not others it should be possible to
- // differentiate between them by the paths themselves, e.g. output paths will likely include
- // ".intermediates" but source paths won't.
- func (r *TestResult) NormalizePathForTesting(path Path) string {
- pathContext := PathContextForTesting(r.Config)
- pathAsString := path.String()
- if rel, isRel := MaybeRel(pathContext, r.Config.SoongOutDir(), pathAsString); isRel {
- return rel
- }
- return pathAsString
- }
- // NormalizePathsForTesting normalizes each path in the supplied list and returns their normalized
- // forms.
- func (r *TestResult) NormalizePathsForTesting(paths Paths) []string {
- var result []string
- for _, path := range paths {
- result = append(result, r.NormalizePathForTesting(path))
- }
- return result
- }
- // Preparer will return a FixturePreparer encapsulating all the preparers used to create the fixture
- // that produced this result.
- //
- // e.g. assuming that this result was created by running:
- //
- // GroupFixturePreparers(preparer1, preparer2, preparer3).RunTest(t)
- //
- // Then this method will be equivalent to running:
- //
- // GroupFixturePreparers(preparer1, preparer2, preparer3)
- //
- // This is intended for use by tests whose output is Android.bp files to verify that those files
- // are valid, e.g. tests of the snapshots produced by the sdk module type.
- func (r *TestResult) Preparer() FixturePreparer {
- return newFixturePreparer(r.fixture.preparers)
- }
- // Module returns the module with the specific name and of the specified variant.
- func (r *TestResult) Module(name string, variant string) Module {
- return r.ModuleForTests(name, variant).Module()
- }
- // CollateErrs adds additional errors to the result and returns true if there is more than one
- // error in the result.
- func (r *TestResult) CollateErrs(errs []error) bool {
- r.Errs = append(r.Errs, errs...)
- return len(r.Errs) > 0
- }
|