Skip to content

Commit 8599405

Browse files
brandoncbrandonc
authored
Merge pull request #765 from hashicorp/TF-9178-go-tfe-gh-issue-764-project-name-attr-is-not-returned-properly
Include parameter validation is a maintenance problem for new valid include options
2 parents b0a0914 + bdbd165 commit 8599405

22 files changed

+11
-478
lines changed

‎admin_organization.go

-21
Original file line numberDiff line numberDiff line change
@@ -233,26 +233,5 @@ func (s *adminOrganizations) Delete(ctx context.Context, organization string) er
233233
}
234234

235235
func (o *AdminOrganizationListOptions) valid() error {
236-
if o == nil {
237-
return nil // nothing to validate
238-
}
239-
240-
if err := validateAdminOrgIncludeParams(o.Include); err != nil {
241-
return err
242-
}
243-
244-
return nil
245-
}
246-
247-
func validateAdminOrgIncludeParams(params []AdminOrgIncludeOpt) error {
248-
for _, p := range params {
249-
switch p {
250-
case AdminOrgOwners:
251-
// do nothing
252-
default:
253-
return ErrInvalidIncludeValue
254-
}
255-
}
256-
257236
return nil
258237
}

‎admin_run.go

-17
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,6 @@ func (o *AdminRunsListOptions) valid() error {
127127
return err
128128
}
129129

130-
if err := validateAdminRunIncludeParams(o.Include); err != nil {
131-
return err
132-
}
133-
134130
return nil
135131
}
136132

@@ -170,16 +166,3 @@ func validateAdminRunFilterParams(runStatus string) error {
170166

171167
return nil
172168
}
173-
174-
func validateAdminRunIncludeParams(params []AdminRunIncludeOpt) error {
175-
for _, p := range params {
176-
switch p {
177-
case AdminRunWorkspace, AdminRunWorkspaceOrg, AdminRunWorkspaceOrgOwners:
178-
// do nothing
179-
default:
180-
return ErrInvalidIncludeValue
181-
}
182-
}
183-
184-
return nil
185-
}

‎admin_user.go

-20
Original file line numberDiff line numberDiff line change
@@ -235,25 +235,5 @@ func (a *adminUsers) Disable2FA(ctx context.Context, userID string) (*AdminUser,
235235
}
236236

237237
func (o *AdminUserListOptions) valid() error {
238-
if o == nil {
239-
return nil // nothing to validate
240-
}
241-
242-
if err := validateAdminUserIncludeParams(o.Include); err != nil {
243-
return err
244-
}
245-
246-
return nil
247-
}
248-
249-
func validateAdminUserIncludeParams(params []AdminUserIncludeOpt) error {
250-
for _, p := range params {
251-
switch p {
252-
case AdminUserOrgs:
253-
// do nothing
254-
default:
255-
return ErrInvalidIncludeValue
256-
}
257-
}
258238
return nil
259239
}

‎admin_workspace.go

-21
Original file line numberDiff line numberDiff line change
@@ -144,26 +144,5 @@ func (s *adminWorkspaces) Delete(ctx context.Context, workspaceID string) error
144144
}
145145

146146
func (o *AdminWorkspaceListOptions) valid() error {
147-
if o == nil {
148-
return nil // nothing to validate
149-
}
150-
151-
if err := validateAdminWSIncludeParams(o.Include); err != nil {
152-
return err
153-
}
154-
155-
return nil
156-
}
157-
158-
func validateAdminWSIncludeParams(params []AdminWorkspaceIncludeOpt) error {
159-
for _, p := range params {
160-
switch p {
161-
case AdminWorkspaceOrg, AdminWorkspaceCurrentRun, AdminWorkspaceOrgOwners:
162-
// do nothing
163-
default:
164-
return ErrInvalidIncludeValue
165-
}
166-
}
167-
168147
return nil
169148
}

‎agent_pool.go

-27
Original file line numberDiff line numberDiff line change
@@ -292,36 +292,9 @@ func (o AgentPoolUpdateOptions) valid() error {
292292
}
293293

294294
func (o *AgentPoolReadOptions) valid() error {
295-
if o == nil {
296-
return nil // nothing to validate
297-
}
298-
if err := validateAgentPoolIncludeParams(o.Include); err != nil {
299-
return err
300-
}
301-
302295
return nil
303296
}
304297

305298
func (o *AgentPoolListOptions) valid() error {
306-
if o == nil {
307-
return nil // nothing to validate
308-
}
309-
if err := validateAgentPoolIncludeParams(o.Include); err != nil {
310-
return err
311-
}
312-
313-
return nil
314-
}
315-
316-
func validateAgentPoolIncludeParams(params []AgentPoolIncludeOpt) error {
317-
for _, p := range params {
318-
switch p {
319-
case AgentPoolWorkspaces:
320-
// do nothing
321-
default:
322-
return ErrInvalidIncludeValue
323-
}
324-
}
325-
326299
return nil
327300
}

‎configuration_version.go

-29
Original file line numberDiff line numberDiff line change
@@ -302,39 +302,10 @@ func (s *configurationVersions) Archive(ctx context.Context, cvID string) error
302302
}
303303

304304
func (o *ConfigurationVersionReadOptions) valid() error {
305-
if o == nil {
306-
return nil // nothing to validate
307-
}
308-
309-
if err := validateConfigVerIncludeParams(o.Include); err != nil {
310-
return err
311-
}
312-
313305
return nil
314306
}
315307

316308
func (o *ConfigurationVersionListOptions) valid() error {
317-
if o == nil {
318-
return nil // nothing to validate
319-
}
320-
321-
if err := validateConfigVerIncludeParams(o.Include); err != nil {
322-
return err
323-
}
324-
325-
return nil
326-
}
327-
328-
func validateConfigVerIncludeParams(params []ConfigVerIncludeOpt) error {
329-
for _, p := range params {
330-
switch p {
331-
case ConfigVerIngressAttributes, ConfigVerRun:
332-
// do nothing
333-
default:
334-
return ErrInvalidIncludeValue
335-
}
336-
}
337-
338309
return nil
339310
}
340311

‎docs/CONTRIBUTING.md

-41
Original file line numberDiff line numberDiff line change
@@ -255,9 +255,6 @@ func (s *example) List(ctx context.Context, organization string, options *Exampl
255255
if !validStringID(&organization) {
256256
return nil, ErrInvalidOrg
257257
}
258-
if err := options.valid(); err != nil {
259-
return nil, err
260-
}
261258

262259
u := fmt.Sprintf("organizations/%s/examples", url.QueryEscape(organization))
263260
req, err := s.client.NewRequest("GET", u, options)
@@ -284,9 +281,6 @@ func (s *example) ReadWithOptions(ctx context.Context, exampleID string, options
284281
if !validStringID(&exampleID) {
285282
return nil, ErrInvalidExampleID
286283
}
287-
if err := options.valid(); err != nil {
288-
return nil, err
289-
}
290284

291285
u := fmt.Sprintf("examples/%s", url.QueryEscape(exampleID))
292286
req, err := s.client.NewRequest("GET", u, options)
@@ -366,41 +360,6 @@ func (o *ExampleCreateOptions) valid() error {
366360

367361
return nil
368362
}
369-
370-
func (o *ExampleListOptions) valid() error {
371-
if o == nil {
372-
return nil // nothing to validate
373-
}
374-
if err := validateExampleIncludeParams(o.Include); err != nil {
375-
return err
376-
}
377-
378-
return nil
379-
}
380-
381-
func (o *ExampleReadOptions) valid() error {
382-
if o == nil {
383-
return nil // nothing to validate
384-
}
385-
if err := validateExampleIncludeParams(o.Include); err != nil {
386-
return err
387-
}
388-
389-
return nil
390-
}
391-
392-
func validateExampleIncludeParams(params []ExampleIncludeOpt) error {
393-
for _, p := range params {
394-
switch p {
395-
case ExampleOrganization, ExampleRun:
396-
// do nothing
397-
default:
398-
return ErrInvalidIncludeValue
399-
}
400-
}
401-
402-
return nil
403-
}
404363
```
405364

406365
## Rebasing a fork to trigger CI (Maintainers Only)

‎oauth_client.go

-21
Original file line numberDiff line numberDiff line change
@@ -286,26 +286,5 @@ func (o OAuthClientCreateOptions) valid() error {
286286
}
287287

288288
func (o *OAuthClientListOptions) valid() error {
289-
if o == nil {
290-
return nil // nothing to validate
291-
}
292-
293-
if err := validateOauthClientIncludeParams(o.Include); err != nil {
294-
return err
295-
}
296-
297-
return nil
298-
}
299-
300-
func validateOauthClientIncludeParams(params []OAuthClientIncludeOpt) error {
301-
for _, p := range params {
302-
switch p {
303-
case OauthClientOauthTokens:
304-
// do nothing
305-
default:
306-
return ErrInvalidIncludeValue
307-
}
308-
}
309-
310289
return nil
311290
}

‎organization_membership.go

-21
Original file line numberDiff line numberDiff line change
@@ -215,10 +215,6 @@ func (o *OrganizationMembershipListOptions) valid() error {
215215
return nil
216216
}
217217

218-
if err := validateOrgMembershipIncludeParams(o.Include); err != nil {
219-
return err
220-
}
221-
222218
if err := validateOrgMembershipEmailParams(o.Emails); err != nil {
223219
return err
224220
}
@@ -227,23 +223,6 @@ func (o *OrganizationMembershipListOptions) valid() error {
227223
}
228224

229225
func (o OrganizationMembershipReadOptions) valid() error {
230-
if err := validateOrgMembershipIncludeParams(o.Include); err != nil {
231-
return err
232-
}
233-
234-
return nil
235-
}
236-
237-
func validateOrgMembershipIncludeParams(params []OrgMembershipIncludeOpt) error {
238-
for _, p := range params {
239-
switch p {
240-
case OrgMembershipUser, OrgMembershipTeam:
241-
// do nothing
242-
default:
243-
return ErrInvalidIncludeValue
244-
}
245-
}
246-
247226
return nil
248227
}
249228

‎organization_membership_integration_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ func TestOrganizationMembershipsReadWithOptions(t *testing.T) {
253253
require.NoError(t, err)
254254
})
255255

256-
t.Run("without invalid include option", func(t *testing.T) {
256+
t.Run("with invalid include option", func(t *testing.T) {
257257
_, err := client.OrganizationMemberships.ReadWithOptions(ctx, memTest.ID, OrganizationMembershipReadOptions{
258258
Include: []OrgMembershipIncludeOpt{"users"},
259259
})

‎policy_check.go

-21
Original file line numberDiff line numberDiff line change
@@ -239,26 +239,5 @@ func (s *policyChecks) Logs(ctx context.Context, policyCheckID string) (io.Reade
239239
}
240240

241241
func (o *PolicyCheckListOptions) valid() error {
242-
if o == nil {
243-
return nil // nothing to validate
244-
}
245-
246-
if err := validatePolicyCheckIncludeParams(o.Include); err != nil {
247-
return err
248-
}
249-
250-
return nil
251-
}
252-
253-
func validatePolicyCheckIncludeParams(params []PolicyCheckIncludeOpt) error {
254-
for _, p := range params {
255-
switch p {
256-
case PolicyCheckRunWorkspace, PolicyCheckRun:
257-
// do nothing
258-
default:
259-
return ErrInvalidIncludeValue
260-
}
261-
}
262-
263242
return nil
264243
}

‎policy_set.go

-21
Original file line numberDiff line numberDiff line change
@@ -658,26 +658,5 @@ func (o PolicySetAddProjectsOptions) valid() error {
658658
}
659659

660660
func (o *PolicySetReadOptions) valid() error {
661-
if o == nil {
662-
return nil // nothing to validate
663-
}
664-
665-
if err := validatePolicySetIncludeParams(o.Include); err != nil {
666-
return err
667-
}
668-
669-
return nil
670-
}
671-
672-
func validatePolicySetIncludeParams(params []PolicySetIncludeOpt) error {
673-
for _, p := range params {
674-
switch p {
675-
case PolicySetPolicies, PolicySetWorkspaces, PolicySetCurrentVersion, PolicySetNewestVersion, PolicySetWorkspaceExclusions, PolicySetProjects:
676-
// do nothing
677-
default:
678-
return ErrInvalidIncludeValue
679-
}
680-
}
681-
682661
return nil
683662
}

‎registry_no_code_module.go

-21
Original file line numberDiff line numberDiff line change
@@ -244,26 +244,5 @@ func (o *RegistryNoCodeModuleUpdateOptions) valid() error {
244244
}
245245

246246
func (o *RegistryNoCodeModuleReadOptions) valid() error {
247-
if o == nil {
248-
return nil // nothing to validate
249-
}
250-
251-
if err := validateNoCodeIncludeParams(o.Include); err != nil {
252-
return err
253-
}
254-
255-
return nil
256-
}
257-
258-
func validateNoCodeIncludeParams(params []RegistryNoCodeModuleIncludeOpt) error {
259-
for _, p := range params {
260-
switch p {
261-
case RegistryNoCodeIncludeVariableOptions:
262-
// do nothing
263-
default:
264-
return ErrInvalidIncludeValue
265-
}
266-
}
267-
268247
return nil
269248
}

0 commit comments

Comments
 (0)