F/#25314 - Return the public key material for a `aws_key_pair` #25371

bschaatsbergen · 2022-06-15T22:07:23Z

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

Output from acceptance testing:

bruno@pop-os ~/G/terraform-provider-aws (f/#25314-aws-key-pair-public-key)> make testacc TESTS=TestAccEC2KeyPairDataSource_ PKG=ec2                                                                                                     (base) 
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/ec2/... -v -count 1 -parallel 20 -run='TestAccEC2KeyPairDataSource_'  -timeout 180m
=== RUN   TestAccEC2KeyPairDataSource_basic
=== PAUSE TestAccEC2KeyPairDataSource_basic
=== RUN   TestAccEC2KeyPairDataSource_includePublicKey
=== PAUSE TestAccEC2KeyPairDataSource_includePublicKey
=== CONT  TestAccEC2KeyPairDataSource_basic
=== CONT  TestAccEC2KeyPairDataSource_includePublicKey
--- PASS: TestAccEC2KeyPairDataSource_includePublicKey (7.51s)
--- PASS: TestAccEC2KeyPairDataSource_basic (8.10s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/ec2        8.177s
bruno@pop-os ~/G/terraform-provider-aws (f/#25314-aws-key-pair-public-key)> make testacc TESTS=TestAccEC2KeyPair_ PKG=ec2                                                                                                               (base) 
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/ec2/... -v -count 1 -parallel 20 -run='TestAccEC2KeyPair_'  -timeout 180m
=== RUN   TestAccEC2KeyPair_basic
=== PAUSE TestAccEC2KeyPair_basic
=== RUN   TestAccEC2KeyPair_tags
=== PAUSE TestAccEC2KeyPair_tags
=== RUN   TestAccEC2KeyPair_nameGenerated
=== PAUSE TestAccEC2KeyPair_nameGenerated
=== RUN   TestAccEC2KeyPair_namePrefix
=== PAUSE TestAccEC2KeyPair_namePrefix
=== RUN   TestAccEC2KeyPair_disappears
=== PAUSE TestAccEC2KeyPair_disappears
=== CONT  TestAccEC2KeyPair_basic
=== CONT  TestAccEC2KeyPair_namePrefix
=== CONT  TestAccEC2KeyPair_disappears
=== CONT  TestAccEC2KeyPair_nameGenerated
=== CONT  TestAccEC2KeyPair_tags
--- PASS: TestAccEC2KeyPair_disappears (6.91s)
--- PASS: TestAccEC2KeyPair_basic (9.71s)
--- PASS: TestAccEC2KeyPair_namePrefix (9.83s)
--- PASS: TestAccEC2KeyPair_nameGenerated (9.83s)
--- PASS: TestAccEC2KeyPair_tags (21.12s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/ec2        21.230s

…blic_key` in the response

…lude_public_key` and `public_key` attributes

bschaatsbergen · 2022-06-15T22:22:31Z

Interesting, the public_key that you provide through the aws_key_pair resource, is not what's coming back from the DescribeKeyPair API call.

For example, in the create I can set PublicKey tossh-rsa xxxx email@example.com and KeyPairName to Foobar.
The PublicKey in the response from the DescribeKeyPair call will have the email replaced with the KeyPairName, so PublicKey will be set to: ssh-rsa xxxx Foobar.

bruno@pop-os ~/G/terraform-provider-aws (f/#25314-aws-key-pair-public-key)> make testacc TESTS=TestAccEC2KeyPairDataSource_includePublicKey PKG=ec2                                                                           (base) 
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/ec2/... -v -count 1 -parallel 20 -run='TestAccEC2KeyPairDataSource_includePublicKey'  -timeout 180m
=== RUN   TestAccEC2KeyPairDataSource_includePublicKey
=== PAUSE TestAccEC2KeyPairDataSource_includePublicKey
=== CONT  TestAccEC2KeyPairDataSource_includePublicKey
    ec2_key_pair_data_source_test.go:66: Step 1/1 error: Check failed: Check 5/6 error: data.aws_key_pair.by_name: Attribute 'public_key' expected "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABABBBgQDC6tBL6AAm4QWjf9Xf78/UPwd6cgC+YVi/ahn4SMd8NZOEoHIVuRd6ZJjw/sHkk2KsRKIWH7sSazxAHaJI+RIYaStcLIJirDCvLcw7sXyBgeX/bldl5a1uO/QeH+dAMi8wleKX1JvSJzgwcC6tsAd0kT0nGaLnQBANcJd1awjAPQ== no-reply@hashicorp.com", got "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABABBBgQDC6tBL6AAm4QWjf9Xf78/UPwd6cgC+YVi/ahn4SMd8NZOEoHIVuRd6ZJjw/sHkk2KsRKIWH7sSazxAHaJI+RIYaStcLIJirDCvLcw7sXyBgeX/bldl5a1uO/QeH+dAMi8wleKX1JvSJzgwcC6tsAd0kT0nGaLnQBANcJd1awjAPQ== tf-acc-test-4365605084555105140"
--- FAIL: TestAccEC2KeyPairDataSource_includePublicKey (12.66s)
FAIL
FAIL    github.com/hashicorp/terraform-provider-aws/internal/service/ec2        12.704s
FAIL
make: *** [GNUmakefile:45: testacc] Error 1

To make the test pass I'm now not providing a email address and I append the KeyName to the PublicKey (not very nice).

Feel free to suggest an alternative, it bugs me that the data source and resource don't share the same public_key.

bschaatsbergen · 2022-06-22T21:57:56Z

@ewbankkit could you please provide me with some feedback on the above

ewbankkit · 2022-06-23T12:54:26Z

@bschaatsbergen I added a new function OpenSHHPublicKeysEqual that ignores the comment part of the key when comparing.

The tests now pass:

% make testacc TESTARGS='-run=TestAccEC2KeyPairDataSource_' PKG=ec2 ACCTEST_PARALLELISM=2
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/ec2/... -v -count 1 -parallel 2  -run=TestAccEC2KeyPairDataSource_ -timeout 180m
=== RUN   TestAccEC2KeyPairDataSource_basic
=== PAUSE TestAccEC2KeyPairDataSource_basic
=== RUN   TestAccEC2KeyPairDataSource_includePublicKey
=== PAUSE TestAccEC2KeyPairDataSource_includePublicKey
=== CONT  TestAccEC2KeyPairDataSource_basic
=== CONT  TestAccEC2KeyPairDataSource_includePublicKey
--- PASS: TestAccEC2KeyPairDataSource_includePublicKey (17.49s)
--- PASS: TestAccEC2KeyPairDataSource_basic (18.72s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/ec2	25.314s

ewbankkit · 2022-06-23T12:56:28Z

Could you please also add create_time and key_type attributes to the data source, plus key_type as a Computed attribute to the aws_key_pair resource? Thanks.

bschaatsbergen · 2022-06-23T21:47:41Z

@bschaatsbergen I added a new function OpenSHHPublicKeysEqual that ignores the comment part of the key when comparing.

The tests now pass:

% make testacc TESTARGS='-run=TestAccEC2KeyPairDataSource_' PKG=ec2 ACCTEST_PARALLELISM=2
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/ec2/... -v -count 1 -parallel 2  -run=TestAccEC2KeyPairDataSource_ -timeout 180m
=== RUN   TestAccEC2KeyPairDataSource_basic
=== PAUSE TestAccEC2KeyPairDataSource_basic
=== RUN   TestAccEC2KeyPairDataSource_includePublicKey
=== PAUSE TestAccEC2KeyPairDataSource_includePublicKey
=== CONT  TestAccEC2KeyPairDataSource_basic
=== CONT  TestAccEC2KeyPairDataSource_includePublicKey
--- PASS: TestAccEC2KeyPairDataSource_includePublicKey (17.49s)
--- PASS: TestAccEC2KeyPairDataSource_basic (18.72s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/ec2	25.314s

Neat fix, I'll take care of what you mentioned in the last comment.

bschaatsbergen · 2022-06-24T23:10:00Z

@ewbankkit, done. Do you suggest that we also fix the existing limitation mentioned through this PR or another one - https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/key_pair#import ?

Please note that still the data source its public key and the public key provided to the resource can differ..

ewbankkit · 2022-06-25T12:14:52Z

@bschaatsbergen I suggest a separate PR to deal with that - There will have to be a DiffSuppressFunc to handle the different content of the public key string returned by the AWS API.

bschaatsbergen · 2022-06-26T00:13:51Z

@bschaatsbergen I suggest a separate PR to deal with that - There will have to be a DiffSuppressFunc to handle the different content of the public key string returned by the AWS API.

Right on, will note it down to pick up in the near future. Removed draft status from this PR.

ewbankkit

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccEC2KeyPairDataSource_' PKG=ec2 ACCTEST_PARALLELISM=3
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/ec2/... -v -count 1 -parallel 3  -run=TestAccEC2KeyPairDataSource_ -timeout 180m
=== RUN   TestAccEC2KeyPairDataSource_basic
=== PAUSE TestAccEC2KeyPairDataSource_basic
=== RUN   TestAccEC2KeyPairDataSource_includePublicKey
=== PAUSE TestAccEC2KeyPairDataSource_includePublicKey
=== CONT  TestAccEC2KeyPairDataSource_basic
=== CONT  TestAccEC2KeyPairDataSource_includePublicKey
--- PASS: TestAccEC2KeyPairDataSource_includePublicKey (16.34s)
--- PASS: TestAccEC2KeyPairDataSource_basic (16.45s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/ec2	20.901s

ewbankkit · 2022-06-26T20:47:06Z

@bschaatsbergen Thanks for the contribution 🎉 👏.

ewbankkit · 2022-06-26T21:39:06Z

% make providerlint
==> Checking source code with providerlint...

github-actions · 2022-07-01T01:11:31Z

This functionality has been released in v4.21.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-07-31T02:42:43Z

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.

bschaatsbergen added 3 commits June 16, 2022 00:01

hashicorp#25314 - Add a include_public_key attribute to set the `pu…

dc51ad6

…blic_key` in the response

hashicorp#25314 - WIP on aws_key_pair its public_key attribute test

8d2e10b

hashicorp#25314 - Update key_pair.html.markdown to include the `inc…

51d5d12

…lude_public_key` and `public_key` attributes

bschaatsbergen changed the title ~~F/#25314 - Return the public key material~~ F/#25314 - Return the public key material for the for aws_key_pair Jun 15, 2022

bschaatsbergen changed the title ~~F/#25314 - Return the public key material for the for aws_key_pair~~ F/#25314 - Return the public key material for a aws_key_pair Jun 15, 2022

fmt ec2_key_pair_data_source_test.go

50dfe8c

justinretzolk added enhancement Requests to existing resources that expand the functionality or scope. and removed needs-triage Waiting for first response or review from a maintainer. labels Jun 16, 2022

Add and use 'OpenSSHPublicKeysEqual'.

4900412

bschaatsbergen added 4 commits June 25, 2022 00:41

Add create_time and key_type attributes to KeyPair data source

379789a

Add key_type attribute to KeyPair resource

c76367c

Create 25371.txt

7f2aca4

Fix import group order

b4a4275

bschaatsbergen marked this pull request as ready for review June 26, 2022 00:13

Update 25371.txt

8d7fe82

ewbankkit approved these changes Jun 26, 2022

View reviewed changes

ewbankkit merged commit ab2ac9f into hashicorp:main Jun 27, 2022

github-actions bot added this to the v4.21.0 milestone Jun 27, 2022

bschaatsbergen deleted the f/#25314-aws-key-pair-public-key branch June 27, 2022 12:49

github-actions bot locked as resolved and limited conversation to collaborators Jul 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

F/#25314 - Return the public key material for a `aws_key_pair` #25371

F/#25314 - Return the public key material for a `aws_key_pair` #25371

bschaatsbergen commented Jun 15, 2022 •

edited

Loading

bschaatsbergen commented Jun 15, 2022 •

edited

Loading

bschaatsbergen commented Jun 22, 2022

ewbankkit commented Jun 23, 2022

ewbankkit commented Jun 23, 2022

bschaatsbergen commented Jun 23, 2022

bschaatsbergen commented Jun 24, 2022 •

edited

Loading

ewbankkit commented Jun 25, 2022

bschaatsbergen commented Jun 26, 2022

ewbankkit left a comment

ewbankkit commented Jun 26, 2022

ewbankkit commented Jun 26, 2022

github-actions bot commented Jul 1, 2022

github-actions bot commented Jul 31, 2022

F/#25314 - Return the public key material for a aws_key_pair #25371

F/#25314 - Return the public key material for a aws_key_pair #25371

Conversation

bschaatsbergen commented Jun 15, 2022 • edited Loading

Community Note

bschaatsbergen commented Jun 15, 2022 • edited Loading

bschaatsbergen commented Jun 22, 2022

ewbankkit commented Jun 23, 2022

ewbankkit commented Jun 23, 2022

bschaatsbergen commented Jun 23, 2022

bschaatsbergen commented Jun 24, 2022 • edited Loading

ewbankkit commented Jun 25, 2022

bschaatsbergen commented Jun 26, 2022

ewbankkit left a comment

Choose a reason for hiding this comment

ewbankkit commented Jun 26, 2022

ewbankkit commented Jun 26, 2022

github-actions bot commented Jul 1, 2022

github-actions bot commented Jul 31, 2022

F/#25314 - Return the public key material for a `aws_key_pair` #25371

F/#25314 - Return the public key material for a `aws_key_pair` #25371

bschaatsbergen commented Jun 15, 2022 •

edited

Loading

bschaatsbergen commented Jun 15, 2022 •

edited

Loading

bschaatsbergen commented Jun 24, 2022 •

edited

Loading