New Terraform Workspace select flag: `-or-create` #31633

brittandeyoung · 2022-08-12T13:26:44Z

This adds the new terraform workspace select flag -or-create. This flag is intended to make managing workspaces easier in CI environments where auto creating or selecting a workspace is useful (especially when using remote backend). This flag will first attempt to select the provided workspace name. If this workspace is not found, it will then create and select it.

Traditionally this functionality has been achieved through some sort of scripting. We currently get this behavior using the following script: terraform workspace select test || terraform workspace new test; however, this does not work well when attempting to use the official terraform docker image as it does not handle shell scripts by design. Having this functionality in the terraform cli itself would be very useful. We want to be able to provide the same functionally locally to our developers as exists in our CI environment. Using the terraform official docker image helps provide this, but missing this functionality is making it difficult to auto provision workspaces for new projects. Calling the workspace new command will error if it already exists, and calling the workspace select command will error if it does not exist.

This will especially help when using terraform with https://dagger.io or any other docker based CI as it relies on docker for running pipelines where bash scripting my not be an option.

Closes: #16191

hashicorp-cla · 2022-08-12T13:26:48Z

All committers have signed the CLA.

crw · 2022-08-12T18:26:19Z

Although I cannot commit to having this PR reviewed at this time, we acknowledge your contribution and appreciate it!

brittandeyoung · 2022-08-31T14:31:59Z

@crw Does this comment mean that this PR will not be reviewed, or that there will be a delay in the review? This feature will be a huge help to those running terraform using docker.

crw · 2022-08-31T16:34:23Z

Hi @brittandeyoung, thanks for the bump. First off thanks for the great initial write-up for the PR - that is always a huge help.

The initial feedback is that per #16191 (comment), a flag would be more appropriate than a new subcommand. Implementing this feature as a flag would make it more likely to get reviewed. Thanks for this submission, and apologies for the late response on this.

brittandeyoung · 2022-08-31T16:41:49Z

@crw Thank you for the direction. I will modify this PR to match what is requested in #16191 and update.

brittandeyoung · 2022-08-31T17:36:49Z

@crw Pull request has been update to follow the strategy suggested. It is ready for review when you have time.

Here is a screen shot running the binary local with both the select a valid state, select a missing state, and select a missing state with new -or-create flag.

brittandeyoung · 2022-09-09T14:12:11Z

Friendly bump @crw. Do we have an idea as to when or if this pull request will be able to be reviewed? The pull request is much smaller now using the flag.

crw · 2022-09-09T22:19:42Z

Hi @brittandeyoung, thanks for the bump! I admit I lost track of this due to the long Labor Day weekend. We are working on finishing up the 1.3 release so apologize if this process is going a bit slowly. There is a bit of functionality coming that may overlap with this feature -- I'm looking into whether it makes sense to review this or wait for the new functionality. I'll keep you updated. Thanks for your patience.

brittandeyoung · 2022-09-13T16:15:31Z

@crw Thank you for the update. I will wait to hear back on what you find in terms of functionality overlap.

jbardin · 2022-09-16T17:05:36Z

internal/command/workspace_select.go

-		c.Ui.Error(fmt.Sprintf(envDoesNotExist, name))
-		return 1
+		if orCreate {
+			_, err = b.StateMgr(name)


This is a "Time of Check Time of Use" race condition, but the workspace select command doesn't have the ability to take a lock. I think this may need to incorporate the new command. I'll have to look into the other code path to see what that entails.

OK, double checked and the StateMgr implementations are expected to handle the check race again internally, so that's not an issue here. The missing options are then only to exclude the lock, but I think for the sake of keeping this simple, we can leave that to using the new subcommand directly,

@jbardin are there any changes needed? From reading your comments we are good to leave state locking for the new command?

@jbardin Are changes actually needed here? or am I able to resolve this conversation?

sorry, no changes needed here

brittandeyoung · 2022-09-21T17:34:32Z

@crw Looks like 1.3.0 release is out. I did not see any potential overlap in the release notes. Any update on that end?

crw · 2022-09-22T01:22:26Z

@brittandeyoung Yes, apologies - @jbardin moving forward with the review is the acknowledgement that we are reviewing this for inclusion. I'll check with @jbardin on what we need to do to press "merge." Thanks again for the contribution!

brittandeyoung · 2022-09-29T18:09:06Z

@crw and @jbardin Any update on this PR?

brittandeyoung · 2022-10-16T23:41:19Z

@crw ans @jbardin any update on this pr? Am I missing a required change?

crw · 2022-10-17T21:44:28Z

Hi @brittandeyoung, this is still on @jbardin's radar. He's just been busy closing issues in the 1.3 release of Terraform. This and one other community PR are in the pipe to be reviewed once 1.3 is stable. Thanks for checking in, apologies for the stop-and-start here.

brittandeyoung · 2022-10-17T22:36:06Z

@crw thank you for the response. I will patiently wait for y'all to get caught up. I just wanted to make sure I wasn't missing something.

crw · 2022-11-11T22:46:20Z

Quick update that I have not forgotten this, we are still working on bugs from 1.3. This is still in the queue to be reviewed.

brittandeyoung · 2022-11-12T12:15:42Z

@crw thank you for the update 👍

brittandeyoung · 2022-12-13T14:48:27Z

@crw and @jbardin . Friendly bump to make sure this didn't fall of the radar.

anderssonw · 2022-12-13T15:01:58Z

This would be a great feature for us, as our action feels needlessly complicated just to deal with the potential creation of a workspace :)

crw · 2022-12-13T20:46:30Z

1.3 seems to have settled out - I'll get this back in the queue. Thanks!

jbardin

just a quick typo

internal/command/workspace_select.go

Co-authored-by: James Bardin <j.bardin@gmail.com>

vercel · 2022-12-16T20:03:49Z

@brittandeyoung is attempting to deploy a commit to the HashiCorp Team on Vercel.

A member of the Team first needs to authorize it.

github-actions · 2022-12-16T20:29:38Z

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

anderssonw · 2022-12-19T10:37:43Z

@jbardin @crw Any plans for which release this flag will be available?

crw · 2022-12-20T01:05:16Z

1.4, which is the next non-bugfix release. I believe it should start showing up in the alpha builds when we do the next one of those, which will likely be in January.

anderssonw · 2022-12-20T08:05:31Z

Cheers :)

github-actions · 2023-01-21T02:13:25Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

vercel bot deployed to Preview August 12, 2022 13:32 View deployment

crw added enhancement workspaces labels Aug 12, 2022

New Terraform Workspace select flag:

5932540

brittandeyoung force-pushed the f-workspace-selectornew branch from 8abd500 to 5932540 Compare August 31, 2022 17:07

brittandeyoung changed the title ~~New Terraform Workspace subcommand: selectornew~~ @brittandeyoung New Terraform Workspace select flag: -or-create Aug 31, 2022

brittandeyoung changed the title ~~@brittandeyoung New Terraform Workspace select flag: -or-create~~ New Terraform Workspace select flag: -or-create Aug 31, 2022

vercel bot deployed to Preview August 31, 2022 17:14 View deployment

brittandeyoung added 2 commits August 31, 2022 13:28

select: -or-create helptext and conditional output

7d0d352

select: Fix capitalization of help text

7110ec8

vercel bot deployed to Preview August 31, 2022 17:35 View deployment

workspace: update envDoesNotExist message

409bd66

vercel bot deployed to Preview August 31, 2022 17:40 View deployment

Spelling Error fixes

11da5af

vercel bot deployed to Preview August 31, 2022 19:17 View deployment

jbardin self-assigned this Sep 16, 2022

jbardin reviewed Sep 16, 2022

View reviewed changes

jbardin approved these changes Sep 16, 2022

View reviewed changes

jbardin requested changes Dec 16, 2022

View reviewed changes

internal/command/workspace_select.go Outdated Show resolved Hide resolved

Update internal/command/workspace_select.go

8881418

Co-authored-by: James Bardin <j.bardin@gmail.com>

jbardin merged commit 25ac4d3 into hashicorp:main Dec 16, 2022

github-actions bot locked as resolved and limited conversation to collaborators Jan 21, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Terraform Workspace select flag: `-or-create` #31633

New Terraform Workspace select flag: `-or-create` #31633

brittandeyoung commented Aug 12, 2022 •

edited

hashicorp-cla commented Aug 12, 2022 •

edited

crw commented Aug 12, 2022

brittandeyoung commented Aug 31, 2022

crw commented Aug 31, 2022 •

edited

brittandeyoung commented Aug 31, 2022

brittandeyoung commented Aug 31, 2022 •

edited

brittandeyoung commented Sep 9, 2022 •

edited

crw commented Sep 9, 2022

brittandeyoung commented Sep 13, 2022

jbardin Sep 16, 2022

jbardin Sep 16, 2022

brittandeyoung Sep 19, 2022 •

edited

brittandeyoung Dec 16, 2022

jbardin Dec 16, 2022

brittandeyoung commented Sep 21, 2022

crw commented Sep 22, 2022

brittandeyoung commented Sep 29, 2022

brittandeyoung commented Oct 16, 2022

crw commented Oct 17, 2022 •

edited

brittandeyoung commented Oct 17, 2022

crw commented Nov 11, 2022

brittandeyoung commented Nov 12, 2022

brittandeyoung commented Dec 13, 2022

anderssonw commented Dec 13, 2022

crw commented Dec 13, 2022

jbardin left a comment

vercel bot commented Dec 16, 2022

github-actions bot commented Dec 16, 2022

anderssonw commented Dec 19, 2022

crw commented Dec 20, 2022

anderssonw commented Dec 20, 2022

github-actions bot commented Jan 21, 2023

New Terraform Workspace select flag: -or-create #31633

New Terraform Workspace select flag: -or-create #31633

Conversation

brittandeyoung commented Aug 12, 2022 • edited

hashicorp-cla commented Aug 12, 2022 • edited

crw commented Aug 12, 2022

brittandeyoung commented Aug 31, 2022

crw commented Aug 31, 2022 • edited

brittandeyoung commented Aug 31, 2022

brittandeyoung commented Aug 31, 2022 • edited

brittandeyoung commented Sep 9, 2022 • edited

crw commented Sep 9, 2022

brittandeyoung commented Sep 13, 2022

jbardin Sep 16, 2022

Choose a reason for hiding this comment

jbardin Sep 16, 2022

Choose a reason for hiding this comment

brittandeyoung Sep 19, 2022 • edited

Choose a reason for hiding this comment

brittandeyoung Dec 16, 2022

Choose a reason for hiding this comment

jbardin Dec 16, 2022

Choose a reason for hiding this comment

brittandeyoung commented Sep 21, 2022

crw commented Sep 22, 2022

brittandeyoung commented Sep 29, 2022

brittandeyoung commented Oct 16, 2022

crw commented Oct 17, 2022 • edited

brittandeyoung commented Oct 17, 2022

crw commented Nov 11, 2022

brittandeyoung commented Nov 12, 2022

brittandeyoung commented Dec 13, 2022

anderssonw commented Dec 13, 2022

crw commented Dec 13, 2022

jbardin left a comment

Choose a reason for hiding this comment

vercel bot commented Dec 16, 2022

github-actions bot commented Dec 16, 2022

anderssonw commented Dec 19, 2022

crw commented Dec 20, 2022

anderssonw commented Dec 20, 2022

github-actions bot commented Jan 21, 2023

New Terraform Workspace select flag: `-or-create` #31633

New Terraform Workspace select flag: `-or-create` #31633

brittandeyoung commented Aug 12, 2022 •

edited

hashicorp-cla commented Aug 12, 2022 •

edited

crw commented Aug 31, 2022 •

edited

brittandeyoung commented Aug 31, 2022 •

edited

brittandeyoung commented Sep 9, 2022 •

edited

brittandeyoung Sep 19, 2022 •

edited

crw commented Oct 17, 2022 •

edited