-
Notifications
You must be signed in to change notification settings - Fork 232
/
schedule_rest.go
487 lines (410 loc) · 11.7 KB
/
schedule_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
package api
import (
"bytes"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
"strings"
"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"
)
// Communicates with the CircleCI REST API to ask questions about
// schedules. It satisfies api.ScheduleInterface.
type ScheduleRestClient struct {
token string
server string
client *http.Client
}
type listSchedulesResponse struct {
Items []Schedule
NextPageToken *string `json:"next_page_token"`
client *ScheduleRestClient
params *listSchedulesParams
}
type listSchedulesParams struct {
PageToken *string
}
// Creates a new schedule in the supplied project.
func (c *ScheduleRestClient) CreateSchedule(vcs, org, project, name, description string,
useSchedulingSystem bool, timetable Timetable, parameters map[string]string) (*Schedule, error) {
req, err := c.newCreateScheduleRequest(vcs, org, project, name, description, useSchedulingSystem, timetable, parameters)
if err != nil {
return nil, err
}
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
bodyBytes, err := ioutil.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return nil, err
}
if resp.StatusCode != 201 {
var dest errorResponse
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return nil, err
}
return nil, errors.New(*dest.Message)
}
var schedule Schedule
if err := json.Unmarshal(bodyBytes, &schedule); err != nil {
return nil, err
}
return &schedule, nil
}
// Updates an existing schedule.
func (c *ScheduleRestClient) UpdateSchedule(scheduleID, name, description string,
useSchedulingSystem bool, timetable Timetable, parameters map[string]string) (*Schedule, error) {
req, err := c.newUpdateScheduleRequest(scheduleID, name, description, useSchedulingSystem, timetable, parameters)
if err != nil {
return nil, err
}
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
bodyBytes, err := ioutil.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)
}
var schedule Schedule
if err := json.Unmarshal(bodyBytes, &schedule); err != nil {
return nil, err
}
return &schedule, nil
}
// Deletes the schedule with the given ID.
func (c *ScheduleRestClient) DeleteSchedule(scheduleID string) error {
req, err := c.newDeleteScheduleRequest(scheduleID)
if err != nil {
return err
}
resp, err := c.client.Do(req)
if err != nil {
return err
}
bodyBytes, err := ioutil.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
}
// Returns all of the schedules for a given project. Note that
// pagination is not currently supported - we get all pages of
// schedules and return them all.
func (c *ScheduleRestClient) Schedules(vcs, org, project string) (*[]Schedule, error) {
schedules, err := c.listAllSchedules(vcs, org, project, &listSchedulesParams{})
return &schedules, err
}
// Returns the schedule with the given ID.
func (c *ScheduleRestClient) ScheduleByID(scheduleID string) (*Schedule, error) {
req, err := c.newGetScheduleRequest(scheduleID)
if err != nil {
return nil, err
}
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
bodyBytes, err := ioutil.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)
}
schedule := Schedule{}
if err := json.Unmarshal(bodyBytes, &schedule); err != nil {
return nil, err
}
return &schedule, err
}
// Finds a single schedule by its name and returns it.
func (c *ScheduleRestClient) ScheduleByName(vcs, org, project, name string) (*Schedule, error) {
params := &listSchedulesParams{}
for {
resp, err := c.listSchedules(vcs, org, project, params)
if err != nil {
return nil, err
}
for _, schedule := range resp.Items {
if schedule.Name == name {
return &schedule, nil
}
}
if resp.NextPageToken == nil {
return nil, nil
}
params.PageToken = resp.NextPageToken
}
}
// Fetches all pages of the schedule list API and returns a single
// list with all the schedules.
func (c *ScheduleRestClient) listAllSchedules(vcs, org, project string, params *listSchedulesParams) (schedules []Schedule, err error) {
var resp *listSchedulesResponse
for {
resp, err = c.listSchedules(vcs, org, project, params)
if err != nil {
return nil, err
}
schedules = append(schedules, resp.Items...)
if resp.NextPageToken == nil {
break
}
params.PageToken = resp.NextPageToken
}
return schedules, nil
}
// Fetches and returns one page of schedules.
func (c *ScheduleRestClient) listSchedules(vcs, org, project string, params *listSchedulesParams) (*listSchedulesResponse, error) {
req, err := c.newListSchedulesRequest(vcs, org, project, params)
if err != nil {
return nil, err
}
resp, err := c.client.Do(req)
if err != nil {
return nil, err
}
bodyBytes, err := ioutil.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 := listSchedulesResponse{
client: c,
params: params,
}
if err := json.Unmarshal(bodyBytes, &dest); err != nil {
return nil, err
}
return &dest, nil
}
// Builds a request to fetch a schedule by ID.
func (c *ScheduleRestClient) newGetScheduleRequest(scheduleID string) (*http.Request, error) {
queryURL, err := url.Parse(c.server)
if err != nil {
return nil, err
}
queryURL, err = queryURL.Parse(fmt.Sprintf("schedule/%s", scheduleID))
if err != nil {
return nil, err
}
return c.newHTTPRequest("GET", queryURL.String(), nil)
}
// Builds a request to create a new schedule.
func (c *ScheduleRestClient) newCreateScheduleRequest(vcs, org, project, name, description string,
useSchedulingSystem bool, timetable Timetable, parameters map[string]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("project/%s/%s/%s/schedule", vcs, org, project))
if err != nil {
return nil, err
}
actor := "current"
if useSchedulingSystem {
actor = "system"
}
var bodyReader io.Reader
var body = struct {
Name string `json:"name"`
Description string `json:"description,omitempty"`
AttributionActor string `json:"attribution-actor"`
Parameters map[string]string `json:"parameters"`
Timetable Timetable `json:"timetable"`
}{
Name: name,
Description: description,
AttributionActor: actor,
Parameters: parameters,
Timetable: timetable,
}
buf, err := json.Marshal(body)
if err != nil {
return nil, err
}
bodyReader = bytes.NewReader(buf)
return c.newHTTPRequest("POST", queryURL.String(), bodyReader)
}
// Builds a request to update an existing schedule.
func (c *ScheduleRestClient) newUpdateScheduleRequest(scheduleID, name, description string,
useSchedulingSystem bool, timetable Timetable, parameters map[string]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("schedule/%s", scheduleID))
if err != nil {
return nil, err
}
actor := "current"
if useSchedulingSystem {
actor = "system"
}
var bodyReader io.Reader
var body = struct {
Name string `json:"name,omitempty"`
Description string `json:"description,omitempty"`
AttributionActor string `json:"attribution-actor,omitempty"`
Parameters map[string]string `json:"parameters,omitempty"`
Timetable Timetable `json:"timetable,omitempty"`
}{
Name: name,
Description: description,
AttributionActor: actor,
Parameters: parameters,
Timetable: timetable,
}
buf, err := json.Marshal(body)
if err != nil {
return nil, err
}
bodyReader = bytes.NewReader(buf)
return c.newHTTPRequest("PATCH", queryURL.String(), bodyReader)
}
// Builds a request to delete an existing schedule.
func (c *ScheduleRestClient) newDeleteScheduleRequest(scheduleID 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("schedule/%s", scheduleID))
if err != nil {
return nil, err
}
return c.newHTTPRequest("DELETE", queryURL.String(), nil)
}
// Builds a requeest to list schedules according to params.
func (c *ScheduleRestClient) newListSchedulesRequest(vcs, org, project string, params *listSchedulesParams) (*http.Request, error) {
var err error
queryURL, err := url.Parse(c.server)
if err != nil {
return nil, err
}
queryURL, err = queryURL.Parse(fmt.Sprintf("project/%s/%s/%s/schedule", vcs, org, project))
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)
}
// Returns a new blank API request with boilerplate headers.
func (c *ScheduleRestClient) newHTTPRequest(method, url string, body io.Reader) (*http.Request, error) {
req, err := http.NewRequest(method, url, body)
if err != nil {
return nil, err
}
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
}
// Verifies that the REST API exists and has the necessary endpoints
// to interact with schedules.
func (c *ScheduleRestClient) 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 := ioutil.ReadAll(resp.Body)
defer resp.Body.Close()
if err != nil {
return err
}
var respBody struct {
Paths struct {
ScheduleEndpoint interface{} `json:"/schedule"`
}
}
if err := json.Unmarshal(bodyBytes, &respBody); err != nil {
return err
}
if respBody.Paths.ScheduleEndpoint == nil {
return errors.New("No schedule endpoint exists")
}
return nil
}
// Returns a new client satisfying the api.ScheduleInterface interface
// via the REST API.
func NewScheduleRestClient(config settings.Config) (*ScheduleRestClient, error) {
// Ensure server ends with a slash
if !strings.HasSuffix(config.RestEndpoint, "/") {
config.RestEndpoint += "/"
}
serverURL, err := url.Parse(config.Host)
if err != nil {
return nil, err
}
serverURL, err = serverURL.Parse(config.RestEndpoint)
if err != nil {
return nil, err
}
client := &ScheduleRestClient{
token: config.Token,
server: serverURL.String(),
client: config.HTTPClient,
}
return client, nil
}