New Data Source: aws_workspaces_image #11428

Tensho · 2019-12-27T12:35:20Z

Community Note

Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Release note for CHANGELOG:

New Data Source: aws_workspaces_image (#11428)

Example

data "aws_workspaces_image" "example" {
  image_id = "wsi-ten5h0y19"
}

TODO

Create aws_workspaces_image resource before inspecting it with the described data source

Acceptance Tests

$ AWS_WORKSPACES_IMAGE_ID=wsi-vwtykwqyx AWS_DEFAULT_REGION=us-east-1 make testacc TEST=./aws TESTARGS='-run=TestAccDataSourceAwsWorkspacesImage_basic'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccDataSourceAwsWorkspacesImage_basic -timeout 120m
=== RUN   TestAccDataSourceAwsWorkspacesImage_basic
=== PAUSE TestAccDataSourceAwsWorkspacesImage_basic
=== CONT  TestAccDataSourceAwsWorkspacesImage_basic
--- PASS: TestAccDataSourceAwsWorkspacesImage_basic (30.84s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	34.844s

References

Support for AWS Workspaces

Tensho · 2019-12-27T12:37:37Z

Unfortunately, it's not possible to create an image with the API at the moment, I've requested corresponding API action with AWS Support ticket.
The current test passes for the manually created image in AWS Web Management Console.

ewbankkit · 2020-02-01T22:00:42Z

aws/data_source_aws_workspaces_image.go

+	resp, err := conn.DescribeWorkspaceImages(input)
+	if err != nil {
+		return err
+	}


Will probably want to check len(resp.Images) > 0 here.
See #11837.

Good point, will add

gdavison

Looks good, @Tensho. A couple changes to make.

aws/data_source_aws_workspaces_image.go

gdavison · 2020-06-04T20:23:18Z

aws/data_source_aws_workspaces_image_test.go

+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceAwsWorkspacesImageConfig("wsi-vwtykwqyx"),


This won't pass in our testing environments, since the image is owned by your account.

We could add an environment variable for the image ID and have a pre-check function that checks for the environment variable. Alternatively, there are API functions to import AMIs as Workspace images.

I like the idea with environment variable, will add the pre-check for now. Unfortunately, ImportWorkspaceImage API works only with Windows. I've submitted respective feature request to AWS Support last year. Is it OK to create aws_workspace_image Terraform resource only for Windows, while AWS supports Linux images too?

Yes, we can do that. We'll just need to document that it only supports Windows images because of the AWS API

Unfortunately, even Windows images could be imported only with BYOL, which looks like a totally separate feature.

Tensho · 2020-06-05T08:48:53Z

@gdavison Thank you, I've added fixes according to your review, please let me know if I can do anything else here 🙇

gdavison

The test will need to be updated to handle arbitrary image ids

gdavison · 2020-06-18T23:07:45Z

aws/data_source_aws_workspaces_image_test.go

+					resource.TestCheckResourceAttr(dataSourceName, "image_id", "wsi-vwtykwqyx"),
+					resource.TestCheckResourceAttr(dataSourceName, "name", "Windows10Baseline"),
+					resource.TestCheckResourceAttr(dataSourceName, "description", "Google Chrome AWS WorkDocs Drive CrowdStrike Falcon Russian/Ukrainian Language Pack"),
+					resource.TestCheckResourceAttr(dataSourceName, "os", "WINDOWS"),
+					resource.TestCheckResourceAttr(dataSourceName, "required_tenancy", "DEFAULT"),
+					resource.TestCheckResourceAttr(dataSourceName, "state", "AVAILABLE"),


Since we're retrieving a WorkSpaces Image using an arbitrary ID, we won't know these values beforehand. You might be able to test this by retrieving the API resource by ID, and then comparing the values in the Terraform resource state. testAccCheckEfsMountTarget() is an example of the approach you could take

testAccCheckEfsMountTarget() retrieves actual resource attributes within AWS API, but doesn't test them against state 😄 But I got the idea, you meant item 2 at Anatomy of an Acceptance Test – testAccCheckCloudWatchDashboardExists().

gdavison · 2020-06-18T23:29:36Z

aws/data_source_aws_workspaces_image_test.go

+
+func testAccWorkspacesImagePreCheck(t *testing.T) {
+	if os.Getenv("AWS_WORKSPACES_IMAGE_ID") == "" {
+		t.Fatal("AWS_WORKSPACES_IMAGE_ID env var must be set for AWS WorkSpaces image acceptance tests. This is required until AWS provides ubiquitous (Windows, Linux) import image API.")


If the environment variable isn't set, this should skip the test instead of failing

Tensho · 2020-06-21T21:58:10Z

@gdavison FIxed, check it out again.

gdavison

Looking good. It will need to be rebased, and I have a few suggested changes.

aws/data_source_aws_workspaces_image_test.go

aws/data_source_aws_workspaces_image.go

gdavison · 2020-07-14T23:19:47Z

aws/data_source_aws_workspaces_image.go

+			"state": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},


We can remove the state attribute, since it is more of a run-time property, not a configuration property.

But this is a data source, not a resource. Don't we need to get info about any possible attribute there?

aws/data_source_aws_workspaces_image.go

Tensho · 2020-07-15T08:08:10Z

@gdavison Adjusted according to your comments. Please let me know if you need anything else 🙇

I also work on aws_workspaces_workspace data source, but I've stuck with one test. If you have some time to look there, please could you guide me the right direction 🙇

Tensho · 2020-08-25T14:18:22Z

@gdavison @ewbankkit Hi ^_^ Please could you check it again?

gdavison

LGTM 🚀

--- PASS: TestAccDataSourceAwsWorkspacesImage_basic (54.32s)

Tensho · 2020-09-18T06:26:47Z

@gdavison Thank you 🙇

ghost · 2020-09-24T22:17:23Z

This has been released in version 3.8.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

ghost · 2020-10-25T17:11:13Z

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

Tensho requested a review from a team December 27, 2019 12:35

Tensho force-pushed the d-workspaces-image branch from 276e7a4 to d4d041d Compare January 11, 2020 12:31

ewbankkit reviewed Feb 1, 2020

View reviewed changes

Tensho force-pushed the d-workspaces-image branch 3 times, most recently from 51ca002 to dc2f918 Compare May 28, 2020 08:25

gdavison self-assigned this Jun 3, 2020

gdavison removed the needs-triage Waiting for first response or review from a maintainer. label Jun 4, 2020

gdavison requested changes Jun 4, 2020

View reviewed changes

Tensho force-pushed the d-workspaces-image branch from dc2f918 to 6ed0c56 Compare June 5, 2020 08:47

ghost added size/L Managed by automation to categorize the size of a PR. and removed size/M Managed by automation to categorize the size of a PR. labels Jun 5, 2020

gdavison requested changes Jun 18, 2020

View reviewed changes

gdavison added the waiting-response Maintainers are waiting on response from community or contributor. label Jun 18, 2020

Tensho force-pushed the d-workspaces-image branch 2 times, most recently from 4bf7c79 to bc6e5a5 Compare June 21, 2020 21:57

ghost removed the waiting-response Maintainers are waiting on response from community or contributor. label Jun 21, 2020

Tensho force-pushed the d-workspaces-image branch from bc6e5a5 to 5fc6e61 Compare June 21, 2020 21:59

anGie44 force-pushed the master branch from 6c6566f to 081bf57 Compare June 29, 2020 16:14

gdavison requested changes Jul 14, 2020

View reviewed changes

Tensho force-pushed the d-workspaces-image branch from 5fc6e61 to b775925 Compare July 15, 2020 08:05

New data source: aws_workspaces_image

b4ba8f2

Tensho force-pushed the d-workspaces-image branch from b775925 to b4ba8f2 Compare August 25, 2020 10:02

Update to Terraform 0.12+ syntax

e4e2c52

Tensho force-pushed the d-workspaces-image branch from d0e321f to e4e2c52 Compare August 25, 2020 12:50

Tensho mentioned this pull request Sep 7, 2020

AWS WorkSpaces Service Maintainer #14821

Merged

gdavison approved these changes Sep 17, 2020

View reviewed changes

gdavison added this to the v3.8.0 milestone Sep 17, 2020

Merge branch 'master' into d-workspaces-image

507726b

gdavison merged commit c7d40f2 into hashicorp:master Sep 24, 2020

gdavison added a commit that referenced this pull request Sep 24, 2020

Update CHANGELOG for #11428

69cf709

ghost locked as resolved and limited conversation to collaborators Oct 25, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Data Source: aws_workspaces_image #11428

New Data Source: aws_workspaces_image #11428

Tensho commented Dec 27, 2019 •

edited

Tensho commented Dec 27, 2019 •

edited

ewbankkit Feb 1, 2020

Tensho Feb 3, 2020

gdavison left a comment

gdavison Jun 4, 2020

Tensho Jun 5, 2020

gdavison Jul 14, 2020

Tensho Jul 24, 2020

Tensho commented Jun 5, 2020

gdavison left a comment

gdavison Jun 18, 2020

Tensho Jun 19, 2020 •

edited

Tensho Jun 21, 2020

gdavison Jun 18, 2020

Tensho Jun 21, 2020

Tensho commented Jun 21, 2020

gdavison left a comment

gdavison Jul 14, 2020

Tensho Jul 15, 2020

Tensho commented Jul 15, 2020

Tensho commented Aug 25, 2020

gdavison left a comment

Tensho commented Sep 18, 2020

ghost commented Sep 24, 2020

ghost commented Oct 25, 2020

New Data Source: aws_workspaces_image #11428

New Data Source: aws_workspaces_image #11428

Conversation

Tensho commented Dec 27, 2019 • edited

Community Note

Example

TODO

Acceptance Tests

References

Tensho commented Dec 27, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gdavison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tensho commented Jun 5, 2020

gdavison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tensho Jun 19, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tensho commented Jun 21, 2020

gdavison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tensho commented Jul 15, 2020

Tensho commented Aug 25, 2020

gdavison left a comment

Choose a reason for hiding this comment

Tensho commented Sep 18, 2020

ghost commented Sep 24, 2020

ghost commented Oct 25, 2020

Tensho commented Dec 27, 2019 •

edited

Tensho commented Dec 27, 2019 •

edited

Tensho Jun 19, 2020 •

edited