WIP: Fixing Add options for TeamProjectAccess

Author: hs26gill

CHANGELOG.md

@@ -3,7 +3,7 @@
 ## Bug Fixes
 
 ## Enhancements
-* Add Beta `TeamProjectAccesses` interface with `list`, `add`, `read`, `update`, `remove` methods and integration tests @hs26gill [#599](https://github.com/hashicorp/go-tfe/pull/599)
+* Add Beta `TeamProjectAccesses` interface with `list`, `add`, `read`, `update`, `remove` methods and integration tests by @hs26gill [#599](https://github.com/hashicorp/go-tfe/pull/599)
 
 # v1.16.0
 

errors.go

@@ -154,6 +154,8 @@ var (
 
 	ErrInvalidTeamProjectAccessID = errors.New("invalid value for team project access ID")
 
+	ErrInvalidTeamProjectAccessType = errors.New("invalid type for team project access")
+
 	ErrInvalidTeamID = errors.New("invalid value for team ID")
 
 	ErrInvalidUsernames = errors.New("invalid value for usernames")

helper_test.go

@@ -1670,9 +1670,9 @@ func createTeamProjectAccess(t *testing.T, client *Client, tm *Team, p *Project,
 
 	ctx := context.Background()
 	tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
-		Access:  ProjectAccess(TeamProjectAccessAdmin),
-		Team:    tm,
-		Project: p,
+		Access:  *ProjectAccess(TeamProjectAccessAdmin),
+		Team:    *tm,
+		Project: *p,
 	})
 	if err != nil {
 		t.Fatal(err)

team_project_access.go

@@ -12,7 +12,7 @@ var _ TeamProjectAccesses = (*teamProjectAccesses)(nil)
 // TeamProjectAccesses describes all the team project access related methods that the Terraform
 // Enterprise API supports
 //
-// TFE API docs: (TODO: ADD DOCS URL)
+// TFE API docs: Documentation will be linked once this feature is available
 // **Note: This functionality is still in BETA and subject to change.**
 type TeamProjectAccesses interface {
 	// List all project accesses for a given project.
@@ -74,12 +74,12 @@ type TeamProjectAccessAddOptions struct {
 	// https://jsonapi.org/format/#crud-creating
 	Type string `jsonapi:"primary,team-projects"`
 	// The type of access to grant.
-	Access *TeamProjectAccessType `jsonapi:"attr,access"`
+	Access TeamProjectAccessType `jsonapi:"attr,access"`
 
 	// The team to add to the project
-	Team *Team `jsonapi:"relation,team"`
+	Team Team `jsonapi:"relation,team"`
 	// The project to which the team is to be added.
-	Project *Project `jsonapi:"relation,project"`
+	Project Project `jsonapi:"relation,project"`
 }
 
 // TeamProjectAccessUpdateOptions represents the options for updating a team project access
@@ -119,6 +119,10 @@ func (s *teamProjectAccesses) Add(ctx context.Context, options TeamProjectAccess
 		return nil, err
 	}
 
+	if err := validateTeamProjectAccessType(options.Access); err != nil {
+		return nil, err
+	}
+
 	req, err := s.client.NewRequest("POST", "team-projects", &options)
 	if err != nil {
 		return nil, err
@@ -160,6 +164,9 @@ func (s *teamProjectAccesses) Update(ctx context.Context, teamProjectAccessID st
 		return nil, ErrInvalidTeamProjectAccessID
 	}
 
+	if err := validateTeamProjectAccessType(*options.Access); err != nil {
+		return nil, err
+	}
 	u := fmt.Sprintf("team-projects/%s", url.QueryEscape(teamProjectAccessID))
 	req, err := s.client.NewRequest("PATCH", u, &options)
 	if err != nil {
@@ -194,25 +201,33 @@ func (o *TeamProjectAccessListOptions) valid() error {
 	if o == nil {
 		return ErrRequiredTeamProjectAccessListOps
 	}
-	if !validString(&o.ProjectID) {
-		return ErrRequiredProjectID
-	}
 	if !validStringID(&o.ProjectID) {
 		return ErrInvalidProjectID
 	}
 
 	return nil
 }
 
-func (o TeamProjectAccessAddOptions) valid() error {
-	if o.Access == nil {
-		return ErrRequiredAccess
+func (o *TeamProjectAccessAddOptions) valid() error {
+	if err := validateTeamProjectAccessType(o.Access); err != nil {
+		return err
+	}
+	if o.Team.ID == "" {
+		return ErrInvalidTeamID
 	}
-	if o.Team == nil {
-		return ErrRequiredTeam
+	if o.Project.ID == "" {
+		return ErrInvalidProjectID
 	}
-	if o.Project == nil {
-		return ErrRequiredProject
+
+	return nil
+}
+
+func validateTeamProjectAccessType(t TeamProjectAccessType) error {
+	switch t {
+	case TeamProjectAccessAdmin, TeamProjectAccessRead:
+		// do nothing
+	default:
+		return ErrInvalidTeamProjectAccessType
 	}
 	return nil
 }

team_project_access_integration_test.go

@@ -129,7 +129,7 @@ func TestTeamProjectAccessesRead(t *testing.T) {
 }
 
 func TestTeamProjectAccessesAdd(t *testing.T) {
-	skipUnlessBeta(t)
+	//skipUnlessBeta(t)
 
 	client := testClient(t)
 	ctx := context.Background()
@@ -145,9 +145,9 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 
 	t.Run("with valid options", func(t *testing.T) {
 		options := TeamProjectAccessAddOptions{
-			Access:  ProjectAccess(TeamProjectAccessAdmin),
-			Team:    tmTest,
-			Project: pTest,
+			Access:  *ProjectAccess(TeamProjectAccessAdmin),
+			Team:    *tmTest,
+			Project: *pTest,
 		}
 
 		tpa, err := client.TeamProjectAccess.Add(ctx, options)
@@ -169,7 +169,7 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 			refreshed,
 		} {
 			assert.NotEmpty(t, item.ID)
-			assert.Equal(t, *options.Access, item.Access)
+			assert.Equal(t, options.Access, item.Access)
 		}
 	})
 
@@ -178,9 +178,9 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 		defer tpaTestCleanup()
 
 		options := TeamProjectAccessAddOptions{
-			Access:  ProjectAccess(TeamProjectAccessAdmin),
-			Team:    tmTest,
-			Project: pTest,
+			Access:  *ProjectAccess(TeamProjectAccessAdmin),
+			Team:    *tmTest,
+			Project: *pTest,
 		}
 
 		_, err := client.TeamProjectAccess.Add(ctx, options)
@@ -189,29 +189,39 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 
 	t.Run("when options is missing access", func(t *testing.T) {
 		tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
-			Team:    tmTest,
-			Project: pTest,
+			Team:    *tmTest,
+			Project: *pTest,
 		})
 		assert.Nil(t, tpa)
-		assert.Equal(t, err, ErrRequiredAccess)
+		assert.Equal(t, err, ErrInvalidTeamProjectAccessType)
 	})
 
 	t.Run("when options is missing team", func(t *testing.T) {
 		tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
-			Access:  ProjectAccess(TeamProjectAccessAdmin),
-			Project: pTest,
+			Access:  *ProjectAccess(TeamProjectAccessAdmin),
+			Project: *pTest,
 		})
 		assert.Nil(t, tpa)
-		assert.Equal(t, err, ErrRequiredTeam)
+		assert.Equal(t, err, ErrInvalidTeamID)
 	})
 
 	t.Run("when options is missing project", func(t *testing.T) {
 		tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
-			Access: ProjectAccess(TeamProjectAccessAdmin),
-			Team:   tmTest,
+			Access: *ProjectAccess(TeamProjectAccessAdmin),
+			Team:   *tmTest,
+		})
+		assert.Nil(t, tpa)
+		assert.Equal(t, err, ErrInvalidProjectID)
+	})
+
+	t.Run("when invalid access is provided in options", func(t *testing.T) {
+		tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
+			Access:  badIdentifier,
+			Team:    *tmTest,
+			Project: *pTest,
 		})
 		assert.Nil(t, tpa)
-		assert.Equal(t, err, ErrRequiredProject)
+		assert.Equal(t, err, ErrInvalidTeamProjectAccessType)
 	})
 }