-
Notifications
You must be signed in to change notification settings - Fork 232
/
api.go
1183 lines (965 loc) · 27.9 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
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
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package api
import (
"encoding/json"
"io/ioutil"
"log"
"os"
"sort"
"strings"
"fmt"
"github.com/CircleCI-Public/circleci-cli/client"
"github.com/CircleCI-Public/circleci-cli/references"
"github.com/Masterminds/semver"
"github.com/go-yaml/yaml"
"github.com/pkg/errors"
)
// GQLErrorsCollection is a slice of errors returned by the GraphQL server.
// Each error is made up of a GQLResponseError type.
type GQLErrorsCollection []GQLResponseError
// Error turns a GQLErrorsCollection into an acceptable error string that can be printed to the user.
func (errs GQLErrorsCollection) Error() string {
messages := []string{}
for i := range errs {
messages = append(messages, errs[i].Message)
}
return strings.Join(messages, "\n")
}
// GQLResponseError is a mapping of the data returned by the GraphQL server of key-value pairs.
// Typically used with the structure "Message: string", but other response errors provide additional fields.
type GQLResponseError struct {
Message string
Value string
AllowedValues []string
EnumType string
Type string
}
// IntrospectionResponse matches the result from making an introspection query
type IntrospectionResponse struct {
Schema struct {
MutationType struct {
Name string
}
QueryType struct {
Name string
}
Types []struct {
Description string
Fields []struct {
Name string
}
Kind string
Name string
}
} `json:"__schema"`
}
// 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
Errors GQLErrorsCollection
}
// BuildConfigResponse wraps the GQL result of the ConfigQuery
type BuildConfigResponse struct {
BuildConfig struct {
ConfigResponse
}
}
// The OrbPublishResponse type matches the data shape of the GQL response for
// publishing an orb.
type OrbPublishResponse struct {
PublishOrb struct {
Orb Orb
Errors GQLErrorsCollection
}
}
// The OrbPromoteResponse type matches the data shape of the GQL response for
// promoting an orb.
type OrbPromoteResponse struct {
PromoteOrb struct {
Orb Orb
Errors GQLErrorsCollection
}
}
// The OrbSetOrbListStatusResponse type matches the data shape of the GQL response for
// setting the list status of an orb.
type OrbSetOrbListStatusResponse struct {
SetOrbListStatus struct {
Listed bool
Errors GQLErrorsCollection
}
}
// OrbLatestVersionResponse wraps the GQL result of fetching an Orb and latest version
type OrbLatestVersionResponse struct {
Orb struct {
Versions []OrbVersion
}
}
// OrbIDResponse matches the GQL response for fetching an Orb and ID
type OrbIDResponse struct {
Orb struct {
ID string
}
RegistryNamespace struct {
ID string
}
}
// CreateNamespaceResponse type matches the data shape of the GQL response for
// creating a namespace
type CreateNamespaceResponse struct {
CreateNamespace struct {
Namespace struct {
CreatedAt string
ID string
}
Errors GQLErrorsCollection
}
}
// GetOrganizationResponse type wraps the GQL response for fetching an organization and ID.
type GetOrganizationResponse struct {
Organization struct {
ID string
}
}
// WhoamiResponse type matches the data shape of the GQL response for the current user
type WhoamiResponse struct {
Me struct {
Name string
}
}
// GetNamespaceResponse type wraps the GQL response for fetching a namespace
type GetNamespaceResponse struct {
RegistryNamespace struct {
ID string
}
}
// CreateOrbResponse type matches the data shape of the GQL response for
// creating an orb
type CreateOrbResponse struct {
CreateOrb struct {
Orb Orb
Errors GQLErrorsCollection
}
}
// NamespaceOrbResponse type matches the result from GQL.
// So that we can use mapstructure to convert from nested maps to a strongly typed struct.
type NamespaceOrbResponse struct {
RegistryNamespace struct {
Name string
ID string
Orbs struct {
Edges []struct {
Cursor string
Node OrbWithData
}
TotalCount int
PageInfo struct {
HasNextPage bool
}
}
}
}
// OrbListResponse type matches the result from GQL.
// So that we can use mapstructure to convert from nested maps to a strongly typed struct.
type OrbListResponse struct {
Orbs struct {
TotalCount int
Edges []struct {
Cursor string
Node OrbWithData
}
PageInfo struct {
HasNextPage bool
}
}
}
// OrbConfigResponse wraps the GQL result for OrbQuery.
type OrbConfigResponse struct {
OrbConfig struct {
ConfigResponse
}
}
// OrbsForListing is a container type for multiple orbs that includes the namespace and orbs for deserializing back into JSON.
type OrbsForListing struct {
Orbs []OrbWithData `json:"orbs"`
Namespace string `json:"namespace,omitempty"`
}
// SortBy allows us to sort a collection of orbs by builds, projects, or orgs from the last 30 days of data.
func (orbs *OrbsForListing) SortBy(sortBy string) {
switch sortBy {
case "builds":
sort.Slice(orbs.Orbs, func(i, j int) bool {
return orbs.Orbs[i].Statistics.Last30DaysBuildCount > orbs.Orbs[j].Statistics.Last30DaysBuildCount
})
case "projects":
sort.Slice(orbs.Orbs, func(i, j int) bool {
return orbs.Orbs[i].Statistics.Last30DaysProjectCount > orbs.Orbs[j].Statistics.Last30DaysProjectCount
})
case "orgs":
sort.Slice(orbs.Orbs, func(i, j int) bool {
return orbs.Orbs[i].Statistics.Last30DaysOrganizationCount > orbs.Orbs[j].Statistics.Last30DaysOrganizationCount
})
}
}
// OrbBase represents the minimum fields we wish to serialize for orbs.
// This type can be embedded for extending orbs with more data. e.g. OrbWithData
type OrbBase struct {
Name string `json:"name"`
HighestVersion string `json:"version"`
Statistics OrbStatistics `json:"statistics"`
Versions []struct {
Version string `json:"version"`
Source string `json:"source"`
} `json:"versions"`
}
// OrbStatistics represents the data we retrieve for orb usage in the last thirty days.
type OrbStatistics struct {
Last30DaysBuildCount int `json:"last30DaysBuildCount"`
Last30DaysProjectCount int `json:"last30DaysProjectCount"`
Last30DaysOrganizationCount int `json:"last30DaysOrganizationCount"`
}
// OrbWithData extends the OrbBase type with additional data used for printing.
type OrbWithData struct {
OrbBase
Commands map[string]OrbElement
Jobs map[string]OrbElement
Executors map[string]OrbElement
}
// MarshalJSON allows us to leave out excess fields we don't want to serialize.
// As is the case with commands/jobs/executors and now statistics.
func (orb OrbWithData) MarshalJSON() ([]byte, error) {
orbForJSON := OrbBase{
orb.Name,
orb.HighestVersion,
orb.Statistics,
orb.Versions,
}
return json.Marshal(orbForJSON)
}
// OrbElementParameter represents the yaml-unmarshled contents of
// a parameter for a command/job/executor
type OrbElementParameter struct {
Description string `json:"-"`
Type string `json:"-"`
Default interface{} `json:"-"`
}
// RealOrbElement represents the yaml-unmarshled contents of
// a named element under a command/job/executor
type RealOrbElement struct {
Description string `json:"-"`
Parameters map[string]OrbElementParameter `json:"-"`
}
// OrbElement implements RealOrbElement interface and allows us to deserialize by hand.
type OrbElement RealOrbElement
// UnmarshalYAML method allows OrbElement to be a string or a map.
// For now, don't even try to dereference the string, just return what is essentially
// an empty OrbElement (no description or parameters)
func (orbElement *OrbElement) UnmarshalYAML(unmarshal func(interface{}) error) error {
var s string
err := unmarshal(&s)
if err == nil {
*orbElement = OrbElement{}
return nil
}
var oe RealOrbElement
err = unmarshal(&oe)
if err == nil {
*orbElement = OrbElement(oe)
return nil
}
return nil
}
// Orb is a struct for containing the yaml-unmarshaled contents of an orb
type Orb struct {
ID string
Name string
Namespace string
CreatedAt string
Source string
HighestVersion string `json:"version"`
Statistics struct {
Last30DaysBuildCount int
Last30DaysProjectCount int
Last30DaysOrganizationCount int
}
Commands map[string]OrbElement
Jobs map[string]OrbElement
Executors map[string]OrbElement
Versions []OrbVersion
}
// OrbVersion wraps the GQL result used by OrbSource and OrbInfo
type OrbVersion struct {
ID string
Version string
Orb Orb
Source string
CreatedAt string
}
// #nosec
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
}
// WhoamiQuery returns the result of querying the `/me` endpoint of the API
func WhoamiQuery(cl *client.Client) (*WhoamiResponse, error) {
response := WhoamiResponse{}
query := `query { me { name } }`
request := client.NewRequest(query)
request.SetToken(cl.Token)
err := cl.Run(request, &response)
if err != nil {
return nil, err
}
return &response, nil
}
// ConfigQuery calls the GQL API to validate and process config
func ConfigQuery(cl *client.Client, configPath string) (*ConfigResponse, error) {
var response BuildConfigResponse
config, err := loadYaml(configPath)
if err != nil {
return nil, err
}
query := `
query ValidateConfig ($config: String!) {
buildConfig(configYaml: $config) {
valid,
errors { message },
sourceYaml,
outputYaml
}
}`
request := client.NewRequest(query)
request.Var("config", config)
request.SetToken(cl.Token)
err = cl.Run(request, &response)
if err != nil {
return nil, errors.Wrap(err, "Unable to validate config")
}
if len(response.BuildConfig.ConfigResponse.Errors) > 0 {
return nil, &response.BuildConfig.ConfigResponse.Errors
}
return &response.BuildConfig.ConfigResponse, nil
}
// OrbQuery validated and processes an orb.
func OrbQuery(cl *client.Client, configPath string) (*ConfigResponse, error) {
var response OrbConfigResponse
config, err := loadYaml(configPath)
if err != nil {
return nil, err
}
query := `
query ValidateOrb ($config: String!) {
orbConfig(orbYaml: $config) {
valid,
errors { message },
sourceYaml,
outputYaml
}
}`
request := client.NewRequest(query)
request.Var("config", config)
request.SetToken(cl.Token)
err = cl.Run(request, &response)
if err != nil {
return nil, errors.Wrap(err, "Unable to validate config")
}
if len(response.OrbConfig.ConfigResponse.Errors) > 0 {
return nil, response.OrbConfig.ConfigResponse.Errors
}
return &response.OrbConfig.ConfigResponse, nil
}
// OrbPublishByID publishes a new version of an orb by id
func OrbPublishByID(cl *client.Client, configPath string, orbID string, orbVersion string) (*Orb, error) {
var response OrbPublishResponse
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.NewRequest(query)
request.SetToken(cl.Token)
request.Var("config", config)
request.Var("orbId", orbID)
request.Var("version", orbVersion)
err = cl.Run(request, &response)
if err != nil {
return nil, errors.Wrap(err, "Unable to publish orb")
}
if len(response.PublishOrb.Errors) > 0 {
return nil, response.PublishOrb.Errors
}
return &response.PublishOrb.Orb, nil
}
// OrbID fetches an orb returning the ID
func OrbID(cl *client.Client, namespace string, orb string) (*OrbIDResponse, error) {
name := namespace + "/" + orb
var response OrbIDResponse
query := `
query ($name: String!, $namespace: String) {
orb(name: $name) {
id
}
registryNamespace(name: $namespace) {
id
}
}
`
request := client.NewRequest(query)
request.SetToken(cl.Token)
request.Var("name", name)
request.Var("namespace", namespace)
err := cl.Run(request, &response)
// If there is an error, or the request was successful, return now.
if err != nil || response.Orb.ID != "" {
return &response, err
}
// Otherwise, we want to generate a nice error message for the user.
namespaceExists := response.RegistryNamespace.ID != ""
if !namespaceExists {
return nil, namespaceNotFound(namespace)
}
return nil, fmt.Errorf("the '%s' orb does not exist in the '%s' namespace. Did you misspell the namespace or the orb name?", orb, namespace)
}
func createNamespaceWithOwnerID(cl *client.Client, name string, ownerID string) (*CreateNamespaceResponse, error) {
var response CreateNamespaceResponse
query := `
mutation($name: String!, $organizationId: UUID!) {
createNamespace(
name: $name,
organizationId: $organizationId
) {
namespace {
id
}
errors {
message
type
}
}
}`
request := client.NewRequest(query)
request.SetToken(cl.Token)
request.Var("name", name)
request.Var("organizationId", ownerID)
err := cl.Run(request, &response)
if len(response.CreateNamespace.Errors) > 0 {
return nil, response.CreateNamespace.Errors
}
if err != nil {
return nil, err
}
return &response, nil
}
func getOrganization(cl *client.Client, organizationName string, organizationVcs string) (*GetOrganizationResponse, error) {
var response GetOrganizationResponse
query := `query($organizationName: String!, $organizationVcs: VCSType!) {
organization(
name: $organizationName
vcsType: $organizationVcs
) {
id
}
}`
request := client.NewRequest(query)
request.SetToken(cl.Token)
request.Var("organizationName", organizationName)
request.Var("organizationVcs", strings.ToUpper(organizationVcs))
err := cl.Run(request, &response)
if err != nil {
return nil, errors.Wrapf(err, "Unable to find organization %s of vcs-type %s", organizationName, organizationVcs)
}
return &response, nil
}
func namespaceNotFound(name string) error {
return fmt.Errorf("the namespace '%s' does not exist. Did you misspell the namespace, or maybe you meant to create the namespace first?", name)
}
func organizationNotFound(name string, vcs string) error {
return fmt.Errorf("the organization '%s' under '%s' VCS-type does not exist. Did you misspell the organization or VCS?", name, vcs)
}
// CreateNamespace creates (reserves) a namespace for an organization
func CreateNamespace(cl *client.Client, name string, organizationName string, organizationVcs string) (*CreateNamespaceResponse, error) {
getOrgResponse, getOrgError := getOrganization(cl, organizationName, organizationVcs)
if getOrgError != nil {
return nil, errors.Wrap(organizationNotFound(organizationName, organizationVcs), getOrgError.Error())
}
createNSResponse, createNSError := createNamespaceWithOwnerID(cl, name, getOrgResponse.Organization.ID)
if createNSError != nil {
return nil, createNSError
}
return createNSResponse, nil
}
func getNamespace(cl *client.Client, name string) (*GetNamespaceResponse, error) {
var response GetNamespaceResponse
query := `
query($name: String!) {
registryNamespace(
name: $name
){
id
}
}`
request := client.NewRequest(query)
request.SetToken(cl.Token)
request.Var("name", name)
if err := cl.Run(request, &response); err != nil {
return nil, errors.Wrapf(err, "failed to load namespace '%s'", err)
}
if response.RegistryNamespace.ID == "" {
return nil, namespaceNotFound(name)
}
return &response, nil
}
func createOrbWithNsID(cl *client.Client, name string, namespaceID string) (*CreateOrbResponse, error) {
var response CreateOrbResponse
query := `mutation($name: String!, $registryNamespaceId: UUID!){
createOrb(
name: $name,
registryNamespaceId: $registryNamespaceId
){
orb {
id
}
errors {
message
type
}
}
}`
request := client.NewRequest(query)
request.SetToken(cl.Token)
request.Var("name", name)
request.Var("registryNamespaceId", namespaceID)
err := cl.Run(request, &response)
if len(response.CreateOrb.Errors) > 0 {
return nil, response.CreateOrb.Errors
}
if err != nil {
return nil, err
}
return &response, nil
}
// CreateOrb creates (reserves) an orb within a namespace
func CreateOrb(cl *client.Client, namespace string, name string) (*CreateOrbResponse, error) {
response, err := getNamespace(cl, namespace)
if err != nil {
return nil, err
}
return createOrbWithNsID(cl, name, response.RegistryNamespace.ID)
}
// TODO(zzak): this function is not really related to the API. Move it to another package?
func incrementVersion(version string, segment string) (string, error) {
v, err := semver.NewVersion(version)
if err != nil {
return "", err
}
var v2 semver.Version
switch segment {
case "major":
v2 = v.IncMajor()
case "minor":
v2 = v.IncMinor()
case "patch":
v2 = v.IncPatch()
}
return v2.String(), nil
}
// OrbIncrementVersion accepts an orb and segment to increment the orb.
func OrbIncrementVersion(cl *client.Client, configPath string, namespace string, orb string, segment string) (*Orb, error) {
// TODO(zzak): We can squash OrbID and OrbLatestVersion to a single query
id, err := OrbID(cl, namespace, orb)
if err != nil {
return nil, err
}
v, err := OrbLatestVersion(cl, namespace, orb)
if err != nil {
return nil, err
}
v2, err := incrementVersion(v, segment)
if err != nil {
return nil, err
}
response, err := OrbPublishByID(cl, configPath, id.Orb.ID, v2)
if err != nil {
return nil, err
}
return response, nil
}
// OrbLatestVersion finds the latest published version of an orb and returns it.
// If it doesn't find a version, it will return 0.0.0 for the orb's version
func OrbLatestVersion(cl *client.Client, namespace string, orb string) (string, error) {
name := namespace + "/" + orb
var response OrbLatestVersionResponse
// This query returns versions sorted by semantic version
query := `query($name: String!) {
orb(name: $name) {
versions(count: 1) {
version
}
}
}`
request := client.NewRequest(query)
request.SetToken(cl.Token)
request.Var("name", name)
err := cl.Run(request, &response)
if err != nil {
return "", err
}
if len(response.Orb.Versions) != 1 {
return "0.0.0", nil
}
return response.Orb.Versions[0].Version, nil
}
// OrbPromote takes an orb and a development version and increments a semantic release with the given segment.
func OrbPromote(cl *client.Client, namespace string, orb string, label string, segment string) (*Orb, error) {
// TODO(zzak): We can squash OrbID and OrbLatestVersion to a single query
id, err := OrbID(cl, namespace, orb)
if err != nil {
return nil, err
}
v, err := OrbLatestVersion(cl, namespace, orb)
if err != nil {
return nil, err
}
v2, err := incrementVersion(v, segment)
if err != nil {
return nil, err
}
var response OrbPromoteResponse
query := `
mutation($orbId: UUID!, $devVersion: String!, $semanticVersion: String!) {
promoteOrb(
orbId: $orbId,
devVersion: $devVersion,
semanticVersion: $semanticVersion
) {
orb {
version
source
}
errors { message }
}
}
`
request := client.NewRequest(query)
request.SetToken(cl.Token)
request.Var("orbId", id.Orb.ID)
request.Var("devVersion", label)
request.Var("semanticVersion", v2)
err = cl.Run(request, &response)
if len(response.PromoteOrb.Errors) > 0 {
return nil, response.PromoteOrb.Errors
}
if err != nil {
return nil, errors.Wrap(err, "Unable to promote orb")
}
return &response.PromoteOrb.Orb, nil
}
// OrbSetOrbListStatus sets whether an orb can be listed in the registry or not.
func OrbSetOrbListStatus(cl *client.Client, namespace string, orb string, list bool) (*bool, error) {
id, err := OrbID(cl, namespace, orb)
if err != nil {
return nil, err
}
var response OrbSetOrbListStatusResponse
query := `
mutation($orbId: UUID!, $list: Boolean!) {
setOrbListStatus(
orbId: $orbId,
list: $list
) {
listed
errors {
message
type
}
}
}
`
request := client.NewRequest(query)
request.SetToken(cl.Token)
request.Var("orbId", id.Orb.ID)
request.Var("list", list)
err = cl.Run(request, &response)
if len(response.SetOrbListStatus.Errors) > 0 {
return nil, response.SetOrbListStatus.Errors
}
if err != nil {
return nil, errors.Wrap(err, "Unable to set orb list status")
}
return &response.SetOrbListStatus.Listed, nil
}
// orbVersionRef is designed to ensure an orb reference fits the orbVersion query where orbVersionRef argument requires a version
func orbVersionRef(orb string) string {
split := strings.Split(orb, "@")
// We're expecting the API to tell us the reference is acceptable
// Without performing a lot of client-side validation
if len(split) > 1 {
return orb
}
// If no version was supplied, append @volatile to the reference
return fmt.Sprintf("%s@%s", split[0], "volatile")
}
// OrbSource gets the source of an orb
func OrbSource(cl *client.Client, orbRef string) (string, error) {
if err := references.IsOrbRefWithOptionalVersion(orbRef); err != nil {
return "", err
}
ref := orbVersionRef(orbRef)
var response struct {
OrbVersion OrbVersion
}
query := `query($orbVersionRef: String!) {
orbVersion(orbVersionRef: $orbVersionRef) {
id
version
orb { id }
source
}
}`
request := client.NewRequest(query)
request.Var("orbVersionRef", ref)
err := cl.Run(request, &response)
if err != nil {
return "", err
}
if response.OrbVersion.ID == "" {
return "", fmt.Errorf("no Orb '%s' was found; please check that the Orb reference is correct", orbRef)
}
return response.OrbVersion.Source, nil
}
// OrbInfo gets the meta-data of an orb
func OrbInfo(cl *client.Client, orbRef string) (*OrbVersion, error) {
if err := references.IsOrbRefWithOptionalVersion(orbRef); err != nil {
return nil, err
}
ref := orbVersionRef(orbRef)
var response struct {
OrbVersion OrbVersion
}
query := `query($orbVersionRef: String!) {
orbVersion(orbVersionRef: $orbVersionRef) {
id
version
orb {
id
createdAt
name
statistics {
last30DaysBuildCount,
last30DaysProjectCount,
last30DaysOrganizationCount
}
versions(count: 200) {
createdAt
version
}
}
source
createdAt
}
}`
request := client.NewRequest(query)
request.Var("orbVersionRef", ref)
err := cl.Run(request, &response)
if err != nil {
return nil, err
}
if response.OrbVersion.ID == "" {
return nil, fmt.Errorf("no Orb '%s' was found; please check that the Orb reference is correct", orbRef)
}
if len(response.OrbVersion.Orb.Versions) > 0 {
v := response.OrbVersion.Orb.Versions[0]
response.OrbVersion.Orb.HighestVersion = v.Version
} else {
response.OrbVersion.Orb.HighestVersion = "Not published"
}
// Parse the orb source to get its commands, executors and jobs
err = yaml.Unmarshal([]byte(response.OrbVersion.Source), &response.OrbVersion.Orb)
if err != nil {
return nil, errors.Wrapf(err, "Corrupt Orb %s %s", response.OrbVersion.Orb.Name, response.OrbVersion.Version)
}
return &response.OrbVersion, nil
}
// ListOrbs queries the API to find all orbs.
// Returns a collection of Orb objects containing their relevant data.
func ListOrbs(cl *client.Client, uncertified bool) (*OrbsForListing, error) {
l := log.New(os.Stderr, "", 0)
query := `
query ListOrbs ($after: String!, $certifiedOnly: Boolean!) {