Simplify built-in quickstarts to a simple hello world #849

heitorlessa · 2018-12-11T14:45:43Z

Issue #, if available:

Description of changes:

This PR simplifies all quickstarts turning them into a much simpler hello world that aims to make it easier for new customers to onboard.

Once complete, the initial experience will look like:

sam init

# Message output now displays next steps
[+] Initializing project structure...

Project generated: ./sam-app

Steps you can take next within the project folder
===================================================
[*] Invoke Function: sam local invoke HelloWorldFunction --event event.json
[*] Start API Gateway locally: sam local start-api

Read sam-app/README.md for further instructions

cd sam-app
sam local invoke HelloWorldFunction -e event.json

Checklist:

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

sanathkr · 2018-12-11T17:07:21Z

...cal/init/templates/cookiecutter-aws-sam-hello-nodejs/{{cookiecutter.project_name}}/README.md

-│           └── test_handler.js
-└── template.yaml               <-- SAM template
+│   └── app.js                  <-- Lambda function code
+├── package.json                <-- NodeJS dependencies and scripts


package.json must be within the function folder. Each function should get its own manifest - that's the best practice we heard from customers and we are codifying that within "sam build" as the default (obviously overridable)

Right! Should we also move tests/ within the hello_world folder? If not, we'd also need to change npm run test behaviour.

Lemme know.

For context, under the Testing section we have:

npm install npm run test

The tests are already in the hello_world folder: https://github.com/awslabs/aws-sam-cli/tree/develop/samcli/local/init/templates/cookiecutter-aws-sam-hello-nodejs/%7B%7Bcookiecutter.project_name%7D%7D/hello_world

ha! That's what happens when you have multiple copies of it locally. Resuming work on this, thanks @jfuss for pointing this out !!!!

Okay, I had to make another change so an user doesn't have to keep jumping in and out to run test, come back to where template.yaml is to run sam local invoke again, etc.

I included npm run start and npm run invoke scripts under hello_world/package.json for that matter.

Ideally, I think, for NodeJS, it'd be great to have a root package.json so one doesn't have to keep jumping to each source code folder and can do something like while still getting the benefit of having a per-function dependency:

npm run test:hello-world: This would take care of sam build && npm run test --prefix hello_world/

npm run invoke:hello-world: This would take care of sam local invoke HelloWorldFunction -e event.json

Which then can be duplicated as one creates more functions and ease the project to grow organically.

Source code tree as an example to visualize this:

. ├── README.md ├── event.json ├── hello_world │ ├── app.js │ ├── etc │ ├── package.json <-- NodeJS dependencies and scripts │ └── tests │ └── unit │ └── test_hello_world.js ├── package.json <-- NodeJS no deps w/ scripts for convenience └── template.yaml

What are your thoughts? @jfuss @sanathkr

@heitorlessa Any changes here are going to conflict with #845, where we are updating the nodejs examples to support sam build for Nodejs Lambdas.

My concern with having two package.json is: How do I know which one to use or update?

That's a totally valid concern @jfuss. After some thought and playing with --prefix I believe that will come down to preference at the end of the day.

Customers I worked with on Node with multiple functions in a repo they had this approach, others used a Makefile so no standard per se.

For this I will hold on any changes to this PR as we agree on what the SAM CLI Core team ultimately prefer as a quickstart

#845 (comment)

heitorlessa · 2018-12-21T11:53:41Z

Completed rebase and pushed new NodeJS simplified along with a legacy template for Nodejs4.3/6.10 and dedicated instructions.

Working on updating the other templates after rebase

heitorlessa · 2018-12-21T16:51:40Z

Description updated and will rebase and resume work after #866 is completed

heitorlessa · 2018-12-21T18:15:44Z

rebase complete and Ruby quickstart now follows other templates as requested.

Ready for review!

jfuss

Please replicate the comments across the different init's. We should aim for them to all read consistently but deviate when needed for the language.

jfuss · 2019-01-07T16:43:18Z

samcli/commands/init/__init__.py

+""".format(output_dir=output_dir, name=name)
+
+    no_build_step_required = (
+        "python", "python3.7", "python3.6", "python2.7", "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "ruby2.5")


Lambda has moved nodejs4.3 to depreciated, meaning creating and updating functions is no longer allows/supported. Can we match that expectation here and remove creation of Nodejs.4.3 functions?

Awesome, done!

jfuss · 2019-01-07T16:46:51Z

samcli/commands/init/__init__.py

+
+    no_build_step_required = (
+        "python", "python3.7", "python3.6", "python2.7", "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "ruby2.5")
+    next_step_msg = no_build_msg if runtime in no_build_step_required else build_msg


What if a custom template takes in a the --runtime arg? This message may or may not be true then.

Not sure what you mean by a custom template takes in 'a in the --runtime arg' -- This is a quick workaround until sam build fully supports all runtimes so the message will remain consistent and this will be deleted, though the workaround is flawed in the sense of as sam build supports more native runtimes this will need updating.

no_build_step_required = ( "python", "python3.7", "python3.6", "python2.7", "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "ruby2.5") next_step_msg = no_build_msg if runtime in no_build_step_required else build_msg

--runtime arg is validated against the ones we support and no_build_step_required essentially borrows the ones that have sam build support.

What would you suggest instead?

I see. I was getting two PRs mixed up, where I thought we were passing runtime to cookiecutter examples that are passed to --location. You can ignore this comment and can handle in the other pr that enables that.

jfuss · 2019-01-07T16:54:28Z

samcli/local/init/__init__.py

    "nodejs8.10": os.path.join(_templates, "cookiecutter-aws-sam-hello-nodejs"),
-    "nodejs4.3": os.path.join(_templates, "cookiecutter-aws-sam-hello-nodejs"),
+    "nodejs4.3": os.path.join(_templates, "cookiecutter-aws-sam-hello-nodejs-legacy"),


Remove 4.3 support since Lambda does not support creating or updating functions with runtimes of nodejs4.3

jfuss · 2019-01-07T17:01:42Z

...cal/init/templates/cookiecutter-aws-sam-hello-dotnet/{{cookiecutter.project_name}}/README.md


-Create your own .NET Core solution template to use with SAM CLI. [Cookiecutter for AWS SAM and .NET](https://github.com/aws-samples/cookiecutter-aws-sam-dotnet) provides you with a sample implementation how to use cookiecutter templating library to standardise how you initialise your Serverless projects.
+Next, you can use AWS Serverless Application Repository to deploy ready to use Apps that go beyond hello world samples and learn how authors developed their applications: [AWS Serverless Application Repository main page](https://aws.amazon.com/serverless/serverlessrepo/)


We could call out the sam publish command here.

jfuss · 2019-01-07T17:05:17Z

...cal/init/templates/cookiecutter-aws-sam-hello-dotnet/{{cookiecutter.project_name}}/README.md

+    --query 'Stacks[].Outputs[?OutputKey==`HelloWorldApi`]' \
+    --output table
+
+# Tail Lambda function Logs using Logical name defined in SAM Template


Should we have a step to invoke the function or API gateway locally with sam logs running in the terminal?

jfuss · 2019-01-07T17:08:53Z

...init/templates/cookiecutter-aws-sam-hello-dotnet/{{cookiecutter.project_name}}/template.yaml

@@ -12,7 +12,7 @@ Globals:
 Resources:

    HelloWorldFunction:
-        Type: AWS::Serverless::Function # More info about Function Resource: https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction
+        Type: AWS::Serverless::Function # More info about Function Resource: https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-template.html#serverless-sam-template-function


We should keep the GH links here. The Spec definitions are held on GH.

jfuss · 2019-01-07T17:10:23Z

samcli/local/init/templates/cookiecutter-aws-sam-hello-golang/README.md

-* `pipenv install cookiecutter`
-
-**NOTE**: [`Pipenv`](https://github.com/pypa/pipenv) is the new and recommended Python packaging tool that works across multiple platforms and makes Windows a first-class citizen.
+* [AWS SAM CLI](https://github.com/awslabs/aws-sam-cli)


Should this point to our landing page instead: https://aws.amazon.com/serverless/sam/

jfuss · 2019-01-07T17:14:06Z

...cal/init/templates/cookiecutter-aws-sam-hello-golang/{{cookiecutter.project_name}}/README.md


-You can issue the following command in a shell to build it:
+**Building an executable target for Lambda runtime**

 ```shell
 GOOS=linux GOARCH=amd64 go build -o hello-world/hello-world ./hello-world


Should this just use the Makefile instead?

jfuss · 2019-01-07T17:16:15Z

...cal/init/templates/cookiecutter-aws-sam-hello-golang/{{cookiecutter.project_name}}/README.md


-#### Chocolatey (Windows)
+### Step-through debugging


There should be this section in the .Net as well

jfuss · 2019-01-07T17:17:09Z

...cal/init/templates/cookiecutter-aws-sam-hello-golang/{{cookiecutter.project_name}}/README.md

 ``` 

+## Fetch, tail, and filter Lambda function logs


Should be in the .Net example as well.

…ss scripts location

…pendix

…ringing to the next level

…; updates appendix to reflect that

This reverts commit dd1d16f.

heitorlessa

Addressed Jacob's feedback and clarified next_step_msg workaround

heitorlessa · 2019-01-07T19:38:56Z

samcli/commands/init/__init__.py

+""".format(output_dir=output_dir, name=name)
+
+    no_build_step_required = (
+        "python", "python3.7", "python3.6", "python2.7", "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "ruby2.5")


Awesome, done!

heitorlessa · 2019-01-07T19:42:14Z

samcli/local/init/__init__.py

    "nodejs8.10": os.path.join(_templates, "cookiecutter-aws-sam-hello-nodejs"),
-    "nodejs4.3": os.path.join(_templates, "cookiecutter-aws-sam-hello-nodejs"),
+    "nodejs4.3": os.path.join(_templates, "cookiecutter-aws-sam-hello-nodejs-legacy"),


heitorlessa · 2019-01-07T19:53:32Z

samcli/commands/init/__init__.py

+
+    no_build_step_required = (
+        "python", "python3.7", "python3.6", "python2.7", "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "ruby2.5")
+    next_step_msg = no_build_msg if runtime in no_build_step_required else build_msg


Not sure what you mean by a custom template takes in 'a in the --runtime arg' -- This is a quick workaround until sam build fully supports all runtimes so the message will remain consistent and this will be deleted, though the workaround is flawed in the sense of as sam build supports more native runtimes this will need updating.

no_build_step_required = ( "python", "python3.7", "python3.6", "python2.7", "nodejs", "nodejs4.3", "nodejs6.10", "nodejs8.10", "ruby2.5") next_step_msg = no_build_msg if runtime in no_build_step_required else build_msg

--runtime arg is validated against the ones we support and no_build_step_required essentially borrows the ones that have sam build support.

What would you suggest instead?

jfuss

WOOT! I know it took some time to get it through, so thanks for keeping with it.

jfuss approved

sanathkr previously requested changes Dec 11, 2018

View reviewed changes

heitorlessa force-pushed the improv/simplify-init-quickstart-templates branch from 0622b9b to 7a82d9f Compare December 21, 2018 11:52

heitorlessa force-pushed the improv/simplify-init-quickstart-templates branch from 81e6125 to c6d5cdc Compare December 21, 2018 18:12

heitorlessa changed the title ~~[WIP] Simplify built-in quickstarts to a simple hello world~~ Simplify built-in quickstarts to a simple hello world Dec 21, 2018

jfuss requested changes Jan 7, 2019

View reviewed changes

heitorlessa added 22 commits January 7, 2019 19:32

NodeJS conflicts fixed

0163474

improv: Remove duplicate repo README on code tree

d53c02d

fix: Add correct CLI permission needed

927d438

improv: Simplifies README and steps

48fc9b6

improv: Simplifies Python boilerplate example and update tests

b65bb11

improv: Simplifies Go boilerplate example and update tests

c539824

fix: isBase64Encoded key now correctly set to Boolean

d562ff8

fix: Address Sanath/Jacob feedback on tests folder/package.json

97210ec

fix: Add functional sam build and npm run test preffix while we discu…

2a3f7d5

…ss scripts location

improv: Add event.json and remove env vars from template

022b827

improv: Updates readme to include invoke with event.json, logs and ap…

777fbef

…pendix

improv: Simplify Java sample and update tests

a9323d4

improv: Add Cleanup section

b8cfc19

improv: Simplify DotNet Core sample

840e662

fix: Trim whitespace on external link

72208d9

improv: Simplify Ruby and all steps work now too

0c6abaa

fix: Remove unused parameters in appendix for sam deploy

68e72c9

improv: Clean up parent README

1caa66d

feat: Address Jacob's feedback on help message upon project build

667e265

feat: Move Nodejs4.3/6.10 to a legacy template, add sam build under b…

80c68f3

…ringing to the next level

improv: sam package no longer needs --template-file for template.yaml…

e75f808

…; updates appendix to reflect that

fix: Correct headings under Appendix

012168e

heitorlessa added 7 commits January 7, 2019 19:32

improv: python simplification after rebase

1b5757f

improv: go and java simplification after rebase

7648247

feat: Add next step message for both strongly styped vs dynamic

5b91fc4

improv: dotnet simplification after rebase

6c5a656

fix: Correct documentation links now pointing to AWS Docs

a9ab5a4

improv: ruby simplification after rebase

89f2e40

fix: revert compiled lang templates

8340bb5

heitorlessa force-pushed the improv/simplify-init-quickstart-templates branch from 4bff4ab to 8340bb5 Compare January 7, 2019 19:36

heitorlessa added 4 commits January 7, 2019 19:40

improv: Removes NodeJS 4.3 template and option

dd1d16f

Revert "improv: Removes NodeJS 4.3 template and option"

14cb8f5

This reverts commit dd1d16f.

fix: Remove NodeJS 4.3 option from runtime selection

58a4f3a

fix: Defaults legacy to 6.10

f02109e

heitorlessa commented Jan 7, 2019

View reviewed changes

heitorlessa added 5 commits January 10, 2019 16:59

fix: Remove --template-file from package in Ruby instructions

a153a30

fix: jacob's feedback on nodejs legacy folder rename to 6

f13ef65

fix: jacob's feedback on package.json and appendix commands

348ef5b

fix: jacob's feedback on README and links to SAM Spec on template too

aeaf413

fix: revert dotnet original readmes

d61e3e8

jfuss approved these changes Jan 14, 2019

View reviewed changes

Merge branch 'develop' into improv/simplify-init-quickstart-templates

e685a94

jfuss merged commit 9600778 into aws:develop Jan 14, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simplify built-in quickstarts to a simple hello world #849

Simplify built-in quickstarts to a simple hello world #849

heitorlessa commented Dec 11, 2018 •

edited

Loading

sanathkr Dec 11, 2018

heitorlessa Dec 11, 2018

jfuss Dec 11, 2018

heitorlessa Dec 12, 2018

heitorlessa Dec 12, 2018

jfuss Dec 12, 2018

heitorlessa Dec 14, 2018 •

edited

Loading

jfuss Dec 14, 2018

heitorlessa commented Dec 21, 2018

heitorlessa commented Dec 21, 2018

heitorlessa commented Dec 21, 2018

jfuss left a comment

jfuss Jan 7, 2019

heitorlessa Jan 7, 2019

jfuss Jan 7, 2019

heitorlessa Jan 7, 2019

jfuss Jan 11, 2019

jfuss Jan 7, 2019

heitorlessa Jan 7, 2019

jfuss Jan 7, 2019

jfuss Jan 7, 2019

jfuss Jan 7, 2019

jfuss Jan 7, 2019

jfuss Jan 7, 2019

jfuss Jan 7, 2019

jfuss Jan 7, 2019

heitorlessa left a comment

heitorlessa Jan 7, 2019

heitorlessa Jan 7, 2019

heitorlessa Jan 7, 2019

jfuss left a comment


		Create your own .NET Core solution template to use with SAM CLI. [Cookiecutter for AWS SAM and .NET](https://github.com/aws-samples/cookiecutter-aws-sam-dotnet) provides you with a sample implementation how to use cookiecutter templating library to standardise how you initialise your Serverless projects.
		Next, you can use AWS Serverless Application Repository to deploy ready to use Apps that go beyond hello world samples and learn how authors developed their applications: [AWS Serverless Application Repository main page](https://aws.amazon.com/serverless/serverlessrepo/)

Simplify built-in quickstarts to a simple hello world #849

Simplify built-in quickstarts to a simple hello world #849

Conversation

heitorlessa commented Dec 11, 2018 • edited Loading

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

heitorlessa Dec 14, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heitorlessa commented Dec 21, 2018

heitorlessa commented Dec 21, 2018

heitorlessa commented Dec 21, 2018

jfuss 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

heitorlessa 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

jfuss left a comment

Choose a reason for hiding this comment

heitorlessa commented Dec 11, 2018 •

edited

Loading

heitorlessa Dec 14, 2018 •

edited

Loading