New resource: `aws_grafana_workspace_api_key` #25286

meetreks · 2022-06-12T09:27:14Z

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

$ make testacc PKG=grafana TESTS=TestAccGrafana_serial/ApiKey
Output from acceptance testing:
:~/terraform-provider-aws (f-aws_grafana_workspace_api_key) 
$ make testacc PKG=grafana TESTS=TestAccGrafana_serial/ApiKey ==> Checking that code complies with gofmt requirements... TF_ACC=1 go test ./internal/service/grafana/... -v -count 1 -parallel 20 -run='TestAccGrafana_serial/ApiKey' -timeout 180m === RUN TestAccGrafana_serial === RUN TestAccGrafana_serial/ApiKey === RUN TestAccGrafana_serial/ApiKey/basic --- PASS: TestAccGrafana_serial (134.54s) --- PASS: TestAccGrafana_serial/ApiKey (134.54s) --- PASS: TestAccGrafana_serial/ApiKey/basic (134.54s) PASS ok github.com/hashicorp/terraform-provider-aws/internal/service/grafana 134.618s :~/terraform-provider-aws (f-aws_grafana_workspace_api_key) $

...

AdamTylerLynch

Great pull request! I would recommend you review Resource Contribution Guide and verify that everything that can be implemented is implemented.

I have suggested some changes.

AdamTylerLynch · 2022-06-21T00:01:54Z

internal/service/grafana/workspace_api_key.go

+
+func ResourceWorkspaceApiKey() *schema.Resource {
+	return &schema.Resource{
+		Create: resourceWorkspaceApiKeyInsert,


Method should be named *Create, not *Insert.

Suggested change

Create: resourceWorkspaceApiKeyInsert,

Create: resourceWorkspaceApiKeyCreate,

Changed to Create as suggested

AdamTylerLynch · 2022-06-21T00:03:34Z

internal/service/grafana/workspace_api_key.go

+			"key_name": {
+				Type:     schema.TypeString,
+				Required: true,
+				//Computed: true,


Please remove left over code.

Changed as suggested

AdamTylerLynch · 2022-06-21T00:05:30Z

internal/service/grafana/workspace_api_key.go

+			"key_role": {
+				Type:     schema.TypeString,
+				Required: true,
+				//Computed:     true,


Please remove left over code.

Changed as suggested

AdamTylerLynch · 2022-06-21T00:27:28Z

internal/service/grafana/workspace_api_key.go

+	}
+}
+
+func resourceWorkspaceApiKeyInsert(d *schema.ResourceData, meta interface{}) error {


We prefer to use the standard name of *Create.

Suggested change

func resourceWorkspaceApiKeyInsert(d *schema.ResourceData, meta interface{}) error {

func resourceWorkspaceApiKeyCreate(d *schema.ResourceData, meta interface{}) error {

Changed to Create as suggested

AdamTylerLynch · 2022-06-21T00:31:10Z

internal/service/grafana/workspace_api_key.go

+			"key_name": {
+				Type:     schema.TypeString,
+				Required: true,
+				//Computed: true,


Please add validation that matches the API documentation.

Suggested change

//Computed: true,

ValidateFunc: validation.StringLenBetween(1, 100),

Changed as suggested

AdamTylerLynch · 2022-06-21T01:10:50Z

internal/service/grafana/workspace_api_key_test.go

+	})
+}
+
+func testAccWorkspaceApiKeyProvider_basic(rName string) string {


Passing in rName, but it is not used in the test.

Now using rName in Test

AdamTylerLynch · 2022-06-21T01:11:24Z

internal/service/grafana/workspace_api_key_test.go

+}
+
+func testAccWorkspaceApiKeyProvider_basic(rName string) string {
+	return fmt.Sprintf(`


unnecessary use of return fmt.Sprintf(, as no strings are being formatted/interpolated.

AdamTylerLynch · 2022-06-21T01:11:50Z

internal/service/grafana/workspace_api_key_test.go

+					resource.TestCheckResourceAttrSet(resourceName, "key_name"),
+					resource.TestCheckResourceAttrSet(resourceName, "key_role"),
+					resource.TestCheckResourceAttrSet(resourceName, "seconds_to_live"),
+					resource.TestCheckResourceAttrPair(resourceName, "workspace_id", workspaceResourceName, "id"),


Please add an evaluation of the requested Key computed output.

Added as requested.

AdamTylerLynch · 2022-06-21T01:14:05Z

website/docs/r/grafana_workspace_api_key.html.markdown

+
+In addition to all arguments above, the following attributes are exported:
+
+* `key` - The key token in JSON format. Use this value as a bearer token to authenticate HTTP requests to the workspace.


I do not see how this value is exported as the _, err = conn.CreateWorkspaceApiKey(input) call is discarding the CreateWorkspaceApiKeyOutput.

Please verify?

AdamTylerLynch · 2022-06-21T01:18:10Z

website/docs/r/grafana_workspace_api_key.html.markdown

+
+## Import
+
+Grafana Workspace API Key cannot be imported.


I see no reason that the API Key can not be imported.

Suggested change

Grafana Workspace API Key cannot be imported.

Grafana Workspace API Key can be imported using the `id`, e.g.,

```sh

$ terraform import aws_grafana_workspace_api_key.example workspace-id/keyname

-> Note: The key attribute cannot be imported as it is a token and is only available at create time.

Changed as Requested.

AdamTylerLynch · 2022-06-21T01:21:38Z

Please also include a copy/paste of AccTest ouutput, not a screenshot. Thank you!

meetreks · 2022-07-04T08:56:47Z

Acceptance test results

GlennChia

Great PR! Some changes requested in addition to Tyler's first review

GlennChia · 2022-07-14T14:20:40Z

internal/service/grafana/workspace_api_key_test.go

+	})
+}
+
+func testAccWorkspaceAPIKeyConfig_basic(rName string, apiKey string) string {


For this test function, 2 parameters are not required, we should be using 1 parameter since only 1 parameter is used in the hcl definition

removed the extra parameter.

GlennChia · 2022-07-14T14:27:26Z

internal/service/grafana/workspace_api_key.go

+		Importer: &schema.ResourceImporter{
+			State: schema.ImportStatePassthrough,
+		},


Since this resource does not support imports, this block can possibly be removed. A similar resource can be found here: https://github.com/hashicorp/terraform-provider-aws/blob/main/internal/service/kms/ciphertext.go

Deleted as Requested.

GlennChia · 2022-07-14T14:28:12Z

internal/service/grafana/workspace_api_key.go

+		Timeouts: &schema.ResourceTimeout{
+			Create: schema.DefaultTimeout(10 * time.Minute),
+			Delete: schema.DefaultTimeout(10 * time.Minute),
+		},


Timeouts are not used in this resource and this block can be removed.

Suggested change

Timeouts: &schema.ResourceTimeout{

Create: schema.DefaultTimeout(10 * time.Minute),

Delete: schema.DefaultTimeout(10 * time.Minute),

},

Deleted as Requested.

GlennChia · 2022-07-14T14:37:56Z

internal/service/grafana/workspace_api_key_test.go

+			{
+				Config: testAccWorkspaceAPIKeyConfig_basic(rName, "test-api-1"),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr(resourceName, "key_name", "test-api-1"),


Instead of hard-coding test-api-1, we can use rName.

Suggested change

resource.TestCheckResourceAttr(resourceName, "key_name", "test-api-1"),

resource.TestCheckResourceAttr(resourceName, "key_name", rName),

Done as suggested.

GlennChia · 2022-07-14T14:38:42Z

internal/service/grafana/workspace_api_key_test.go

+		ProviderFactories: acctest.ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccWorkspaceAPIKeyConfig_basic(rName, "test-api-1"),


We can remove "test-api-1" since only rName is used in the HCL

Suggested change

Config: testAccWorkspaceAPIKeyConfig_basic(rName, "test-api-1"),

Config: testAccWorkspaceAPIKeyConfig_basic(rName),

Done as requested, and used just rName as the random name.

GlennChia · 2022-07-14T14:41:12Z

internal/service/grafana/workspace_api_key_test.go

+				Config: testAccWorkspaceAPIKeyConfig_basic(rName, "test-api-1"),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr(resourceName, "key_name", "test-api-1"),
+					resource.TestCheckResourceAttr(resourceName, "key_role", "EDITIR"),


This can be changed to use the value that the SDK provides

const ( // RoleAdmin is a Role enum value RoleAdmin = "ADMIN" // RoleEditor is a Role enum value RoleEditor = "EDITOR" // RoleViewer is a Role enum value RoleViewer = "VIEWER" )

Done as requested.

GlennChia · 2022-07-14T14:44:55Z

website/docs/r/grafana_workspace_api_key.html.markdown

+
+

Extra empty lines can be removed

GlennChia · 2022-07-14T14:45:44Z

website/docs/r/grafana_workspace_api_key.html.markdown

+
+The following arguments are required:
+
+* `editor_role_values` - (Required) The editor role values.


The valid values for Role can be defined here. From the documentation at https://docs.aws.amazon.com/grafana/latest/APIReference/API_CreateWorkspaceApiKey.html, the valid values are VIEWER|EDITOR|ADMIN

GlennChia · 2022-07-14T14:46:45Z

website/docs/r/grafana_workspace_api_key.html.markdown

+
+* `key` - The key token in JSON format. Use this value as a bearer token to authenticate HTTP requests to the workspace.
+
+## Import


Since imports are not supported, this can be removed

meetreks · 2022-07-25T05:26:32Z

:/terraform-provider-aws (f-aws_grafana_workspace_api_key) $ make testacc PKG=grafana TESTS=TestAccGrafana_serial/ApiKey
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/grafana/... -v -count 1 -parallel 20 -run='TestAccGrafana_serial/ApiKey' -timeout 180m
=== RUN TestAccGrafana_serial
=== RUN TestAccGrafana_serial/ApiKey
=== RUN TestAccGrafana_serial/ApiKey/basic
--- PASS: TestAccGrafana_serial (139.80s)
--- PASS: TestAccGrafana_serial/ApiKey (139.80s)
--- PASS: TestAccGrafana_serial/ApiKey/basic (139.80s)
PASS
ok github.com/hashicorp/terraform-provider-aws/internal/service/grafana 139.908s
:/terraform-provider-aws (f-aws_grafana_workspace_api_key) $

louismrose · 2022-07-28T16:39:10Z

Is there more to be done on this change? Anything I could help with? We're keen to see this change land and stop managing Grafana API keys outside of Terraform!

This reverts commit 3fe1fec.

This reverts commit 5ab5cfe.

This reverts commit 246ce9b.

This reverts commit ddaec83.

This reverts commit 340061d.

This reverts commit 493888a.

This reverts commit 8c75558.

This reverts commit 4be49dd.

This reverts commit 00e65e8.

This reverts commit d71728b.

This reverts commit 3e32805.

This reverts commit e10eb39.

This reverts commit dc1c31f.

This reverts commit 662197c.

This reverts commit 6782ffc.

This reverts commit eef5fc6.

…rp#26383.

ewbankkit

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccGrafana_serial/ApiKey' PKG=grafana
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/grafana/... -v -count 1 -parallel 20  -run=TestAccGrafana_serial/ApiKey -timeout 180m
=== RUN   TestAccGrafana_serial
=== RUN   TestAccGrafana_serial/ApiKey
=== RUN   TestAccGrafana_serial/ApiKey/basic
--- PASS: TestAccGrafana_serial (135.92s)
    --- PASS: TestAccGrafana_serial/ApiKey (135.92s)
        --- PASS: TestAccGrafana_serial/ApiKey/basic (135.92s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/grafana	139.938s

ewbankkit · 2022-08-22T15:22:20Z

@meetreks Thanks for the contribution 🎉 👏.

meetreks · 2022-08-22T15:37:44Z

@meetreks Thanks for the contribution 🎉 👏.

Thanks sir, this is really helpful.

github-actions · 2022-08-26T16:13:42Z

This functionality has been released in v4.28.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. Thank you!

github-actions · 2022-09-26T02:45:52Z

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 issues.
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.

wip-For-Internal-AWS-Review

ca238f0

justinretzolk removed the needs-triage Waiting for first response or review from a maintainer. label Jun 17, 2022

AdamTylerLynch suggested changes Jun 21, 2022

View reviewed changes

ewbankkit changed the title ~~wip-For-Internal-AWS-Review~~ New resource: aws_grafana_workspace_api_key Jul 1, 2022

ewbankkit added the new-resource Introduces a new resource. label Jul 1, 2022

Grafana new resource aws_grafana_workspace_api_key

11a37b9

EC2 Default User added 3 commits July 4, 2022 20:23

Grafana new resource aws_grafana_workspace_api_key

4afdc5b

Grafana new resource aws_grafana_workspace_api_key

a305e0b

Grafana new resource aws_grafana_workspace_api_key

f495674

meetreks force-pushed the f-aws_grafana_workspace_api_key branch from d0d15df to f495674 Compare July 4, 2022 20:31

Fix Linting Issues

849759a

meetreks force-pushed the f-aws_grafana_workspace_api_key branch from af5be97 to 849759a Compare July 4, 2022 21:01

bryantbiggs mentioned this pull request Jul 6, 2022

Grafana API key or a way to provision dashboards terraform-aws-modules/terraform-aws-managed-service-grafana#7

Closed

address change in Provider.Go

aa5c4b2

meetreks force-pushed the f-aws_grafana_workspace_api_key branch from a2b392e to aa5c4b2 Compare July 13, 2022 09:58

linting fix

73cff8d

meetreks force-pushed the f-aws_grafana_workspace_api_key branch from 68dfbd7 to 73cff8d Compare July 13, 2022 15:38

GlennChia suggested changes Jul 14, 2022

View reviewed changes

incorporate review comments

6b6f3bd

meetreks force-pushed the f-aws_grafana_workspace_api_key branch from a5a3662 to 6b6f3bd Compare July 25, 2022 05:23

ewbankkit added 18 commits August 22, 2022 10:24

Revert "Update grafana_workspace_api_key.html.markdown"

6ca17f1

This reverts commit 3fe1fec.

Revert "Update internal/service/grafana/workspace_api_key_test.go"

d3cc2df

This reverts commit 5ab5cfe.

Revert "Update internal/service/grafana/workspace_api_key_test.go"

54da3d1

This reverts commit 246ce9b.

Revert "Update internal/service/grafana/workspace_api_key_test.go"

f8539cd

This reverts commit ddaec83.

Revert "post fix test name with Config"

18141b5

This reverts commit 340061d.

Revert "Add testAccWorkspaceApiKey_basic to TestAccGrafana_serial"

00bf390

This reverts commit 493888a.

Revert "pass rName to key_name and fmt"

1df13f7

This reverts commit 8c75558.

Revert "Use EDITOR as key_role"

54e75f0

This reverts commit 4be49dd.

Revert "Create workspace_api_key_test.go"

f80724a

This reverts commit 00e65e8.

Revert "ForceNew on required attributes"

fb84a4f

This reverts commit d71728b.

Revert "Fix casing typoops"

de8f06b

This reverts commit 3e32805.

Revert "Remove custom timeout"

3e1d76e

This reverts commit e10eb39.

Revert "Create 26383.txt"

0fd72f5

This reverts commit dc1c31f.

Revert "Create grafana_workspace_api_key.html.markdown"

8d9b427

This reverts commit 662197c.

Revert "Create provider entry for aws_grafana_workspace_api_key"

9422d22

This reverts commit 6782ffc.

Revert "Create workspace_api_key.go"

8442338

This reverts commit eef5fc6.

Merge commit '844233865862b1678b18ea736da55a9d30b5f9f8' into HEAD

29bb6be

r/aws_grafana_workspace_api_key: Incorporate some tweaks from hashico…

c38010e

…rp#26383.

ewbankkit mentioned this pull request Aug 22, 2022

New resource: Grafana Workspace Api Key #26383

Closed

ewbankkit approved these changes Aug 22, 2022

View reviewed changes

ewbankkit merged commit 9a1a162 into hashicorp:main Aug 22, 2022

github-actions bot added this to the v4.28.0 milestone Aug 22, 2022

lewinkedrs mentioned this pull request Aug 25, 2022

Setup Managed Grafana API Keys aws-observability/terraform-aws-observability-accelerator#6

Closed

bryantbiggs mentioned this pull request Aug 26, 2022

feat: Add support for generating workspace API keys terraform-aws-modules/terraform-aws-managed-service-grafana#9

Merged

3 tasks

github-actions bot locked as resolved and limited conversation to collaborators Sep 26, 2022

justinretzolk added the partner Contribution from a partner. label May 16, 2024

	Create: resourceWorkspaceApiKeyInsert,
	Create: resourceWorkspaceApiKeyCreate,

	func resourceWorkspaceApiKeyInsert(d *schema.ResourceData, meta interface{}) error {
	func resourceWorkspaceApiKeyCreate(d *schema.ResourceData, meta interface{}) error {

	//Computed: true,
	ValidateFunc: validation.StringLenBetween(1, 100),


		In addition to all arguments above, the following attributes are exported:

		* `key` - The key token in JSON format. Use this value as a bearer token to authenticate HTTP requests to the workspace.

-Grafana Workspace API Key cannot be imported.
+Grafana Workspace API Key can be imported using the `id`, e.g.,
+```sh
+$ terraform import aws_grafana_workspace_api_key.example workspace-id/keyname

	resource.TestCheckResourceAttr(resourceName, "key_name", "test-api-1"),
	resource.TestCheckResourceAttr(resourceName, "key_name", rName),

	Config: testAccWorkspaceAPIKeyConfig_basic(rName, "test-api-1"),
	Config: testAccWorkspaceAPIKeyConfig_basic(rName),


		The following arguments are required:

		* `editor_role_values` - (Required) The editor role values.


		* `key` - The key token in JSON format. Use this value as a bearer token to authenticate HTTP requests to the workspace.

		## Import

New resource: aws_grafana_workspace_api_key #25286

New resource: aws_grafana_workspace_api_key #25286

Conversation

meetreks commented Jun 12, 2022 • edited by ewbankkit Loading

Community Note

AdamTylerLynch 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

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

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

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

AdamTylerLynch commented Jun 21, 2022

meetreks commented Jul 4, 2022

GlennChia 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

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

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

Choose a reason for hiding this comment

meetreks commented Jul 25, 2022

louismrose commented Jul 28, 2022

ewbankkit left a comment

Choose a reason for hiding this comment

ewbankkit commented Aug 22, 2022

meetreks commented Aug 22, 2022

github-actions bot commented Aug 26, 2022

github-actions bot commented Sep 26, 2022

New resource: `aws_grafana_workspace_api_key` #25286

New resource: `aws_grafana_workspace_api_key` #25286

meetreks commented Jun 12, 2022 •

edited by ewbankkit

Loading