Add support for source_workstation in workstations_workstation resource.

[esu]

This adds support for workstation PD cloning using source_workstation. It can only be set during workstation resource creation and cannot be updated afterwards: https://cloud.google.com/workstations/docs/reference/rest/v1beta/projects.locations.workstationClusters.workstationConfigs.workstations#Workstation.FIELDS.source_workstation

The primary use case of this field is for recovery, so it doesn't seem possible to write an automated test for it. This is because a workstation must be started manually before it can be cloned, else its PD is not created. If there is a way to write a test that can send API calls outside of Terraform, please let me know.

Fixes hashicorp/terraform-provider-google#19730.

Release Note Template for Downstream PRs (will be copied)

See Write release notes for guidance.

workstations: add `source_workstation` field to `google_workstations_workstation` resource

[github-actions]

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

@ScottSuarez, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 1 file changed, 5 insertions(+))
google-beta provider: Diff ( 2 files changed, 29 insertions(+))
terraform-google-conversion: Diff ( 1 file changed, 10 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_workstations_workstation (8 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_workstations_workstation" "primary" {
  source_workstation = # value needed
}

[modular-magician]

Tests analytics

Total tests: 37
Passed tests: 37
Skipped tests: 0
Affected tests: 0

Click here to see the affected service packages

• workstations

🟢 All tests passed!

View the build log

[ScottSuarez]

Can you add tests for this field? Potentially an update and create test.

You can extend existing ones where appropriate

[esu]

It's difficult to write a create test for this field because it requires a manual human interaction on a dependency resource. A create test would have to:

1. Create a workstation
2. Start the workstation so that its PDs are initialized, else the API will reject the next step (and StartWorkstation is not possible through Terraform)
3. Create a second workstation specifying source_workstation to clone the first workstation's PDs

Is it possible to send GCP API calls without Terraform during a create test? Open to suggestions on how to implement this.
Lastly, if the field is immutable, does it need an update test?

[ScottSuarez]

You can do a two step test where you first create a workstation. Then you add another workstation which depends on the previous in that config.

https://github.com/hashicorp/terraform-provider-google-beta/blob/dcc0e42c39d9a69a4d97a7d932cf1eae23835239/google-beta/services/workstations/resource_workstations_workstation_test.go#L12-L46

So your config would look something like

{
	Config: testAccWorkstationsWorkstation_initialWorkStation(context),
},
{
  // import verify 
}
{
	Config: testAccWorkstationsWorkstation_initialWorkStationWithSecondaryReference(context),
},
{
  // import verify 
}

[esu]

I am not sure we can do that -- the initial workstation can be created using Terraform, but it's created in a STOPPED state in which it is not cloneable, even after the CREATE operation is reported as complete by the API.

In your example, creating a secondary workstation using source_workstation is "cloning" it, which the Workstations API will reject if the initial workstation is not manually started. Workstations are for human use and cannot be started using Terraform.

[github-actions]

@ScottSuarez This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

[ScottSuarez]

Ah! I see! Thanks for that clarification! Let me try and test it locally.

[ScottSuarez]

tested locally