Add auto_apply_run_trigger attribute to workspace resource and data source #1123

nfagerlund · 2023-10-31T01:20:55Z

Description

This adds provider support for the new auto-apply-run-trigger workspace attribute. This setting has shipped to the general public on TFC prod, but is not in TFE yet.

Remember to:

Update the Change Log
Update the Documentation

Testing plan

Set the attribute to true.
Set the attribute to false.
Leave the attribute blank when creating a workspace (defaults to hard-false, instead of allowing the API to decide for itself).

Something like this:

terraform {
  required_providers {
    tfe = {
      source = "hashicorp/tfe"
      version = "0.49.2" # EXCEPT, DO A BUILD AND SET YOUR DEV OVERRIDES CONFIG
    }
  }
}

provider "tfe" {
  hostname = "app.terraform.io"
  organization = "YOUR ORG"
}

data tfe_project "one-offs" {
    name = "One-offs" # YOUR PROJECT OF CHOICE FOR USELESS WORKSPACES
}

resource tfe_workspace "auto-trigger-test" {
    name = "auto-trigger-test"
    project_id = data.tfe_project.one-offs.id
    auto_apply = false
    auto_apply_run_trigger = true
    description = "Nov 2023 - Just testing provider support for this new attr."
}

External links

Output from acceptance tests

I'm internal, so see CI.

brandonc

Everything was great. I'm just requesting changes until go-tfe is released and bumped

brandonc · 2023-11-03T16:10:05Z

internal/provider/data_source_workspace_test.go

@@ -204,6 +205,13 @@ func TestAccTFEWorkspaceDataSource_readProjectIDNonDefault(t *testing.T) {
 }

 func testAccTFEWorkspaceDataSourceConfig(rInt int) string {


I think its OK to specify auto_apply_run_trigger even if the API doesn't support it. Many enterprise installations will not.

I think it's cool that this feature was enabled in the test environment

brandonc · 2023-11-03T16:12:31Z

internal/provider/resource_tfe_workspace.go

+			"auto_apply_run_trigger": {
+				Type:     schema.TypeBool,
+				Optional: true,
+				Default:  false,


Is the default needed for some behavior you are trying to elicit? I wonder if optional is enough

Good question! I was following the existing behavior of auto_apply, since it's basically the exact same setting.

Torn between my user brain saying "unmanaged is fine," my dev brain saying "Optional + Computed always causes weirdness on unset, love 2 avoid that when possible," and both brains saying "just be consistent with the other thing it's basically identical to."

brandonc · 2023-11-03T16:16:50Z

In order to test this, I had to update go-tfe to fbcc54a62e4a6265d8395a477148d72e689ba2e9

sebasslash · 2023-11-06T18:56:14Z

internal/provider/resource_tfe_workspace_test.go

+func testAccCheckTFEWorkspaceAutoApplyRunTrigger(res, value string) resource.TestCheckFunc {
+	if enterpriseEnabled() {
+		return func(s *terraform.State) error {
+			return nil
+		}
+	}
+	return resource.TestCheckResourceAttr(res, "auto_apply_run_trigger", value)
+}


This is a fantastic helper. I'm wondering if we could refactor this method as a generic helper for any attribute we should test TFC-only. This could avoid having to duplicate this logic again or worse, force the parent test to be flagged entirely. 👍

👀 that's an interesting thought. I'll be going back to this branch anyway to update go-tfe, may as well refactor this to a general helper while I'm in there.

Required for AutoApplyRunTrigger support.

Sometimes you want to test a new attribute that hasn't landed in TFE yet, but you don't want to skip the entire surrounding test when running against TFE. Well! here's a wrapper around `TestCheckResourceAttr` that always passes on TFE.

The convoluted stuff here is temporary, and can be simplified once the feature flag is gone; I wanted to skip testing this attribute on TFE *without* creating additional test cases.

Upgrading go-tfe pulled in this update for free, but it fixes a user-facing bug in the provider that deserves mention.

Since this is only used for a single resource attribute at this time, the linter is being uptight about it. It's meant to vary, we're just not using it elsewhere yet! Please cool your jets!!

sebasslash · 2023-11-07T21:57:47Z

internal/provider/testing.go

+func testCheckResourceAttrUnlessEnterprise(name, key, value string) resource.TestCheckFunc {
+	if enterpriseEnabled() {
+		return func(s *terraform.State) error {
+			return nil
+		}
+	}
+	return resource.TestCheckResourceAttr(name, key, value)
+}


Did the required go-tfe update

nfagerlund mentioned this pull request Nov 1, 2023

Add AutoApplyRunTrigger attribute to workspaces hashicorp/go-tfe#798

Merged

nfagerlund force-pushed the nf/oct23-auto-run-trigger branch 2 times, most recently from 5ebe4bb to 1c45299 Compare November 1, 2023 23:32

nfagerlund marked this pull request as ready for review November 3, 2023 00:15

nfagerlund requested a review from a team as a code owner November 3, 2023 00:15

brandonc previously requested changes Nov 3, 2023

View reviewed changes

sebasslash reviewed Nov 6, 2023

View reviewed changes

nfagerlund force-pushed the nf/oct23-auto-run-trigger branch from f034953 to 960175a Compare November 7, 2023 21:22

nfagerlund added 8 commits November 7, 2023 13:22

Update to go-tfe v1.39.0

e7e3e4f

Required for AutoApplyRunTrigger support.

Add auto_apply_run_trigger attribute to workspace resource/data-source

17f8912

Add data/resource tests for auto_apply_run_trigger attribute

ab39f0f

The convoluted stuff here is temporary, and can be simplified once the feature flag is gone; I wanted to skip testing this attribute on TFE *without* creating additional test cases.

Update docs for auto_apply_run_trigger

a6f5ce0

Update changelog

3ed1c25

Document testAccCheckTFEWorkspaceAttributes helper

307c279

Changelog: note the fix from upgrading go-slug

de30691

Upgrading go-tfe pulled in this update for free, but it fixes a user-facing bug in the provider that deserves mention.

nfagerlund force-pushed the nf/oct23-auto-run-trigger branch from 960175a to de30691 Compare November 7, 2023 21:23

Ignore unused func param lint for new test helper

5482ee8

Since this is only used for a single resource attribute at this time, the linter is being uptight about it. It's meant to vary, we're just not using it elsewhere yet! Please cool your jets!!

sebasslash approved these changes Nov 7, 2023

View reviewed changes

nfagerlund merged commit 0050f18 into main Nov 7, 2023
9 checks passed

nfagerlund deleted the nf/oct23-auto-run-trigger branch November 7, 2023 22:06

zhimsel mentioned this pull request Nov 13, 2023

Add support for tfe_workspace attribute auto-apply-run-trigger #1129

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add auto_apply_run_trigger attribute to workspace resource and data source #1123

Add auto_apply_run_trigger attribute to workspace resource and data source #1123

nfagerlund commented Oct 31, 2023 •

edited

Loading

brandonc left a comment

brandonc Nov 3, 2023

brandonc Nov 3, 2023

brandonc Nov 3, 2023

nfagerlund Nov 6, 2023

brandonc commented Nov 3, 2023

sebasslash Nov 6, 2023

nfagerlund Nov 6, 2023

sebasslash Nov 7, 2023

		@@ -204,6 +205,13 @@ func TestAccTFEWorkspaceDataSource_readProjectIDNonDefault(t *testing.T) {
		}

		func testAccTFEWorkspaceDataSourceConfig(rInt int) string {

Add auto_apply_run_trigger attribute to workspace resource and data source #1123

Add auto_apply_run_trigger attribute to workspace resource and data source #1123

Conversation

nfagerlund commented Oct 31, 2023 • edited Loading

Description

Testing plan

External links

Output from acceptance tests

brandonc left a comment

Choose a reason for hiding this comment

brandonc Nov 3, 2023

Choose a reason for hiding this comment

brandonc Nov 3, 2023

Choose a reason for hiding this comment

brandonc Nov 3, 2023

Choose a reason for hiding this comment

nfagerlund Nov 6, 2023

Choose a reason for hiding this comment

brandonc commented Nov 3, 2023

sebasslash Nov 6, 2023

Choose a reason for hiding this comment

nfagerlund Nov 6, 2023

Choose a reason for hiding this comment

sebasslash Nov 7, 2023

Choose a reason for hiding this comment

nfagerlund commented Oct 31, 2023 •

edited

Loading