Skip to content

Always move test outs even if there are test args or failures #3550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
toastwaffle merged 2 commits into from
Jul 21, 2026
+60 −20
Merged

Always move test outs even if there are test args or failures #3550

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
debbda8
Always move test outs even if there are test args or failures
chris-franklin Jul 21, 2026
506a420
Add e2e tests and treat movement of the test results file as caching
chris-franklin Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 30 additions & 20 deletions src/test/test_step.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,27 +94,14 @@ func test(state *core.BuildState, label core.BuildLabel, target *core.BuildTarge
return &results
}

moveAndCacheOutputFiles := func(results *core.TestSuite, coverage *core.TestCoverage) bool {
// Never cache test results when given arguments; the results may be incomplete.
if len(state.TestArgs) > 0 {
log.Debug("Not caching results for %s, we passed it arguments", label)
return true
}
// Never cache test results if there were failures (usually flaky tests).
if results.Failures() > 0 {
log.Debug("Not caching results for %s, test had failures", label)
return true
}
outs := []string{filepath.Base(target.TestResultsFile())}
if err := moveOutputFile(state, hash, outputFile, target.TestResultsFile(), dummyOutput); err != nil {
state.LogTestResult(target, run, core.TargetTestFailed, results, coverage, err, "Failed to move test output file")
return false
}
// This moves all files OTHER THAN the result file to the plz-out/bin dir.
moveOutputFiles := func(results *core.TestSuite, coverage *core.TestCoverage) []string {
outs := []string{}

if needCoverage || core.PathExists(coverageFile) {
if err := moveOutputFile(state, hash, coverageFile, target.CoverageFile(), dummyCoverage); err != nil {
state.LogTestResult(target, run, core.TargetTestFailed, results, coverage, err, "Failed to move test coverage file")
return false
return nil
}
outs = append(outs, filepath.Base(target.CoverageFile()))
}
Expand All @@ -123,12 +110,33 @@ func test(state *core.BuildState, label core.BuildLabel, target *core.BuildTarge
outFile := filepath.Join(target.OutDir(), output)
if err := moveOutputFile(state, hash, tmpFile, outFile, ""); err != nil {
state.LogTestResult(target, run, core.TargetTestFailed, results, coverage, err, "Failed to move test output file")
return false
return nil
}
outs = append(outs, output)
}
return outs
}

cacheOutputFiles := func(results *core.TestSuite, coverage *core.TestCoverage, outs []string) bool {
// Never cache test results when given arguments; the results may be incomplete.
if len(state.TestArgs) > 0 {
log.Debug("Not caching results for %s, we passed it arguments", label)
return false
}
// Never cache test results if there were failures (usually flaky tests).
if results.Failures() > 0 {
log.Debug("Not caching results for %s, test had failures", label)
return false
}

// The test result file is moved here rather than in moveOutputFiles because it is
// effectively a cache of the test result.
if err := moveOutputFile(state, hash, outputFile, target.TestResultsFile(), dummyOutput); err != nil {
state.LogTestResult(target, run, core.TargetTestFailed, results, coverage, err, "Failed to move test output file")
return false
}
if state.Cache != nil && !runRemotely {
state.Cache.Store(target, hash, outs)
state.Cache.Store(target, hash, append(outs, filepath.Base(target.TestResultsFile())))
}
return true
}
Expand Down Expand Up @@ -189,9 +197,11 @@ func test(state *core.BuildState, label core.BuildLabel, target *core.BuildTarge
results, coverage = doFlakeRun(state, target, run, runRemotely)
target.AddTestResults(results)

outs := moveOutputFiles(target.Test.Results, coverage)

if target.Test.Results.TestCases.AllSucceeded() {
// Success, store in cache
moveAndCacheOutputFiles(target.Test.Results, coverage)
cacheOutputFiles(target.Test.Results, coverage, outs)
}
} else if state.TestSequentially {
for run := 1; run <= int(state.NumTestRuns); run++ {
Expand Down
30 changes: 30 additions & 0 deletions test/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,43 @@ gentest(
test_cmd = "cp $(location test_output_test_2.xml) test.results",
)

# Test that when test arguments are supplied, other output files are still moved to bin/.
plz_e2e_test(
name = "test_outputs_move_test",
cmd = "plz test //test:test_outputs_move_test_case -- some_test_arg",
expect_output_contains = "4 passed.",
expect_file_exists = "plz-out/bin/test/foo.txt",
)

gentest(
name = "test_outputs_move_test_case",
data = ["test_output_test_1.txt"],
labels = ["manual"],
test_outputs = ["foo.txt"],
test_cmd = "cp $(location test_output_test_1.txt) test.results && echo 'hello' > foo.txt #",
)

# Test that on re-running a test it is cached.
plz_e2e_test(
name = "test_caching_test",
cmd = "plz test //test:caching_test && plz test -v 4 //test:caching_test",
expect_output_contains = "Not re-running test //test:caching_test",
)

# Test that on running a test with args, it is NOT cached.
plz_e2e_test(
name = "test_nocache_with_args_test",
cmd = "plz test --rerun //test:nocache_test -- some_arg && plz test -v 4 //test:nocache_test",
expect_output_doesnt_contain = "Not re-running test //test:nocache_test",
)

gentest(
name = "nocache_test",
labels = ["manual"],
no_test_output = True,
test_cmd = "true",
)

gentest(
name = "caching_test",
labels = ["manual"],
Expand Down
Loading