team project access cleanup and update changelog

Author: hs26gill

CHANGELOG.md

@@ -3,6 +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 `Projects` interface with `list`, `read`, `update`, `delete` methods and integration tests @hs26gill [#564](https://github.com/hashicorp/go-tfe/pull/564)
 
 # v1.14.0

team_project_access.go

@@ -13,6 +13,7 @@ var _ TeamProjectAccesses = (*teamProjectAccesses)(nil)
 // Enterprise API supports
 //
 // TFE API docs: (TODO: ADD DOCS URL)
+// **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)
@@ -77,7 +78,6 @@ type TeamProjectAccessAddOptions struct {
 
 	// The team to add to the project
 	Team *Team `jsonapi:"relation,team"`
-
 	// The project to which the team is to be added.
 	Project *Project `jsonapi:"relation,project"`
 }
@@ -88,8 +88,7 @@ type TeamProjectAccessUpdateOptions struct {
 	// 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
-	ID string `jsonapi:"primary,team-projects"`
-
+	Type string `jsonapi:"primary,team-projects"`
 	// The type of access to grant.
 	Access *TeamProjectAccessType `jsonapi:"attr,access,omitempty"`
 }

team_project_access_integration_test.go

@@ -9,6 +9,8 @@ import (
 )
 
 func TestTeamProjectAccessesList(t *testing.T) {
+	skipIfBeta(t)
+
 	client := testClient(t)
 	ctx := context.Background()
 
@@ -23,72 +25,66 @@ func TestTeamProjectAccessesList(t *testing.T) {
 	tmTest2, tmTest2Cleanup := createTeam(t, client, orgTest)
 	defer tmTest2Cleanup()
 
-	tpaTest1, taTest1Cleanup := createTeamProjectAccess(t, client, tmTest1, pTest, orgTest)
-	defer taTest1Cleanup()
-	tpaTest2, taTest2Cleanup := createTeamProjectAccess(t, client, tmTest2, pTest, orgTest)
-	defer taTest2Cleanup()
+	tpaTest1, tpaTest1Cleanup := createTeamProjectAccess(t, client, tmTest1, pTest, orgTest)
+	defer tpaTest1Cleanup()
+	tpaTest2, tpaTest2Cleanup := createTeamProjectAccess(t, client, tmTest2, pTest, orgTest)
+	defer tpaTest2Cleanup()
 
 	t.Run("with valid options", func(t *testing.T) {
 		tpal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
 			ProjectID: pTest.ID,
-			ListOptions: ListOptions{
-				PageNumber: 1,
-				PageSize:   100,
-			},
 		})
 		require.NoError(t, err)
 		assert.Contains(t, tpal.Items, tpaTest1)
 		assert.Contains(t, tpal.Items, tpaTest2)
-
-		//t.Skip("paging not supported yet in API")
-		assert.Equal(t, 1, tpal.CurrentPage)
-		assert.Equal(t, 2, tpal.TotalCount)
 	})
 
 	t.Run("with list options", func(t *testing.T) {
-		t.Skip("paging not supported yet in API")
 		// 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.
-		tal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
+		tpal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
+			ProjectID: pTest.ID,
 			ListOptions: ListOptions{
 				PageNumber: 999,
 				PageSize:   100,
 			},
 		})
 		require.NoError(t, err)
-		assert.Empty(t, tal.Items)
-		assert.Equal(t, 999, tal.CurrentPage)
-		assert.Equal(t, 2, tal.TotalCount)
+		assert.Empty(t, tpal.Items)
+		assert.Equal(t, 999, tpal.CurrentPage)
+		assert.Equal(t, 2, tpal.TotalCount)
 	})
 
 	t.Run("without TeamProjectAccessListOptions", func(t *testing.T) {
-		tal, err := client.TeamProjectAccess.List(ctx, nil)
-		assert.Nil(t, tal)
+		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) {
-		tal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
+		tpal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
 			ListOptions: ListOptions{
 				PageNumber: 2,
 				PageSize:   25,
 			},
 		})
-		assert.Nil(t, tal)
+		assert.Nil(t, tpal)
 		assert.Equal(t, err, ErrRequiredProjectID)
 	})
 
 	t.Run("without a valid projectID", func(t *testing.T) {
-		tal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
+		tpal, err := client.TeamProjectAccess.List(ctx, &TeamProjectAccessListOptions{
 			ProjectID: badIdentifier,
 		})
-		assert.Nil(t, tal)
+		assert.Nil(t, tpal)
 		assert.EqualError(t, err, ErrInvalidProjectID.Error())
 	})
 }
 
 func TestTeamProjectAccessesRead(t *testing.T) {
+	skipIfBeta(t)
+
 	client := testClient(t)
 	ctx := context.Background()
 
@@ -105,34 +101,36 @@ func TestTeamProjectAccessesRead(t *testing.T) {
 	defer tpaTestCleanup()
 
 	t.Run("when the team access exists", func(t *testing.T) {
-		ta, err := client.TeamProjectAccess.Read(ctx, tpaTest.ID)
+		tpa, err := client.TeamProjectAccess.Read(ctx, tpaTest.ID)
 		require.NoError(t, err)
 
-		assert.Equal(t, TeamProjectAccessAdmin, ta.Access)
+		assert.Equal(t, TeamProjectAccessAdmin, tpa.Access)
 
 		t.Run("team relationship is decoded", func(t *testing.T) {
-			assert.NotEmpty(t, ta.Team)
+			assert.NotEmpty(t, tpa.Team)
 		})
 
 		t.Run("project relationship is decoded", func(t *testing.T) {
-			assert.NotEmpty(t, ta.Project)
+			assert.NotEmpty(t, tpa.Project)
 		})
 	})
 
 	t.Run("when the team access does not exist", func(t *testing.T) {
-		ta, err := client.TeamProjectAccess.Read(ctx, "nonexisting")
-		assert.Nil(t, ta)
+		tpa, err := client.TeamProjectAccess.Read(ctx, "nonexisting")
+		assert.Nil(t, tpa)
 		assert.Equal(t, err, ErrResourceNotFound)
 	})
 
 	t.Run("without a valid team access ID", func(t *testing.T) {
-		ta, err := client.TeamProjectAccess.Read(ctx, badIdentifier)
-		assert.Nil(t, ta)
+		tpa, err := client.TeamProjectAccess.Read(ctx, badIdentifier)
+		assert.Nil(t, tpa)
 		assert.Equal(t, err, ErrInvalidTeamProjectAccessID)
 	})
 }
 
 func TestTeamProjectAccessesAdd(t *testing.T) {
+	skipIfBeta(t)
+
 	client := testClient(t)
 	ctx := context.Background()
 
@@ -152,22 +150,22 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 			Project: pTest,
 		}
 
-		ta, err := client.TeamProjectAccess.Add(ctx, options)
+		tpa, err := client.TeamProjectAccess.Add(ctx, options)
 		defer func() {
-			err := client.TeamProjectAccess.Remove(ctx, ta.ID)
+			err := client.TeamProjectAccess.Remove(ctx, tpa.ID)
 			if err != nil {
-				t.Logf("error removing team access (%s): %s", ta.ID, err)
+				t.Logf("error removing team access (%s): %s", tpa.ID, err)
 			}
 		}()
 
 		require.NoError(t, err)
 
 		// Get a refreshed view from the API.
-		refreshed, err := client.TeamProjectAccess.Read(ctx, ta.ID)
+		refreshed, err := client.TeamProjectAccess.Read(ctx, tpa.ID)
 		require.NoError(t, err)
 
 		for _, item := range []*TeamProjectAccess{
-			ta,
+			tpa,
 			refreshed,
 		} {
 			assert.NotEmpty(t, item.ID)
@@ -176,8 +174,8 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 	})
 
 	t.Run("when the team already has access to the project", func(t *testing.T) {
-		_, taTestCleanup := createTeamProjectAccess(t, client, tmTest, pTest, nil)
-		defer taTestCleanup()
+		_, tpaTestCleanup := createTeamProjectAccess(t, client, tmTest, pTest, nil)
+		defer tpaTestCleanup()
 
 		options := TeamProjectAccessAddOptions{
 			Access:  ProjectAccess(TeamProjectAccessAdmin),
@@ -190,34 +188,36 @@ func TestTeamProjectAccessesAdd(t *testing.T) {
 	})
 
 	t.Run("when options is missing access", func(t *testing.T) {
-		ta, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
+		tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
 			Team:    tmTest,
 			Project: pTest,
 		})
-		assert.Nil(t, ta)
+		assert.Nil(t, tpa)
 		assert.Equal(t, err, ErrRequiredAccess)
 	})
 
 	t.Run("when options is missing team", func(t *testing.T) {
-		ta, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
+		tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
 			Access:  ProjectAccess(TeamProjectAccessAdmin),
 			Project: pTest,
 		})
-		assert.Nil(t, ta)
+		assert.Nil(t, tpa)
 		assert.Equal(t, err, ErrRequiredTeam)
 	})
 
 	t.Run("when options is missing project", func(t *testing.T) {
-		ta, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
+		tpa, err := client.TeamProjectAccess.Add(ctx, TeamProjectAccessAddOptions{
 			Access: ProjectAccess(TeamProjectAccessAdmin),
 			Team:   tmTest,
 		})
-		assert.Nil(t, ta)
+		assert.Nil(t, tpa)
 		assert.Equal(t, err, ErrRequiredProject)
 	})
 }
 
 func TestTeamProjectAccessesUpdate(t *testing.T) {
+	skipIfBeta(t)
+
 	client := testClient(t)
 	ctx := context.Background()
 
@@ -238,14 +238,16 @@ func TestTeamProjectAccessesUpdate(t *testing.T) {
 			Access: ProjectAccess(TeamProjectAccessRead),
 		}
 
-		ta, err := client.TeamProjectAccess.Update(ctx, tpaTest.ID, options)
+		tpa, err := client.TeamProjectAccess.Update(ctx, tpaTest.ID, options)
 		require.NoError(t, err)
 
-		assert.Equal(t, ta.Access, TeamProjectAccessRead)
+		assert.Equal(t, tpa.Access, TeamProjectAccessRead)
 	})
 }
 
 func TestTeamProjectAccessesRemove(t *testing.T) {
+	skipIfBeta(t)
+
 	client := testClient(t)
 	ctx := context.Background()