Support for listing team tokens of an organization (#1109)

* Add support for listing team tokens

* Add changelog entry

Author: mkam

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Enhancements
 
 * Adds BETA support for speculative runs with `Stacks` resources and removes VCS repo validity check on `Stack` creation, which is EXPERIMENTAL, SUBJECT TO CHANGE, and may not be available to all users by @hwatkins05-hashicorp [#1119](https://github.com/hashicorp/go-tfe/pull/1119)
+* Adds support for listing team tokens, by @mkam [#1109](https://github.com/hashicorp/go-tfe/pull/1109)
 
 # v1.81.0
 

mocks/team_token_mocks.go

@@ -34,6 +34,9 @@ type TeamTokens interface {
 	// Read a team token by its token ID.
 	ReadByID(ctx context.Context, teamID string) (*TeamToken, error)
 
+	// List an organization's team tokens.
+	List(ctx context.Context, organizationID string, options *TeamTokenListOptions) (*TeamTokenList, error)
+
 	// Delete a team token by its team ID.
 	Delete(ctx context.Context, teamID string) error
 
@@ -69,6 +72,25 @@ type TeamTokenCreateOptions struct {
 	Description *string `jsonapi:"attr,description,omitempty"`
 }
 
+// TeamTokenListOptions contains the options for listing team tokens.
+type TeamTokenListOptions struct {
+	ListOptions
+
+	// Optional: A query string used to filter team tokens by
+	// a specified team name.
+	Query string `url:"q,omitempty"`
+
+	// Optional: Allows sorting the team tokens by "team-name",
+	// "created-by", "expired-at", and "last-used-at"
+	Sort string `url:"sort,omitempty"`
+}
+
+// TeamTokenList represents a list of team tokens.
+type TeamTokenList struct {
+	*Pagination
+	Items []*TeamToken
+}
+
 // Create a new team token using the legacy creation behavior, which creates a token without a description
 // or regenerates the existing, descriptionless token.
 func (s *teamTokens) Create(ctx context.Context, teamID string) (*TeamToken, error) {
@@ -146,6 +168,28 @@ func (s *teamTokens) ReadByID(ctx context.Context, tokenID string) (*TeamToken,
 	return tt, err
 }
 
+// List an organization's team tokens with the option to filter by team name.
+func (s *teamTokens) List(ctx context.Context, organizationID string, options *TeamTokenListOptions) (*TeamTokenList, error) {
+	if !validStringID(&organizationID) {
+		return nil, ErrInvalidOrg
+	}
+
+	u := fmt.Sprintf("organizations/%s/team-tokens", url.PathEscape(organizationID))
+
+	req, err := s.client.NewRequest("GET", u, options)
+	if err != nil {
+		return nil, err
+	}
+
+	tt := &TeamTokenList{}
+	err = req.Do(ctx, tt)
+	if err != nil {
+		return nil, err
+	}
+
+	return tt, err
+}
+
 // Delete a team token by its team ID.
 func (s *teamTokens) Delete(ctx context.Context, teamID string) error {
 	if !validStringID(&teamID) {

team_token.go

@@ -300,6 +300,97 @@ func TestTeamTokensReadByID(t *testing.T) {
 	})
 }
 
+func TestTeamTokensList(t *testing.T) {
+	client := testClient(t)
+	ctx := context.Background()
+
+	org, orgTestCleanup := createOrganization(t, client)
+	t.Cleanup(orgTestCleanup)
+
+	// Create a team with a token
+	team1, tmTestCleanup1 := createTeam(t, client, org)
+	t.Cleanup(tmTestCleanup1)
+
+	currentTime := time.Now().UTC().Truncate(time.Second)
+	oneDayLater := currentTime.Add(24 * time.Hour)
+	token1, ttTestCleanup := createTeamTokenWithOptions(t, client, team1, TeamTokenCreateOptions{
+		ExpiredAt: &oneDayLater,
+	})
+	t.Cleanup(ttTestCleanup)
+
+	// Create a second team with a token that has a later expiration date
+	team2, tmTestCleanup2 := createTeam(t, client, org)
+	t.Cleanup(tmTestCleanup2)
+
+	twoDaysLater := currentTime.Add(48 * time.Hour)
+	token2, ttTestCleanup := createTeamTokenWithOptions(t, client, team2, TeamTokenCreateOptions{
+		ExpiredAt: &twoDaysLater,
+	})
+	t.Cleanup(ttTestCleanup)
+
+	t.Run("with team tokens across multiple teams", func(t *testing.T) {
+		tokens, err := client.TeamTokens.List(ctx, org.Name, nil)
+		require.NoError(t, err)
+		require.NotNil(t, tokens)
+		require.Len(t, tokens.Items, 2)
+		require.ElementsMatch(t, []string{token1.ID, token2.ID}, []string{tokens.Items[0].ID, tokens.Items[1].ID})
+	})
+
+	t.Run("with filtering by team name", func(t *testing.T) {
+		tokens, err := client.TeamTokens.List(ctx, org.Name, &TeamTokenListOptions{
+			Query: team1.Name,
+		})
+		require.NoError(t, err)
+		require.NotNil(t, tokens)
+		require.Len(t, tokens.Items, 1)
+		require.Equal(t, token1.ID, tokens.Items[0].ID)
+	})
+
+	t.Run("with sorting", func(t *testing.T) {
+		tokens, err := client.TeamTokens.List(ctx, org.Name, &TeamTokenListOptions{
+			Sort: "expired-at",
+		})
+		require.NoError(t, err)
+		require.NotNil(t, tokens)
+		require.Len(t, tokens.Items, 2)
+		require.Equal(t, []string{token1.ID, token2.ID}, []string{tokens.Items[0].ID, tokens.Items[1].ID})
+
+		tokens, err = client.TeamTokens.List(ctx, org.Name, &TeamTokenListOptions{
+			Sort: "-expired-at",
+		})
+		require.NoError(t, err)
+		require.NotNil(t, tokens)
+		require.Len(t, tokens.Items, 2)
+		require.Equal(t, []string{token2.ID, token1.ID}, []string{tokens.Items[0].ID, tokens.Items[1].ID})
+	})
+
+	t.Run("with multiple team tokens in a single team", func(t *testing.T) {
+		skipUnlessBeta(t)
+		desc1 := fmt.Sprintf("go-tfe-team-token-test-%s", randomString(t))
+		multiToken1, ttTestCleanup := createTeamTokenWithOptions(t, client, team1, TeamTokenCreateOptions{
+			Description: &desc1,
+		})
+		t.Cleanup(ttTestCleanup)
+
+		desc2 := fmt.Sprintf("go-tfe-team-token-test-%s", randomString(t))
+		multiToken2, ttTestCleanup := createTeamTokenWithOptions(t, client, team1, TeamTokenCreateOptions{
+			Description: &desc2,
+		})
+		t.Cleanup(ttTestCleanup)
+
+		tokens, err := client.TeamTokens.List(ctx, org.Name, nil)
+		require.NoError(t, err)
+		require.NotNil(t, tokens)
+		require.Len(t, tokens.Items, 4)
+		actualIDs := []string{}
+		for _, token := range tokens.Items {
+			actualIDs = append(actualIDs, token.ID)
+		}
+		require.ElementsMatch(t, []string{token1.ID, token2.ID, multiToken1.ID, multiToken2.ID},
+			actualIDs)
+	})
+}
+
 func TestTeamTokensDelete(t *testing.T) {
 	client := testClient(t)
 	ctx := context.Background()