-
Notifications
You must be signed in to change notification settings - Fork 234
/
api.go
504 lines (415 loc) · 12 KB
/
api.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
package api
import (
"context"
"io/ioutil"
"net/url"
"os"
"strings"
"fmt"
"github.com/CircleCI-Public/circleci-cli/client"
"github.com/CircleCI-Public/circleci-cli/logger"
"github.com/pkg/errors"
"github.com/spf13/viper"
)
// GQLResponseErrors is a slice of errors returned by the GraphQL server. Each
// error message is a key-value pair with the structure "Message: string"
type GQLResponseErrors struct {
Errors []struct {
Message string
}
}
// ConfigResponse is a structure that matches the result of the GQL
// query, so that we can use mapstructure to convert from
// nested maps to a strongly typed struct.
type ConfigResponse struct {
Valid bool
SourceYaml string
OutputYaml string
GQLResponseErrors
}
// The PublishOrbResponse type matches the data shape of the GQL response for
// publishing an orb.
type PublishOrbResponse struct {
Orb struct {
CreatedAt string
Version string
}
GQLResponseErrors
}
// CreateNamespaceResponse type matches the data shape of the GQL response for
// creating a namespace
type CreateNamespaceResponse struct {
Namespace struct {
CreatedAt string
ID string
}
GQLResponseErrors
}
// CreateOrbResponse type matches the data shape of the GQL response for
// creating an orb
type CreateOrbResponse struct {
Orb struct {
ID string
}
GQLResponseErrors
}
// ToError returns all GraphQL errors for a single response concatenated, or
// nil.
func (response GQLResponseErrors) ToError() error {
messages := []string{}
for i := range response.Errors {
messages = append(messages, response.Errors[i].Message)
}
return errors.New(strings.Join(messages, ": "))
}
// EnvEndpointHost pulls the endpoint and host values from viper
func EnvEndpointHost() (string, string) {
return viper.GetString("endpoint"), viper.GetString("host")
}
// GraphQLServerAddress returns the full address to CircleCI GraphQL API server
func GraphQLServerAddress(endpoint string, host string) (string, error) {
// 1. Parse the endpoint
e, err := url.Parse(endpoint)
if err != nil {
return e.String(), errors.Wrapf(err, "Parsing endpoint '%s'", endpoint)
}
// 2. Parse the host
h, err := url.Parse(host)
if err != nil {
return h.String(), errors.Wrapf(err, "Parsing host '%s'", host)
}
if !h.IsAbs() {
return h.String(), fmt.Errorf("Host (%s) must be absolute URL, including scheme", host)
}
// 3. Resolve the two URLs using host as the base
// We use ResolveReference which has specific behavior we can rely for
// older configurations which included the absolute path for the endpoint flag.
//
// https://golang.org/pkg/net/url/#URL.ResolveReference
//
// Specifically this function always returns the reference (endpoint) if provided an absolute URL.
// This way we can safely introduce --host and merge the two.
return h.ResolveReference(e).String(), err
}
// nolint: gosec
func loadYaml(path string) (string, error) {
var err error
var config []byte
if path == "-" {
config, err = ioutil.ReadAll(os.Stdin)
} else {
config, err = ioutil.ReadFile(path)
}
if err != nil {
return "", errors.Wrapf(err, "Could not load config file at %s", path)
}
return string(config), nil
}
func buildAndOrbQuery(ctx context.Context, logger *logger.Logger, configPath string, response interface{}, query string) error {
config, err := loadYaml(configPath)
if err != nil {
return err
}
request := client.NewAuthorizedRequest(viper.GetString("token"), query)
request.Var("config", config)
address, err := GraphQLServerAddress(EnvEndpointHost())
if err != nil {
return err
}
graphQLclient := client.NewClient(address, logger)
err = graphQLclient.Run(ctx, request, response)
if err != nil {
return errors.Wrap(err, "Unable to validate config")
}
return nil
}
// ConfigQuery calls the GQL API to validate and process config
func ConfigQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error) {
var response struct {
BuildConfig struct {
ConfigResponse
}
}
return &response.BuildConfig.ConfigResponse, buildAndOrbQuery(ctx, logger, configPath, &response, `
query ValidateConfig ($config: String!) {
buildConfig(configYaml: $config) {
valid,
errors { message },
sourceYaml,
outputYaml
}
}`)
}
// OrbQuery validated and processes an orb.
func OrbQuery(ctx context.Context, logger *logger.Logger, configPath string) (*ConfigResponse, error) {
var response struct {
OrbConfig struct {
ConfigResponse
}
}
return &response.OrbConfig.ConfigResponse, buildAndOrbQuery(ctx, logger, configPath, &response, `
query ValidateOrb ($config: String!) {
orbConfig(orbYaml: $config) {
valid,
errors { message },
sourceYaml,
outputYaml
}
}`)
}
// OrbPublish publishes a new version of an orb
func OrbPublish(ctx context.Context, logger *logger.Logger,
configPath string, namespace string, orb string, orbVersion string) (*PublishOrbResponse, error) {
name := namespace + "/" + orb
orbID, err := getOrbID(ctx, logger, name)
if err != nil {
return nil, err
}
var response struct {
PublishOrb struct {
PublishOrbResponse
}
}
config, err := loadYaml(configPath)
if err != nil {
return nil, err
}
query := `
mutation($config: String!, $orbId: UUID!, $version: String!) {
publishOrb(
orbId: $orbId,
orbYaml: $config,
version: $version
) {
orb {
version
}
errors { message }
}
}
`
request := client.NewAuthorizedRequest(viper.GetString("token"), query)
request.Var("config", config)
request.Var("orbId", orbID)
request.Var("version", orbVersion)
address, err := GraphQLServerAddress(EnvEndpointHost())
if err != nil {
return nil, err
}
graphQLclient := client.NewClient(address, logger)
err = graphQLclient.Run(ctx, request, &response)
if err != nil {
err = errors.Wrap(err, "Unable to publish orb")
}
return &response.PublishOrb.PublishOrbResponse, err
}
func getOrbID(ctx context.Context, logger *logger.Logger, name string) (string, error) {
var response struct {
Orb struct {
ID string
}
}
query := `query($name: String!) {
orb(name: $name) {
id
}
}`
request := client.NewAuthorizedRequest(viper.GetString("token"), query)
request.Var("name", name)
address, err := GraphQLServerAddress(EnvEndpointHost())
if err != nil {
return "", err
}
graphQLclient := client.NewClient(address, logger)
err = graphQLclient.Run(ctx, request, &response)
if err != nil {
return "", err
}
if response.Orb.ID == "" {
return "", fmt.Errorf("the %s orb could not be found", name)
}
return response.Orb.ID, nil
}
func createNamespaceWithOwnerID(ctx context.Context, logger *logger.Logger, name string, ownerID string) (*CreateNamespaceResponse, error) {
var response struct {
CreateNamespace struct {
CreateNamespaceResponse
}
}
query := `
mutation($name: String!, $organizationId: UUID!) {
createNamespace(
name: $name,
organizationId: $organizationId
) {
namespace {
id
}
errors {
message
type
}
}
}`
request := client.NewAuthorizedRequest(viper.GetString("token"), query)
request.Var("name", name)
request.Var("organizationId", ownerID)
address, err := GraphQLServerAddress(EnvEndpointHost())
if err != nil {
return nil, err
}
graphQLclient := client.NewClient(address, logger)
err = graphQLclient.Run(ctx, request, &response)
if err != nil {
err = errors.Wrap(err, fmt.Sprintf("Unable to create namespace %s for ownerId %s", name, ownerID))
}
return &response.CreateNamespace.CreateNamespaceResponse, err
}
func getOrganization(ctx context.Context, logger *logger.Logger, organizationName string, organizationVcs string) (string, error) {
var response struct {
Organization struct {
ID string
}
}
query := `
query($organizationName: String!, $organizationVcs: VCSType!) {
organization(
name: $organizationName
vcsType: $organizationVcs
) {
id
}
}`
request := client.NewAuthorizedRequest(viper.GetString("token"), query)
request.Var("organizationName", organizationName)
request.Var("organizationVcs", organizationVcs)
address, err := GraphQLServerAddress(EnvEndpointHost())
if err != nil {
return "", err
}
graphQLclient := client.NewClient(address, logger)
err = graphQLclient.Run(ctx, request, &response)
if err != nil {
err = errors.Wrapf(err, "Unable to find organization %s of vcs-type %s", organizationName, organizationVcs)
} else if response.Organization.ID == "" {
err = fmt.Errorf("Unable to find organization %s of vcs-type %s", organizationName, organizationVcs)
}
return response.Organization.ID, err
}
// CreateNamespace creates (reserves) a namespace for an organization
func CreateNamespace(ctx context.Context, logger *logger.Logger, name string, organizationName string, organizationVcs string) (*CreateNamespaceResponse, error) {
organizationID, err := getOrganization(ctx, logger, organizationName, organizationVcs)
if err != nil {
return nil, err
}
namespace, err := createNamespaceWithOwnerID(ctx, logger, name, organizationID)
if err != nil {
return nil, err
}
return namespace, err
}
func getNamespace(ctx context.Context, logger *logger.Logger, name string) (string, error) {
var response struct {
RegistryNamespace struct {
ID string
}
}
query := `
query($name: String!) {
registryNamespace(
name: $name
){
id
}
}`
request := client.NewAuthorizedRequest(viper.GetString("token"), query)
request.Var("name", name)
address, err := GraphQLServerAddress(EnvEndpointHost())
if err != nil {
return "", err
}
graphQLclient := client.NewClient(address, logger)
err = graphQLclient.Run(ctx, request, &response)
if err != nil {
err = errors.Wrapf(err, "Unable to find namespace %s", name)
} else if response.RegistryNamespace.ID == "" {
err = fmt.Errorf("Unable to find namespace %s", name)
}
return response.RegistryNamespace.ID, err
}
func createOrbWithNsID(ctx context.Context, logger *logger.Logger, name string, namespaceID string) (*CreateOrbResponse, error) {
var response struct {
CreateOrb struct {
CreateOrbResponse
}
}
query := `mutation($name: String!, $registryNamespaceId: UUID!){
createOrb(
name: $name,
registryNamespaceId: $registryNamespaceId
){
orb {
id
}
errors {
message
type
}
}
}`
request := client.NewAuthorizedRequest(viper.GetString("token"), query)
request.Var("name", name)
request.Var("registryNamespaceId", namespaceID)
address, err := GraphQLServerAddress(EnvEndpointHost())
if err != nil {
return nil, err
}
graphQLclient := client.NewClient(address, logger)
err = graphQLclient.Run(ctx, request, &response)
if err != nil {
err = errors.Wrapf(err, "Unable to create orb %s for namespaceID %s", name, namespaceID)
}
return &response.CreateOrb.CreateOrbResponse, err
}
// CreateOrb creates (reserves) an orb within a namespace
func CreateOrb(ctx context.Context, logger *logger.Logger, namespace string, name string) (*CreateOrbResponse, error) {
namespaceID, err := getNamespace(ctx, logger, namespace)
if err != nil {
return nil, err
}
orb, err := createOrbWithNsID(ctx, logger, name, namespaceID)
return orb, err
}
// OrbSource gets the source or an orb
func OrbSource(ctx context.Context, logger *logger.Logger, namespace string, orb string) (string, error) {
name := namespace + "/" + orb
var response struct {
Orb struct {
Versions []struct {
Source string
}
}
}
query := `query($name: String!) {
orb(name: $name) {
versions(count: 1) {
source
}
}
}`
request := client.NewAuthorizedRequest(viper.GetString("token"), query)
request.Var("name", name)
address, err := GraphQLServerAddress(EnvEndpointHost())
if err != nil {
return "", err
}
graphQLclient := client.NewClient(address, logger)
err = graphQLclient.Run(ctx, request, &response)
if err != nil {
return "", err
}
if len(response.Orb.Versions) != 1 {
return "", fmt.Errorf("the %s orb has never published a revision", name)
}
return response.Orb.Versions[0].Source, nil
}