Merge pull request #849 from hashicorp/jspiker/search-projects-and-teams

Allow searching by name on team and project list

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Unreleased
 
+## Enhancements
+* Adds `Query` field to `Project` and `Team` list options, to allow projects and teams to be searched by name by @JarrettSpiker [#849](https://github.com/hashicorp/go-tfe/pull/849)
+
 # v1.45.0
 
 ## Enhancements

project.go

@@ -57,10 +57,13 @@ type Project struct {
 type ProjectListOptions struct {
 	ListOptions
 
-	// Optional: String (partial project name) used to filter the results.
+	// Optional: String (complete project name) used to filter the results.
 	// If multiple, comma separated values are specified, projects matching
 	// any of the names are returned.
 	Name string `url:"filter[names],omitempty"`
+
+	// Optional: A query string to search projects by names.
+	Query string `url:"q,omitempty"`
 }
 
 // ProjectCreateOptions represents the options for creating a project

projects_integration_test.go

@@ -34,7 +34,7 @@ func TestProjectsList(t *testing.T) {
 		assert.Equal(t, 3, pl.TotalCount)
 	})
 
-	t.Run("with list options", func(t *testing.T) {
+	t.Run("with pagination list options", func(t *testing.T) {
 		pl, err := client.Projects.List(ctx, orgTest.Name, &ProjectListOptions{
 			ListOptions: ListOptions{
 				PageNumber: 1,
@@ -48,6 +48,15 @@ func TestProjectsList(t *testing.T) {
 		assert.Equal(t, 3, len(pl.Items))
 	})
 
+	t.Run("with query list option", func(t *testing.T) {
+		pl, err := client.Projects.List(ctx, orgTest.Name, &ProjectListOptions{
+			Query: "Default",
+		})
+		require.NoError(t, err)
+		assert.Equal(t, true, containsProject(pl.Items, "Default Project"))
+		assert.Equal(t, 1, len(pl.Items))
+	})
+
 	t.Run("without a valid organization", func(t *testing.T) {
 		pl, err := client.Projects.List(ctx, badIdentifier, nil)
 		assert.Nil(t, pl)

team.go

@@ -98,6 +98,9 @@ type TeamListOptions struct {
 
 	// Optional: A list of team names to filter by.
 	Names []string `url:"filter[names],omitempty"`
+
+	// Optional: A query string to search teams by names.
+	Query string `url:"q,omitempty"`
 }
 
 // TeamCreateOptions represents the options for creating a team.

team_integration_test.go

@@ -33,14 +33,13 @@ func TestTeamsList(t *testing.T) {
 		require.NoError(t, err)
 		assert.Contains(t, tl.Items, tmTest1)
 		assert.Contains(t, tl.Items, tmTest2)
+		assert.Contains(t, tl.Items, tmTest3)
 
-		t.Skip("paging not supported yet in API")
 		assert.Equal(t, 1, tl.CurrentPage)
-		assert.Equal(t, 2, tl.TotalCount)
+		assert.Equal(t, 4, tl.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.
@@ -53,16 +52,24 @@ func TestTeamsList(t *testing.T) {
 		require.NoError(t, err)
 		assert.Empty(t, tl.Items)
 		assert.Equal(t, 999, tl.CurrentPage)
-		assert.Equal(t, 2, tl.TotalCount)
+		assert.Equal(t, 4, tl.TotalCount)
 
 		tl, err = client.Teams.List(ctx, orgTest.Name, &TeamListOptions{
 			Names: []string{tmTest2.Name, tmTest3.Name},
 		})
-
-		assert.Equal(t, tl.Items, 2)
+		require.NoError(t, err)
+		assert.Equal(t, len(tl.Items), 2)
 		assert.Contains(t, tl.Items, tmTest2)
 		assert.Contains(t, tl.Items, tmTest3)
 
+		tl, err = client.Teams.List(ctx, orgTest.Name, &TeamListOptions{
+			Query: tmTest1.Name[:len(tmTest1.Name)-2],
+		})
+		require.NoError(t, err)
+		assert.Equal(t, len(tl.Items), 1)
+		assert.Equal(t, 1, tl.TotalCount)
+		assert.Contains(t, tl.Items, tmTest1)
+
 		t.Run("with invalid names query param", func(t *testing.T) {
 			// should return an error because we've included an empty string
 			tl, err = client.Teams.List(ctx, orgTest.Name, &TeamListOptions{