Add project level auto destroy #1550

simonxmh · 2024-12-19T20:29:49Z

Description

Add support in the tfe provider for the project level ephemeral workspace settings.

Remember to:

Update the Change Log
Update the Documentation

Testing plan

Set up a workspace inside a project like such

resource "tfe_project" "test" {
  organization = var.organization
  name = "test-project"
  auto_destroy_activity_duration = "9h"
}

resource "tfe_workspace" "overriding_workspace" {
  organization = var.organization
  name = "test_workspace"
  project_id = tfe_project.test.id

  vcs_repo {
    identifier = var.repo
    branch = var.branch
    oauth_token_id = tfe_oauth_client.github.oauth_token_id
  }
}

The workspace should pick up the setting from the project. You can verify this by going to /app/<orgname>/workspaces/<workspace_name>/settings/delete
Set up an overriding workspace

resource "tfe_project" "test" {
  organization = var.organization
  name = "test-project"
  auto_destroy_activity_duration = "9h"
}

resource "tfe_workspace" "overriding_workspace" {
  organization = var.organization
  name = "test_workspace"
  project_id = tfe_project.test.id
  auto_destroy_activity_duration = "10d"
  inherits_project_auto_destroy = false

  vcs_repo {
    identifier = var.repo
    branch = var.branch
    oauth_token_id = tfe_oauth_client.github.oauth_token_id
  }
}

The workspace should override the setting from the project.

External links

Include any links here that might be helpful for people reviewing your PR. If there are none, feel free to delete this section.

go-tfe PR

Output from acceptance tests

Please run applicable acceptance tests locally and include the output here. See testing.md to learn how to run acceptance tests.

Project Resource

Workspace Resource

Project Data source

TESTARGS="-run TestAccTFEProjectDataSource_*" envchain tf-provider make testacc          $! simonxmh/add_project_level_auto_destroy 
TF_ACC=1 TF_LOG_SDK_PROTO=OFF go test $(go list ./... |grep -v 'vendor') -v -run TestAccTFEProjectDataSource_* -timeout 15m
?       github.com/hashicorp/terraform-provider-tfe     [no test files]
testing: warning: no tests to run
PASS
ok      github.com/hashicorp/terraform-provider-tfe/internal/client     0.293s [no tests to run]
testing: warning: no tests to run
PASS
ok      github.com/hashicorp/terraform-provider-tfe/internal/logging    0.470s [no tests to run]
?       github.com/hashicorp/terraform-provider-tfe/internal/provider/validators        [no test files]
?       github.com/hashicorp/terraform-provider-tfe/version     [no test files]
=== RUN   TestAccTFEProjectDataSource_basic
--- PASS: TestAccTFEProjectDataSource_basic (9.52s)
=== RUN   TestAccTFEProjectDataSource_caseInsensitive
--- PASS: TestAccTFEProjectDataSource_caseInsensitive (7.30s)
=== RUN   TestAccTFEProjectDataSource_basicWithAutoDestroy
--- PASS: TestAccTFEProjectDataSource_basicWithAutoDestroy (9.16s)
PASS
ok      github.com/hashicorp/terraform-provider-tfe/internal/provider   26.446s

Workspace Data source

TESTARGS="-run TestAccTFEWorkspaceDataSource_*" envchain tf-provider make testacc        
TF_ACC=1 TF_LOG_SDK_PROTO=OFF go test $(go list ./... |grep -v 'vendor') -v -run TestAccTFEWorkspaceDataSource_* -timeout 15m
?       github.com/hashicorp/terraform-provider-tfe     [no test files]
testing: warning: no tests to run
PASS
ok      github.com/hashicorp/terraform-provider-tfe/internal/client     0.471s [no tests to run]
testing: warning: no tests to run
PASS
ok      github.com/hashicorp/terraform-provider-tfe/internal/logging    (cached) [no tests to run]
?       github.com/hashicorp/terraform-provider-tfe/internal/provider/validators        [no test files]
?       github.com/hashicorp/terraform-provider-tfe/version     [no test files]
=== RUN   TestAccTFEWorkspaceDataSource_remoteStateConsumers
--- PASS: TestAccTFEWorkspaceDataSource_remoteStateConsumers (11.11s)
=== RUN   TestAccTFEWorkspaceDataSource_basic
--- PASS: TestAccTFEWorkspaceDataSource_basic (6.16s)
=== RUN   TestAccTFEWorkspaceDataSourceWithTriggerPatterns
--- PASS: TestAccTFEWorkspaceDataSourceWithTriggerPatterns (4.11s)
=== RUN   TestAccTFEWorkspaceDataSource_readAutoDestroyAt
--- PASS: TestAccTFEWorkspaceDataSource_readAutoDestroyAt (10.25s)
=== RUN   TestAccTFEWorkspaceDataSource_readAutoDestroyDuration
--- PASS: TestAccTFEWorkspaceDataSource_readAutoDestroyDuration (10.36s)
=== RUN   TestAccTFEWorkspaceDataSource_readProjectIDDefault
--- PASS: TestAccTFEWorkspaceDataSource_readProjectIDDefault (6.05s)
=== RUN   TestAccTFEWorkspaceDataSource_readProjectIDNonDefault
--- PASS: TestAccTFEWorkspaceDataSource_readProjectIDNonDefault (7.61s)
PASS
ok      github.com/hashicorp/terraform-provider-tfe/internal/provider   56.248s
TESTARGS="-run TestAccTFEWorkspaceDataSource_*" envchain tf-provider make   7.37s user 4.54s system 20% cpu 59.017 total

...

go.mod

notchairmk · 2025-01-03T16:34:51Z

CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Unreleased

+BREAKING_CHANGES:
+* `r/tfe_workspace`: Add attribute `inherits_project_auto_destroy` to tfe_workspace, existing workspaces with auto-destroy settings should add `inherits_project_auto_destroy: false` to tfe_workspace resource [1550](https://github.com/hashicorp/terraform-provider-tfe/pull/1550)


IMO we should do fill this out for the user the same way we do on the frontend. Basically if they have one defined in config then we should automatically set this to false

internal/provider/resource_tfe_workspace_test.go

Add business org delegation to the datasource test Run go mod tidy Add interface stub Use datasource for organzation Reference data source Add missing reference Modify resource to directly reference orgname

CHANGELOG.md

go.mod

Update latest version to v0.63.0 cdktf: update documentation empty Fix merged conflicts

emailnitram

tested provider locally and looks good

notchairmk · 2025-01-28T19:44:50Z

Just tried this out, it looks like removing an auto_destroy_at override from a workspace that's in a project with an auto destroy duration defined doesn't work.

simonxmh · 2025-01-28T22:47:07Z

Just tried this out, it looks like removing an auto_destroy_at override from a workspace that's in a project with an auto destroy duration defined doesn't work.

Will sync with you on this. Cannot replicate this at the moment.

notchairmk · 2025-01-29T22:48:34Z

internal/provider/resource_tfe_workspace.go

 		d.Set("auto_destroy_activity_duration", v)
+	} else {
+		d.Set("auto_destroy_activity_duration", nil)


very minor nit, imitating the logic above for other nilable strings (and what we do in the project data source) would probably be better

var autoDestroyDuration string if proj.AutoDestroyActivityDuration.IsSpecified() { autoDestroyDuration, err = proj.AutoDestroyActivityDuration.Get() if err != nil { return diag.Errorf("Error reading auto destroy activity duration: %v", err) } }

notchairmk

Thanks, looks good! 🚢

sebasslash

Implementation is looking good. We're missing the doc changes for r/tfe_project, r/tfe_workspace and d/tfe_workspace however

sebasslash · 2025-01-28T17:30:20Z

internal/provider/data_source_project_test.go

@@ -62,6 +62,33 @@ func TestAccTFEProjectDataSource_caseInsensitive(t *testing.T) {
 	})
 }

+func TestAccTFEProjectDataSource_basicWithAutoDestroy(t *testing.T) {
+	rInt := rand.New(rand.NewSource(time.Now().UnixNano())).Int()


Since this feature requires a subscription upgrade we should skip this test for our nightly TFE CI using skipUnlessCloud(t).

I'll use skipIfEnterprise if that's the flag you mean? I don't believe skipUnlessCloud is a thing. Unless you mean the opposite in skipIfCloud?

simonxmh · 2025-02-03T15:42:54Z

Implementation is looking good. We're missing the doc changes for r/tfe_project, r/tfe_workspace and d/tfe_workspace however

I added the docs for r/tfe_project,and d/tfe_workspace, but not for r/tfe_workspace because the interface didn't really change for the resource. The inherits_project_auto_destroy attribute is also read-only so not a configuring attribute.

Edit: My bad, thanks for leting me know that we should still add it to the attribute reference section.

simonxmh requested a review from a team as a code owner December 19, 2024 20:29

simonxmh added 5 commits December 19, 2024 15:34

Add existing changes for just modifying the attributes

c47bc97

Remove testing residues

6bfea88

Add conditional switch logic for nonbreaking changing

bf80b24

Remove automated boolean setting

cef9d18

Add all test changes

01a4069

simonxmh force-pushed the simonxmh/add_project_level_auto_destroy branch from 91a6fb5 to 01a4069 Compare December 19, 2024 20:34

simonxmh added 6 commits December 19, 2024 16:55

Add changelog changes and datasource

468036a

Merge branch 'main' into simonxmh/add_project_level_auto_destroy

37bacc3

Add project data source changes

822df2e

Add workspace data source tests

2152c80

Merge branch 'main' into simonxmh/add_project_level_auto_destroy

1b115d0

Add go mod replace for now

63b9299

simonxmh requested a review from a team December 20, 2024 18:52

Revert test for auto destroy

cfd4c95

notchairmk reviewed Jan 3, 2025

View reviewed changes

go.mod Outdated Show resolved Hide resolved

notchairmk reviewed Jan 3, 2025

View reviewed changes

notchairmk reviewed Jan 4, 2025

View reviewed changes

internal/provider/resource_tfe_workspace_test.go Show resolved Hide resolved

simonxmh added 6 commits January 6, 2025 12:52

Change go mod, make automated toggle

bbbc2cd

Add missing interface method

c05b61a

Reduce nesting and add automated logic

2d2c113

Use the config level setting

c57f046

Change behavior of inherited field

c2beedc

Fix the data source test

54858bc

Add business org delegation to the datasource test Run go mod tidy Add interface stub Use datasource for organzation Reference data source Add missing reference Modify resource to directly reference orgname

simonxmh force-pushed the simonxmh/add_project_level_auto_destroy branch from 15be161 to 54858bc Compare January 9, 2025 21:33

simonxmh added 5 commits January 9, 2025 16:49

Merge branch 'main' into simonxmh/add_project_level_auto_destroy

f6701d0

Remove duplicate tag binding stub

3c5ba7c

Disable beta tests

541a519

Merge branch 'main' into simonxmh/add_project_level_auto_destroy

7e8107f

Fix creation flow

bc421e4

Merge branch 'main' into simonxmh/add_project_level_auto_destroy

760f7f8

notchairmk reviewed Jan 24, 2025

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

notchairmk reviewed Jan 24, 2025

View reviewed changes

go.mod Outdated Show resolved Hide resolved

Fix merged conflicts

0213836

simonxmh requested a review from notchairmk January 27, 2025 17:05

Add provider doc update in projects doc

8d46bb0

Update latest version to v0.63.0 cdktf: update documentation empty Fix merged conflicts

emailnitram previously approved these changes Jan 27, 2025

View reviewed changes

Merge branch 'main' into simonxmh/add_project_level_auto_destroy

bd30592

simonxmh dismissed emailnitram’s stale review via bd30592 January 27, 2025 23:31

emailnitram previously approved these changes Jan 28, 2025

View reviewed changes

Add ignore specificity based on attribute

48315c8

simonxmh dismissed emailnitram’s stale review via 48315c8 January 28, 2025 22:46

simonxmh added 3 commits January 28, 2025 15:56

Change auto destroy activity duration into computed property

fa1b6b5

Fix data source test

522bdd0

Add read sensitivity to unsetting

f571c80

simonxmh requested a review from a team January 29, 2025 21:28

notchairmk reviewed Jan 29, 2025

View reviewed changes

notchairmk previously approved these changes Jan 29, 2025

View reviewed changes

sebasslash requested changes Jan 30, 2025

View reviewed changes

Add doc changes

6d46e79

simonxmh dismissed notchairmk’s stale review via 6d46e79 February 3, 2025 15:41

Use SkipIfEnterprise on datasource test

d0bf2d1

simonxmh requested a review from sebasslash February 3, 2025 16:37

Add inherits attr to attribute referene

6dd39b3

sebasslash approved these changes Feb 3, 2025

View reviewed changes

simonxmh merged commit 404d250 into main Feb 3, 2025
5 checks passed

simonxmh deleted the simonxmh/add_project_level_auto_destroy branch February 3, 2025 21:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add project level auto destroy #1550

Add project level auto destroy #1550

simonxmh commented Dec 19, 2024 •

edited

Loading

notchairmk Jan 3, 2025

emailnitram left a comment

notchairmk commented Jan 28, 2025

simonxmh commented Jan 28, 2025

notchairmk Jan 29, 2025

notchairmk left a comment

sebasslash left a comment •

edited

Loading

sebasslash Jan 28, 2025

simonxmh Feb 3, 2025 •

edited

Loading

simonxmh commented Feb 3, 2025 •

edited

Loading

Add project level auto destroy #1550

Add project level auto destroy #1550

Conversation

simonxmh commented Dec 19, 2024 • edited Loading

Description

Testing plan

External links

Output from acceptance tests

notchairmk Jan 3, 2025

Choose a reason for hiding this comment

emailnitram left a comment

Choose a reason for hiding this comment

notchairmk commented Jan 28, 2025

simonxmh commented Jan 28, 2025

notchairmk Jan 29, 2025

Choose a reason for hiding this comment

notchairmk left a comment

Choose a reason for hiding this comment

sebasslash left a comment • edited Loading

Choose a reason for hiding this comment

sebasslash Jan 28, 2025

Choose a reason for hiding this comment

simonxmh Feb 3, 2025 • edited Loading

Choose a reason for hiding this comment

simonxmh commented Feb 3, 2025 • edited Loading

simonxmh commented Dec 19, 2024 •

edited

Loading

sebasslash left a comment •

edited

Loading

simonxmh Feb 3, 2025 •

edited

Loading

simonxmh commented Feb 3, 2025 •

edited

Loading