Adds Agent Pool to OAuth Client API

errors.go

@@ -372,4 +372,8 @@ var (
 	ErrRequiredRawState = errors.New("RawState is required")
 
 	ErrStateVersionUploadNotSupported = errors.New("upload not supported by this version of Terraform Enterprise")
+
+	ErrPrivateVCSDisabled = errors.New("the organization does not have private VCS enabled")
+
+	ErrAgentPoolUnavailable = errors.New("the provided agent pool does not exist or you are not authorized to use it")
 )

oauth_client.go

@@ -95,6 +95,8 @@ type OAuthClient struct {
 	// Relations
 	Organization *Organization `jsonapi:"relation,organization"`
 	OAuthTokens  []*OAuthToken `jsonapi:"relation,oauth-tokens"`
+	AgentPool    *AgentPool    `jsonapi:"relation,agent-pool"`
+
 	// **Note: This field is still in BETA and subject to change.**
 	// The projects to which the oauth client applies.
 	Projects []*Project `jsonapi:"relation,projects"`
@@ -165,6 +167,9 @@ type OAuthClientCreateOptions struct {
 	// Required: The VCS provider being connected with.
 	ServiceProvider *ServiceProviderType `jsonapi:"attr,service-provider"`
 
+	// Optional: AgentPool to associate the VCS Provider with, for PrivateVCS support
+	AgentPool *AgentPool `jsonapi:"relation,agent-pool,omitempty"`
+
 	// **Note: This field is still in BETA and subject to change.**
 	// Optional: Whether the OAuthClient is available to all workspaces in the organization.
 	// True if the oauth client is organization scoped, false otherwise.

oauth_client_integration_test.go

@@ -224,6 +224,74 @@ func TestOAuthClientsCreate_rsaKeyPair(t *testing.T) {
 	})
 }
 
+func TestOAuthClientsCreate_agentPool(t *testing.T) {
+	client := testClient(t)
+	ctx := context.Background()
+
+	githubToken := os.Getenv("OAUTH_CLIENT_GITHUB_TOKEN")
+	if githubToken == "" {
+		t.Skip("Export a valid OAUTH_CLIENT_GITHUB_TOKEN before running this test!")
+	}
+
+	orgTest, orgTestCleanup := createOrganization(t, client)
+	defer orgTestCleanup()
+	agentPoolTest, agentPoolCleanup := createAgentPool(t, client, orgTest)
+	defer agentPoolCleanup()
+
+	t.Run("with valid agent pool external id", func(t *testing.T) {
+		t.Skip()
+		orgTest, errOrg := client.Organizations.Read(ctx, "xxxxx")
+		require.NoError(t, errOrg)
+		agentPoolTest, errAgentPool := client.AgentPools.Read(ctx, "xxxxx")
+		require.NoError(t, errAgentPool)
+		options := OAuthClientCreateOptions{
+			APIURL:          String("https://api.github.com"),
+			HTTPURL:         String("https://github.com"),
+			OAuthToken:      String(githubToken),
+			ServiceProvider: ServiceProvider(ServiceProviderGithub),
+			AgentPool:       agentPoolTest,
+		}
+		oc, errCreate := client.OAuthClients.Create(ctx, orgTest.Name, options)
+		require.NoError(t, errCreate)
+		assert.NotEmpty(t, oc.ID)
+		assert.Nil(t, oc.Name)
+		assert.Equal(t, "https://api.github.com", oc.APIURL)
+		assert.Equal(t, "https://github.com", oc.HTTPURL)
+		assert.Equal(t, 1, len(oc.OAuthTokens))
+		assert.Equal(t, ServiceProviderGithub, oc.ServiceProvider)
+		assert.Equal(t, agentPoolTest.ID, oc.AgentPool.ID)
+	})
+
+	t.Run("with an invalid agent pool", func(t *testing.T) {
+		agentPoolID := agentPoolTest.ID
+		agentPoolTest.ID = badIdentifier
+		options := OAuthClientCreateOptions{
+			APIURL:          String("https://api.github.com"),
+			HTTPURL:         String("https://github.com"),
+			OAuthToken:      String(githubToken),
+			ServiceProvider: ServiceProvider(ServiceProviderGithub),
+			AgentPool:       agentPoolTest,
+		}
+		_, errCreate := client.OAuthClients.Create(ctx, orgTest.Name, options)
+		require.Error(t, errCreate)
+		assert.Contains(t, errCreate.Error(), ErrAgentPoolUnavailable.Error())
+		agentPoolTest.ID = agentPoolID
+	})
+
+	t.Run("with no agents connected", func(t *testing.T) {
+		options := OAuthClientCreateOptions{
+			APIURL:          String("https://api.github.com"),
+			HTTPURL:         String("https://github.com"),
+			OAuthToken:      String(githubToken),
+			ServiceProvider: ServiceProvider(ServiceProviderGithub),
+			AgentPool:       agentPoolTest,
+		}
+		_, errCreate := client.OAuthClients.Create(ctx, orgTest.Name, options)
+		assert.Contains(t, errCreate.Error(), ErrPrivateVCSDisabled.Error())
+		require.Error(t, errCreate)
+	})
+}
+
 func TestOAuthClientsRead(t *testing.T) {
 	client := testClient(t)
 	ctx := context.Background()