forked from hashicorp/go-tfe
-
Notifications
You must be signed in to change notification settings - Fork 0
/
variable_set.go
398 lines (327 loc) · 12.1 KB
/
variable_set.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
package tfe
import (
"context"
"fmt"
"net/url"
)
// Compile-time proof of interface implementation.
var _ VariableSets = (*variableSets)(nil)
// VariableSets describes all the Variable Set related methods that the
// Terraform Enterprise API supports.
//
// TFE API docs: https://www.terraform.io/cloud-docs/api-docs/variable-sets
type VariableSets interface {
// List all the variable sets within an organization.
List(ctx context.Context, organization string, options *VariableSetListOptions) (*VariableSetList, error)
// ListForWorkspace gets the associated variable sets for a workspace.
ListForWorkspace(ctx context.Context, workspaceId string, options *VariableSetListOptions) (*VariableSetList, error)
// Create is used to create a new variable set.
Create(ctx context.Context, organization string, options *VariableSetCreateOptions) (*VariableSet, error)
// Read a variable set by its ID.
Read(ctx context.Context, variableSetID string, options *VariableSetReadOptions) (*VariableSet, error)
// Update an existing variable set.
Update(ctx context.Context, variableSetID string, options *VariableSetUpdateOptions) (*VariableSet, error)
// Delete a variable set by ID.
Delete(ctx context.Context, variableSetID string) error
// Apply variable set to workspaces in the supplied list.
ApplyToWorkspaces(ctx context.Context, variableSetID string, options *VariableSetApplyToWorkspacesOptions) error
// Remove variable set from workspaces in the supplied list.
RemoveFromWorkspaces(ctx context.Context, variableSetID string, options *VariableSetRemoveFromWorkspacesOptions) error
// Update list of workspaces to which the variable set is applied to match the supplied list.
UpdateWorkspaces(ctx context.Context, variableSetID string, options *VariableSetUpdateWorkspacesOptions) (*VariableSet, error)
}
// variableSets implements VariableSets.
type variableSets struct {
client *Client
}
// VariableSetList represents a list of variable sets.
type VariableSetList struct {
*Pagination
Items []*VariableSet
}
// VariableSet represents a Terraform Enterprise variable set.
type VariableSet struct {
ID string `jsonapi:"primary,varsets"`
Name string `jsonapi:"attr,name"`
Description string `jsonapi:"attr,description"`
Global bool `jsonapi:"attr,global"`
// Relations
Organization *Organization `jsonapi:"relation,organization"`
Workspaces []*Workspace `jsonapi:"relation,workspaces,omitempty"`
Variables []*VariableSetVariable `jsonapi:"relation,vars,omitempty"`
}
// A list of relations to include. See available resources
// https://www.terraform.io/docs/cloud/api/admin/organizations.html#available-related-resources
type VariableSetIncludeOpt string
const (
VariableSetWorkspaces VariableSetIncludeOpt = "workspaces"
VariableSetVars VariableSetIncludeOpt = "vars"
)
// VariableSetListOptions represents the options for listing variable sets.
type VariableSetListOptions struct {
ListOptions
Include string `url:"include"`
}
// VariableSetCreateOptions represents the options for creating a new variable set within in a organization.
type VariableSetCreateOptions 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,varsets"`
// The name of the variable set.
// Affects variable precedence when there are conflicts between Variable Sets
// https://www.terraform.io/cloud-docs/api-docs/variable-sets#apply-variable-set-to-workspaces
Name *string `jsonapi:"attr,name"`
// A description to provide context for the variable set.
Description *string `jsonapi:"attr,description,omitempty"`
// If true the variable set is considered in all runs in the organization.
Global *bool `jsonapi:"attr,global,omitempty"`
}
// VariableSetReadOptions represents the options for reading variable sets.
type VariableSetReadOptions struct {
Include *[]VariableSetIncludeOpt `url:"include:omitempty"`
}
// VariableSetUpdateOptions represents the options for updating a variable set.
type VariableSetUpdateOptions 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,varsets"`
// The name of the variable set.
// Affects variable precedence when there are conflicts between Variable Sets
// https://www.terraform.io/cloud-docs/api-docs/variable-sets#apply-variable-set-to-workspaces
Name *string `jsonapi:"attr,name,omitempty"`
// A description to provide context for the variable set.
Description *string `jsonapi:"attr,description,omitempty"`
// If true the variable set is considered in all runs in the organization.
Global *bool `jsonapi:"attr,global,omitempty"`
}
// VariableSetApplyToWorkspacesOptions represents the options for applying variable sets to workspaces.
type VariableSetApplyToWorkspacesOptions struct {
// The workspaces to apply the variable set to (additive).
Workspaces []*Workspace
}
// VariableSetRemoveFromWorkspacesOptions represents the options for removing variable sets from workspaces.
type VariableSetRemoveFromWorkspacesOptions struct {
// The workspaces to remove the variable set from.
Workspaces []*Workspace
}
// VariableSetUpdateWorkspacesOptions represents a subset of update options specifically for applying variable sets to workspaces
type VariableSetUpdateWorkspacesOptions 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,varsets"`
// The workspaces to be applied to. An empty set means remove all applied
Workspaces []*Workspace `jsonapi:"relation,workspaces"`
}
type privateVariableSetUpdateWorkspacesOptions struct {
Type string `jsonapi:"primary,varsets"`
Global bool `jsonapi:"attr,global"`
Workspaces []*Workspace `jsonapi:"relation,workspaces"`
}
// List all Variable Sets in the organization
func (s *variableSets) List(ctx context.Context, organization string, options *VariableSetListOptions) (*VariableSetList, error) {
if !validStringID(&organization) {
return nil, ErrInvalidOrg
}
if options != nil {
if err := options.valid(); err != nil {
return nil, err
}
}
u := fmt.Sprintf("organizations/%s/varsets", url.QueryEscape(organization))
req, err := s.client.NewRequest("GET", u, options)
if err != nil {
return nil, err
}
vl := &VariableSetList{}
err = req.Do(ctx, vl)
if err != nil {
return nil, err
}
return vl, nil
}
// ListForWorkspace gets the associated variable sets for a workspace.
func (s *variableSets) ListForWorkspace(ctx context.Context, workspaceID string, options *VariableSetListOptions) (*VariableSetList, error) {
if !validStringID(&workspaceID) {
return nil, ErrInvalidOrg
}
if options != nil {
if err := options.valid(); err != nil {
return nil, err
}
}
u := fmt.Sprintf("workspaces/%s/varsets", url.QueryEscape(workspaceID))
req, err := s.client.NewRequest("GET", u, options)
if err != nil {
return nil, err
}
vl := &VariableSetList{}
err = req.Do(ctx, vl)
if err != nil {
return nil, err
}
return vl, nil
}
// Create is used to create a new variable set.
func (s *variableSets) Create(ctx context.Context, organization string, options *VariableSetCreateOptions) (*VariableSet, error) {
if !validStringID(&organization) {
return nil, ErrInvalidOrg
}
if err := options.valid(); err != nil {
return nil, err
}
u := fmt.Sprintf("organizations/%s/varsets", url.QueryEscape(organization))
req, err := s.client.NewRequest("POST", u, options)
if err != nil {
return nil, err
}
vl := &VariableSet{}
err = req.Do(ctx, vl)
if err != nil {
return nil, err
}
return vl, nil
}
// Read is used to inspect a given variable set based on ID
func (s *variableSets) Read(ctx context.Context, variableSetID string, options *VariableSetReadOptions) (*VariableSet, error) {
if !validStringID(&variableSetID) {
return nil, ErrInvalidVariableSetID
}
u := fmt.Sprintf("varsets/%s", url.QueryEscape(variableSetID))
req, err := s.client.NewRequest("GET", u, options)
if err != nil {
return nil, err
}
vs := &VariableSet{}
err = req.Do(ctx, vs)
if err != nil {
return nil, err
}
return vs, err
}
// Update an existing variable set.
func (s *variableSets) Update(ctx context.Context, variableSetID string, options *VariableSetUpdateOptions) (*VariableSet, error) {
if !validStringID(&variableSetID) {
return nil, ErrInvalidVariableSetID
}
u := fmt.Sprintf("varsets/%s", url.QueryEscape(variableSetID))
req, err := s.client.NewRequest("PATCH", u, options)
if err != nil {
return nil, err
}
v := &VariableSet{}
err = req.Do(ctx, v)
if err != nil {
return nil, err
}
return v, nil
}
// Delete a variable set by its ID.
func (s *variableSets) Delete(ctx context.Context, variableSetID string) error {
if !validStringID(&variableSetID) {
return ErrInvalidVariableSetID
}
u := fmt.Sprintf("varsets/%s", url.QueryEscape(variableSetID))
req, err := s.client.NewRequest("DELETE", u, nil)
if err != nil {
return err
}
return req.Do(ctx, nil)
}
// Apply variable set to workspaces in the supplied list.
// Note: this method will return an error if the variable set has global = true.
func (s *variableSets) ApplyToWorkspaces(ctx context.Context, variableSetID string, options *VariableSetApplyToWorkspacesOptions) error {
if !validStringID(&variableSetID) {
return ErrInvalidVariableSetID
}
if err := options.valid(); err != nil {
return err
}
u := fmt.Sprintf("varsets/%s/relationships/workspaces", url.QueryEscape(variableSetID))
req, err := s.client.NewRequest("POST", u, options.Workspaces)
if err != nil {
return err
}
return req.Do(ctx, nil)
}
// Remove variable set from workspaces in the supplied list.
// Note: this method will return an error if the variable set has global = true.
func (s *variableSets) RemoveFromWorkspaces(ctx context.Context, variableSetID string, options *VariableSetRemoveFromWorkspacesOptions) error {
if !validStringID(&variableSetID) {
return ErrInvalidVariableSetID
}
if err := options.valid(); err != nil {
return err
}
u := fmt.Sprintf("varsets/%s/relationships/workspaces", url.QueryEscape(variableSetID))
req, err := s.client.NewRequest("DELETE", u, options.Workspaces)
if err != nil {
return err
}
return req.Do(ctx, nil)
}
// Update variable set to be applied to only the workspaces in the supplied list.
func (s *variableSets) UpdateWorkspaces(ctx context.Context, variableSetID string, options *VariableSetUpdateWorkspacesOptions) (*VariableSet, error) {
if err := options.valid(); err != nil {
return nil, err
}
// Use private struct to ensure global is set to false when applying to workspaces
o := privateVariableSetUpdateWorkspacesOptions{
Global: bool(false),
Workspaces: options.Workspaces,
}
// We force inclusion of workspaces as that is the primary data for which we are concerned with confirming changes.
u := fmt.Sprintf("varsets/%s?include=%s", url.QueryEscape(variableSetID), VariableSetWorkspaces)
req, err := s.client.NewRequest("PATCH", u, &o)
if err != nil {
return nil, err
}
v := &VariableSet{}
err = req.Do(ctx, v)
if err != nil {
return nil, err
}
return v, nil
}
func (o *VariableSetListOptions) valid() error {
return nil
}
func (o *VariableSetCreateOptions) valid() error {
if o == nil {
return nil
}
if !validString(o.Name) {
return ErrRequiredName
}
if o.Global == nil {
return ErrRequiredGlobalFlag
}
return nil
}
func (o *VariableSetApplyToWorkspacesOptions) valid() error {
for _, s := range o.Workspaces {
if !validStringID(&s.ID) {
return ErrRequiredWorkspaceID
}
}
return nil
}
func (o *VariableSetRemoveFromWorkspacesOptions) valid() error {
for _, s := range o.Workspaces {
if !validStringID(&s.ID) {
return ErrRequiredWorkspaceID
}
}
return nil
}
func (o *VariableSetUpdateWorkspacesOptions) valid() error {
if o == nil || o.Workspaces == nil {
return ErrRequiredWorkspacesList
}
return nil
}