src-cli/internal/api/errors_test.go at fcf3a8624ba38ea2ccfa53b6139f8cd3c8d23db2 · sourcegraph/src-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
package api

import (
	"encoding/json"
	"testing"
)

func TestGraphQLError_Code(t *testing.T) {
	for name, tc := range map[string]struct {
		in      string
		want    string
		wantErr bool
	}{
		"invalid code": {
			in: `{
				"errors": [
					{
						"message": "The feature \"campaigns\" is not activated because it requires a valid Sourcegraph license. Purchase a Sourcegraph subscription to activate this feature.",
						"path": [
							"createBatchSpec"
						],
						"extensions": {
							"code": 42
						}
					}
				],
				"data": null
			}`,
			wantErr: true,
		},
		"invalid extensions": {
			in: `{
				"errors": [
					{
						"message": "The feature \"campaigns\" is not activated because it requires a valid Sourcegraph license. Purchase a Sourcegraph subscription to activate this feature.",
						"path": [
							"createBatchSpec"
						],
						"extensions": 42
					}
				],
				"data": null
			}`,
			wantErr: true,
		},
		"no code": {
			in: `{
				"errors": [
					{
						"message": "The feature \"campaigns\" is not activated because it requires a valid Sourcegraph license. Purchase a Sourcegraph subscription to activate this feature.",
						"path": [
							"createBatchSpec"
						],
						"extensions": {}
					}
				],
				"data": null
			}`,
			want: "",
		},
		"no extensions": {
			in: `{
				"errors": [
					{
						"message": "The feature \"campaigns\" is not activated because it requires a valid Sourcegraph license. Purchase a Sourcegraph subscription to activate this feature.",
						"path": [
							"createBatchSpec"
						]
					}
				],
				"data": null
			}`,
			want: "",
		},
		"valid code": {
			in: `{
				"errors": [
					{
						"message": "The feature \"campaigns\" is not activated because it requires a valid Sourcegraph license. Purchase a Sourcegraph subscription to activate this feature.",
						"path": [
							"createBatchSpec"
						],
						"extensions": {
							"code": "ErrBatchChangesUnlicensed"
						}
					}
				],
				"data": null
			}`,
			want: "ErrBatchChangesUnlicensed",
		},
	} {
		t.Run(name, func(t *testing.T) {
			var result rawResult
			if err := json.Unmarshal([]byte(tc.in), &result); err != nil {
				t.Fatal(err)
			}
			if ne := len(result.Errors); ne != 1 {
				t.Fatalf("unexpected number of GraphQL errors (this test can only handle one!): %d", ne)
			}

			ge := &GraphQlError{result.Errors[0]}
			have, err := ge.Code()
			if tc.wantErr {
				if err == nil {
					t.Errorf("unexpected nil error")
				}
			} else {
				if err != nil {
					t.Errorf("unexpected error: %+v", err)
				}
				if have != tc.want {
					t.Errorf("unexpected code: have=%q want=%q", have, tc.want)
				}
			}
		})
	}

}

func TestGraphQLError_Message(t *testing.T) {
	for name, tc := range map[string]struct {
		in      string
		want    string
		wantErr bool
	}{
		"invalid message": {
			in: `{
				"errors": [
					{
						"message": 42
					}
				],
				"data": null
			}`,
			wantErr: true,
		},
		"no message": {
			in: `{
				"errors": [
					{
						"extensions": {
							"code": "ErrBatchChangesUnlicensed"
						}
					}
				],
				"data": null
			}`,
			want: "",
		},
		"valid message": {
			in: `{
				"errors": [
					{
						"message": "Cannot query field \"batchChanges\" on type \"Query\"."
					}
				],
				"data": null
			}`,
			want: `Cannot query field "batchChanges" on type "Query".`,
		},
	} {
		t.Run(name, func(t *testing.T) {
			var result rawResult
			if err := json.Unmarshal([]byte(tc.in), &result); err != nil {
				t.Fatal(err)
			}
			if ne := len(result.Errors); ne != 1 {
				t.Fatalf("unexpected number of GraphQL errors (this test can only handle one!): %d", ne)
			}

			ge := &GraphQlError{result.Errors[0]}
			have, err := ge.Message()
			if tc.wantErr {
				if err == nil {
					t.Errorf("unexpected nil error")
				}
			} else {
				if err != nil {
					t.Errorf("unexpected error: %+v", err)
				}
				if have != tc.want {
					t.Errorf("unexpected message: have=%q want=%q", have, tc.want)
				}
			}
		})
	}
}