Fix add options and tests 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 endpoint `TeamProjectAccesses` to manage Project Access for Teams 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,7 +1670,7 @@ func createTeamProjectAccess(t *testing.T, client *Client, tm *Team, p *Project,
 
 	ctx := context.Background()
 	tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
-		Access:  ProjectAccess(TeamProjectAccessAdmin),
+		Access:  *ProjectAccess(TeamProjectAccessAdmin),
 		Team:    tm,
 		Project: p,
 	})

mocks/team_project_access_mocks.go

@@ -12,11 +12,11 @@ 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.
-	List(ctx context.Context, options *TeamProjectAccessListOptions) (*TeamProjectAccessList, error)
+	List(ctx context.Context, options TeamProjectAccessListOptions) (*TeamProjectAccessList, error)
 
 	// Add team access for a project.
 	Add(ctx context.Context, options TeamProjectAccessAddOptions) (*TeamProjectAccess, error)
@@ -74,7 +74,7 @@ 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"`
@@ -94,12 +94,12 @@ type TeamProjectAccessUpdateOptions struct {
 }
 
 // List all team accesses for a given project.
-func (s *teamProjectAccesses) List(ctx context.Context, options *TeamProjectAccessListOptions) (*TeamProjectAccessList, error) {
+func (s *teamProjectAccesses) List(ctx context.Context, options TeamProjectAccessListOptions) (*TeamProjectAccessList, error) {
 	if err := options.valid(); err != nil {
 		return nil, err
 	}
 
-	req, err := s.client.NewRequest("GET", "team-projects", options)
+	req, err := s.client.NewRequest("GET", "team-projects", &options)
 	if err != nil {
 		return nil, err
 	}
@@ -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 {
@@ -191,28 +198,33 @@ func (s *teamProjectAccesses) Remove(ctx context.Context, teamProjectAccessID st
 }
 
 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 == nil {
 		return ErrRequiredTeam
 	}
 	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.go

@@ -31,7 +31,7 @@ func TestTeamProjectAccessesList(t *testing.T) {
 	defer tpaTest2Cleanup()
 
 	t.Run("with valid options", func(t *testing.T) {
-		tpal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
+		tpal, err := client.TeamProjectAccess.List(ctx, TeamProjectAccessListOptions{
 			ProjectID: pTest.ID,
 		})
 		require.NoError(t, err)
@@ -43,7 +43,7 @@ func TestTeamProjectAccessesList(t *testing.T) {
 		// Request a page number which is out of range. The result should
 		// be successful, but return no results if the paging options are
 		// properly passed along.
-		tpal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
+		tpal, err := client.TeamProjectAccess.List(ctx, TeamProjectAccessListOptions{
 			ProjectID: pTest.ID,
 			ListOptions: ListOptions{
 				PageNumber: 999,
@@ -56,25 +56,19 @@ func TestTeamProjectAccessesList(t *testing.T) {
 		assert.Equal(t, 2, tpal.TotalCount)
 	})
 
-	t.Run("without TeamProjectAccessListOptions", func(t *testing.T) {
-		tpal, err := client.TeamProjectAccess.List(ctx, nil)
-		assert.Nil(t, tpal)
-		assert.Equal(t, err, ErrRequiredTeamProjectAccessListOps)
-	})
-
 	t.Run("without projectID options", func(t *testing.T) {
-		tpal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
+		tpal, err := client.TeamProjectAccess.List(ctx, TeamProjectAccessListOptions{
 			ListOptions: ListOptions{
 				PageNumber: 2,
 				PageSize:   25,
 			},
 		})
 		assert.Nil(t, tpal)
-		assert.Equal(t, err, ErrRequiredProjectID)
+		assert.Equal(t, err, ErrInvalidProjectID)
 	})
 
 	t.Run("without a valid projectID", func(t *testing.T) {
-		tpal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
+		tpal, err := client.TeamProjectAccess.List(ctx, TeamProjectAccessListOptions{
 			ProjectID: badIdentifier,
 		})
 		assert.Nil(t, tpal)
@@ -145,7 +139,7 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 
 	t.Run("with valid options", func(t *testing.T) {
 		options := TeamProjectAccessAddOptions{
-			Access:  ProjectAccess(TeamProjectAccessAdmin),
+			Access:  *ProjectAccess(TeamProjectAccessAdmin),
 			Team:    tmTest,
 			Project: pTest,
 		}
@@ -169,7 +163,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,7 +172,7 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 		defer tpaTestCleanup()
 
 		options := TeamProjectAccessAddOptions{
-			Access:  ProjectAccess(TeamProjectAccessAdmin),
+			Access:  *ProjectAccess(TeamProjectAccessAdmin),
 			Team:    tmTest,
 			Project: pTest,
 		}
@@ -193,12 +187,12 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 			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),
+			Access:  *ProjectAccess(TeamProjectAccessAdmin),
 			Project: pTest,
 		})
 		assert.Nil(t, tpa)
@@ -207,12 +201,22 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 
 	t.Run("when options is missing project", func(t *testing.T) {
 		tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
-			Access: ProjectAccess(TeamProjectAccessAdmin),
+			Access: *ProjectAccess(TeamProjectAccessAdmin),
 			Team:   tmTest,
 		})
 		assert.Nil(t, tpa)
 		assert.Equal(t, err, ErrRequiredProject)
 	})
+
+	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, ErrInvalidTeamProjectAccessType)
+	})
 }
 
 func TestTeamProjectAccessesUpdate(t *testing.T) {