Repository navigation
feat(golang): every failure a guest reports is a Diagnostic that unwraps to its sentinel #1110
+1,067
−42
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| package auth | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "os" | ||
| "path/filepath" | ||
| "testing" | ||
| ) | ||
|
|
||
| // wantDiagnostic asserts that err carries a *Diagnostic with code and a | ||
| // message, and returns it. | ||
| func wantDiagnostic(t *testing.T, err error, code string) *Diagnostic { | ||
| t.Helper() | ||
| var d *Diagnostic | ||
| if !errors.As(err, &d) { | ||
| t.Fatalf("%v carries no Diagnostic", err) | ||
| } | ||
| if d.Code != code { | ||
| t.Fatalf("code = %q, want %q (%v)", d.Code, code, err) | ||
| } | ||
| if d.Message == "" { | ||
| t.Fatalf("%s has no message", code) | ||
| } | ||
| return d | ||
| } | ||
|
|
||
| // wantCode is wantDiagnostic for a test that needs only the code. | ||
| func wantCode(t *testing.T, err error, code string) { | ||
| t.Helper() | ||
| _ = wantDiagnostic(t, err, code) | ||
| } | ||
|
|
||
| // Each kind the profile store reports is its sentinel for errors.Is and a | ||
| // Diagnostic for errors.As. The strategies' kinds are asserted beside the | ||
| // tests that provoke them, in strategy_test.go. ErrInvalidFilename is not | ||
| // here: the store refuses every filename the guest would before asking it. | ||
| func TestEachStoreKindCarriesItsDiagnostic(t *testing.T) { | ||
| ctx := context.Background() | ||
| dir, s := profile(t) | ||
| ws, err := s.WorkspaceStore(ctx, wsB) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| cases := []struct { | ||
| name string | ||
| run func() error | ||
| want error | ||
| code string | ||
| }{ | ||
| {"no current workspace", func() error { | ||
| _, err := s.CurrentWorkspace(ctx) | ||
| return err | ||
| }, ErrNoCurrentWorkspace, "stack_profile::no_current_workspace"}, | ||
| {"a workspace with no directory", func() error { | ||
| return s.SetCurrentWorkspace(ctx, "CCCCCCCCCCCCCCCC") | ||
| }, ErrWorkspaceNotFound, "stack_profile::workspace_not_found"}, | ||
| {"a workspace id that is a path", func() error { | ||
| return s.SetCurrentWorkspace(ctx, "../escape") | ||
| }, ErrInvalidWorkspaceID, "stack_profile::invalid_workspace_id"}, | ||
| {"a file that is not there", func() error { | ||
| _, err := ws.Token(ctx) | ||
| return err | ||
| }, ErrNotFound, "stack_profile::not_found"}, | ||
| {"a file that is not JSON", func() error { | ||
| write(t, filepath.Join(dir, "workspaces", wsB, "auth.json"), "{not json") | ||
| _, err := ws.Token(ctx) | ||
| return err | ||
| }, ErrInvalid, "stack_profile::json"}, | ||
| {"a file that is a directory", func() error { | ||
| if err := os.MkdirAll(filepath.Join(dir, "workspaces", wsB, "secretkey.json"), 0o700); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| _, _, err := ws.SecretKey(ctx) | ||
| return err | ||
| }, ErrIO, "stack_profile::io"}, | ||
| } | ||
| for _, tc := range cases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| err := tc.run() | ||
| if !errors.Is(err, tc.want) { | ||
| t.Fatalf("%v, want %v", err, tc.want) | ||
| } | ||
| wantCode(t, err, tc.code) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| // A profile file that is not JSON says where: the line and column, never | ||
| // the parser's message, which could quote the file. | ||
| func TestAProfileJSONErrorNamesTheLine(t *testing.T) { | ||
| ctx := context.Background() | ||
| dir, s := profile(t) | ||
| write(t, filepath.Join(dir, "workspaces", wsB, "auth.json"), "{\n \"access_token\": 7\n}") | ||
| ws, err := s.WorkspaceStore(ctx, wsB) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| _, err = ws.Token(ctx) | ||
| d := wantDiagnostic(t, err, "stack_profile::json") | ||
| if d.Fields["line"] != uint64(2) { | ||
| t.Errorf("fields = %v, want line 2", d.Fields) | ||
| } | ||
| if d.Help == "" { | ||
| t.Error("a JSON error gives no help") | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| package encrypt | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
|
|
||
| "github.com/cipherstash/vitaminc/bindings/go/vcffi" | ||
| ) | ||
|
|
||
| // wantDiagnostic asserts that err carries a *Diagnostic with code and a | ||
| // message, and returns it. | ||
| func wantDiagnostic(t *testing.T, err error, code string) *Diagnostic { | ||
| t.Helper() | ||
| var d *Diagnostic | ||
| if !errors.As(err, &d) { | ||
| t.Fatalf("%v carries no Diagnostic", err) | ||
| } | ||
| if d.Code != code { | ||
| t.Fatalf("code = %q, want %q (%v)", d.Code, code, err) | ||
| } | ||
| if d.Message == "" { | ||
| t.Fatalf("%s has no message", code) | ||
| } | ||
| return d | ||
| } | ||
|
|
||
| // wantCode is wantDiagnostic for a test that needs only the code. | ||
| func wantCode(t *testing.T, err error, code string) { | ||
| t.Helper() | ||
| _ = wantDiagnostic(t, err, code) | ||
| } | ||
|
|
||
| // The guest's own refusals, which no ZeroKMS stub reaches: input that is | ||
| // not the codec, and an operation before init. | ||
| func TestGuestRefusalsCarryTheirDiagnostic(t *testing.T) { | ||
| ctx := context.Background() | ||
| c := rawInstance(t) | ||
| _, err := c.call(ctx, func(inst *instance) ([]byte, error) { | ||
| return inst.call(ctx, inst.planCheck, buf([]byte{0xff})) | ||
| }) | ||
| if !errors.Is(err, ErrEncoding) { | ||
| t.Fatalf("plan check of bytes that are not the codec: %v, want ErrEncoding", err) | ||
| } | ||
| wantCode(t, err, "stack_guest_abi::malformed_input") | ||
|
|
||
| selector, err := vcffi.Marshal(KeysetName("tenant-b").selector()) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| _, err = c.call(ctx, func(inst *instance) ([]byte, error) { | ||
| return inst.call(ctx, inst.keyset, buf(selector)) | ||
| }) | ||
| if !errors.Is(err, ErrState) { | ||
| t.Fatalf("a keyset before init: %v, want ErrState", err) | ||
| } | ||
| if d := wantDiagnostic(t, err, "stack_guest_abi::out_of_order"); d.Help == "" { | ||
| t.Error("an out-of-order call gives no help") | ||
| } | ||
| } | ||
|
|
||
| // A guest built before se_last_error fails as it always did: the bare | ||
| // sentinel, and nothing else. | ||
| func TestAGuestWithoutLastErrorFailsWithTheBareSentinel(t *testing.T) { | ||
| ctx := context.Background() | ||
| c := rawInstance(t) | ||
| c.inst.exports.LastError = nil | ||
| _, err := c.call(ctx, func(inst *instance) ([]byte, error) { | ||
| return inst.call(ctx, inst.planCheck, buf([]byte{0xff})) | ||
| }) | ||
| if err != ErrEncoding { | ||
| t.Fatalf("err = %#v, want the bare ErrEncoding", err) | ||
| } | ||
| var d *Diagnostic | ||
| if errors.As(err, &d) { | ||
| t.Fatalf("a Diagnostic from a guest with no se_last_error: %+v", d) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix in a follow-up: The malformed access key check at lines 457-460 does not check the
Diagnosticcode or look for the key text.Impact:
profile.AutosendsCS_CLIENT_ACCESS_KEYto the guest in the strategy config. The guest'screaterefuses a key that does not parse. This is the only guest call that receives an access key and fails before any HTTP request. If a later change puts the key text in that error, the text reachesDiagnostic.MessageorFields. No test fails.Evidence:
create, because theauthmodule exists only on wasm32 (auth/guest/src/lib.rs:101-102). So only this Go test runs the real code."not-a-key". It checks onlyerrors.Is(err, ErrConfig).wantCodecall. The access key check does not.Fix: Replace the check at lines 457-460 with the code below. The new code sets
CS_CLIENT_ACCESS_KEYto a marker string and callsprofile.Auto. It expectsErrConfig, codestack_auth::invalid_access_key, and no marker text in the error string or theDiagnostic.Before you paste the code, compare it with lines 457-460:
err =. Iferris not declared before this point, change it toerr :=.The code also calls a helper
wantDiagnostic(t, err, code). The helper must fail the test unlesserrcontains a*Diagnosticwith that code. It must return that*Diagnostic. If theauthtests have no helper with this name, add one next towantCode.Found by 1 model: claude