Merge pull request #1382 from awslabs/release/v1.20.0

Release/v1.20.0

Author: praneetap

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/python/black
+    rev: 19.3b0
+    hooks:
+      - id: black
+        language_version: python3.7
+        exclude_types: ['markdown', 'ini', 'toml', 'rst']

.travis.yml

@@ -5,6 +5,9 @@ language: python
 
 matrix:
   include:
+    - python: 3.8
+      env:
+        - TOXENV=py38
     - python: 3.7
       env:
         - TOXENV=py37
@@ -18,6 +21,12 @@ matrix:
 
 install:
 # Install the code requirements
+- mkdir $HOME/bin-black
+- wget -O $HOME/bin-black/black https://github.com/python/black/releases/download/19.3b0/black
+- chmod +x $HOME/bin-black/black
+- export PATH=$PATH:$HOME/bin-black
+- black --version
+
 - make init
 
 # Install Docs requirements

CONTRIBUTING.md

@@ -87,7 +87,7 @@ Here are some questions that you should answer in your plan:
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check [existing open](https://github.com/awslabs/PRIVATE-aws-sam-development/issues), or [recently closed](https://github.com/awslabs/PRIVATE-aws-sam-development/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
+When filing an issue, please check [existing open](https://github.com/awslabs/serverless-application-model/issues), or [recently closed](https://github.com/awslabs/serverless-application-model/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
 - A reproducible test case or series of steps

DEVELOPMENT_GUIDE.rst

@@ -17,7 +17,7 @@ steps manually.
 
 1. Install Python Versions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
-Our officially supported Python versions are 2.7, 3.6, and 3.7. Follow the idioms from this `excellent cheatsheet`_ to
+Our officially supported Python versions are 2.7, 3.6, 3.7 and 3.8. Follow the idioms from this `excellent cheatsheet`_ to
 make sure your code is compatible with both Python 2.7 and 3 versions.
 
 Setup Python locally using `pyenv`_
@@ -26,8 +26,23 @@ Setup Python locally using `pyenv`_
 #. ``pyenv install 2.7.14``
 #. Make the Python version available in the project: ``pyenv local 2.7.14``
 
+2. Install Additional Tooling
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1. Black
+~~~~~~~~
+We format our code using [Black](https://github.com/python/black) and verify the source code is black compliant
+in Appveyor during PRs. You can find installation instructions on [Black's docs](https://black.readthedocs.io/en/stable/installation_and_usage.html).
 
-2. Activate Virtualenv
+After installing, you can run our formatting through our Makefile by `make black-format` or integrating Black directly in your favorite IDE (instructions
+can be found [here](https://black.readthedocs.io/en/stable/editor_integration.html))
+
+Pre-commit
+~~~~~~~~~~
+If you don't wish to manually run black on each pr or install black manually, we have integrated black into git hooks through [pre-commit](https://pre-commit.com/).
+After installing pre-commit, run `pre-commit install` in the root of the project. This will install black for you and run the black formatting on
+commit.
+
+3. Activate Virtualenv
 ~~~~~~~~~~~~~~~~~~~~~~
 Virtualenv allows you to install required libraries outside of the Python installation. A good practice is to setup
 a different virtualenv for each project. `pyenv`_ comes with a handy plugin that can create virtualenv.
@@ -37,7 +52,7 @@ a different virtualenv for each project. `pyenv`_ comes with a handy plugin that
 #. [Optional] Automatically activate the virtualenv in for this folder: ``pyenv local samtranslator27``
 
 
-3. Install dependencies
+4. Install dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~
 Install dependencies by running the following command. Make sure the Virtualenv you created above is active.
 

Makefile

@@ -39,19 +39,23 @@ init:
 	$(info [*] Install requirements...)
 	@pip install -r requirements/dev.txt -r requirements/base.txt
 
-flake:
-	$(info [*] Running flake8...)
-	@flake8 samtranslator
-
 test:
 	$(info [*] Run the unit test with minimum code coverage of $(CODE_COVERAGE)%...)
 	@pytest --cov samtranslator --cov-report term-missing --cov-fail-under $(CODE_COVERAGE) tests
 
+black:
+	rm -f tests/*.pyc samtranslator/*.pyc
+	black setup.py samtranslator/* tests/* bin/*
+
+black-check:
+	rm -f tests/*.pyc samtranslator/*.pyc
+	black --check setup.py samtranslator/* tests/* bin/*
+
 # Command to run everytime you make changes to verify everything works
-dev: flake test
+dev: test
 
 # Verifications to run before sending a pull request
-pr: init dev
+pr: black-check init dev
 
 define HELP_MESSAGE
 
@@ -64,7 +68,6 @@ TARGETS
 	init        Initialize and install the requirements and dev-requirements for this project.
 	test        Run the Unit tests.
 	dev         Run all development tests after a change.
-	build-docs  Generate the documentation.
 	pr          Perform all checks before submitting a Pull Request.
 
 endef

README.md

@@ -87,7 +87,7 @@ Read the [SAM Documentation Contribution Guide](https://github.com/awsdocs/aws-s
 started. 
 
 ### Join the SAM Community on Slack
-[Join the SAM developers channel (#samdev)](https://join.slack.com/t/awsdevelopers/shared_invite/enQtMzg3NTc5OTM2MzcxLTdjYTdhYWE3OTQyYTU4Njk1ZWY4Y2ZjYjBhMTUxNGYzNDg5MWQ1ZTc5MTRlOGY0OTI4NTdlZTMwNmI5YTgwOGM/) on Slack to collaborate with fellow community members and the AWS SAM team.
+[Join the SAM developers channel (#samdev)](https://join.slack.com/t/awsdevelopers/shared_invite/enQtMzg3NTc5OTM2MzcxLTIxNjc0ZTJkNmYyNWY3OWE4NTFiNzU1ZTM2Y2VkNmFlNjQ2YjI3YTE1ZDA5YjE5NDE2MjVmYWFlYWIxNjE2NjU) on Slack to collaborate with fellow community members and the AWS SAM team.
 
 
 

appveyor.yml

@@ -0,0 +1,17 @@
+version: 1.0.{build}
+image: Ubuntu
+
+environment:
+  matrix:
+  - TOXENV: py27
+  - TOXENV: py36
+  - TOXENV: py37
+  - TOXENV: py38
+
+build: off
+
+install:
+- make init
+
+test_script:
+- tox

bin/sam-translate.py

@@ -29,7 +29,7 @@
 from docopt import docopt
 
 my_path = os.path.dirname(os.path.abspath(__file__))
-sys.path.insert(0, my_path + '/..')
+sys.path.insert(0, my_path + "/..")
 
 from samtranslator.public.translator import ManagedPolicyLoader
 from samtranslator.translator.transform import transform
@@ -38,18 +38,19 @@
 
 LOG = logging.getLogger(__name__)
 cli_options = docopt(__doc__)
-iam_client = boto3.client('iam')
+iam_client = boto3.client("iam")
 cwd = os.getcwd()
 
-if cli_options.get('--verbose'):
+if cli_options.get("--verbose"):
     logging.basicConfig(level=logging.DEBUG)
 else:
     logging.basicConfig()
 
+
 def execute_command(command, args):
     try:
-        aws_cmd = 'aws' if platform.system().lower() != 'windows' else 'aws.cmd'
-        command_with_args = [aws_cmd, 'cloudformation', command] + list(args)
+        aws_cmd = "aws" if platform.system().lower() != "windows" else "aws.cmd"
+        command_with_args = [aws_cmd, "cloudformation", command] + list(args)
 
         LOG.debug("Executing command: %s", command_with_args)
 
@@ -63,8 +64,8 @@ def execute_command(command, args):
 
 
 def get_input_output_file_paths():
-    input_file_option = cli_options.get('--template-file')
-    output_file_option = cli_options.get('--output-template')
+    input_file_option = cli_options.get("--template-file")
+    output_file_option = cli_options.get("--output-template")
     input_file_path = os.path.join(cwd, input_file_option)
     output_file_path = os.path.join(cwd, output_file_option)
 
@@ -73,67 +74,58 @@ def get_input_output_file_paths():
 
 def package(input_file_path, output_file_path):
     template_file = input_file_path
-    package_output_template_file = input_file_path + '._sam_packaged_.yaml'
-    s3_bucket = cli_options.get('--s3-bucket')
+    package_output_template_file = input_file_path + "._sam_packaged_.yaml"
+    s3_bucket = cli_options.get("--s3-bucket")
     args = [
-        '--template-file',
+        "--template-file",
         template_file,
-        '--output-template-file',
+        "--output-template-file",
         package_output_template_file,
-        '--s3-bucket',
-        s3_bucket
+        "--s3-bucket",
+        s3_bucket,
     ]
 
-    execute_command('package', args)
+    execute_command("package", args)
 
     return package_output_template_file
 
 
 def transform_template(input_file_path, output_file_path):
-    with open(input_file_path, 'r') as f:
+    with open(input_file_path, "r") as f:
         sam_template = yaml_parse(f)
 
     try:
-        cloud_formation_template = transform(
-            sam_template, {}, ManagedPolicyLoader(iam_client))
-        cloud_formation_template_prettified = json.dumps(
-            cloud_formation_template, indent=2)
+        cloud_formation_template = transform(sam_template, {}, ManagedPolicyLoader(iam_client))
+        cloud_formation_template_prettified = json.dumps(cloud_formation_template, indent=2)
 
-        with open(output_file_path, 'w') as f:
+        with open(output_file_path, "w") as f:
             f.write(cloud_formation_template_prettified)
 
-        print('Wrote transformed CloudFormation template to: ' + output_file_path)
+        print ("Wrote transformed CloudFormation template to: " + output_file_path)
     except InvalidDocumentException as e:
-        errorMessage = reduce(lambda message, error: message + ' ' + error.message, e.causes, e.message)
+        errorMessage = reduce(lambda message, error: message + " " + error.message, e.causes, e.message)
         LOG.error(errorMessage)
         errors = map(lambda cause: cause.message, e.causes)
         LOG.error(errors)
 
 
 def deploy(template_file):
-    capabilities = cli_options.get('--capabilities')
-    stack_name = cli_options.get('--stack-name')
-    args = [
-        '--template-file',
-        template_file,
-        '--capabilities',
-        capabilities,
-        '--stack-name',
-        stack_name
-    ]
+    capabilities = cli_options.get("--capabilities")
+    stack_name = cli_options.get("--stack-name")
+    args = ["--template-file", template_file, "--capabilities", capabilities, "--stack-name", stack_name]
 
-    execute_command('deploy', args)
+    execute_command("deploy", args)
 
     return package_output_template_file
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     input_file_path, output_file_path = get_input_output_file_paths()
 
-    if cli_options.get('package'):
+    if cli_options.get("package"):
         package_output_template_file = package(input_file_path, output_file_path)
         transform_template(package_output_template_file, output_file_path)
-    elif cli_options.get('deploy'):
+    elif cli_options.get("deploy"):
         package_output_template_file = package(input_file_path, output_file_path)
         transform_template(package_output_template_file, output_file_path)
         deploy(output_file_path)

docs/cloudformation_compatibility.rst

@@ -63,6 +63,7 @@ DeploymentPreference               All
 Layers                             All
 AutoPublishAlias             Ref of a CloudFormation Parameter  Alias resources created by SAM uses a LocicalId <FunctionLogicalId+AliasName>. So SAM either needs a string for alias name, or a Ref to template Parameter that SAM can resolve into a string.
 ReservedConcurrentExecutions       All
+EventInvokeConfig                  All
 ============================ ================================== ========================
 
 Events Properties
@@ -139,7 +140,17 @@ Description              All
 Enabled                  All
 ======================== ================================== ========================
 
-CloudWatchEvent
+CloudWatchEvent (superseded by EventBridgeRule, see below)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+======================== ================================== ========================
+     Property Name        Intrinsic(s) Supported            Reasons
+======================== ================================== ========================
+Pattern                  All
+Input                    All
+InputPath                All
+======================== ================================== ========================
+
+EventBridgeRule
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ======================== ================================== ========================
      Property Name        Intrinsic(s) Supported            Reasons
@@ -184,6 +195,7 @@ MinimumCompressionSize              All
 Cors                                All
 TracingEnabled                      All
 OpenApiVersion                      None
+Domain                              All
 ================================== ======================== ========================
 
 

docs/globals.rst

@@ -69,6 +69,7 @@ Currently, the following resources and properties are being supported:
       DeploymentPreference:
       PermissionsBoundary:
       ReservedConcurrentExecutions:
+      EventInvokeConfig:
 
     Api:
       # Properties of AWS::Serverless::Api
@@ -89,6 +90,7 @@ Currently, the following resources and properties are being supported:
       CanarySetting:
       TracingEnabled:
       OpenApiVersion:
+      Domain:
 
     HttpApi:
       # Properties of AWS::Serverless::HttpApi