diff --git a/checks/failurekit/failurekit.go b/checks/failurekit/failurekit.go index 968dca665..c5b7a7a45 100644 --- a/checks/failurekit/failurekit.go +++ b/checks/failurekit/failurekit.go @@ -5,7 +5,7 @@ // exempt from that, and said so. Every build module, test step or not, must also hold a test that calls // conformance.LeftRunning with its own start sweep, so a step a previous process left running is ended at its start // (issue 1890), and one that calls conformance.Passing, so a step whose network did not answer is said as a transport fault -// (issue 1748). +// (issue 1748). Its manifest asks the capability seat-settle-delay (ADR 0664 §5). package failurekit import ( @@ -14,6 +14,7 @@ import ( "io/fs" "os" "path/filepath" + "slices" "sort" "strings" ) @@ -28,9 +29,15 @@ type manifest struct { Claims []struct { Name string `json:"name"` } `json:"claims"` - Tools []json.RawMessage `json:"tools"` + Tools []json.RawMessage `json:"tools"` + Capabilities []string `json:"capabilities"` } +// settleDelay is the capability a tool runner states when it can settle a seat's ask with a delayed negative acknowledgement +// (mesh-sdk CapSeatSettleDelay): a build module gives its ask again after a delay by it, so the delivery plan places a tool +// runner that states it before the module (ADR 0664 §1, §5). +const settleDelay = "seat-settle-delay" + // Judge reads every modules//module.json of the catalogue at root and judges each module that claims a node-build-* // seat. func Judge(root string) ([]Judged, error) { @@ -94,6 +101,12 @@ func Judge(root string) ([]Judged, error) { refused = append(refused, fmt.Sprintf("it claims %s, and no test of it calls conformance.Passing "+ "(mesh-build-go buildstep/conformance): run the kit's passing case with the module's own path from a failed run to its step's error (issue 1748)", seat)) } + // Every build module gives a step that met a transport fault again by the bus (ADR 0664 §5): it asks the tool runner's + // capability in its manifest, so the delivery plan places a tool runner that states it first. + if !slices.Contains(m.Capabilities, settleDelay) { + refused = append(refused, fmt.Sprintf("it claims %s, and its manifest's capabilities do not ask %s: a step given again by the bus needs "+ + "a tool runner that can settle with a delay (ADR 0664 §5, issue 1748)", seat, settleDelay)) + } j.Refused = strings.Join(refused, "; ") out = append(out, j) } diff --git a/checks/failurekit/failurekit_test.go b/checks/failurekit/failurekit_test.go index 6d1f33f3b..f4467c85e 100644 --- a/checks/failurekit/failurekit_test.go +++ b/checks/failurekit/failurekit_test.go @@ -8,7 +8,8 @@ import ( // 1901/AC7 and 1890/AC8: a build module with a test step and no kit is refused, one that runs the kit passes, one with no // test step is exempt from the failure cases but not from the left-running case, a module that runs only the failure -// cases is refused, and a module that claims no node-build-* seat is not judged. +// cases is refused, a module that does not ask the capability seat-settle-delay is refused (ADR 0664 §5), and a module that +// claims no node-build-* seat is not judged. func TestABuildModuleWithATestStepMustRunTheKit(t *testing.T) { root := t.TempDir() const imp = "package main\n\nimport \"git.novox.be/novox/mesh-catalog/modules/mesh-build-go/buildstep/conformance\"\n\n" @@ -17,9 +18,9 @@ func TestABuildModuleWithATestStepMustRunTheKit(t *testing.T) { for path, body := range map[string]string{ "modules/a/module.json": `{"claims":[{"name":"node-build-a"}],"tools":["build_a_fetch","build_a_test"]}`, "modules/a/cmd/a/check_test.go": "package main\n", - "modules/b/module.json": `{"claims":[{"name":"node-build-b"}],"tools":[{"name":"build_b_test"}]}`, + "modules/b/module.json": `{"claims":[{"name":"node-build-b"}],"capabilities":["seat-settle-delay"],"tools":[{"name":"build_b_test"}]}`, "modules/b/cmd/b/kit_test.go": kit, - "modules/c/module.json": `{"claims":[{"name":"node-build-c"}],"tools":["build_c_build"]}`, + "modules/c/module.json": `{"claims":[{"name":"node-build-c"}],"capabilities":["seat-settle-delay"],"tools":["build_c_build"]}`, "modules/c/cmd/c/kit_test.go": imp + sweep, "modules/f/module.json": `{"claims":[{"name":"node-build-f"}],"tools":["build_f_build"]}`, "modules/g/module.json": `{"claims":[{"name":"node-build-g"}],"tools":["build_g_test"]}`, @@ -27,6 +28,8 @@ func TestABuildModuleWithATestStepMustRunTheKit(t *testing.T) { "modules/d/module.json": `{"claims":[{"name":"other"}],"tools":["d_test"]}`, "modules/h/module.json": `{"claims":[{"name":"node-build-h"}],"tools":["build_h_build"]}`, // the sweep, and no passing case "modules/h/cmd/h/kit_test.go": imp + "func TestSweep(t *testing.T) { conformance.LeftRunning(t, nil) }\n", + "modules/i/module.json": `{"claims":[{"name":"node-build-i"}],"capabilities":["other"],"tools":["build_i_build"]}`, // the whole kit, and no seat-settle-delay + "modules/i/cmd/i/kit_test.go": imp + sweep, "modules/e/module.json": `{"claims":[{"name":"node-build-e"}],"tools":["build_e_test"]}`, "modules/e/cmd/e/kit.go": kit, // not a test file } { @@ -42,9 +45,9 @@ func TestABuildModuleWithATestStepMustRunTheKit(t *testing.T) { if err != nil { t.Fatal(err) } - want := map[string]string{"a": "refused", "b": "passes", "c": "exempt", "e": "refused", "f": "refused", "g": "refused", "h": "refused"} + want := map[string]string{"a": "refused", "b": "passes", "c": "exempt", "e": "refused", "f": "refused", "g": "refused", "h": "refused", "i": "refused"} if len(got) != len(want) { - t.Fatalf("judged %+v, want a, b, c, e, f, g and h", got) + t.Fatalf("judged %+v, want a, b, c, e, f, g, h and i", got) } for _, j := range got { is := "passes"