Workspace Source Name and URL #527

lucymhdavies · 2022-06-21T15:26:37Z

Description

Addresses #392

Testing plan

Example code:

resource "tfe_workspace" "test" {
  name         = "test-source"
  organization = "lmhd"
  source_name  = "TFE Provider"
  source_url   = "https://github.com/hashicorp/terraform-provider-tfe/issues/392"
}

(See #392 for further tests)

External links

API documentation
- As these are listed as beta parameters, I can understand if we wish to hold off on adding support to the provider for now. On the other hand, they are already supported by the Go TFE SDK.

Output from acceptance tests

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

If you are an external contributor, your contribution(s) will first be reviewed before running them against the project's CI pipeline.

$ TESTARGS="-run TestAccTFEWorkspace" make testacc
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test $(go list ./... |grep -v 'vendor') -v -run TestAccTFEWorkspace -timeout 15m
?   	github.com/hashicorp/terraform-provider-tfe	[no test files]
=== RUN   TestAccTFEWorkspaceIDsDataSource_basic
--- PASS: TestAccTFEWorkspaceIDsDataSource_basic (23.16s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_wildcard
--- PASS: TestAccTFEWorkspaceIDsDataSource_wildcard (19.90s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_tags
--- PASS: TestAccTFEWorkspaceIDsDataSource_tags (19.18s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_searchByTagAndName
--- PASS: TestAccTFEWorkspaceIDsDataSource_searchByTagAndName (20.73s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_empty
--- PASS: TestAccTFEWorkspaceIDsDataSource_empty (3.45s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_namesEmpty
--- PASS: TestAccTFEWorkspaceIDsDataSource_namesEmpty (26.51s)
=== RUN   TestAccTFEWorkspaceRunTaskDataSource_basic
    testing.go:65: Skipping tests for Run Tasks. Set 'RUN_TASKS_URL' to enabled this tests.
--- SKIP: TestAccTFEWorkspaceRunTaskDataSource_basic (0.00s)
=== RUN   TestAccTFEWorkspaceDataSource_remoteStateConsumers
--- PASS: TestAccTFEWorkspaceDataSource_remoteStateConsumers (25.28s)
=== RUN   TestAccTFEWorkspaceDataSource_basic
--- PASS: TestAccTFEWorkspaceDataSource_basic (20.84s)
=== RUN   TestAccTFEWorkspaceRunTask_create
    testing.go:65: Skipping tests for Run Tasks. Set 'RUN_TASKS_URL' to enabled this tests.
--- SKIP: TestAccTFEWorkspaceRunTask_create (0.00s)
=== RUN   TestAccTFEWorkspaceRunTask_import
    testing.go:65: Skipping tests for Run Tasks. Set 'RUN_TASKS_URL' to enabled this tests.
--- SKIP: TestAccTFEWorkspaceRunTask_import (0.00s)
=== RUN   TestAccTFEWorkspace_basic
--- PASS: TestAccTFEWorkspace_basic (21.79s)
=== RUN   TestAccTFEWorkspace_panic
--- PASS: TestAccTFEWorkspace_panic (18.79s)
=== RUN   TestAccTFEWorkspace_monorepo
--- PASS: TestAccTFEWorkspace_monorepo (16.36s)
=== RUN   TestAccTFEWorkspace_renamed
--- PASS: TestAccTFEWorkspace_renamed (29.48s)
=== RUN   TestAccTFEWorkspace_update
--- PASS: TestAccTFEWorkspace_update (25.68s)
=== RUN   TestAccTFEWorkspace_updateWorkingDirectory
--- PASS: TestAccTFEWorkspace_updateWorkingDirectory (32.28s)
=== RUN   TestAccTFEWorkspace_updateFileTriggers
--- PASS: TestAccTFEWorkspace_updateFileTriggers (19.76s)
=== RUN   TestAccTFEWorkspace_updateTriggerPrefixes
--- PASS: TestAccTFEWorkspace_updateTriggerPrefixes (26.69s)
=== RUN   TestAccTFEWorkspace_changeTags
--- PASS: TestAccTFEWorkspace_changeTags (73.04s)
=== RUN   TestAccTFEWorkspace_updateSpeculative
--- PASS: TestAccTFEWorkspace_updateSpeculative (19.19s)
=== RUN   TestAccTFEWorkspace_structuredRunOutputDisabled
--- PASS: TestAccTFEWorkspace_structuredRunOutputDisabled (18.97s)
=== RUN   TestAccTFEWorkspace_updateVCSRepo
    resource_tfe_workspace_test.go:556: Please set GITHUB_TOKEN to run this test
--- SKIP: TestAccTFEWorkspace_updateVCSRepo (0.55s)
=== RUN   TestAccTFEWorkspace_sshKey
--- PASS: TestAccTFEWorkspace_sshKey (28.93s)
=== RUN   TestAccTFEWorkspace_import
--- PASS: TestAccTFEWorkspace_import (14.71s)
=== RUN   TestAccTFEWorkspace_importVCSBranch
    resource_tfe_workspace_test.go:706: Please set GITHUB_TOKEN to run this test
--- SKIP: TestAccTFEWorkspace_importVCSBranch (0.47s)
=== RUN   TestAccTFEWorkspace_operationsAndExecutionModeInteroperability
    resource_tfe_workspace_test.go:750: Step 5/5 error: Error running apply: exit status 1

        Error: Error creating agent pool agent-pool-test for organization tst-terraform-3886321602341347244: resource not found

          with tfe_agent_pool.foobar,
          on terraform_plugin_test.tf line 7, in resource "tfe_agent_pool" "foobar":
           7: resource "tfe_agent_pool" "foobar" {

--- FAIL: TestAccTFEWorkspace_operationsAndExecutionModeInteroperability (35.04s)
=== RUN   TestAccTFEWorkspace_globalRemoteState
--- PASS: TestAccTFEWorkspace_globalRemoteState (17.85s)
=== RUN   TestAccTFEWorkspace_alterRemoteStateConsumers
    resource_tfe_workspace_test.go:865: Step 1/5 error: Check failed: Check 2/2 error: tfe_workspace.foobar: Attribute 'global_remote_state' expected "true", got "false"
--- FAIL: TestAccTFEWorkspace_alterRemoteStateConsumers (7.50s)
=== RUN   TestAccTFEWorkspace_createWithRemoteStateConsumers
--- PASS: TestAccTFEWorkspace_createWithRemoteStateConsumers (10.43s)
=== RUN   TestAccTFEWorkspace_paginatedRemoteStateConsumers
--- PASS: TestAccTFEWorkspace_paginatedRemoteStateConsumers (73.65s)
FAIL
FAIL	github.com/hashicorp/terraform-provider-tfe/tfe	652.987s
?   	github.com/hashicorp/terraform-provider-tfe/version	[no test files]
FAIL
make: *** [testacc] Error 1
...

i.e. there was a failure... but not in resources I've modified

Addresses hashicorp#392 The TFE SDK does actually contain `SourceName` and `SourceURL` fields already: https://github.com/hashicorp/go-tfe/blob/main/workspace.go#L129-L130 This is currently untested

`tfe.WorkspaceUpdateOptions` does not contain these fields, which makes sense, as those fields can only be set upon workspace creation. Will need to test to see what happens when a workspace is updated to add these fields.

Additionally, if SourceURL is set, but SourceName is not, set Name to URL

lucymhdavies · 2022-06-30T15:44:54Z

Ah, it's failing on:

=== RUN   TestAccTFEWorkspace_operationsAndExecutionModeInteroperability
    resource_tfe_workspace_test.go:750: Step 5/5 error: Error running apply: exit status 1

        Error: Error creating agent pool agent-pool-test for organization tst-terraform-5037466040717225428: resource not found

          with tfe_agent_pool.foobar,
          on terraform_plugin_test.tf line 7, in resource "tfe_agent_pool" "foobar":
           7: resource "tfe_agent_pool" "foobar" {

--- FAIL: TestAccTFEWorkspace_operationsAndExecutionModeInteroperability (39.92s)

because agent pools are a paid feature.

With SKIP_PAID=1...

$ SKIP_PAID=1 TESTARGS="-run TestAccTFEWorkspace" make testacc
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test $(go list ./... |grep -v 'vendor') -v -run TestAccTFEWorkspace -timeout 15m
?   	github.com/hashicorp/terraform-provider-tfe	[no test files]
=== RUN   TestAccTFEWorkspaceIDsDataSource_basic
--- PASS: TestAccTFEWorkspaceIDsDataSource_basic (15.13s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_wildcard
--- PASS: TestAccTFEWorkspaceIDsDataSource_wildcard (14.87s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_tags
--- PASS: TestAccTFEWorkspaceIDsDataSource_tags (13.99s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_searchByTagAndName
--- PASS: TestAccTFEWorkspaceIDsDataSource_searchByTagAndName (19.23s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_empty
--- PASS: TestAccTFEWorkspaceIDsDataSource_empty (2.19s)
=== RUN   TestAccTFEWorkspaceIDsDataSource_namesEmpty
--- PASS: TestAccTFEWorkspaceIDsDataSource_namesEmpty (15.63s)
=== RUN   TestAccTFEWorkspaceRunTaskDataSource_basic
    testing.go:65: Skipping tests for Run Tasks. Set 'RUN_TASKS_URL' to enabled this tests.
--- SKIP: TestAccTFEWorkspaceRunTaskDataSource_basic (0.00s)
=== RUN   TestAccTFEWorkspaceDataSource_remoteStateConsumers
--- PASS: TestAccTFEWorkspaceDataSource_remoteStateConsumers (17.62s)
=== RUN   TestAccTFEWorkspaceDataSource_basic
--- PASS: TestAccTFEWorkspaceDataSource_basic (15.41s)
=== RUN   TestAccTFEWorkspaceRunTask_create
    testing.go:65: Skipping tests for Run Tasks. Set 'RUN_TASKS_URL' to enabled this tests.
--- SKIP: TestAccTFEWorkspaceRunTask_create (0.00s)
=== RUN   TestAccTFEWorkspaceRunTask_import
    testing.go:65: Skipping tests for Run Tasks. Set 'RUN_TASKS_URL' to enabled this tests.
--- SKIP: TestAccTFEWorkspaceRunTask_import (0.00s)
=== RUN   TestAccTFEWorkspace_basic
--- PASS: TestAccTFEWorkspace_basic (13.50s)
=== RUN   TestAccTFEWorkspace_panic
--- PASS: TestAccTFEWorkspace_panic (14.22s)
=== RUN   TestAccTFEWorkspace_monorepo
--- PASS: TestAccTFEWorkspace_monorepo (14.98s)
=== RUN   TestAccTFEWorkspace_renamed
--- PASS: TestAccTFEWorkspace_renamed (17.30s)
=== RUN   TestAccTFEWorkspace_update
--- PASS: TestAccTFEWorkspace_update (26.76s)
=== RUN   TestAccTFEWorkspace_updateWorkingDirectory
--- PASS: TestAccTFEWorkspace_updateWorkingDirectory (30.21s)
=== RUN   TestAccTFEWorkspace_updateFileTriggers
--- PASS: TestAccTFEWorkspace_updateFileTriggers (16.43s)
=== RUN   TestAccTFEWorkspace_updateTriggerPrefixes
--- PASS: TestAccTFEWorkspace_updateTriggerPrefixes (22.41s)
=== RUN   TestAccTFEWorkspace_changeTags
--- PASS: TestAccTFEWorkspace_changeTags (80.46s)
=== RUN   TestAccTFEWorkspace_updateSpeculative
--- PASS: TestAccTFEWorkspace_updateSpeculative (21.07s)
=== RUN   TestAccTFEWorkspace_structuredRunOutputDisabled
--- PASS: TestAccTFEWorkspace_structuredRunOutputDisabled (17.76s)
=== RUN   TestAccTFEWorkspace_updateVCSRepo
    resource_tfe_workspace_test.go:556: Please set GITHUB_TOKEN to run this test
--- SKIP: TestAccTFEWorkspace_updateVCSRepo (0.54s)
=== RUN   TestAccTFEWorkspace_sshKey
--- PASS: TestAccTFEWorkspace_sshKey (37.78s)
=== RUN   TestAccTFEWorkspace_import
--- PASS: TestAccTFEWorkspace_import (15.48s)
=== RUN   TestAccTFEWorkspace_importVCSBranch
    resource_tfe_workspace_test.go:706: Please set GITHUB_TOKEN to run this test
--- SKIP: TestAccTFEWorkspace_importVCSBranch (0.58s)
=== RUN   TestAccTFEWorkspace_operationsAndExecutionModeInteroperability
    testing.go:47: Skipping test that requires a paid feature. Remove 'SKIP_PAID=1' if you want to run this test
--- SKIP: TestAccTFEWorkspace_operationsAndExecutionModeInteroperability (0.00s)
=== RUN   TestAccTFEWorkspace_globalRemoteState
--- PASS: TestAccTFEWorkspace_globalRemoteState (26.38s)
=== RUN   TestAccTFEWorkspace_alterRemoteStateConsumers
    resource_tfe_workspace_test.go:865: Step 1/5 error: Check failed: Check 2/2 error: tfe_workspace.foobar: Attribute 'global_remote_state' expected "true", got "false"
--- FAIL: TestAccTFEWorkspace_alterRemoteStateConsumers (11.77s)
=== RUN   TestAccTFEWorkspace_createWithRemoteStateConsumers
--- PASS: TestAccTFEWorkspace_createWithRemoteStateConsumers (14.98s)
=== RUN   TestAccTFEWorkspace_paginatedRemoteStateConsumers
--- PASS: TestAccTFEWorkspace_paginatedRemoteStateConsumers (87.79s)
FAIL
FAIL	github.com/hashicorp/terraform-provider-tfe/tfe	584.851s
?   	github.com/hashicorp/terraform-provider-tfe/version	[no test files]
FAIL
make: *** [testacc] Error 1

so not sure if that's a flakey test, or something else up

lucymhdavies · 2022-06-30T19:29:10Z

Added some tests specific to this feature:

$ SKIP_PAID=1 TESTARGS="-run TestAccTFEWorkspace_createWithSource" make testacc
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test $(go list ./... |grep -v 'vendor') -v -run TestAccTFEWorkspace_createWithSource -timeout 15m
?   	github.com/hashicorp/terraform-provider-tfe	[no test files]
=== RUN   TestAccTFEWorkspace_createWithSourceURL
    resource_tfe_workspace_test.go:944: Step 1/1 error: After applying this test step, the plan was not empty.
        stdout:


        Terraform used the selected providers to generate the following execution
        plan. Resource actions are indicated with the following symbols:
        -/+ destroy and then create replacement

        Terraform will perform the following actions:

          # tfe_workspace.foobar must be replaced
        -/+ resource "tfe_workspace" "foobar" {
              ~ execution_mode                = "remote" -> (known after apply)
              ~ global_remote_state           = false -> (known after apply)
              ~ id                            = "ws-z194mW93qgPQJdpa" -> (known after apply)
                name                          = "workspace-test"
              ~ operations                    = true -> (known after apply)
              ~ remote_state_consumer_ids     = [] -> (known after apply)
              - source_name                   = "https://example.com" -> null # forces replacement
              ~ terraform_version             = "1.2.4" -> (known after apply)
              ~ trigger_prefixes              = [] -> (known after apply)
                # (10 unchanged attributes hidden)
            }

        Plan: 1 to add, 0 to change, 1 to destroy.
--- FAIL: TestAccTFEWorkspace_createWithSourceURL (19.37s)
=== RUN   TestAccTFEWorkspace_createWithSourceURLAndName
--- PASS: TestAccTFEWorkspace_createWithSourceURLAndName (24.55s)

And it looks like there's actually a problem with my own functionality too, specifically how it handles the case where source_name is not set. Leave that with me, and I'll fix that.

(I might be trying to overcomplicate it actually; perhaps it's better not to try to be clever, and instead require that if either of source_name or source_url is set, then the other should be too 🤔)

…be set together

lucymhdavies · 2022-06-30T19:51:55Z

$ TESTARGS="-run TestAccTFEWorkspace_createWithSource" make testacc
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test $(go list ./... |grep -v 'vendor') -v -run TestAccTFEWorkspace_createWithSource -timeout 15m
?   	github.com/hashicorp/terraform-provider-tfe	[no test files]
=== RUN   TestAccTFEWorkspace_createWithSourceURL
--- PASS: TestAccTFEWorkspace_createWithSourceURL (1.39s)
=== RUN   TestAccTFEWorkspace_createWithSourceName
--- PASS: TestAccTFEWorkspace_createWithSourceName (1.07s)
=== RUN   TestAccTFEWorkspace_createWithSourceURLAndName
--- PASS: TestAccTFEWorkspace_createWithSourceURLAndName (14.75s)
PASS
ok  	github.com/hashicorp/terraform-provider-tfe/tfe	17.803s
?   	github.com/hashicorp/terraform-provider-tfe/version	[no test files]

sudomateo

This looks good overall. Might want to have someone that writes providers frequently review it just in case I missed something. I left a few wording suggestions and some general comments. Nice work!

website/docs/d/workspace.html.markdown

website/docs/r/workspace.html.markdown

tfe/resource_tfe_workspace_test.go

lucymhdavies · 2022-06-30T21:06:55Z

Good catches! This is what happens when I finish off a PR while half-asleep on a train and procrastinating from the work I'm actually supposed to be doing 🤣

I'll get those added.

Co-authored-by: Matthew Sanabria <24284972+sudomateo@users.noreply.github.com>

lucymhdavies · 2022-07-07T15:31:53Z

Changelog updated to fix conflicts

annawinkler

💖 Thank you for submitting this PR! We'll wait to merge this until the attributes are in GA.

annawinkler · 2022-07-07T18:38:42Z

Added the label DO NOT MERGE so it's clear to folks that we're not ready to merge this PR. Once the 2 attributes are GA then we can merge this PR.

lucymhdavies · 2022-07-07T19:11:26Z

That’s fair. I suspected we might want to do that, just in case we change how they work. 🙂

Do we have any timeline on when we expect those to be GA?
(Feel free to slack the answer if that information is not public yet)

annawinkler · 2023-02-02T15:08:44Z

I'm finding out if we can merge this PR. Stay tuned! 📻

lucymhdavies · 2023-02-02T15:14:38Z

Oh nice! We'd need to resolve the conflict of course, but if this is likely to get merged that'd be awesome :)

lucymhdavies · 2023-02-02T16:24:20Z

Conflicts should be resolved. I'm gonna do a quick once-over in the diff to make sure it didn't break anything, then it should be all ready to go.

Edit: Some auto-checks failed, due to changes in the code since I originally raised the PR. Getting those resolved, and then I'll let you know when it's ready.

Edit 2: Well... it's still failing, but as far as I can tell that's not due to anything in my change.

It has had a new field added since I initially raised the PR

annawinkler · 2023-02-02T19:04:17Z

Small update: we're sorting out a build/CI issue.

annawinkler

lucymhdavies · 2023-02-03T11:56:50Z

#783 for the version of this with working CI

lucymhdavies added 6 commits June 21, 2022 15:31

Initial support for Source Name and Source URL when creating a Workspace

539c4f8

Addresses hashicorp#392 The TFE SDK does actually contain `SourceName` and `SourceURL` fields already: https://github.com/hashicorp/go-tfe/blob/main/workspace.go#L129-L130 This is currently untested

Remove SourceName and SourceURL from the update function

be1a957

`tfe.WorkspaceUpdateOptions` does not contain these fields, which makes sense, as those fields can only be set upon workspace creation. Will need to test to see what happens when a workspace is updated to add these fields.

Only set workspace SourceURL if the value is set (and is a valid URL)

2c070bc

Additionally, if SourceURL is set, but SourceName is not, set Name to URL

Changelog and docs

5948aef

Update docs based on API docs

95b61a2

Merge branch 'main' into source-name-url

3b9c8db

Tests for Workspace Source and require source_name and source_url to …

35e18cd

…be set together

Update source_url docs

7abadcc

sudomateo approved these changes Jun 30, 2022

View reviewed changes

website/docs/d/workspace.html.markdown Outdated Show resolved Hide resolved

website/docs/r/workspace.html.markdown Outdated Show resolved Hide resolved

tfe/resource_tfe_workspace_test.go Outdated Show resolved Hide resolved

tfe/resource_tfe_workspace_test.go Outdated Show resolved Hide resolved

lucymhdavies and others added 4 commits June 30, 2022 22:07

Update website/docs/r/workspace.html.markdown

e6057ed

Co-authored-by: Matthew Sanabria <24284972+sudomateo@users.noreply.github.com>

Update website/docs/d/workspace.html.markdown

aa27024

Co-authored-by: Matthew Sanabria <24284972+sudomateo@users.noreply.github.com>

Merge branch 'main' into source-name-url

1d82481

Update CHANGELOG.md

907ccef

annawinkler suggested changes Jul 7, 2022

View reviewed changes

annawinkler added the DO NOT MERGE label Jul 7, 2022

lucymhdavies requested a review from a team as a code owner February 2, 2023 16:23

Merge remote-tracking branch 'origin/main' into source-name-url

f97eae5

lucymhdavies force-pushed the source-name-url branch from 52d2ab9 to f97eae5 Compare February 2, 2023 16:25

Add missing field to testAccCheckTFEWorkspaceExists

b11f822

It has had a new field added since I initially raised the PR

annawinkler removed the DO NOT MERGE label Feb 2, 2023

annawinkler approved these changes Feb 2, 2023

View reviewed changes

annawinkler merged commit b11f822 into hashicorp:main Feb 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Workspace Source Name and URL #527

Workspace Source Name and URL #527

lucymhdavies commented Jun 21, 2022 •

edited

Loading

lucymhdavies commented Jun 30, 2022

lucymhdavies commented Jun 30, 2022

lucymhdavies commented Jun 30, 2022

sudomateo left a comment

lucymhdavies commented Jun 30, 2022

lucymhdavies commented Jul 7, 2022

annawinkler left a comment

annawinkler commented Jul 7, 2022

lucymhdavies commented Jul 7, 2022 •

edited

Loading

annawinkler commented Feb 2, 2023

lucymhdavies commented Feb 2, 2023

lucymhdavies commented Feb 2, 2023 •

edited

Loading

annawinkler commented Feb 2, 2023

annawinkler left a comment

lucymhdavies commented Feb 3, 2023

Workspace Source Name and URL #527

Workspace Source Name and URL #527

Conversation

lucymhdavies commented Jun 21, 2022 • edited Loading

Description

Testing plan

External links

Output from acceptance tests

lucymhdavies commented Jun 30, 2022

lucymhdavies commented Jun 30, 2022

lucymhdavies commented Jun 30, 2022

sudomateo left a comment

Choose a reason for hiding this comment

lucymhdavies commented Jun 30, 2022

lucymhdavies commented Jul 7, 2022

annawinkler left a comment

Choose a reason for hiding this comment

annawinkler commented Jul 7, 2022

lucymhdavies commented Jul 7, 2022 • edited Loading

annawinkler commented Feb 2, 2023

lucymhdavies commented Feb 2, 2023

lucymhdavies commented Feb 2, 2023 • edited Loading

annawinkler commented Feb 2, 2023

annawinkler left a comment

Choose a reason for hiding this comment

lucymhdavies commented Feb 3, 2023

lucymhdavies commented Jun 21, 2022 •

edited

Loading

lucymhdavies commented Jul 7, 2022 •

edited

Loading

lucymhdavies commented Feb 2, 2023 •

edited

Loading