Updated the resource type walkthrough #980

mrog · 2023-03-16T16:38:29Z

Issue #, if available:
979

Description of changes:
Updating the resource type walkthrough so it works with current versions of CloudFormation and dependencies.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

doc_source/resource-type-walkthrough.md

mrog · 2023-03-16T16:40:03Z

doc_source/resource-type-walkthrough.md

-[Setting up your environment for developing extensions](what-is-cloudformation-cli.md#resource-type-setup)
+- Java 8
+- For purposes of this walkthrough, it's assumed you have already set up the CloudFormation CLI and associated tooling for your Java development environment: [Setting up your environment for developing extensions](what-is-cloudformation-cli.md#resource-type-setup)
+- This walkthrough uses an AMI that requires [a subscription](https://aws.amazon.com/marketplace/server/procurement?productId=7d426cb7-9522-4dd7-a56b-55dd8cc1c8d0) before you can use it with your account\.


I'm guessing this is the same AMI that was used in the original walkthrough. That old AMI ID isn't working anymore. The new AMI ID isn't usable without a free subscription.

mrog · 2023-03-16T16:40:37Z

doc_source/resource-type-walkthrough.md

@@ -24,10 +24,19 @@ This walkthrough uses the Community Edition of the [IntelliJ IDEA](https://www.j
   Initializing new project
   ```

-1. The `init` command launches a wizard that walks you through setting up the project, including specifying the resource name\. For this walkthrough, specify `Example::Testing::WordPress`\.
+1. The `init` command launches a wizard that walks you through setting up the project, including specifying the resource name\.  Start by specifying that you want to create a resource\.


The cfn init interface has changed a bit.

mrog · 2023-03-16T16:42:12Z

doc_source/resource-type-walkthrough.md

@@ -141,7 +164,6 @@ When you initiate the resource type project, an example resource type schema fil
     },
     "additionalProperties": false,
     "primaryIdentifier": [
-       "/properties/PublicIp",


PublicIp can't be part of the primary identifier. CloudFormation requires a public identifier in all responses, including the first one. The IP address isn't available until some time after the EC2 instance creation begins.

mrog · 2023-03-16T16:42:41Z

doc_source/resource-type-walkthrough.md

+
+1. Open the project's `template.yml` file in the project's root directory\.
+
+1. Find the `MemorySize` setting and change the value to `512`\.


I was getting OutOfMemoryErrors with 256 MB.

mrog · 2023-03-16T16:44:32Z

doc_source/resource-type-walkthrough.md


-1. In your IDE, open the `CreateHandler.java` file, located in the `src/main/java/com/example/testing/wordpress/CreateHandler.java` folder\.
+We'll create a base class for the handlers. This simply provides a place to put code that would otherwise be duplicated by the various handlers\.


There were already two classes with the same code for getting EC2 instance info. I had to add a third class that also needed this data. Instead of duplicating the code again, I moved it to a shared location.

mrog · 2023-03-16T16:46:04Z

doc_source/resource-type-walkthrough.md

@@ -314,11 +359,14 @@ The CallbackContext is modeled as a POJO so you can define what information you
           }

           if (instanceStateSoFar == null) {
+               Instance instance = createEC2Instance(model);
+               model.setInstanceId(instance.getInstanceId());


The instance ID needs to be set here so the primary identifier can be included in the result.

mrog · 2023-03-16T16:46:31Z

doc_source/resource-type-walkthrough.md

@@ -407,7 +457,7 @@ The CallbackContext is modeled as a POJO so you can define what information you
               .withSubnetIds(subnetId);

           final DescribeSubnetsResult describeSubnetsResult =
-               clientProxy.injectCredentialsAndInvoke(describeSubnetsRequest, ec2Client::describeSubnets);
+               clientProxy.injectCredentialsAndInvoke(describeSubnetsRequest, (DescribeSubnetsRequest r) -> ec2Client.describeSubnets(r));


Resolving an ambiguous method name

mrog · 2023-03-16T16:46:48Z

doc_source/resource-type-walkthrough.md

@@ -438,20 +488,6 @@ The CallbackContext is modeled as a POJO so you can define what information you
               .withTags(new Tag().withKey(SITE_NAME_TAG_KEY).withValue(siteName));
       }

-       private Instance updatedInstanceProgress(String instanceId) {


Moved to base class

mrog · 2023-03-16T16:47:09Z

doc_source/resource-type-walkthrough.md

-           doReturn(new RunInstancesResult().withReservation(new Reservation().withInstances(instance))).when(proxy).injectCredentialsAndInvoke(any(RunInstancesRequest.class), any());
-           doReturn(new CreateSecurityGroupResult().withGroupId("sg-1234")).when(proxy).injectCredentialsAndInvoke(any(CreateSecurityGroupRequest.class), any());
-           doReturn(new AuthorizeSecurityGroupIngressResult()).when(proxy).injectCredentialsAndInvoke(any(AuthorizeSecurityGroupIngressRequest.class), any());
+           doReturn(new DescribeSubnetsResult().withSubnets(new Subnet().withVpcId("vpc-1234"))).when(proxy).injectCredentialsAndInvoke(any(DescribeSubnetsRequest.class), ArgumentMatchers.<Function<DescribeSubnetsRequest, DescribeSubnetsResult>>any());


Fixing more ambiguous method names

mrog · 2023-03-16T16:48:04Z

doc_source/resource-type-walkthrough.md

@@ -775,7 +785,6 @@ Again, we'll implement the delete handler as a state machine\.
           } else if (callbackContext.getInstance().getState().getName().equals(DELETED_INSTANCE_STATE)) {
               callbackContext.getInstanceSecurityGroups().forEach(this::deleteSecurityGroup);
               return ProgressEvent.<ResourceModel, CallbackContext>builder()
-                   .resourceModel(model)


The delete handler must not return a model after a successful deletion.

mrog · 2023-03-16T16:48:16Z

doc_source/resource-type-walkthrough.md

@@ -807,20 +816,6 @@ Again, we'll implement the delete handler as a state machine\.
                             .orElse(new Instance());
       }

-       private Instance currentInstanceState(String instanceId) {


Moved to base class

mrog · 2023-03-16T16:48:27Z

doc_source/resource-type-walkthrough.md

@@ -890,7 +870,7 @@ We'll also need to update the unit test for the delete handler\.
       @Test
       public void testSuccessState() {
           final DeleteSecurityGroupResult deleteSecurityGroupResult = new DeleteSecurityGroupResult();
-           doReturn(deleteSecurityGroupResult).when(proxy).injectCredentialsAndInvoke(any(DeleteSecurityGroupRequest.class), any());
+           doReturn(deleteSecurityGroupResult).when(proxy).injectCredentialsAndInvoke(any(DeleteSecurityGroupRequest.class), ArgumentMatchers.<Function<DeleteSecurityGroupRequest, DeleteSecurityGroupResult>>any());


Resolving an ambiguous method name

mrog · 2023-03-16T16:49:43Z

doc_source/resource-type-walkthrough.md

@@ -1085,6 +1065,190 @@ We'll also need to update the unit test for the delete handler\.
   }
   ```

+#### Code the Read Handler<a name="resource-type-walkthrough-implement-read-handler-code"></a>


CloudFormation requires a read handler

mrog · 2023-03-16T16:50:11Z

doc_source/resource-type-walkthrough.md

+
+           Instance currentInstanceState = retrieveCurrentInstanceState(proxy, ec2Client, model.getInstanceId());
+
+           if (currentInstanceState.getInstanceId() == null || DELETED_INSTANCE_STATE.equals(currentInstanceState.getState().getName())) {


The read handler must return a Not Found error if the instance has been deleted.

mrog · 2023-03-16T16:50:29Z

doc_source/resource-type-walkthrough.md

@@ -1200,7 +1364,7 @@ Occasionally these tests will fail with a retry\-able error\. In such a case, ru
               },
               "architecture": "x86_64",
               "ebsOptimized": false,
-               "imageId": "ami-04fb0368671b6f138",
+               "imageId": "ami-0039c114b5e564742",


mrog · 2023-03-16T16:50:52Z

doc_source/resource-type-walkthrough.md

@@ -1458,3 +1622,56 @@ As a final test of the resource type delete handler, you can delete the `wordpre
 aws cloudformation delete-stack --region us-west-2 \
  --stack-name wordpress
 ```
+
+## Clean up ##


I like having clean up instructions.

mrog · 2023-03-16T21:04:10Z

doc_source/resource-type-walkthrough.md

@@ -1434,6 +1598,24 @@ Use [DescribeTypeRegistration](https://docs.aws.amazon.com/AWSCloudFormation/lat
                   "Name": "MyWebsite"
               }
           }
+       },


I thought it would be nice to see some outputs here, since they're included in the model.

mmaeng

LGTM. Will look into the Github Actions, they should have completed by now.

mmaeng · 2023-05-01T21:06:41Z

@mrog If you could update your fork with the recent merges into the master branch? It looks like GitHub Actions got hung up for some reason on those 6 tests. Just want to kick start the workflow again.

…hrough

mrog · 2023-05-02T15:04:23Z

@mmaeng I synced my fork. It should be okay to merge once the GitHub Actions are done. Thanks!

mrinaudo-aws

Thank you for your contribution, @mrog! Please review/add the suggestion I made on the usage of Java 11, that is also supported, and that includes steps to follow if the user chooses to use Java 11 instead of Java 8. I was able to run contract tests with your changes as follows:

Contract tests using Java 8: 5 passed, 3 skipped, 16 deselected in 860.09s (0:14:20)
Contract tests using Java 11 (per the suggestion I added in the PR): 5 passed, 3 skipped, 16 deselected in 835.56s (0:13:55)

In addition to the above, I also tested the following: I submitted, to the private registry in the account I use and for the us-west-2 region, the resource type with your changes, that I compiled with Java 11 (see my suggestion in the PR), and was able to run it.

doc_source/resource-type-walkthrough.md

Co-authored-by: Matteo Rinaudo <[email protected]>

mrinaudo-aws

LGTM

mmaeng · 2023-05-03T18:23:02Z

Looks like there are a few linting errors in the pre-commit. If you install pre-commit and run through the checks it should go through clean then. We are thinking we should be moving away from the pre-commit and just do it as part of the pipeline...

The install of pre-commit is defined in the Github actions file here (I would suggest a virtual env)
https://github.com/aws-cloudformation/cloudformation-cli/blob/master/.github/workflows/pr-ci.yaml

Assuming you are running on a Mac but from the cloudformation-cli root directory -
brew install autoconf automake libtool jq
pip install pyjq
pip install --upgrade 'attrs==19.2.0' wheel -r requirements.txt
pip install .
pre-commit run --all-files

Will have to run pre-commit a couple of times until it returns successful as it fixes linting issues. We have plans to rework pre-commit but it hasn't come to fruition yet.

Hope you don't mind but I pushed to your branch with the linting update.

mmaeng · 2023-05-09T19:48:19Z

Closes #979

Updated the resource type walkthrough

6d6077e

mrog commented Mar 16, 2023

View reviewed changes

doc_source/resource-type-walkthrough.md Outdated Show resolved Hide resolved

mrog commented Mar 16, 2023

View reviewed changes

mrog mentioned this pull request Mar 16, 2023

Resource type walkthrough is outdated #979

Closed

Added outputs to CloudFormation template

5217abf

mrog commented Mar 16, 2023

View reviewed changes

Minor code fixes

c5fed8d

ericzbeard requested review from mrinaudo-aws and mmaeng May 1, 2023 16:27

ericzbeard added the documentation I'll give you a guess what this is about. label May 1, 2023

mmaeng approved these changes May 1, 2023

View reviewed changes

ericzbeard approved these changes May 1, 2023

View reviewed changes

Merge branch 'aws-cloudformation:master' into fix_resource_type_walkt…

5e4bc51

…hrough

mrinaudo-aws requested changes May 2, 2023

View reviewed changes

doc_source/resource-type-walkthrough.md Outdated Show resolved Hide resolved

doc_source/resource-type-walkthrough.md Outdated Show resolved Hide resolved

Update doc_source/resource-type-walkthrough.md

01886ce

Co-authored-by: Matteo Rinaudo <[email protected]>

mrinaudo-aws self-requested a review May 3, 2023 17:15

mrinaudo-aws approved these changes May 3, 2023

View reviewed changes

linting

7d1b53a

mmaeng merged commit 6d42100 into aws-cloudformation:master May 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated the resource type walkthrough #980

Updated the resource type walkthrough #980

mrog commented Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023

mrog Mar 16, 2023 •

edited

Loading

mmaeng left a comment

mmaeng commented May 1, 2023

mrog commented May 2, 2023

mrinaudo-aws left a comment

mrinaudo-aws left a comment

mmaeng commented May 3, 2023 •

edited

Loading

mmaeng commented May 9, 2023


		1. Open the project's `template.yml` file in the project's root directory\.

		1. Find the `MemorySize` setting and change the value to `512`\.


		1. In your IDE, open the `CreateHandler.java` file, located in the `src/main/java/com/example/testing/wordpress/CreateHandler.java` folder\.
		We'll create a base class for the handlers. This simply provides a place to put code that would otherwise be duplicated by the various handlers\.


		Instance currentInstanceState = retrieveCurrentInstanceState(proxy, ec2Client, model.getInstanceId());

		if (currentInstanceState.getInstanceId() == null \|\| DELETED_INSTANCE_STATE.equals(currentInstanceState.getState().getName())) {

Updated the resource type walkthrough #980

Updated the resource type walkthrough #980

Conversation

mrog commented Mar 16, 2023

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

mrog Mar 16, 2023 • edited Loading

Choose a reason for hiding this comment

mmaeng left a comment

Choose a reason for hiding this comment

mmaeng commented May 1, 2023

mrog commented May 2, 2023

mrinaudo-aws left a comment

Choose a reason for hiding this comment

mrinaudo-aws left a comment

Choose a reason for hiding this comment

mmaeng commented May 3, 2023 • edited Loading

mmaeng commented May 9, 2023

mrog Mar 16, 2023 •

edited

Loading

mmaeng commented May 3, 2023 •

edited

Loading