beads/scripts/nogo_integration_step_script_test.go
Julian Knutsen 38c0f24adb
ci: F5 S2 Variant A — nogo ownership for the integration configuration group (#7486)
* ci: F5 S2 Variant A nogo ownership for the integration configuration group

No full Bazel lane validates the integration / doltserver-integration /
doltserver-cmd configurations anymore (all three now pass
--norun_validations). Instead bazel-integration gains a narrow "Nogo:
integration library files" step that keeps full nogo (vet + golangci-lint)
on the configuration's one non-test library package,
//internal/testutil/integration, via
`bazel build --config=integration --@rules_go//go/config:race --keep_going
--output_groups=nogo_fix -- //internal/testutil/integration:integration`.

This accepts a scoped coverage loss (f5-spec.md §3/§5 S2, Variant A): the 56
integration-tagged _test.go files (listed in
tools/nogo/unvalidated_integration_tests.txt, derived from source by the new
T4 test) no longer get a vet pass in any lane, since golangci-lint already
skips all _test.go files repo-wide (.golangci.yml's run.tests: false) and no
lane builds those test binaries with validations on. Verified directly with
real `bazel build` runs: a planted vet finding in the library package still
fails the new step; the same finding in an integration-tagged _test.go file
no longer fails anything; a planted finding in a plain race-configuration
library still fails bazel-test; and GoCompilePkg action keys for the
integration configuration are identical with and without
--norun_validations (it is a build-request option, not a configuration
flag, so no farm cache invalidation).

scripts/nogo_lint_policy_test.go: the nogoConfigurations table gains a
"integ" row with an ownerIsNogoOnlyStep flag and a dedicated
checkNogoOnlyStepRow, generalizing T1/T2/T5/T6 to cover an owner that is a
narrow build step rather than a full lane; adds T4
(TestNogoIntegrationStepCoversItsConfiguration), which derives the step's
expected target set from source via go/build's own tag matching instead of
a hardcoded list.

Also fixes four should-fix items from julianknutsen's review of #7482:
1. expandBazelrcConfig now follows `common:` lines and --config= tokens
   anywhere on a line, not just a first-position `build:`/`test:` one.
2. TestNogoRaceOwnerBuildsEverything now expands every config the owner job
   can reach (including shell-variable-gated ones like sole-run), not just
   the statically-named "ci".
3. The package-gate check now compares full key-flag fingerprints instead
   of substring-matching --@rules_go//go/config:race / --norun_validations.
4. tools/bazel/nogo_ownership.py now fails loudly (exit 2) when both the
   owner's and non-owners' action-key sets are empty, instead of reporting
   a vacuous pass.

Each fix has new mutation-test coverage in TestNogoPolicyRejectsMutations
(should-fixes 1-3) or nogo_ownership_test.py (should-fix 4).

engdocs/LINTING.md and engdocs/CI_REQUIRED_CHECK_TOPOLOGY.md updated to
remove the stale "integration still validates in all three lanes" claim and
document the Variant A trade-off.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* fix(ci): make T4's source scan work under Bazel, not just plain go test

scripts:scripts_test only declares //:repo_other_files as data (every
tracked file but Go and Markdown source, by design: a Go-only change
should not re-run the CI/workflow policy tests). TestNogoIntegrationStep
CoversItsConfiguration's source scan needs every non-test .go file, so
under `bazel test //scripts:scripts_test` its runfiles tree had none and
the scan always came back empty.

Fixes:
- scripts/BUILD.bazel: add //:repo_go_srcs to scripts_test's data, with a
  comment explaining why (this is the one test in the target that needs it).
- integrationOnlyLibraryPackages: use bazelPolicyRoot(t) + repoFiles(t, ...)
  (the existing Bazel-safe, runfiles-aware file listing other policy tests
  in this package already use) instead of sourceRepoRoot(t) +
  filepath.WalkDir, which only sees what //scripts's own go_test target
  declares.

Verified with real `bazel test --config=integration --@rules_go//go/config:race`
and `--config=ci --@rules_go//go/config:race` runs of //scripts:scripts_test
(both pass); CI caught the original gap (PR #7486's first push failed
Bazel / integration and Bazel / test with exactly this).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* fix(bazel): address independent review + bee-ghosttrack findings on F5 S2 Variant A

Independent review of #7486, must-fixes 1-7: pipefail on the nogo-only
step's tee pipeline; exact source-scan equality check for
tools/nogo/unvalidated_integration_tests.txt; expandBazelrcConfig
follows common:-lines and non-first-position --config= tokens in both
the Go policy test and nogo_ownership.py; mirrored
nogo_ownership.py should-fix guarding against a non-owner action-key
query silently matching nothing.

Cost fix: split T4/T6's whole-repo .go source scan into its own
go_test target (//scripts:nogo_integration_scan_test) so a Go-only
change no longer re-runs all of scripts_test; extracted the shared
bazelInvocations and ciWorkflow helpers into helper-only files so
both targets can depend on them without violating the
one-target-per-test-file partition rule.

bee-ghosttrack review: checkNogoOnlyStepRow's own fingerprint now
excludes test:-sourced .bazelrc lines pulled in via --config=X
(buildOrCommonLines), since the nogo-only step is a `bazel build`
invocation that never reads a test: line; added mutation s2i
reproducing the gap this closes.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

* fix(nogo): pin integration nogo-only step's target, fingerprint its lane, add behavioral test

Addresses the remaining should-fixes from the independent review of #7486:

1. TestNogoIntegrationStepScriptFailsWithoutMaskingBazelsExitCode
   (scripts/nogo_integration_step_script_test.go) extracts the real
   "Nogo: integration library files" step script from bazel.yml and runs it
   under plain `bash -e` (GitHub's actual run: semantics, no pipefail added)
   against a stub bazel, closing the gap a text-only pin can't: it catches
   rc=0 before `exit "$rc"`, `|| :`/`|| true` on the tee pipeline, or a
   missing/negated `set -o pipefail`, regardless of how the mutation is
   spelled.

2. The nogo-only step's target set is now pinned by exact go_library
   label, not just package: nogo_integration_scan_test.go derives the
   label(s) from source + BUILD.bazel and nogo_lint_policy_test.go pins
   them literally (its own go_test target has no //:repo_go_srcs). Both
   reject a `-//` exclusion pattern outright.

3. checkNonOwnerCommandLineAddsNoKeyFlag is now also applied to the
   integ row's owner's own full lane: under Variant A that lane validates
   nothing, so it is effectively a non-owner for this check's purpose, and
   must not override a key-affecting flag on its command line either.

4. Latent items: TestNoUnconditionalValidationOff now also scans
   .github/actions/setup-bazel/write-bazelrc.sh for run_validations (every
   line it emits lacks a :config suffix, so any occurrence would turn
   validation off everywhere with no owner lane to catch it).
   tools/bazel/nogo_ownership.py's docstring is corrected: it had said S2
   was simply "out of scope," which is now stale since S2 has its own
   validating lane (the nogo-only step, checked statically); the script's
   dynamic aquery-based cross-check remains S1-only because S2's owner has
   no non-owner test lane building the same configuration to compare
   actions against.

Skipped (not cheap / not reachable):
- bazel-server-storage's `if:` not modeling an "integration" input: no such
  input exists to model; the gate is RBE-enabled-only by design, and
  resolving this requires understanding pr.yml's broader gating semantics,
  not a textual fix.
- defaults.run.shell parsing: bazel.yml has no `defaults:` block today
  (confirmed by grep), so there is nothing to parse; the gap is latent only
  for a future change, not a live bug.
- race-off scan's future-wrong-fix edge case: the review itself
  characterizes this as not reachable with today's file set.

New mutation cases s2j/s2k/s2l in TestNogoPolicyRejectsMutations cover
items 2 and 3. All mutation-verifications performed by hand-editing the
real files, confirming FAIL, and reverting via Edit (never git
stash/checkout).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-10 23:19:16 +00:00

76 lines
3.5 KiB
Go

package scripts_test
import (
"fmt"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
)
// TestNogoIntegrationStepScriptFailsWithoutMaskingBazelsExitCode (independent
// review of #7486, should-fix 1): runs bazel-integration's "Nogo: integration
// library files" step's own script text -- extracted from bazel.yml, not
// reimplemented -- the way GitHub Actions actually runs a `run:` step with no
// `shell:` override: `bash --noprofile --norc -e {0}`. GitHub does not pass
// `-o pipefail` itself; the step's own `set -o pipefail` line is what makes
// its `bazel build | tee` pipeline report bazel's exit code instead of tee's,
// so this test must not add `-o pipefail` on the bash invocation either, or
// it would mask exactly the class of bug it exists to catch. That rules out
// reusing runRRCScript (bazel_rrc_test.go), whose own invocation always
// passes "-eo pipefail".
//
// scripts/*.go's own checks (checkNogoOnlyStepRow in nogo_lint_policy_test.go)
// pin the script's text -- "set -o pipefail" is present, no "|| true" on the
// tee pipeline, the last line is exactly `exit "$rc"` -- but a textual pin can
// miss a mutation its author did not anticipate (e.g. `rc=0` inserted right
// before the final `exit "$rc"`, which satisfies every one of those text pins
// while still always exiting 0). Running the real script end to end against a
// stub `bazel` closes that gap: it fails if the step ever stops propagating a
// real `bazel build` failure, regardless of how.
func TestNogoIntegrationStepScriptFailsWithoutMaskingBazelsExitCode(t *testing.T) {
workflow := readCIWorkflow(t, bazelWorkflowName)
step := workflow.job(t, bazelIntegJobName).step(t, "Nogo: integration library files")
if strings.TrimSpace(step.Run) == "" {
t.Fatal("bazel-integration has no \"Nogo: integration library files\" step with a run: script")
}
if got := nogoOnlyStepScriptExitCode(t, step.Run, 1); got == 0 {
t.Error("the step's real script exits 0 when `bazel build` exits 1 with a finding; CI would report this lane green despite a real nogo finding " +
"(e.g. a stray `rc=0` before `exit \"$rc\"`, `|| :` or `|| true` in place of `|| rc=$?`, or a missing/negated `set -o pipefail` would all produce this)")
}
if got := nogoOnlyStepScriptExitCode(t, step.Run, 0); got != 0 {
t.Errorf("the step's real script exits %d when `bazel build` exits 0 (no finding); want 0", got)
}
}
// nogoOnlyStepScriptExitCode runs script under bash with exactly the flags
// GitHub Actions uses for a plain `run:` step (no `shell:` override): `bash
// --noprofile --norc -e {0}`. It puts a stub `bazel` on PATH that prints a
// line a real nogo finding would produce and exits bazelExit, and returns the
// script's own exit code (-1 if bash itself could not be run, which should
// not happen with "bash" resolved from PATH).
func nogoOnlyStepScriptExitCode(t *testing.T, script string, bazelExit int) int {
t.Helper()
dir := t.TempDir()
bin := filepath.Join(dir, "bin")
if err := os.Mkdir(bin, 0o755); err != nil {
t.Fatal(err)
}
stub := fmt.Sprintf("#!/bin/sh\necho 'internal/testutil/integration/harness.go:1:1: fake nogo finding'\nexit %d\n", bazelExit)
if err := os.WriteFile(filepath.Join(bin, "bazel"), []byte(stub), 0o755); err != nil {
t.Fatal(err)
}
cmd := exec.Command("bash", "--noprofile", "--norc", "-e", "-c", script)
cmd.Dir = dir
cmd.Env = []string{
"PATH=" + bin + ":" + os.Getenv("PATH"),
"HOME=" + dir,
"RUNNER_TEMP=" + t.TempDir(),
"GITHUB_STEP_SUMMARY=" + filepath.Join(dir, "step-summary.txt"),
}
err := cmd.Run()
return exitCode(err)
}