-
Notifications
You must be signed in to change notification settings - Fork 232
/
context_rest.go
620 lines (535 loc) · 14 KB
/
context_rest.go
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
package api
import (
"bytes"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"github.com/CircleCI-Public/circleci-cli/api/header"
"github.com/CircleCI-Public/circleci-cli/settings"
"github.com/CircleCI-Public/circleci-cli/version"
"github.com/pkg/errors"
)
// ContextRestClient communicates with the CircleCI REST API to ask questions
// about contexts. It satisfies api.ContextInterface.
type ContextRestClient struct {
token string
server string
client *http.Client
}
type listEnvironmentVariablesResponse struct {
Items []EnvironmentVariable
NextPageToken *string `json:"next_page_token"`
client *ContextRestClient
params *listEnvironmentVariablesParams
}
type listContextsResponse struct {
Items []Context
NextPageToken *string `json:"next_page_token"`
client *ContextRestClient
params *listContextsParams
}
type errorResponse struct {
Message *string `json:"message"`
}
type listContextsParams struct {
OwnerID *string
OwnerSlug *string
OwnerType *string
PageToken *string
}
type listEnvironmentVariablesParams struct {
ContextID *string
PageToken *string
}
func toSlug(vcs, org string) *string {
slug := fmt.Sprintf("%s/%s", vcs, org)
return &slug
}
// DeleteEnvironmentVariable deletes the environment variable in the context. It
// does not return an error if the environment variable did not exist.
func (c *ContextRestClient) DeleteEnvironmentVariable(contextID, variable string) error {
req, err := c.newDeleteEnvironmentVariableRequest(contextID, variable)
if err != nil {
return err
}
resp, err := c.client.Do(req)
if err != nil {
return err
}
bodyBytes, err := io.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return err
}
if resp.StatusCode != 200 {
var dest errorResponse
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return err
}
return errors.New(*dest.Message)
}
return nil
}
func (c *ContextRestClient) CreateContextWithOrgID(orgID *string, name string) error {
req, err := c.newCreateContextRequestWithOrgID(orgID, name)
if err != nil {
return err
}
resp, err := c.client.Do(req)
if err != nil {
return err
}
bodyBytes, err := io.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return err
}
if resp.StatusCode != 200 {
var dest errorResponse
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return err
}
return errors.New(*dest.Message)
}
var dest Context
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return err
}
return nil
}
// CreateContext creates a new context in the supplied organization.
func (c *ContextRestClient) CreateContext(vcs, org, name string) error {
req, err := c.newCreateContextRequest(vcs, org, name)
if err != nil {
return err
}
resp, err := c.client.Do(req)
if err != nil {
return err
}
bodyBytes, err := io.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return err
}
if resp.StatusCode != 200 {
var dest errorResponse
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return err
}
return errors.New(*dest.Message)
}
var dest Context
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return err
}
return nil
}
// CreateEnvironmentVariable creates OR UPDATES an environment variable.
func (c *ContextRestClient) CreateEnvironmentVariable(contextID, variable, value string) error {
req, err := c.newCreateEnvironmentVariableRequest(contextID, variable, value)
if err != nil {
return err
}
resp, err := c.client.Do(req)
if err != nil {
return err
}
bodyBytes, err := io.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return err
}
if resp.StatusCode != 200 {
var dest errorResponse
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return err
}
return errors.New(*dest.Message)
}
return nil
}
// DeleteContext deletes the context with the given ID.
func (c *ContextRestClient) DeleteContext(contextID string) error {
req, err := c.newDeleteContextRequest(contextID)
if err != nil {
return err
}
resp, err := c.client.Do(req)
if err != nil {
return err
}
bodyBytes, err := io.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return err
}
if resp.StatusCode != 200 {
var dest errorResponse
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return err
}
return errors.New(*dest.Message)
}
return nil
}
// EnvironmentVariables returns all of the environment variables owned by the
// given context. Note that pagination is not currently supported - we get all
// pages of env vars and return them all.
func (c *ContextRestClient) EnvironmentVariables(contextID string) (*[]EnvironmentVariable, error) {
envVars, error := c.listAllEnvironmentVariables(
&listEnvironmentVariablesParams{
ContextID: &contextID,
},
)
return &envVars, error
}
// Contexts returns all of the contexts owned by the given org. Note that
// pagination is not currently supported - we get all pages of contexts and
// return them all.
func (c *ContextRestClient) Contexts(vcs, org string) (*[]Context, error) {
contexts, error := c.listAllContexts(
&listContextsParams{
OwnerSlug: toSlug(vcs, org),
},
)
return &contexts, error
}
// ContextByName finds a single context by its name and returns it.
func (c *ContextRestClient) ContextByName(vcs, org, name string) (*Context, error) {
params := &listContextsParams{
OwnerSlug: toSlug(vcs, org),
}
for {
resp, err := c.listContexts(params)
if err != nil {
return nil, err
}
for _, context := range resp.Items {
if context.Name == name {
return &context, nil
}
}
if resp.NextPageToken == nil {
return nil, fmt.Errorf("Cannot find context named '%s'", name)
}
params.PageToken = resp.NextPageToken
}
}
func (c *ContextRestClient) listAllEnvironmentVariables(params *listEnvironmentVariablesParams) (envVars []EnvironmentVariable, err error) {
var resp *listEnvironmentVariablesResponse
for {
resp, err = c.listEnvironmentVariables(params)
if err != nil {
return nil, err
}
envVars = append(envVars, resp.Items...)
if resp.NextPageToken == nil {
break
}
params.PageToken = resp.NextPageToken
}
return envVars, nil
}
func (c *ContextRestClient) listAllContexts(params *listContextsParams) (contexts []Context, err error) {
var resp *listContextsResponse
for {
resp, err = c.listContexts(params)
if err != nil {
return nil, err
}
contexts = append(contexts, resp.Items...)
if resp.NextPageToken == nil {
break
}
params.PageToken = resp.NextPageToken
}
return contexts, nil
}
func (c *ContextRestClient) listEnvironmentVariables(params *listEnvironmentVariablesParams) (*listEnvironmentVariablesResponse, error) {
req, err := c.newListEnvironmentVariablesRequest(params)
if err != nil {
return nil, err
}
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
bodyBytes, err := io.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return nil, err
}
if resp.StatusCode != 200 {
var dest errorResponse
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return nil, err
}
return nil, errors.New(*dest.Message)
}
dest := listEnvironmentVariablesResponse{
client: c,
params: params,
}
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return nil, err
}
return &dest, nil
}
func (c *ContextRestClient) listContexts(params *listContextsParams) (*listContextsResponse, error) {
req, err := c.newListContextsRequest(params)
if err != nil {
return nil, err
}
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
bodyBytes, err := io.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return nil, err
}
if resp.StatusCode != 200 {
var dest errorResponse
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return nil, err
}
return nil, errors.New(*dest.Message)
}
dest := listContextsResponse{
client: c,
params: params,
}
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return nil, err
}
return &dest, nil
}
// newCreateContextRequest posts a new context creation with orgname and vcs type using a slug
func (c *ContextRestClient) newCreateContextRequest(vcs, org, name string) (*http.Request, error) {
var err error
queryURL, err := url.Parse(c.server)
if err != nil {
return nil, err
}
queryURL, err = queryURL.Parse("context")
if err != nil {
return nil, err
}
var bodyReader io.Reader
var body = struct {
Name string `json:"name"`
Owner struct {
Slug *string `json:"slug,omitempty"`
} `json:"owner"`
}{
Name: name,
Owner: struct {
Slug *string `json:"slug,omitempty"`
}{
Slug: toSlug(vcs, org),
},
}
buf, err := json.Marshal(body)
if err != nil {
return nil, err
}
bodyReader = bytes.NewReader(buf)
return c.newHTTPRequest("POST", queryURL.String(), bodyReader)
}
// newCreateContextRequestWithOrgID posts a new context creation with an orgID
func (c *ContextRestClient) newCreateContextRequestWithOrgID(orgID *string, name string) (*http.Request, error) {
var err error
queryURL, err := url.Parse(c.server)
if err != nil {
return nil, err
}
queryURL, err = queryURL.Parse("context")
if err != nil {
return nil, err
}
var bodyReader io.Reader
var body = struct {
Name string `json:"name"`
Owner struct {
ID *string `json:"id,omitempty"`
} `json:"owner"`
}{
Name: name,
Owner: struct {
ID *string `json:"id,omitempty"`
}{
ID: orgID,
},
}
buf, err := json.Marshal(body)
if err != nil {
return nil, err
}
bodyReader = bytes.NewReader(buf)
return c.newHTTPRequest("POST", queryURL.String(), bodyReader)
}
func (c *ContextRestClient) newCreateEnvironmentVariableRequest(contextID, variable, value string) (*http.Request, error) {
var err error
queryURL, err := url.Parse(c.server)
if err != nil {
return nil, err
}
queryURL, err = queryURL.Parse(fmt.Sprintf("context/%s/environment-variable/%s", contextID, variable))
if err != nil {
return nil, err
}
var bodyReader io.Reader
body := struct {
Value string `json:"value"`
}{
Value: value,
}
buf, err := json.Marshal(body)
if err != nil {
return nil, err
}
bodyReader = bytes.NewReader(buf)
return c.newHTTPRequest("PUT", queryURL.String(), bodyReader)
}
func (c *ContextRestClient) newDeleteEnvironmentVariableRequest(contextID, name string) (*http.Request, error) {
var err error
queryURL, err := url.Parse(c.server)
if err != nil {
return nil, err
}
queryURL, err = queryURL.Parse(fmt.Sprintf("context/%s/environment-variable/%s", contextID, name))
if err != nil {
return nil, err
}
return c.newHTTPRequest("DELETE", queryURL.String(), nil)
}
func (c *ContextRestClient) newDeleteContextRequest(contextID string) (*http.Request, error) {
var err error
queryURL, err := url.Parse(c.server)
if err != nil {
return nil, err
}
queryURL, err = queryURL.Parse(fmt.Sprintf("context/%s", contextID))
if err != nil {
return nil, err
}
return c.newHTTPRequest("DELETE", queryURL.String(), nil)
}
func (c *ContextRestClient) newListEnvironmentVariablesRequest(params *listEnvironmentVariablesParams) (*http.Request, error) {
var err error
queryURL, err := url.Parse(c.server)
if err != nil {
return nil, err
}
queryURL, err = queryURL.Parse(fmt.Sprintf("context/%s/environment-variable", *params.ContextID))
if err != nil {
return nil, err
}
urlParams := url.Values{}
if params.PageToken != nil {
urlParams.Add("page-token", *params.PageToken)
}
queryURL.RawQuery = urlParams.Encode()
return c.newHTTPRequest("GET", queryURL.String(), nil)
}
func (c *ContextRestClient) newListContextsRequest(params *listContextsParams) (*http.Request, error) {
var err error
queryURL, err := url.Parse(c.server)
if err != nil {
return nil, err
}
queryURL, err = queryURL.Parse("context")
if err != nil {
return nil, err
}
urlParams := url.Values{}
if params.OwnerID != nil {
urlParams.Add("owner-id", *params.OwnerID)
}
if params.OwnerSlug != nil {
urlParams.Add("owner-slug", *params.OwnerSlug)
}
if params.OwnerType != nil {
urlParams.Add("owner-type", *params.OwnerType)
}
if params.PageToken != nil {
urlParams.Add("page-token", *params.PageToken)
}
queryURL.RawQuery = urlParams.Encode()
return c.newHTTPRequest("GET", queryURL.String(), nil)
}
func (c *ContextRestClient) newHTTPRequest(method, url string, body io.Reader) (*http.Request, error) {
req, err := http.NewRequest(method, url, body)
if err != nil {
return nil, err
}
if c.token != "" {
req.Header.Add("circle-token", c.token)
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Content-Type", "application/json")
req.Header.Add("User-Agent", version.UserAgent())
commandStr := header.GetCommandStr()
if commandStr != "" {
req.Header.Add("Circleci-Cli-Command", commandStr)
}
return req, nil
}
// EnsureExists verifies that the REST API exists and has the necessary
// endpoints to interact with contexts and env vars.
func (c *ContextRestClient) EnsureExists() error {
queryURL, err := url.Parse(c.server)
if err != nil {
return err
}
queryURL, err = queryURL.Parse("openapi.json")
if err != nil {
return err
}
req, err := c.newHTTPRequest("GET", queryURL.String(), nil)
if err != nil {
return err
}
resp, err := c.client.Do(req)
if err != nil {
return err
}
if resp.StatusCode != 200 {
return errors.New("API v2 test request failed.")
}
bodyBytes, err := io.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return err
}
var respBody struct {
Paths struct {
ContextEndpoint interface{} `json:"/context"`
}
}
if err := json.Unmarshal(bodyBytes, &respBody); err != nil {
return err
}
if respBody.Paths.ContextEndpoint == nil {
return errors.New("No context endpoint exists")
}
return nil
}
// NewContextRestClient returns a new client satisfying the api.ContextInterface
// interface via the REST API.
func NewContextRestClient(config settings.Config) (*ContextRestClient, error) {
serverURL, err := config.ServerURL()
if err != nil {
return nil, err
}
client := &ContextRestClient{
token: config.Token,
server: serverURL.String(),
client: config.HTTPClient,
}
return client, nil
}