Merge pull request #417 from hashicorp/jspiker/agent-pool-search

Add query option to agent pool list options

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Unreleased
 
 * [beta] Add support for triggering Workspace runs through matching Git tags [#434](https://github.com/hashicorp/go-tfe/pull/434)
+* Add `Query` param field to `AgentPoolListOptions` to allow searching based on agent pool name, by @JarrettSpiker [#417](https://github.com/hashicorp/go-tfe/pull/417)
 * Add organization scope and allowed workspaces field for scope agents by @Netra2104 [#453](https://github.com/hashicorp/go-tfe/pull/453)
 
 ## Bug fixes

agent_pool.go

@@ -72,6 +72,9 @@ type AgentPoolListOptions struct {
 	// Optional: A list of relations to include. See available resources
 	// https://www.terraform.io/cloud-docs/api-docs/agents#available-related-resources
 	Include []AgentPoolIncludeOpt `url:"include,omitempty"`
+
+	// Optional: A search query string used to filter agent pool. Agent pools are searchable by name
+	Query string `url:"q,omitempty"`
 }
 
 // AgentPoolCreateOptions represents the options for creating an agent pool.

agent_pool_integration_test.go

@@ -68,6 +68,21 @@ func TestAgentPoolsList(t *testing.T) {
 		assert.Nil(t, pools)
 		assert.EqualError(t, err, ErrInvalidOrg.Error())
 	})
+
+	t.Run("with query options", func(t *testing.T) {
+
+		pools, err := client.AgentPools.List(ctx, orgTest.Name, &AgentPoolListOptions{
+			Query: agentPool.Name,
+		})
+		require.NoError(t, err)
+		assert.Equal(t, len(pools.Items), 1)
+
+		pools, err = client.AgentPools.List(ctx, orgTest.Name, &AgentPoolListOptions{
+			Query: agentPool.Name + "not_going_to_match",
+		})
+		require.NoError(t, err)
+		assert.Empty(t, pools.Items)
+	})
 }
 
 func TestAgentPoolsCreate(t *testing.T) {