|
| 1 | +package state_test |
| 2 | + |
| 3 | +import ( |
| 4 | + "errors" |
| 5 | + "strings" |
| 6 | + "testing" |
| 7 | + "time" |
| 8 | + |
| 9 | + "github.com/stablekernel/crucible/state" |
| 10 | +) |
| 11 | + |
| 12 | +// TestTypedErrors_Messages asserts every typed kernel error renders a non-empty, |
| 13 | +// self-describing message that names the offending entity. These are the |
| 14 | +// diagnostic surface a host logs and matches on, so the messages are part of the |
| 15 | +// contract. |
| 16 | +func TestTypedErrors_Messages(t *testing.T) { |
| 17 | + cases := []struct { |
| 18 | + name string |
| 19 | + err error |
| 20 | + contains []string |
| 21 | + }{ |
| 22 | + { |
| 23 | + name: "InvalidTransition with target", |
| 24 | + err: &state.InvalidTransitionError{From: "a", To: "b", Event: "go", Reason: "guard failed"}, |
| 25 | + contains: []string{"invalid transition", "a", "b", "go", "guard failed"}, |
| 26 | + }, |
| 27 | + { |
| 28 | + name: "InvalidTransition without target", |
| 29 | + err: &state.InvalidTransitionError{From: "a", Event: "go", Reason: "no transition"}, |
| 30 | + contains: []string{"invalid transition", "a", "go", "no transition"}, |
| 31 | + }, |
| 32 | + { |
| 33 | + name: "GuardFailed", |
| 34 | + err: &state.GuardFailedError{GuardName: "isReady", Reason: "predicate returned false"}, |
| 35 | + contains: []string{"guard", "isReady", "predicate returned false"}, |
| 36 | + }, |
| 37 | + { |
| 38 | + name: "GuardPanic", |
| 39 | + err: &state.GuardPanicError{GuardName: "isReady", Recovered: "nil deref"}, |
| 40 | + contains: []string{"guard", "isReady", "panicked", "nil deref"}, |
| 41 | + }, |
| 42 | + { |
| 43 | + name: "AssignPanic", |
| 44 | + err: &state.AssignPanicError{AssignName: "fold", Recovered: "boom"}, |
| 45 | + contains: []string{"assign", "fold", "panicked", "boom"}, |
| 46 | + }, |
| 47 | + { |
| 48 | + name: "PolicyDenied", |
| 49 | + err: &state.PolicyDeniedError{PolicyName: "rbac", Reason: "no role"}, |
| 50 | + contains: []string{"policy", "rbac", "denied", "no role"}, |
| 51 | + }, |
| 52 | + { |
| 53 | + name: "UndeclaredState", |
| 54 | + err: &state.UndeclaredStateError{State: "ghost"}, |
| 55 | + contains: []string{"undeclared state", "ghost"}, |
| 56 | + }, |
| 57 | + { |
| 58 | + name: "UnboundRef", |
| 59 | + err: &state.UnboundRefError{Kind: "guard", Name: "g"}, |
| 60 | + contains: []string{"unbound", "guard", "g"}, |
| 61 | + }, |
| 62 | + { |
| 63 | + name: "MicrostepOverflow", |
| 64 | + err: &state.MicrostepOverflowError{Limit: 64, State: "loop"}, |
| 65 | + contains: []string{"run-to-completion", "64", "loop"}, |
| 66 | + }, |
| 67 | + { |
| 68 | + name: "NoPath", |
| 69 | + err: &state.NoPathError{From: "a", To: "z"}, |
| 70 | + contains: []string{"no path", "a", "z"}, |
| 71 | + }, |
| 72 | + { |
| 73 | + name: "WaitTimeout", |
| 74 | + err: &state.WaitTimeoutError{Machine: "m", Timeout: 5 * time.Second, Last: "idle"}, |
| 75 | + contains: []string{"WaitFor", "m", "5s", "idle"}, |
| 76 | + }, |
| 77 | + { |
| 78 | + name: "NoInitialState", |
| 79 | + err: &state.NoInitialStateError{Machine: "m"}, |
| 80 | + contains: []string{"cannot Cast", "m", "no CurrentStateFn"}, |
| 81 | + }, |
| 82 | + { |
| 83 | + name: "UnknownBuiltin", |
| 84 | + err: &state.UnknownBuiltinError{Name: "crucible.bogus"}, |
| 85 | + contains: []string{"unknown built-in action", "crucible.bogus"}, |
| 86 | + }, |
| 87 | + { |
| 88 | + name: "UnboundActor", |
| 89 | + err: &state.UnboundActorError{Name: "child"}, |
| 90 | + contains: []string{"unbound actor ref", "child"}, |
| 91 | + }, |
| 92 | + { |
| 93 | + name: "Snapshot with state", |
| 94 | + err: &state.SnapshotError{Op: "restore", State: "leaf", Reason: "not declared"}, |
| 95 | + contains: []string{"snapshot restore", "leaf", "not declared"}, |
| 96 | + }, |
| 97 | + { |
| 98 | + name: "Snapshot without state", |
| 99 | + err: &state.SnapshotError{Op: "marshal", Reason: "encode failed"}, |
| 100 | + contains: []string{"snapshot marshal", "encode failed"}, |
| 101 | + }, |
| 102 | + { |
| 103 | + name: "SnapshotVersion", |
| 104 | + err: &state.SnapshotVersionError{Kind: "machineVersion", Machine: "m", Got: "2", Want: "1", Reason: "major bump"}, |
| 105 | + contains: []string{"version mismatch", "machineVersion", "m", "2", "1", "major bump"}, |
| 106 | + }, |
| 107 | + { |
| 108 | + name: "UnsupportedSchema", |
| 109 | + err: &state.UnsupportedSchemaError{Got: "2.0", Supported: "1.0"}, |
| 110 | + contains: []string{"unsupported schema version", "2.0", "1.0"}, |
| 111 | + }, |
| 112 | + { |
| 113 | + name: "UnknownEffectKind", |
| 114 | + err: &state.UnknownEffectKindError{Kind: "foreign"}, |
| 115 | + contains: []string{"unknown effect kind", "foreign"}, |
| 116 | + }, |
| 117 | + } |
| 118 | + |
| 119 | + for _, tc := range cases { |
| 120 | + t.Run(tc.name, func(t *testing.T) { |
| 121 | + msg := tc.err.Error() |
| 122 | + if msg == "" { |
| 123 | + t.Fatal("error message is empty") |
| 124 | + } |
| 125 | + for _, want := range tc.contains { |
| 126 | + if !strings.Contains(msg, want) { |
| 127 | + t.Fatalf("message %q does not contain %q", msg, want) |
| 128 | + } |
| 129 | + } |
| 130 | + }) |
| 131 | + } |
| 132 | +} |
| 133 | + |
| 134 | +// TestActionFailedError_WrapsCause asserts ActionFailedError renders its context |
| 135 | +// and unwraps to the underlying cause for errors.Is / errors.As. |
| 136 | +func TestActionFailedError_WrapsCause(t *testing.T) { |
| 137 | + cause := errors.New("downstream boom") |
| 138 | + err := &state.ActionFailedError{TransitionName: "a->b", ActionName: "charge", Cause: cause} |
| 139 | + |
| 140 | + msg := err.Error() |
| 141 | + for _, want := range []string{"action", "charge", "a->b", "downstream boom"} { |
| 142 | + if !strings.Contains(msg, want) { |
| 143 | + t.Fatalf("message %q does not contain %q", msg, want) |
| 144 | + } |
| 145 | + } |
| 146 | + if !errors.Is(err, cause) { |
| 147 | + t.Fatal("ActionFailedError should unwrap to its cause") |
| 148 | + } |
| 149 | +} |
| 150 | + |
| 151 | +// TestMultiRegionError_AggregatesAndUnwraps asserts MultiRegionError renders each |
| 152 | +// region's message and exposes them for errors.As traversal. |
| 153 | +func TestMultiRegionError_AggregatesAndUnwraps(t *testing.T) { |
| 154 | + g := &state.GuardFailedError{GuardName: "g", Reason: "false"} |
| 155 | + a := &state.AssignPanicError{AssignName: "fold", Recovered: "boom"} |
| 156 | + err := &state.MultiRegionError{Errors: []error{g, a}} |
| 157 | + |
| 158 | + msg := err.Error() |
| 159 | + for _, want := range []string{"2 regions errored", "g", "fold"} { |
| 160 | + if !strings.Contains(msg, want) { |
| 161 | + t.Fatalf("message %q does not contain %q", msg, want) |
| 162 | + } |
| 163 | + } |
| 164 | + |
| 165 | + var gf *state.GuardFailedError |
| 166 | + if !errors.As(err, &gf) { |
| 167 | + t.Fatal("MultiRegionError should expose a *GuardFailedError via errors.As") |
| 168 | + } |
| 169 | + var ap *state.AssignPanicError |
| 170 | + if !errors.As(err, &ap) { |
| 171 | + t.Fatal("MultiRegionError should expose an *AssignPanicError via errors.As") |
| 172 | + } |
| 173 | +} |
0 commit comments