|
| 1 | +package auth |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "errors" |
| 6 | + "os" |
| 7 | + "path/filepath" |
| 8 | + "testing" |
| 9 | +) |
| 10 | + |
| 11 | +// wantDiagnostic asserts that err carries a *Diagnostic with code and a |
| 12 | +// message, and returns it. |
| 13 | +func wantDiagnostic(t *testing.T, err error, code string) *Diagnostic { |
| 14 | + t.Helper() |
| 15 | + var d *Diagnostic |
| 16 | + if !errors.As(err, &d) { |
| 17 | + t.Fatalf("%v carries no Diagnostic", err) |
| 18 | + } |
| 19 | + if d.Code != code { |
| 20 | + t.Fatalf("code = %q, want %q (%v)", d.Code, code, err) |
| 21 | + } |
| 22 | + if d.Message == "" { |
| 23 | + t.Fatalf("%s has no message", code) |
| 24 | + } |
| 25 | + return d |
| 26 | +} |
| 27 | + |
| 28 | +// wantCode is wantDiagnostic for a test that needs only the code. |
| 29 | +func wantCode(t *testing.T, err error, code string) { |
| 30 | + t.Helper() |
| 31 | + _ = wantDiagnostic(t, err, code) |
| 32 | +} |
| 33 | + |
| 34 | +// Each kind the profile store reports is its sentinel for errors.Is and a |
| 35 | +// Diagnostic for errors.As. The strategies' kinds are asserted beside the |
| 36 | +// tests that provoke them, in strategy_test.go. ErrInvalidFilename is not |
| 37 | +// here: the store refuses every filename the guest would before asking it. |
| 38 | +func TestEachStoreKindCarriesItsDiagnostic(t *testing.T) { |
| 39 | + ctx := context.Background() |
| 40 | + dir, s := profile(t) |
| 41 | + ws, err := s.WorkspaceStore(ctx, wsB) |
| 42 | + if err != nil { |
| 43 | + t.Fatal(err) |
| 44 | + } |
| 45 | + cases := []struct { |
| 46 | + name string |
| 47 | + run func() error |
| 48 | + want error |
| 49 | + code string |
| 50 | + }{ |
| 51 | + {"no current workspace", func() error { |
| 52 | + _, err := s.CurrentWorkspace(ctx) |
| 53 | + return err |
| 54 | + }, ErrNoCurrentWorkspace, "stack_profile::no_current_workspace"}, |
| 55 | + {"a workspace with no directory", func() error { |
| 56 | + return s.SetCurrentWorkspace(ctx, "CCCCCCCCCCCCCCCC") |
| 57 | + }, ErrWorkspaceNotFound, "stack_profile::workspace_not_found"}, |
| 58 | + {"a workspace id that is a path", func() error { |
| 59 | + return s.SetCurrentWorkspace(ctx, "../escape") |
| 60 | + }, ErrInvalidWorkspaceID, "stack_profile::invalid_workspace_id"}, |
| 61 | + {"a file that is not there", func() error { |
| 62 | + _, err := ws.Token(ctx) |
| 63 | + return err |
| 64 | + }, ErrNotFound, "stack_profile::not_found"}, |
| 65 | + {"a file that is not JSON", func() error { |
| 66 | + write(t, filepath.Join(dir, "workspaces", wsB, "auth.json"), "{not json") |
| 67 | + _, err := ws.Token(ctx) |
| 68 | + return err |
| 69 | + }, ErrInvalid, "stack_profile::json"}, |
| 70 | + {"a file that is a directory", func() error { |
| 71 | + if err := os.MkdirAll(filepath.Join(dir, "workspaces", wsB, "secretkey.json"), 0o700); err != nil { |
| 72 | + t.Fatal(err) |
| 73 | + } |
| 74 | + _, _, err := ws.SecretKey(ctx) |
| 75 | + return err |
| 76 | + }, ErrIO, "stack_profile::io"}, |
| 77 | + } |
| 78 | + for _, tc := range cases { |
| 79 | + t.Run(tc.name, func(t *testing.T) { |
| 80 | + err := tc.run() |
| 81 | + if !errors.Is(err, tc.want) { |
| 82 | + t.Fatalf("%v, want %v", err, tc.want) |
| 83 | + } |
| 84 | + wantCode(t, err, tc.code) |
| 85 | + }) |
| 86 | + } |
| 87 | +} |
| 88 | + |
| 89 | +// A profile file that is not JSON says where: the line and column, never |
| 90 | +// the parser's message, which could quote the file. |
| 91 | +func TestAProfileJSONErrorNamesTheLine(t *testing.T) { |
| 92 | + ctx := context.Background() |
| 93 | + dir, s := profile(t) |
| 94 | + write(t, filepath.Join(dir, "workspaces", wsB, "auth.json"), "{\n \"access_token\": 7\n}") |
| 95 | + ws, err := s.WorkspaceStore(ctx, wsB) |
| 96 | + if err != nil { |
| 97 | + t.Fatal(err) |
| 98 | + } |
| 99 | + _, err = ws.Token(ctx) |
| 100 | + d := wantDiagnostic(t, err, "stack_profile::json") |
| 101 | + if d.Fields["line"] != uint64(2) { |
| 102 | + t.Errorf("fields = %v, want line 2", d.Fields) |
| 103 | + } |
| 104 | + if d.Help == "" { |
| 105 | + t.Error("a JSON error gives no help") |
| 106 | + } |
| 107 | +} |
0 commit comments