Add default agent pool and execution mode support to projects (#1185)

* Add ExcludedWorkspaces and AllowedProjects to AgentPools

* Add DefaultExecutionMode, DefaultAgentPool, and SettingOverwrites to Project

* Update CHANGELOG

* Address lint failures

* Update mocks

* Private receiver to reduce duplication

* Prefer t.Cleanup over defer

* Use require.Equal() or require.NotNil() to prevent downstream panics when accessing the slice by index

* Remove unnecessary org subscription upgrades

* Added comment to updateArrayAttribute

---------

Co-authored-by: Chris Trombley <[email protected]>

Author: tylerwolf

CHANGELOG.md

@@ -8,6 +8,8 @@
 * Adds `CanceledAt`, `RunEvents`, `TriggerReason` field to `Run` by @jpadrianoGo [#1161](https://github.com/hashicorp/go-tfe/pull/1161)
 * Adds `CreatedAt` field to `AgentPool` by @jpadrianoGo [#1150](https://github.com/hashicorp/go-tfe/pull/1150)
 * Adds `CreatedBy` relation to `AgentToken` by @jpadrianoGo [#1149](https://github.com/hashicorp/go-tfe/pull/1149)
+* Adds `AllowedProjects` and `ExcludedWorkspaces` to `AgentPool` by @tylerwolf [#1185](https://github.com/hashicorp/go-tfe/pull/1185)
+* Adds `DefaultExecutionMode`, `DefaultAgentPool`, and `SettingOverwrites` to `Project` by @tylerwolf [#1185](https://github.com/hashicorp/go-tfe/pull/1185)
 
 # v1.90.0
 

agent_pool.go

@@ -36,6 +36,12 @@ type AgentPools interface {
 	// UpdateAllowedWorkspaces updates the list of allowed workspaces associated with an agent pool.
 	UpdateAllowedWorkspaces(ctx context.Context, agentPool string, options AgentPoolAllowedWorkspacesUpdateOptions) (*AgentPool, error)
 
+	// UpdateAllowedProjects updates the list of allowed projects associated with an agent pool.
+	UpdateAllowedProjects(ctx context.Context, agentPool string, options AgentPoolAllowedProjectsUpdateOptions) (*AgentPool, error)
+
+	// UpdateExcludedWorkspaces updates the list of excluded workspaces associated with an agent pool.
+	UpdateExcludedWorkspaces(ctx context.Context, agentPool string, options AgentPoolExcludedWorkspacesUpdateOptions) (*AgentPool, error)
+
 	// Delete an agent pool by its ID.
 	Delete(ctx context.Context, agentPoolID string) error
 }
@@ -60,9 +66,11 @@ type AgentPool struct {
 	CreatedAt          time.Time `jsonapi:"attr,created-at,iso8601"`
 
 	// Relations
-	Organization      *Organization `jsonapi:"relation,organization"`
-	Workspaces        []*Workspace  `jsonapi:"relation,workspaces"`
-	AllowedWorkspaces []*Workspace  `jsonapi:"relation,allowed-workspaces"`
+	Organization       *Organization `jsonapi:"relation,organization"`
+	Workspaces         []*Workspace  `jsonapi:"relation,workspaces"`
+	AllowedWorkspaces  []*Workspace  `jsonapi:"relation,allowed-workspaces"`
+	AllowedProjects    []*Project    `jsonapi:"relation,allowed-projects"`
+	ExcludedWorkspaces []*Workspace  `jsonapi:"relation,excluded-workspaces"`
 }
 
 // A list of relations to include
@@ -87,6 +95,9 @@ type AgentPoolListOptions struct {
 
 	// Optional: String (workspace name) used to filter the results.
 	AllowedWorkspacesName string `url:"filter[allowed_workspaces][name],omitempty"`
+
+	// Optional: String (project name) used to filter the results.
+	AllowedProjectsName string `url:"filter[allowed_projects][name],omitempty"`
 }
 
 // AgentPoolCreateOptions represents the options for creating an agent pool.
@@ -105,6 +116,12 @@ type AgentPoolCreateOptions struct {
 
 	// List of workspaces that are associated with an agent pool.
 	AllowedWorkspaces []*Workspace `jsonapi:"relation,allowed-workspaces,omitempty"`
+
+	// List of projects that are associated with an agent pool.
+	AllowedProjects []*Project `jsonapi:"relation,allowed-projects,omitempty"`
+
+	// List of workspaces that are excluded from the scope of an agent pool.
+	ExcludedWorkspaces []*Workspace `jsonapi:"relation,excluded-workspaces,omitempty"`
 }
 
 // List all the agent pools of the given organization.
@@ -201,9 +218,15 @@ type AgentPoolUpdateOptions struct {
 
 	// A new list of workspaces that are associated with an agent pool.
 	AllowedWorkspaces []*Workspace `jsonapi:"relation,allowed-workspaces,omitempty"`
+
+	// A new list of projects that are associated with an agent pool.
+	AllowedProjects []*Project `jsonapi:"relation,allowed-projects,omitempty"`
+
+	// A new list of workspaces that are excluded from the scope of an agent pool.
+	ExcludedWorkspaces []*Workspace `jsonapi:"relation,excluded-workspaces,omitempty"`
 }
 
-// AgentPoolUpdateAllowedWorkspacesOptions represents the options for updating the allowed workspace on an agent pool
+// AgentPoolAllowedWorkspacesUpdateOptions represents the options for updating the allowed workspace on an agent pool
 type AgentPoolAllowedWorkspacesUpdateOptions struct {
 	// Type is a public field utilized by JSON:API to
 	// set the resource type via the field tag.
@@ -215,8 +238,33 @@ type AgentPoolAllowedWorkspacesUpdateOptions struct {
 	AllowedWorkspaces []*Workspace `jsonapi:"relation,allowed-workspaces"`
 }
 
+// AgentPoolAllowedProjectsUpdateOptions represents the options for updating the allowed projects on an agent pool
+type AgentPoolAllowedProjectsUpdateOptions struct {
+	// Type is a public field utilized by JSON:API to
+	// 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
+	Type string `jsonapi:"primary,agent-pools"`
+
+	// A new list of projects that are associated with an agent pool.
+	AllowedProjects []*Project `jsonapi:"relation,allowed-projects"`
+}
+
+// AgentPoolExcludedWorkspacesUpdateOptions represents the options for updating the excluded workspace on an agent pool
+type AgentPoolExcludedWorkspacesUpdateOptions struct {
+	// Type is a public field utilized by JSON:API to
+	// 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
+	Type string `jsonapi:"primary,agent-pools"`
+
+	// A new list of workspaces that are excluded from the scope of an agent pool.
+	ExcludedWorkspaces []*Workspace `jsonapi:"relation,excluded-workspaces"`
+}
+
 // Update an agent pool by its ID.
-// **Note:** This method cannot be used to clear the allowed workspaces field, instead use UpdateAllowedWorkspaces
+// **Note:** This method cannot be used to clear the allowed workspaces, allowed projects, or excluded workspaces fields.
+// instead use UpdateAllowedWorkspaces, UpdateAllowedProjects, or UpdateExcludedWorkspaces methods respectively.
 func (s *agentPools) Update(ctx context.Context, agentPoolID string, options AgentPoolUpdateOptions) (*AgentPool, error) {
 	if !validStringID(&agentPoolID) {
 		return nil, ErrInvalidAgentPoolID
@@ -242,23 +290,15 @@ func (s *agentPools) Update(ctx context.Context, agentPoolID string, options Age
 }
 
 func (s *agentPools) UpdateAllowedWorkspaces(ctx context.Context, agentPoolID string, options AgentPoolAllowedWorkspacesUpdateOptions) (*AgentPool, error) {
-	if !validStringID(&agentPoolID) {
-		return nil, ErrInvalidAgentPoolID
-	}
-
-	u := fmt.Sprintf("agent-pools/%s", url.PathEscape(agentPoolID))
-	req, err := s.client.NewRequest("PATCH", u, &options)
-	if err != nil {
-		return nil, err
-	}
+	return s.updateArrayAttribute(ctx, agentPoolID, &options)
+}
 
-	k := &AgentPool{}
-	err = req.Do(ctx, k)
-	if err != nil {
-		return nil, err
-	}
+func (s *agentPools) UpdateAllowedProjects(ctx context.Context, agentPoolID string, options AgentPoolAllowedProjectsUpdateOptions) (*AgentPool, error) {
+	return s.updateArrayAttribute(ctx, agentPoolID, &options)
+}
 
-	return k, nil
+func (s *agentPools) UpdateExcludedWorkspaces(ctx context.Context, agentPoolID string, options AgentPoolExcludedWorkspacesUpdateOptions) (*AgentPool, error) {
+	return s.updateArrayAttribute(ctx, agentPoolID, &options)
 }
 
 // Delete an agent pool by its ID.
@@ -276,6 +316,30 @@ func (s *agentPools) Delete(ctx context.Context, agentPoolID string) error {
 	return req.Do(ctx, nil)
 }
 
+// updateArrayAttribute is a helper function to update array attributes of an agent pool, such as allowed workspaces, allowed projects, or excluded workspaces.
+// Note: This function does not validate the options parameter, so it should be used with caution.  It is intended to be used with options structs
+// (e.g. AgentPoolAllowedWorkspacesUpdateOptions, AgentPoolAllowedProjectsUpdateOptions, AgentPoolExcludedWorkspacesUpdateOptions) whose array
+// attributes are NOT marked `omitempty`, so that an empty array is sent to the API to clear the existing values.
+func (s *agentPools) updateArrayAttribute(ctx context.Context, agentPoolID string, options any) (*AgentPool, error) {
+	if !validStringID(&agentPoolID) {
+		return nil, ErrInvalidAgentPoolID
+	}
+
+	u := fmt.Sprintf("agent-pools/%s", url.PathEscape(agentPoolID))
+	req, err := s.client.NewRequest("PATCH", u, options)
+	if err != nil {
+		return nil, err
+	}
+
+	k := &AgentPool{}
+	err = req.Do(ctx, k)
+	if err != nil {
+		return nil, err
+	}
+
+	return k, nil
+}
+
 func (o AgentPoolCreateOptions) valid() error {
 	if !validString(o.Name) {
 		return ErrRequiredName