Add Grafana service account #38101

bonclay7 · 2024-06-24T23:20:32Z

Description

Adds support for Grafana Service Account with Amazon Managed Grafana

Relations

References

Output from Acceptance Testing

==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.4 test ./internal/service/grafana/... -v -count 1 -parallel 20 -run='TestAccGrafanaWorkspaceServiceAccountToken'  -timeout 360m
=== RUN   TestAccGrafanaWorkspaceServiceAccountToken_basic
=== PAUSE TestAccGrafanaWorkspaceServiceAccountToken_basic
=== RUN   TestAccGrafanaWorkspaceServiceAccountToken_disappears
=== PAUSE TestAccGrafanaWorkspaceServiceAccountToken_disappears
=== CONT  TestAccGrafanaWorkspaceServiceAccountToken_basic
=== CONT  TestAccGrafanaWorkspaceServiceAccountToken_disappears
--- PASS: TestAccGrafanaWorkspaceServiceAccountToken_basic (297.83s)
--- PASS: TestAccGrafanaWorkspaceServiceAccountToken_disappears (331.44s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/grafana	337.234s
...

github-actions · 2024-06-24T23:20:46Z

Community Note

Voting for Prioritization

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

For Submitters

Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

github-actions · 2024-06-24T23:21:11Z

Thank you for your contribution! 🚀

Please note that typically Go dependency changes are handled in this repository by dependabot or the maintainers. This is to prevent pull request merge conflicts and further delay reviews of contributions. Remove any changes to the go.mod or go.sum files and commit them into this pull request.

Additional details:

Check open pull requests with the dependencies label to view other dependency updates.
If this pull request includes an update the AWS Go SDK (or any other dependency) version, only updates submitted via dependabot will be merged. This pull request will need to remove these changes and will need to be rebased after the existing dependency update via dependabot has been merged for this pull request to be reviewed.
If this pull request is for supporting a new AWS service:
- Ensure the new AWS service changes are following the Contributing Guide section on new services, in particular that the dependency addition and initial provider support are in a separate pull request from other changes (e.g. new resources). Contributions not following this item will not be reviewed until the changes are split.
- If this pull request is already a separate pull request from the above item, you can ignore this message.

bonclay7 · 2024-06-26T21:04:17Z

Got a few questions for reviewers myself

bonclay7 · 2024-06-26T21:08:48Z

internal/service/grafana/workspace_service_account_test.go

+		PreCheck:                 func() { acctest.PreCheck(ctx, t); acctest.PreCheckPartitionHasService(t, names.Grafana) },
+		ErrorCheck:               acctest.ErrorCheck(t, grafana.ServiceID),
+		ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
+		CheckDestroy:             testAccCheckWorkspaceServiceAccountDestroy(ctx),


CheckDestroy throws an error that looks like a race condition and I don't know how to fix it.

make: Verifying source code with gofmt... ==> Checking that code complies with gofmt requirements... make: Building provider... make: Verifying source code with gofmt... ==> Checking that code complies with gofmt requirements... TF_ACC=1 go1.22.4 test ./internal/service/grafana/... -v -count 1 -parallel 20 -run='TestAccWorkspaceServiceAccount' -timeout 360m === RUN TestAccWorkspaceServiceAccount_basic === PAUSE TestAccWorkspaceServiceAccount_basic === RUN TestAccWorkspaceServiceAccount_disappears === PAUSE TestAccWorkspaceServiceAccount_disappears === CONT TestAccWorkspaceServiceAccount_basic === CONT TestAccWorkspaceServiceAccount_disappears --- PASS: TestAccWorkspaceServiceAccount_disappears (339.76s) === NAME TestAccWorkspaceServiceAccount_basic workspace_service_account_test.go:29: Error running post-test destroy, there may be dangling resources: operation error grafana: ListWorkspaceServiceAccounts, https response error StatusCode: 404, RequestID: 108fce02-80f4-49d1-8541-4d78d559a454, ResourceNotFoundException: Workspace with id=g-ca7016d798 of account=339743103717 does not exist. --- FAIL: TestAccWorkspaceServiceAccount_basic (369.06s) FAIL FAIL github.com/hashicorp/terraform-provider-aws/internal/service/grafana 374.937s FAIL make: *** [testacc] Error 1

However, the same tests outside with a normal main.tf and apply/destroy do not generate any error. Any insights on how to move forward?

I think the workspace gets destroyed before the service token is deleted.

used acctest.CheckDestroyNoop on CheckDestroy. Happy to revisit if there's another path

bonclay7 · 2024-06-26T21:09:57Z

3rd question - should the implementation of service account token (which share a lot with this PR) continue with the same PR or be separate and branched out of this one?

bonclay7 · 2024-06-26T21:10:16Z

any insights on this @justinretzolk @ewbankkit?

As service account by itself is not really useful, I merged locally my branch on service account token. Happy to drop this commit if it needs to be submitted separately commit 6b70e6e59b7dc0bd1ac652ce3038413f65c11e8b Author: Rodrigue Koffi <bonclay7@users.noreply.github.com> Date: Thu Jun 27 21:55:00 2024 +0200 Add service account token doc commit bd3fad4e84eb75815516cd658dc155ece76f5791 Author: Rodrigue Koffi <bonclay7@users.noreply.github.com> Date: Thu Jun 27 16:05:28 2024 +0200 Optimize tests paths commit 560148e983736a2e193442d24782e5c755be2fca Author: Rodrigue Koffi <bonclay7@users.noreply.github.com> Date: Thu Jun 27 12:41:41 2024 +0200 Add acceptance testing commit 39090f6e22252ff979405715a6e0f094f383933b Author: Rodrigue Koffi <bonclay7@users.noreply.github.com> Date: Thu Jun 27 11:32:00 2024 +0200 Add service account token resource

bonclay7 · 2024-06-27T21:47:21Z

make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
make: Building provider...
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.4 test ./internal/service/grafana/... -v -count 1 -parallel 20 -run='TestAccGrafanaWorkspaceServiceAccountToken'  -timeout 360m
=== RUN   TestAccGrafanaWorkspaceServiceAccountToken_basic
=== PAUSE TestAccGrafanaWorkspaceServiceAccountToken_basic
=== RUN   TestAccGrafanaWorkspaceServiceAccountToken_disappears
=== PAUSE TestAccGrafanaWorkspaceServiceAccountToken_disappears
=== CONT  TestAccGrafanaWorkspaceServiceAccountToken_basic
=== CONT  TestAccGrafanaWorkspaceServiceAccountToken_disappears
--- PASS: TestAccGrafanaWorkspaceServiceAccountToken_basic (297.83s)
--- PASS: TestAccGrafanaWorkspaceServiceAccountToken_disappears (331.44s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/grafana	337.234s

# Conflicts: # go.mod # go.sum # internal/conns/awsclient_gen.go # internal/service/grafana/exports_test.go # internal/service/grafana/generate.go # internal/service/grafana/service_endpoint_resolver_gen.go # internal/service/grafana/service_endpoints_gen_test.go # internal/service/grafana/service_package_gen.go # names/data/names_data.hcl

…nfiguration.

…ample.

ewbankkit

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccGrafanaWorkspaceServiceAccount_basic' PKG=grafana ACCTEST_PARALLELISM=2 
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.4 test ./internal/service/grafana/... -v -count 1 -parallel 2  -run=TestAccGrafanaWorkspaceServiceAccount_basic -timeout 360m
=== RUN   TestAccGrafanaWorkspaceServiceAccount_basic
=== PAUSE TestAccGrafanaWorkspaceServiceAccount_basic
=== CONT  TestAccGrafanaWorkspaceServiceAccount_basic
--- PASS: TestAccGrafanaWorkspaceServiceAccount_basic (380.37s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/grafana	385.341s

% make testacc TESTARGS='-run=TestAccGrafanaWorkspaceServiceAccount_disappears\|TestAccGrafanaWorkspaceServiceAccountToken_' PKG=grafana ACCTEST_PARALLELISM=2
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.4 test ./internal/service/grafana/... -v -count 1 -parallel 2  -run=TestAccGrafanaWorkspaceServiceAccount_disappears\|TestAccGrafanaWorkspaceServiceAccountToken_ -timeout 360m
=== RUN   TestAccGrafanaWorkspaceServiceAccount_disappears
=== PAUSE TestAccGrafanaWorkspaceServiceAccount_disappears
=== RUN   TestAccGrafanaWorkspaceServiceAccountToken_basic
=== PAUSE TestAccGrafanaWorkspaceServiceAccountToken_basic
=== RUN   TestAccGrafanaWorkspaceServiceAccountToken_disappears
=== PAUSE TestAccGrafanaWorkspaceServiceAccountToken_disappears
=== CONT  TestAccGrafanaWorkspaceServiceAccount_disappears
=== CONT  TestAccGrafanaWorkspaceServiceAccountToken_disappears
--- PASS: TestAccGrafanaWorkspaceServiceAccountToken_disappears (352.25s)
=== CONT  TestAccGrafanaWorkspaceServiceAccountToken_basic
--- PASS: TestAccGrafanaWorkspaceServiceAccount_disappears (378.66s)
--- PASS: TestAccGrafanaWorkspaceServiceAccountToken_basic (333.86s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/grafana	691.105s

ewbankkit · 2024-07-12T23:15:14Z

@bonclay7 Thanks for the contribution 🎉 👏.

github-actions · 2024-07-19T23:21:55Z

This functionality has been released in v5.59.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 · 2024-08-20T02:16:48Z

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.

bonclay7 added 8 commits June 22, 2024 19:21

Setup workspace_service_account resource

715bfff

Implement create, read and delete

3a02995

Rename typo

d1243a5

Compile resource

9de6680

Add validation for Grafana role

a021f10

Add pagination for list, align schema with grafana api

bc6cff9

Fix acceptance tests

6ba9b54

Add doc

d78b3e5

bonclay7 requested a review from a team as a code owner June 24, 2024 23:20

bonclay7 marked this pull request as draft June 24, 2024 23:20

terraform-aws-provider bot added needs-triage Waiting for first response or review from a maintainer. partner Contribution from a partner. labels Jun 24, 2024

bonclay7 added 4 commits June 25, 2024 01:37

Lint doc and code

a27d8cb

Lint doc and code

70e9250

Refactor and rename

6a94b7b

fixup! Refactor and rename

c09bb4e

justinretzolk added new-resource Introduces a new resource. and removed needs-triage Waiting for first response or review from a maintainer. labels Jun 25, 2024

remove unnecessary leading space

94f1141

bonclay7 marked this pull request as ready for review June 26, 2024 21:03

bonclay7 commented Jun 26, 2024

View reviewed changes

bonclay7 added 7 commits June 27, 2024 13:06

Add schema validators

c16045c

Optimize tests

a72a23a

Clean docs

65e029f

Update docs

1f51bc6

fixup! Adding service account token

b62c77c

Drop dead code

47c7d7a

ewbankkit added 7 commits July 12, 2024 10:53

Remove 'workspace_id' constant.

6b89e4c

Add CHANGELOG entries.

e7a6a6d

r/aws_grafana_workspace_service_account: Tidy up.

6db522d

r/aws_grafana_workspace_service_account_token: Tidy up.

1e5ab73

Fixes after some testing.

2e1b4e1

Run 'make fix-constants PKG=grafana'.

140f97c

ewbankkit self-assigned this Jul 12, 2024

ewbankkit added 4 commits July 12, 2024 15:34

Fix typos.

7b96b4f

More fixes after testing.

b796cba

r/aws_grafana_workspace_service_account_token: Fix acceptance test co…

da430af

…nfiguration.

r/aws_grafana_workspace_service_account_token: Tweak documentation ex…

9b3012d

…ample.

ewbankkit approved these changes Jul 12, 2024

View reviewed changes

ewbankkit merged commit 26d1b59 into hashicorp:main Jul 12, 2024
46 checks passed

github-actions bot added this to the v5.59.0 milestone Jul 12, 2024

github-actions bot locked as resolved and limited conversation to collaborators Aug 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Grafana service account #38101

Add Grafana service account #38101

bonclay7 commented Jun 24, 2024 •

edited

Loading

github-actions bot commented Jun 24, 2024

github-actions bot commented Jun 24, 2024

bonclay7 commented Jun 26, 2024

bonclay7 Jun 26, 2024 •

edited

Loading

bonclay7 Jun 27, 2024 •

edited

Loading

bonclay7 commented Jun 26, 2024 •

edited

Loading

bonclay7 commented Jun 26, 2024

bonclay7 commented Jun 27, 2024

ewbankkit left a comment

ewbankkit commented Jul 12, 2024

github-actions bot commented Jul 19, 2024

github-actions bot commented Aug 20, 2024

Add Grafana service account #38101

Add Grafana service account #38101

Conversation

bonclay7 commented Jun 24, 2024 • edited Loading

Description

Relations

References

Output from Acceptance Testing

github-actions bot commented Jun 24, 2024

Community Note

github-actions bot commented Jun 24, 2024

bonclay7 commented Jun 26, 2024

bonclay7 Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

bonclay7 Jun 27, 2024 • edited Loading

Choose a reason for hiding this comment

bonclay7 commented Jun 26, 2024 • edited Loading

bonclay7 commented Jun 26, 2024

bonclay7 commented Jun 27, 2024

ewbankkit left a comment

Choose a reason for hiding this comment

ewbankkit commented Jul 12, 2024

github-actions bot commented Jul 19, 2024

github-actions bot commented Aug 20, 2024

bonclay7 commented Jun 24, 2024 •

edited

Loading

bonclay7 Jun 26, 2024 •

edited

Loading

bonclay7 Jun 27, 2024 •

edited

Loading

bonclay7 commented Jun 26, 2024 •

edited

Loading