Enable workspace and organization Health Assessment (drift detection) setting management

CHANGELOG.md

@@ -1,6 +1,8 @@
 # Unreleased
 * Add `Query` param field to `OrganizationListOptions` to allow searching based on name or email by @laurenolivia [#529](https://github.com/hashicorp/go-tfe/pull/529)
 
+* Add support for managing workspace and organization health assessment (drift detection) setting [#462](https://github.com/hashicorp/go-tfe/pull/462)
+
 ## Bug Fixes
 * Fixes null value returned in variable set relationship in `VariableSetVariable` by @sebasslash [#521](https://github.com/hashicorp/go-tfe/pull/521)
 

organization.go

@@ -68,6 +68,7 @@ type Organization struct {
 	CostEstimationEnabled                             bool                     `jsonapi:"attr,cost-estimation-enabled"`
 	CreatedAt                                         time.Time                `jsonapi:"attr,created-at,iso8601"`
 	Email                                             string                   `jsonapi:"attr,email"`
+	AssessmentsEnforced                               bool                     `jsonapi:"attr,assessments-enforced"`
 	ExternalID                                        string                   `jsonapi:"attr,external-id"`
 	OwnersTeamSAMLRoleID                              string                   `jsonapi:"attr,owners-team-saml-role-id"`
 	Permissions                                       *OrganizationPermissions `jsonapi:"attr,permissions"`
@@ -162,6 +163,9 @@ type OrganizationCreateOptions struct {
 
 	// Optional: SendPassingStatusesForUntriggeredSpeculativePlans toggles behavior of untriggered speculative plans to send status updates to version control systems like GitHub.
 	SendPassingStatusesForUntriggeredSpeculativePlans *bool `jsonapi:"attr,send-passing-statuses-for-untriggered-speculative-plans,omitempty"`
+
+	// Optional: AssessmentsEnforced toggles whether health assessment enablement is enforced across all assessable workspaces (those with a minimum terraform versio of 0.15.4 and not running in local execution mode) or if the decision to enabled health assessments is delegated to the workspace setting AssessmentsEnabled.
+	AssessmentsEnforced *bool `jsonapi:"attr,assessments-enforced"`
 }
 
 // OrganizationUpdateOptions represents the options for updating an organization.
@@ -195,6 +199,9 @@ type OrganizationUpdateOptions struct {
 
 	// SendPassingStatusesForUntriggeredSpeculativePlans toggles behavior of untriggered speculative plans to send status updates to version control systems like GitHub.
 	SendPassingStatusesForUntriggeredSpeculativePlans *bool `jsonapi:"attr,send-passing-statuses-for-untriggered-speculative-plans,omitempty"`
+
+	// Optional: AssessmentsEnforced toggles whether health assessment enablement is enforced across all assessable workspaces (those with a minimum terraform versio of 0.15.4 and not running in local execution mode) or if the decision to enabled health assessments is delegated to the workspace setting AssessmentsEnabled.
+	AssessmentsEnforced *bool `jsonapi:"attr,assessments-enforced"`
 }
 
 // ReadRunQueueOptions represents the options for showing the queue.

organization_integration_test.go

@@ -478,6 +478,7 @@ func TestOrganization_Unmarshal(t *testing.T) {
 			"type": "organizations",
 			"id":   "org-name",
 			"attributes": map[string]interface{}{
+				"assessments-enforced":     true,
 				"collaborator-auth-policy": AuthPolicyPassword,
 				"cost-estimation-enabled":  true,
 				"created-at":               "2018-03-02T23:42:06.651Z",
@@ -500,6 +501,7 @@ func TestOrganization_Unmarshal(t *testing.T) {
 	parsedTime, err := time.Parse(iso8601TimeFormat, "2018-03-02T23:42:06.651Z")
 	require.NoError(t, err)
 	assert.Equal(t, org.Name, "org-name")
+	assert.Equal(t, org.AssessmentsEnforced, true)
 	assert.Equal(t, org.CreatedAt, parsedTime)
 	assert.Equal(t, org.CollaboratorAuthPolicy, AuthPolicyPassword)
 	assert.Equal(t, org.CostEstimationEnabled, true)

workspace.go

@@ -115,6 +115,7 @@ type Workspace struct {
 	CanQueueDestroyPlan        bool                  `jsonapi:"attr,can-queue-destroy-plan"`
 	CreatedAt                  time.Time             `jsonapi:"attr,created-at,iso8601"`
 	Description                string                `jsonapi:"attr,description"`
+	AssessmentsEnabled         bool                  `jsonapi:"attr,assessments-enabled"`
 	Environment                string                `jsonapi:"attr,environment"`
 	ExecutionMode              string                `jsonapi:"attr,execution-mode"`
 	FileTriggersEnabled        bool                  `jsonapi:"attr,file-triggers-enabled"`
@@ -270,6 +271,11 @@ type WorkspaceCreateOptions struct {
 	// Optional: A description for the workspace.
 	Description *string `jsonapi:"attr,description,omitempty"`
 
+	// Optional: Whether to enable health assessments (drift detection etc.) for the workspace.
+	// Reference: https://www.terraform.io/cloud-docs/api-docs/workspaces#create-a-workspace
+	// Requires remote execution mode, Terraform Cloud Business entitlement, and a valid agent pool to work
+	AssessmentsEnabled *bool `jsonapi:"attr,assessments-enabled,omitempty"`
+
 	// Optional: Which execution mode to use. Valid values are remote, local, and agent.
 	// When set to local, the workspace will be used for state storage only.
 	// This value must not be specified if operations is specified.
@@ -389,6 +395,11 @@ type WorkspaceUpdateOptions struct {
 	// Optional: A description for the workspace.
 	Description *string `jsonapi:"attr,description,omitempty"`
 
+	// Optional: Whether to enable health assessments (drift detection etc.) for the workspace.
+	// Reference: https://www.terraform.io/cloud-docs/api-docs/workspaces#update-a-workspace
+	// Requires remote execution mode, Terraform Cloud Business entitlement, and a valid agent pool to work
+	AssessmentsEnabled *bool `jsonapi:"attr,assessments-enabled,omitempty"`
+
 	// Optional: Which execution mode to use. Valid values are remote, local, and agent.
 	// When set to local, the workspace will be used for state storage only.
 	// This value must not be specified if operations is specified.

workspace_integration_test.go

@@ -327,6 +327,7 @@ func TestWorkspacesCreate(t *testing.T) {
 			AllowDestroyPlan:           Bool(false),
 			AutoApply:                  Bool(true),
 			Description:                String("qux"),
+			AssessmentsEnabled:         Bool(false),
 			FileTriggersEnabled:        Bool(true),
 			Operations:                 Bool(true),
 			QueueAllRuns:               Bool(true),
@@ -363,6 +364,7 @@ func TestWorkspacesCreate(t *testing.T) {
 			assert.Equal(t, *options.Description, item.Description)
 			assert.Equal(t, *options.AllowDestroyPlan, item.AllowDestroyPlan)
 			assert.Equal(t, *options.AutoApply, item.AutoApply)
+			assert.Equal(t, *options.AssessmentsEnabled, item.AssessmentsEnabled)
 			assert.Equal(t, *options.FileTriggersEnabled, item.FileTriggersEnabled)
 			assert.Equal(t, *options.Operations, item.Operations)
 			assert.Equal(t, *options.QueueAllRuns, item.QueueAllRuns)
@@ -715,16 +717,19 @@ func TestWorkspacesUpdate(t *testing.T) {
 	orgTest, orgTestCleanup := createOrganization(t, client)
 	defer orgTestCleanup()
 
+	upgradeOrganizationSubscription(t, client, orgTest)
+
 	wTest, _ := createWorkspace(t, client, orgTest)
 
 	t.Run("when updating a subset of values", func(t *testing.T) {
 		options := WorkspaceUpdateOptions{
-			Name:             String(wTest.Name),
-			AllowDestroyPlan: Bool(false),
-			AutoApply:        Bool(true),
-			Operations:       Bool(true),
-			QueueAllRuns:     Bool(true),
-			TerraformVersion: String("0.10.0"),
+			Name:               String(wTest.Name),
+			AllowDestroyPlan:   Bool(false),
+			AutoApply:          Bool(true),
+			Operations:         Bool(true),
+			QueueAllRuns:       Bool(true),
+			AssessmentsEnabled: Bool(true),
+			TerraformVersion:   String("0.15.4"),
 		}
 
 		wAfter, err := client.Workspaces.Update(ctx, orgTest.Name, wTest.Name, options)
@@ -734,6 +739,7 @@ func TestWorkspacesUpdate(t *testing.T) {
 		assert.NotEqual(t, wTest.AllowDestroyPlan, wAfter.AllowDestroyPlan)
 		assert.NotEqual(t, wTest.AutoApply, wAfter.AutoApply)
 		assert.NotEqual(t, wTest.QueueAllRuns, wAfter.QueueAllRuns)
+		assert.NotEqual(t, wTest.AssessmentsEnabled, wAfter.AssessmentsEnabled)
 		assert.NotEqual(t, wTest.TerraformVersion, wAfter.TerraformVersion)
 		assert.Equal(t, wTest.WorkingDirectory, wAfter.WorkingDirectory)
 	})