/
registry_provider.go
243 lines (206 loc) · 6.81 KB
/
registry_provider.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
package tfe
import (
"context"
"fmt"
"net/url"
)
// Compile-time proof of interface implementation.
var _ RegistryProviders = (*registryProviders)(nil)
// RegistryProviders describes all the registry provider related methods that the Terraform
// Enterprise API supports.
//
// TFE API docs: https://www.terraform.io/docs/cloud/api/providers.html
type RegistryProviders interface {
// List all the providers within an organization.
List(ctx context.Context, organization string, options *RegistryProviderListOptions) (*RegistryProviderList, error)
// Create a registry provider
Create(ctx context.Context, organization string, options RegistryProviderCreateOptions) (*RegistryProvider, error)
// Read a registry provider
Read(ctx context.Context, providerId RegistryProviderID, options *RegistryProviderReadOptions) (*RegistryProvider, error)
// Delete a registry provider
Delete(ctx context.Context, providerId RegistryProviderID) error
}
// registryProviders implements RegistryProviders.
type registryProviders struct {
client *Client
}
// RegistryName represents which registry is being targeted
type RegistryName string
// List of available registry names
const (
PrivateRegistry RegistryName = "private"
PublicRegistry RegistryName = "public"
)
func (rn RegistryName) valid() error {
switch rn {
case PrivateRegistry, PublicRegistry:
return nil
}
return ErrInvalidRegistryName
}
// RegistryProvider represents a registry provider
type RegistryProvider struct {
ID string `jsonapi:"primary,registry-providers"`
Namespace string `jsonapi:"attr,namespace"`
Name string `jsonapi:"attr,name"`
RegistryName RegistryName `jsonapi:"attr,registry-name"`
Permissions *RegistryProviderPermissions `jsonapi:"attr,permissions"`
CreatedAt string `jsonapi:"attr,created-at"`
UpdatedAt string `jsonapi:"attr,updated-at"`
// Relations
Organization *Organization `jsonapi:"relation,organization"`
RegistryProviderVersions []*RegistryProviderVersion `jsonapi:"relation,registry-provider-version"`
}
type RegistryProviderPermissions struct {
CanDelete bool `jsonapi:"attr,can-delete"`
}
type RegistryProviderListOptions struct {
ListOptions
// A query string to filter by registry_name
RegistryName RegistryName `url:"filter[registry_name],omitempty"`
// A query string to filter by organization
OrganizationName string `url:"filter[organization_name],omitempty"`
// A query string to do a fuzzy search
Search string `url:"q,omitempty"`
}
type RegistryProviderList struct {
*Pagination
Items []*RegistryProvider
}
func (o RegistryProviderListOptions) valid() error {
return nil
}
func (r *registryProviders) List(ctx context.Context, organization string, options *RegistryProviderListOptions) (*RegistryProviderList, error) {
if !validStringID(&organization) {
return nil, ErrInvalidOrg
}
if options != nil {
if err := options.valid(); err != nil {
return nil, err
}
}
u := fmt.Sprintf("organizations/%s/registry-providers", url.QueryEscape(organization))
req, err := r.client.newRequest("GET", u, options)
if err != nil {
return nil, err
}
pl := &RegistryProviderList{}
err = r.client.do(ctx, req, pl)
if err != nil {
return nil, err
}
return pl, nil
}
// RegistryProviderCreateOptions is used when creating a registry provider
type RegistryProviderCreateOptions struct {
// Type is a public field utilized by JSON:API to
// set the resource type via the field tag.
// It is not a user-defined value and does not need to be set.
// https://jsonapi.org/format/#crud-creating
Type string `jsonapi:"primary,registry-providers"`
Namespace string `jsonapi:"attr,namespace"`
Name string `jsonapi:"attr,name"`
RegistryName RegistryName `jsonapi:"attr,registry-name"`
}
func (o RegistryProviderCreateOptions) valid() error {
if !validStringID(&o.Name) {
return ErrInvalidName
}
if !validStringID(&o.Namespace) {
return ErrInvalidNamespace
}
if err := o.RegistryName.valid(); err != nil {
return err
}
return nil
}
func (r *registryProviders) Create(ctx context.Context, organization string, options RegistryProviderCreateOptions) (*RegistryProvider, error) {
if !validStringID(&organization) {
return nil, ErrInvalidOrg
}
if err := options.valid(); err != nil {
return nil, err
}
// Private providers must match their namespace and organization name
// This is enforced by the API as well
if options.RegistryName == PrivateRegistry && organization != options.Namespace {
return nil, ErrPrivateProviderNamespaceDoesntMatchOrganization
}
u := fmt.Sprintf(
"organizations/%s/registry-providers",
url.QueryEscape(organization),
)
req, err := r.client.newRequest("POST", u, &options)
if err != nil {
return nil, err
}
prv := &RegistryProvider{}
err = r.client.do(ctx, req, prv)
if err != nil {
return nil, err
}
return prv, nil
}
// RegistryProviderID is the multi key ID for addressing a provider
type RegistryProviderID struct {
OrganizationName string `jsonapi:"attr,organization-name"`
Namespace string `jsonapi:"attr,namespace"`
Name string `jsonapi:"attr,name"`
RegistryName RegistryName `jsonapi:"attr,registry-name"`
}
func (id RegistryProviderID) valid() error {
if !validStringID(&id.OrganizationName) {
return ErrInvalidOrg
}
if !validStringID(&id.Name) {
return ErrInvalidName
}
if !validStringID(&id.Namespace) {
return ErrInvalidNamespace
}
if err := id.RegistryName.valid(); err != nil {
return err
}
return nil
}
type RegistryProviderReadOptions struct {
}
func (r *registryProviders) Read(ctx context.Context, providerId RegistryProviderID, options *RegistryProviderReadOptions) (*RegistryProvider, error) {
if err := providerId.valid(); err != nil {
return nil, err
}
u := fmt.Sprintf(
"organizations/%s/registry-providers/%s/%s/%s",
url.QueryEscape(providerId.OrganizationName),
url.QueryEscape(string(providerId.RegistryName)),
url.QueryEscape(providerId.Namespace),
url.QueryEscape(providerId.Name),
)
req, err := r.client.newRequest("GET", u, options)
if err != nil {
return nil, err
}
prv := &RegistryProvider{}
err = r.client.do(ctx, req, prv)
if err != nil {
return nil, err
}
return prv, nil
}
func (r *registryProviders) Delete(ctx context.Context, providerId RegistryProviderID) error {
if err := providerId.valid(); err != nil {
return err
}
u := fmt.Sprintf(
"organizations/%s/registry-providers/%s/%s/%s",
url.QueryEscape(providerId.OrganizationName),
url.QueryEscape(string(providerId.RegistryName)),
url.QueryEscape(providerId.Namespace),
url.QueryEscape(providerId.Name),
)
req, err := r.client.newRequest("DELETE", u, nil)
if err != nil {
return err
}
return r.client.do(ctx, req, nil)
}