Serverless Application Repository initial support #15874

gdavison · 2020-10-27T22:53:40Z

Adds AWS Serverless Application Repository applications to the Terraform provider. Replaces #5961, since I'm no longer working with that fork of the provider repo.

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

Closes #3981

Release note for CHANGELOG:

* **New Data Source:** `aws_serverlessrepository_application`
* **New Resource:** `aws_serverlessrepository_stack`

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccAwsServerlessRepositoryStack_\|TestAccDataSourceAwsServerlessRepositoryApplication_'

--- PASS: TestAccDataSourceAwsServerlessRepositoryApplication_Versioned (100.81s)
--- PASS: TestAccDataSourceAwsServerlessRepositoryApplication_Basic (102.51s)
--- PASS: TestAccAwsServerlessRepositoryStack_versioned (163.66s)
--- PASS: TestAccAwsServerlessRepositoryStack_tagged (186.77s)
--- PASS: TestAccAwsServerlessRepositoryStack_basic (186.93s)
--- PASS: TestAccAwsServerlessRepositoryStack_versionUpdate (264.62s)
--- PASS: TestAccAwsServerlessRepositoryStack_update (297.12s)

…ata source

…cation

…e function; will be reused for Update

…te function; will be reused for Update

…o separate function; will be reused for Update" This was a premature simplification

This confirms that no tags show up in the state when no tags are added to the resource

bflad

First round of changes, I think overall this is handling this unique service pretty well though 👍

aws/internal/service/cloudformation/waiter/status.go

bflad · 2020-11-23T15:08:01Z

aws/resource_aws_serverlessrepository_stack.go

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


Resource import support is missing acceptance testing, e.g.

{ ResourceName: resourceName, ImportState: true, ImportStateVerify: true, },

bflad · 2020-11-23T15:10:49Z

website/docs/r/serverlessrepository_stack.html.markdown

@@ -0,0 +1,50 @@
+---


Documentation is missing section on resource import.

bflad · 2020-11-23T15:15:13Z

aws/resource_aws_serverlessrepository_stack.go

+	getApplicationInput := &serverlessrepository.GetApplicationInput{
+		ApplicationId: aws.String(d.Get("application_id").(string)),
+	}
+
+	_, ok := d.GetOk("semantic_version")
+	if !ok {
+		getApplicationOutput, err := serverlessConn.GetApplication(getApplicationInput)
+		if err != nil {
+			return err
+		}
+		d.Set("semantic_version", getApplicationOutput.Version.SemanticVersion)
+	}


This will likely cause issues on import since it is currently set to ImportStatePassthrough -- will need to add these to custom import function where they are present in the ID then passed into the correct attributes for the Read function.

bflad · 2020-11-23T15:23:39Z

aws/resource_aws_serverlessrepository_stack.go

+		return nil
+	}
+	if err != nil {
+		return err


To help operators and code maintainers with context around error messages:

Suggested change

return err

return fmt.Errorf("error describing CloudFormation Stack (%s): %w", d.Id(), err)

See also: #15892

bflad · 2020-11-23T15:30:15Z

website/docs/r/serverlessrepository_stack.html.markdown

+  Deploys an application from the Serverless Application Repository.
+---
+
+# Resource: aws_serverlessrepository_application


Suggested change

# Resource: aws_serverlessrepository_application

# Resource: aws_serverlessrepository_stack

(Or whatever is decided with potentially lengthening the naming)

See also: #15842

bflad · 2020-11-23T15:30:52Z

website/docs/r/serverlessrepository_stack.html.markdown

+
+# Resource: aws_serverlessrepository_application
+
+Deploys an application from the Serverless Application Repository.


Suggested change

Deploys an application from the Serverless Application Repository.

Deploys a CloudFormation Stack using an Application from the Serverless Application Repository.

bflad · 2020-11-23T15:31:04Z

website/docs/r/serverlessrepository_stack.html.markdown

+## Example Usage
+
+```hcl
+resource "aws_serverlessrepository_application" "postgres-rotator" {


(Or whatever is decided with potentially lengthening the naming)

Suggested change

resource "aws_serverlessrepository_application" "postgres-rotator" {

resource "aws_serverlessrepository_stack" "postgres-rotator" {

bflad · 2020-11-23T15:36:07Z

aws/provider.go

@@ -892,6 +893,7 @@ func Provider() *schema.Provider {
 			"aws_securityhub_member":                                  resourceAwsSecurityHubMember(),
 			"aws_securityhub_product_subscription":                    resourceAwsSecurityHubProductSubscription(),
 			"aws_securityhub_standards_subscription":                  resourceAwsSecurityHubStandardsSubscription(),
+			"aws_serverlessrepository_stack":                          resourceAwsServerlessRepositoryStack(),


I apologize if we've discussed this before, but these SAR resources and data sources should probably be expanded to the full service naming per the Contribution Guide, unless there is a blocking reason not to (length be darned 🙁 ).

"aws_serverlessapplicationrepository_stack": resourceAwsServerlessApplicationRepositoryStack(),

We may also want to consider adding "CloudFormation" Stack in here to match the API CreateCloudFormationStack naming, in case SAR releases some other form of "stacks" (such as its own).

"aws_serverlessapplicationrepository_cloudformation_stack": resourceAwsServerlessApplicationRepositoryCloudFormationStack(),

bflad · 2020-11-24T19:13:58Z

aws/resource_aws_serverlessapplicationrepository_cloudformation_stack.go

+	var e *resource.NotFoundError
+	if errors.As(err, &e) {


Since its not being used yet (only tfresource.TimedOut), it might be good time to update

terraform-provider-aws/aws/internal/tfresource/errors.go

Lines 9 to 12 in 2975c11

func NotFound(err error) bool {

_, ok := err.(*resource.NotFoundError)

return ok

}

with errors.As and use it here. 👍

bflad

Excellent! 🚀

Output from acceptance testing in AWS Commercial:

--- PASS: TestAccDataSourceAwsServerlessApplicationRepositoryApplication_Basic (52.09s)
--- PASS: TestAccDataSourceAwsServerlessApplicationRepositoryApplication_Versioned (92.29s)

--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_disappears (138.27s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_paired (142.73s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_basic (164.41s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_update (232.10s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_versioned (262.14s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_Tags (271.30s)

Output from acceptance testing in AWS GovCloud (US):

--- PASS: TestAccDataSourceAwsServerlessApplicationRepositoryApplication_Basic (86.85s)
--- PASS: TestAccDataSourceAwsServerlessApplicationRepositoryApplication_Versioned (97.04s)

--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_disappears (129.86s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_basic (143.42s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_paired (144.45s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_update (226.49s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_Tags (250.56s)
--- PASS: TestAccAwsServerlessApplicationRepositoryCloudFormationStack_versioned (257.11s)

bflad · 2020-11-25T19:57:36Z

aws/internal/tfresource/errors.go

-	_, ok := err.(*resource.NotFoundError)
-	return ok
+	var e *resource.NotFoundError
+	return errors.As(err, &e)


ghost · 2020-11-25T21:31:18Z

This has been released in version 3.18.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-12-26T17:10:47Z

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!

Graham Davison and others added 26 commits September 3, 2019 23:50

Created happy path latest version Serverless Repo data source

fab4ce2

Handle non-existent applications in the repo

9d762eb

Added version parameter for Serverless Application Repo application d…

294e1e8

…ata source

Added documentation

b2cd9c3

Added basic creation, reading, and deletion of a Serveless Repo Appli…

649d557

…cation

Added version parameter as output and optional input

13eedc6

Added test for changing application version

69b0823

Added parameter tests for basic case

d6a90ec

Formatting changes

48a747a

Added outputs to serverless repo application

14c40a2

Added CloudFormation capabilities field as output; needed for update

8ad2111

Factored waiting for creation of CloudFormation change set to separat…

41c3a7f

…e function; will be reused for Update

Moved status check into function as well

8b6e857

Factored waiting for execution of CloudFormation change set to separa…

6f28051

…te function; will be reused for Update

Revert "Factored waiting for execution of CloudFormation change set t…

0b42e3e

…o separate function; will be reused for Update" This was a premature simplification

Added Update to serverless application

8f715b7

Added tags to Read operation

753fa55

Add a test for reading tags

76a3de2

This confirms that no tags show up in the state when no tags are added to the resource

Fixes linting error

8344eb4

Creates and updates tags

cc1f10e

Updates AWS region used to the default us-west-2

3c5419f

Renames the resource to aws_serverlessrepository_stack

70fd994

Adds documentation for aws_serverlessrepository_stack

69701fa

Renames tests for aws_serverlessrepository_stack

062f836

Fixes typo in function name

507fbfb

Merge branch 'master' into serverless_app_repo

18132b1

gdavison added 2 commits November 13, 2020 15:49

Tweaks

a7679dc

Merge branch 'master' into serverless_app_repo

c5c4b99

ghost added the service/cloudformation Issues and PRs that pertain to the cloudformation service. label Nov 20, 2020

Adds exclusion to multiple AWS service rule

1ad9806

gdavison marked this pull request as ready for review November 20, 2020 21:53

gdavison requested a review from a team as a code owner November 20, 2020 21:53

gdavison added new-data-source Introduces a new data source. new-resource Introduces a new resource. labels Nov 20, 2020

bflad self-assigned this Nov 23, 2020

bflad suggested changes Nov 23, 2020

View reviewed changes

gdavison added 5 commits November 23, 2020 17:43

Adds import functionality

56a5fd4

Renaming to match package name

f3aabe1

Merge branch 'master' into serverless_app_repo

66bccf1

Renames file

49c7ded

Merge branch 'master' into serverless_app_repo

a70a12d

bflad reviewed Nov 24, 2020

View reviewed changes

gdavison added 3 commits November 24, 2020 12:02

More renaming

0908954

Removes unneeded ForceNew from semantic_version attribute

124075f

Updates tfresource.NotFound() to support wrapped errors

69a0677

bflad self-requested a review November 25, 2020 15:31

bflad added this to the v3.18.0 milestone Nov 25, 2020

gdavison added 2 commits November 25, 2020 11:33

Reorganizes import and read code

167791b

Avoids Go formatting churn and Git conflict

19b88f7

bflad approved these changes Nov 25, 2020

View reviewed changes

gdavison merged commit 18279c6 into master Nov 25, 2020

gdavison deleted the serverless_app_repo branch November 25, 2020 20:57

gdavison added a commit that referenced this pull request Nov 25, 2020

Update CHANGELOG for #15874

158f85b

ghost locked as resolved and limited conversation to collaborators Dec 26, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Serverless Application Repository initial support #15874

Serverless Application Repository initial support #15874

gdavison commented Oct 27, 2020

bflad left a comment

bflad Nov 23, 2020

bflad Nov 23, 2020

bflad Nov 23, 2020

bflad Nov 23, 2020

bflad Nov 23, 2020 •

edited

Loading

bflad Nov 23, 2020

bflad Nov 23, 2020 •

edited

Loading

bflad Nov 23, 2020

bflad Nov 24, 2020

bflad left a comment

bflad Nov 25, 2020

ghost commented Nov 25, 2020

ghost commented Dec 26, 2020

	return err
	return fmt.Errorf("error describing CloudFormation Stack (%s): %w", d.Id(), err)

	# Resource: aws_serverlessrepository_application
	# Resource: aws_serverlessrepository_stack


		# Resource: aws_serverlessrepository_application

		Deploys an application from the Serverless Application Repository.

	Deploys an application from the Serverless Application Repository.
	Deploys a CloudFormation Stack using an Application from the Serverless Application Repository.

	resource "aws_serverlessrepository_application" "postgres-rotator" {
	resource "aws_serverlessrepository_stack" "postgres-rotator" {

	func NotFound(err error) bool {
	_, ok := err.(*resource.NotFoundError)
	return ok
	}

Serverless Application Repository initial support #15874

Serverless Application Repository initial support #15874

Conversation

gdavison commented Oct 27, 2020

Community Note

bflad 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

bflad Nov 23, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bflad Nov 23, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bflad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Nov 25, 2020

ghost commented Dec 26, 2020

bflad Nov 23, 2020 •

edited

Loading

bflad Nov 23, 2020 •

edited

Loading