Merge pull request #1330 from hashicorp/gs/global-run-tasks-update

Add Global Run Task support

Author: glennsarti

CHANGELOG.md

@@ -4,6 +4,12 @@ FEATURES:
 * `r/tfe_team`: Add attribute `manage_agent_pools` to `organization_access` on `tfe_team` by @emlanctot [#1358](https://github.com/hashicorp/terraform-provider-tfe/pull/1358)
 * `r/tfe_workspace`: Add an `auto_destroy_activity_duration` attribute for automatic scheduling of auto-destroy runs based off of workspace activity, by @notchairmk [#1377](https://github.com/hashicorp/terraform-provider-tfe/pull/1377)
 * `d/tfe_workspace`: Add an `auto_destroy_activity_duration`, by @notchairmk [#1377](https://github.com/hashicorp/terraform-provider-tfe/pull/1377)
+* `d/tfe_organization_run_task_global_settings`: Add a datasource to retrieve the global settings of Run tasks, by @glennsarti [#1328](https://github.com/hashicorp/terraform-provider-tfe/pull/1330)
+* `r/tfe_organization_run_task_global_settings`: Add a resource to manage the global settings of Run tasks, by @glennsarti [#1328](https://github.com/hashicorp/terraform-provider-tfe/pull/1330)
+
+DEPRECATIONS and BREAKING CHANGES:
+* `r/_workspace_run_task`: The `stage` attribute has been deprecated in favor of the `stages` attribute, by @glennsarti [#1328](https://github.com/hashicorp/terraform-provider-tfe/pull/1330)
+* `d/_workspace_run_task`: The `stage` attribute has been deprecated in favor of the `stages` attribute, by @glennsarti [#1328](https://github.com/hashicorp/terraform-provider-tfe/pull/1330)
 
 ## v0.56.0
 

internal/provider/data_source_organization_run_task_global_settings.go

@@ -0,0 +1,114 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package provider
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+)
+
+var (
+	_ datasource.DataSource              = &dataSourceOrganizationRunTask{}
+	_ datasource.DataSourceWithConfigure = &dataSourceOrganizationRunTask{}
+)
+
+func NewOrganizationRunTaskGlobalSettingsDataSource() datasource.DataSource {
+	return &dataSourceOrganizationRunTaskGlobalSettings{}
+}
+
+type dataSourceOrganizationRunTaskGlobalSettings struct {
+	config ConfiguredClient
+}
+
+func (d *dataSourceOrganizationRunTaskGlobalSettings) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_organization_run_task_global_settings"
+}
+
+func (d *dataSourceOrganizationRunTaskGlobalSettings) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		Attributes: map[string]schema.Attribute{
+			"enabled": schema.BoolAttribute{
+				Description: "Whether the run task will be applied globally",
+				Optional:    true,
+			},
+			"enforcement_level": schema.StringAttribute{
+				Description: "The enforcement level of the global task.",
+				Optional:    true,
+			},
+			"id": schema.StringAttribute{
+				Computed:    true,
+				Description: "Service-generated identifier for the task settings",
+			},
+			"stages": schema.ListAttribute{
+				ElementType: types.StringType,
+				Description: "Which stages the task will run in.",
+				Optional:    true,
+			},
+			"task_id": schema.StringAttribute{
+				Description: "The id of the run task.",
+				Required:    true,
+			},
+		},
+	}
+}
+
+func (d *dataSourceOrganizationRunTaskGlobalSettings) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
+	if req.ProviderData == nil {
+		return
+	}
+
+	client, ok := req.ProviderData.(ConfiguredClient)
+	if !ok {
+		resp.Diagnostics.AddError(
+			"Unexpected Data Source Configure Type",
+			fmt.Sprintf("Expected tfe.ConfiguredClient, got %T. This is a bug in the tfe provider, so please report it on GitHub.", req.ProviderData),
+		)
+
+		return
+	}
+	d.config = client
+}
+
+func (d *dataSourceOrganizationRunTaskGlobalSettings) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var data modelDataTFEOrganizationRunTaskGlobalSettings
+
+	// Read Terraform configuration data into the model
+	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	taskID := data.TaskID.ValueString()
+
+	task, err := d.config.Client.RunTasks.Read(ctx, taskID)
+	if err != nil {
+		resp.Diagnostics.AddError("Error retrieving task",
+			fmt.Sprintf("Error retrieving task %s: %s", taskID, err.Error()),
+		)
+		return
+	}
+
+	if task == nil {
+		resp.Diagnostics.AddError("Error retrieving task",
+			fmt.Sprintf("Error retrieving task %s", taskID),
+		)
+		return
+	}
+
+	if task.Global == nil {
+		resp.Diagnostics.AddWarning("Error retrieving task",
+			fmt.Sprintf("The task %s exists however it does not support global run tasks.", taskID),
+		)
+		return
+	}
+
+	result := dataModelFromTFEOrganizationRunTaskGlobalSettings(*task)
+
+	// Save updated data into Terraform state
+	resp.Diagnostics.Append(resp.State.Set(ctx, result)...)
+}

internal/provider/data_source_workspace_run_task.go

@@ -10,25 +10,22 @@ import (
 	tfe "github.com/hashicorp/go-tfe"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
-// Ensure the implementation satisfies the expected interfaces.
 var (
 	_ datasource.DataSource              = &dataSourceWorkspaceRunTask{}
 	_ datasource.DataSourceWithConfigure = &dataSourceWorkspaceRunTask{}
 )
 
-// NewWorkspaceRunTaskDataSource is a helper function to simplify the provider implementation.
 func NewWorkspaceRunTaskDataSource() datasource.DataSource {
 	return &dataSourceWorkspaceRunTask{}
 }
 
-// dataSourceWorkspaceRunTask is the data source implementation.
 type dataSourceWorkspaceRunTask struct {
 	config ConfiguredClient
 }
 
-// Metadata returns the data source type name.
 func (d *dataSourceWorkspaceRunTask) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
 	resp.TypeName = req.ProviderTypeName + "_workspace_run_task"
 }
@@ -53,7 +50,13 @@ func (d *dataSourceWorkspaceRunTask) Schema(_ context.Context, _ datasource.Sche
 				Computed:    true,
 			},
 			"stage": schema.StringAttribute{
-				Description: "Which stage the task will run in.",
+				DeprecationMessage: "stage is deprecated, please use stages instead",
+				Description:        "Which stage the task will run in.",
+				Computed:           true,
+			},
+			"stages": schema.ListAttribute{
+				ElementType: types.StringType,
+				Description: "Which stages the task will run in.",
 				Computed:    true,
 			},
 		},
@@ -78,9 +81,8 @@ func (d *dataSourceWorkspaceRunTask) Configure(_ context.Context, req datasource
 	d.config = client
 }
 
-// Read refreshes the Terraform state with the latest data.
 func (d *dataSourceWorkspaceRunTask) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
-	var data modelTFEWorkspaceRunTaskV0
+	var data modelTFEWorkspaceRunTaskV1
 
 	// Read Terraform configuration data into the model
 	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)

internal/provider/data_source_workspace_run_task_test.go

@@ -37,6 +37,7 @@ func TestAccTFEWorkspaceRunTaskDataSource_basic(t *testing.T) {
 					resource.TestCheckResourceAttrSet("data.tfe_workspace_run_task.foobar", "id"),
 					resource.TestCheckResourceAttrSet("data.tfe_workspace_run_task.foobar", "task_id"),
 					resource.TestCheckResourceAttrSet("data.tfe_workspace_run_task.foobar", "workspace_id"),
+					resource.TestCheckResourceAttr("data.tfe_workspace_run_task.foobar", "stages.#", "1"),
 				),
 			},
 		},

internal/provider/helper_test.go

@@ -66,6 +66,17 @@ func createBusinessOrganization(t *testing.T, client *tfe.Client) (*tfe.Organiza
 	return org, orgCleanup
 }
 
+func createTrialOrganization(t *testing.T, client *tfe.Client) (*tfe.Organization, func()) {
+	org, orgCleanup := createOrganization(t, client, tfe.OrganizationCreateOptions{
+		Name:  tfe.String("tst-" + randomString(t)),
+		Email: tfe.String(fmt.Sprintf("%[email protected]", randomString(t))),
+	})
+
+	newSubscriptionUpdater(org).WithTrialPlan().Update(t)
+
+	return org, orgCleanup
+}
+
 func createOrganization(t *testing.T, client *tfe.Client, options tfe.OrganizationCreateOptions) (*tfe.Organization, func()) {
 	ctx := context.Background()
 	org, err := client.Organizations.Create(ctx, options)

internal/provider/provider_next.go

@@ -123,19 +123,21 @@ func (p *frameworkProvider) Configure(ctx context.Context, req provider.Configur
 
 func (p *frameworkProvider) DataSources(ctx context.Context) []func() datasource.DataSource {
 	return []func() datasource.DataSource{
+		NewNoCodeModuleDataSource,
 		NewOrganizationRunTaskDataSource,
+		NewOrganizationRunTaskGlobalSettingsDataSource,
 		NewRegistryGPGKeyDataSource,
 		NewRegistryGPGKeysDataSource,
 		NewRegistryProviderDataSource,
 		NewRegistryProvidersDataSource,
-		NewNoCodeModuleDataSource,
 		NewSAMLSettingsDataSource,
 		NewWorkspaceRunTaskDataSource,
 	}
 }
 
 func (p *frameworkProvider) Resources(ctx context.Context) []func() resource.Resource {
 	return []func() resource.Resource{
+		NewOrganizationRunTaskGlobalSettingsResource,
 		NewOrganizationRunTaskResource,
 		NewRegistryGPGKeyResource,
 		NewRegistryProviderResource,