Add PrepareForDebug_DO_NOT_SUBMIT
Simplifies the process of debugging failing tests by making it easy for
the test fixture to produce debug output on a case by case basis.
Bug: 181070625
Test: m nothing
Change-Id: I22620a1bfb1737cffd017bdf7bbbfb609b60468c
diff --git a/android/fixture.go b/android/fixture.go
index 5fc668a..fd051a7 100644
--- a/android/fixture.go
+++ b/android/fixture.go
@@ -339,6 +339,15 @@
})
}
+// 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.
//
@@ -708,6 +717,9 @@
// 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 {
@@ -725,6 +737,11 @@
func (f *fixture) RunTest() *TestResult {
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
@@ -769,6 +786,39 @@
return result
}
+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.
//