[SAM] Makes S3 Bucket parameter optional and creates bucket automatically in the deployment region

awscli/customizations/cloudformation/exceptions.py

@@ -46,3 +46,12 @@ class DeployFailedError(CloudFormationCommandError):
          "to fetch the list of events leading up to the failure"
          "\n"
          "aws cloudformation describe-stack-events --stack-name {stack_name}")
+
+
+class PackageFailedRegionMismatchError(CloudFormationCommandError):
+    fmt = \
+        ("Failed to create package as deployment and S3 bucket region mismatch"
+         "\n\n"
+         "\tS3 Bucket region: {bucket_region}"
+         "\n"
+         "\tDeployment region: {deploy_region}")

awscli/customizations/cloudformation/package.py

@@ -11,19 +11,18 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-import os
+import json
 import logging
+import os
 import sys
 
-import json
-
-from botocore.client import Config
-
+from awscli.customizations.cloudformation import exceptions
 from awscli.customizations.cloudformation.artifact_exporter import Template
 from awscli.customizations.cloudformation.yamlhelper import yaml_dump
-from awscli.customizations.cloudformation import exceptions
 from awscli.customizations.commands import BasicCommand
 from awscli.customizations.s3uploader import S3Uploader
+from botocore.client import Config
+from botocore.exceptions import ClientError
 
 LOG = logging.getLogger(__name__)
 
@@ -40,6 +39,10 @@ class PackageCommand(BasicCommand):
         "--stack-name <YOUR STACK NAME>"
         "\n")
 
+    MSG_PACKAGE_S3_BUCKET_CREATION = (
+        "Bucket {bucket} doesn't exist.\n"
+        "Creating s3://{bucket} at {region} region.\n")
+
     NAME = "package"
 
     DESCRIPTION = BasicCommand.FROM_FILE("cloudformation",
@@ -57,7 +60,7 @@ class PackageCommand(BasicCommand):
 
         {
             'name': 's3-bucket',
-            'required': True,
+            'required': False,
             'help_text': (
                 'The name of the S3 bucket where this command uploads'
                 ' the artifacts that are referenced in your template.'
@@ -112,19 +115,70 @@ class PackageCommand(BasicCommand):
         }
     ]
 
+    def _get_bucket_region(self, s3_bucket, s3_client):
+        s3_loc = s3_client.get_bucket_location(
+            Bucket=s3_bucket).get("LocationConstraint", "us-east-1")
+        return s3_loc.get
+
     def _run_main(self, parsed_args, parsed_globals):
+        region = parsed_globals.region if parsed_globals.region else "us-east-1"
         s3_client = self._session.create_client(
             "s3",
             config=Config(signature_version='s3v4'),
-            region_name=parsed_globals.region,
+            region_name=region,
             verify=parsed_globals.verify_ssl)
 
         template_path = parsed_args.template_file
         if not os.path.isfile(template_path):
             raise exceptions.InvalidTemplatePathError(
-                    template_path=template_path)
+                template_path=template_path)
+
+        if (parsed_args.s3_bucket is not None):
+            bucket = parsed_args.s3_bucket
+            s3_bucket_region = self._get_bucket_region(bucket, s3_client)
+            if not s3_bucket_region == region:
+                raise exceptions.PackageFailedRegionMismatchError(
+                    bucket_region=s3_bucket_region,
+                    deploy_region=region
+                )
+        else:
+            sts_client = self._session.create_client(
+                "sts",
+                config=Config(signature_version='s3v4'),
+                verify=parsed_globals.verify_ssl
+            )
+            account = sts_client.get_caller_identity().get('Account', "")
+            bucket = "sam-{region}-{account}".format(
+                account=account,
+                region=region
+            )
 
-        bucket = parsed_args.s3_bucket
+            # Check if SAM deployment bucket already exists otherwise create it
+            try:
+                s3_client.head_bucket(Bucket=bucket)
+            except ClientError as e:
+                if e.response["Error"]["Code"] == "404":
+                    sys.stdout.write(
+                        self.MSG_PACKAGE_S3_BUCKET_CREATION.format(
+                            bucket=bucket, region=region))
+
+                    _s3_params = {
+                        "all_regions": {
+                            "Bucket": bucket
+                        },
+                        "us_standard": {
+                            "Bucket": bucket,
+                            "CreateBucketConfiguration": {
+                                "LocationConstraint": region
+                            }
+                        }
+                    }
+
+                    # Create bucket in specified region or else use us-east-1
+                    if parsed_globals.region:
+                        s3_client.create_bucket(**_s3_params['all_regions'])
+                    else:
+                        s3_client.create_bucket(**_s3_params['us_standard'])
 
         self.s3_uploader = S3Uploader(s3_client,
                                       bucket,
@@ -142,8 +196,8 @@ def _run_main(self, parsed_args, parsed_globals):
 
         if output_file:
             msg = self.MSG_PACKAGED_TEMPLATE_WRITTEN.format(
-                    output_file_name=output_file,
-                    output_file_path=os.path.abspath(output_file))
+                output_file_name=output_file,
+                output_file_path=os.path.abspath(output_file))
             sys.stdout.write(msg)
 
         sys.stdout.flush()
@@ -154,7 +208,8 @@ def _export(self, template_path, use_json):
         exported_template = template.export()
 
         if use_json:
-            exported_str = json.dumps(exported_template, indent=4, ensure_ascii=False)
+            exported_str = json.dumps(
+                exported_template, indent=4, ensure_ascii=False)
         else:
             exported_str = yaml_dump(exported_template)
 

tests/unit/customizations/cloudformation/test_package.py

@@ -21,6 +21,7 @@
 from awscli.customizations.cloudformation.package import PackageCommand
 from awscli.customizations.cloudformation.artifact_exporter import Template
 from awscli.customizations.cloudformation.yamlhelper import yaml_dump
+from awscli.customizations.cloudformation.exceptions import PackageFailedRegionMismatchError
 
 
 class FakeArgs(object):
@@ -74,6 +75,8 @@ def test_main(self, mock_yaml_dump):
                 self.parsed_args.template_file = filename
                 self.parsed_args.use_json=use_json
 
+                self.package_command._get_bucket_region = MagicMock(return_value="us-east-1")
+
                 rc = self.package_command._run_main(self.parsed_args, self.parsed_globals)
                 self.assertEquals(rc, 0)
 
@@ -84,7 +87,63 @@ def test_main(self, mock_yaml_dump):
                 self.package_command._export.reset_mock()
                 self.package_command.write_output.reset_mock()
 
+    @patch("awscli.customizations.cloudformation.package.yaml_dump")
+    def test_main_without_bucket(self, mock_yaml_dump):
+        exported_template_str = "hello"
+
+        self.package_command.write_output = Mock()
+        self.package_command._export = Mock()
+        mock_yaml_dump.return_value = exported_template_str
+
+        # Create a temporary file and make this my template
+        with tempfile.NamedTemporaryFile() as handle:
+            for use_json in (False, True):
+                filename = handle.name
+                self.parsed_args.template_file = filename
+                self.parsed_args.use_json = use_json
+
+                self.package_command._get_bucket_region = MagicMock(
+                    return_value="us-east-1")
+                self.parsed_args.s3_bucket = None
+
+                rc = self.package_command._run_main(
+                    self.parsed_args, self.parsed_globals)
+                self.assertEquals(rc, 0)
+
+                self.package_command._export.assert_called_once_with(
+                    filename, use_json)
+                self.package_command.write_output.assert_called_once_with(
+                    self.parsed_args.output_template_file, mock.ANY)
 
+                self.package_command._export.reset_mock()
+                self.package_command.write_output.reset_mock()
+
+    @patch("awscli.customizations.cloudformation.package.yaml_dump")
+    def test_main_bucket_different_deployment_region(self, mock_yaml_dump):
+        exported_template_str = "hello"
+
+        self.package_command.write_output = Mock()
+        self.package_command._export = Mock()
+        mock_yaml_dump.return_value = exported_template_str
+
+        # Create a temporary file and make this my template
+        with tempfile.NamedTemporaryFile() as handle:
+            for use_json in (False, True):
+                filename = handle.name
+                self.parsed_args.template_file = filename
+                self.parsed_args.use_json = use_json
+
+                self.package_command._get_bucket_region = MagicMock(
+                    return_value="us-east-1")
+                self.parsed_args.s3_bucket = "bucket-in-different-region"
+                self.parsed_globals.region = "eu-west-1"
+
+                with self.assertRaises(PackageFailedRegionMismatchError):
+                    self.package_command._run_main(
+                        self.parsed_args, self.parsed_globals)
+
+                self.package_command._export.reset_mock()
+                self.package_command.write_output.reset_mock()
 
     def test_main_error(self):
 
@@ -96,6 +155,9 @@ def test_main_error(self):
             filename = handle.name
             self.parsed_args.template_file = filename
 
+            self.package_command._get_bucket_region = MagicMock(
+                    return_value="us-east-1")
+
             with self.assertRaises(RuntimeError):
                 self.package_command._run_main(self.parsed_args, self.parsed_globals)