def setUp(self):
self.deploy_command_context = DeployContext(
template_file="template-file",
stack_name="stack-name",
s3_bucket="s3-bucket",
force_upload=True,
s3_prefix="s3-prefix",
kms_key_id="kms-key-id",
parameter_overrides={"a": "b"},
capabilities="CAPABILITY_IAM",
no_execute_changeset=False,
role_arn="role-arn",
notification_arns=[],
fail_on_empty_changeset=False,
tags={"a": "b"},
region=None,
profile=None,
confirm_changeset=False,
)
class TestSamDeployCommand(TestCase):
def setUp(self):
self.deploy_command_context = DeployContext(
template_file="template-file",
stack_name="stack-name",
s3_bucket="s3-bucket",
image_repository="image-repo",
image_repositories=None,
force_upload=True,
no_progressbar=False,
s3_prefix="s3-prefix",
kms_key_id="kms-key-id",
parameter_overrides={"a": "b"},
capabilities="CAPABILITY_IAM",
no_execute_changeset=False,
role_arn="role-arn",
notification_arns=[],
fail_on_empty_changeset=False,
tags={"a": "b"},
region=None,
profile=None,
confirm_changeset=False,
signing_profiles=None,
)
def test_template_improper(self):
with tempfile.NamedTemporaryFile(delete=False) as template_file:
with self.assertRaises(DeployFailedError):
self.deploy_command_context.template_file = template_file.name
self.deploy_command_context.run()
def test_template_size_large_no_s3_bucket(self):
with tempfile.NamedTemporaryFile(delete=False) as template_file:
template_file.write(b" " * 51200)
template_file.write(b"{}")
template_file.flush()
self.deploy_command_context.template_file = template_file.name
self.deploy_command_context.s3_bucket = None
with self.assertRaises(DeployBucketRequiredError):
self.deploy_command_context.run()
@patch("boto3.Session")
@patch.object(Deployer, "create_and_wait_for_changeset",
MagicMock(return_value=({
"Id": "test"
}, "CREATE")))
@patch.object(Deployer, "execute_changeset", MagicMock())
@patch.object(Deployer, "wait_for_execute", MagicMock())
def test_template_size_large_and_s3_bucket(self, patched_boto):
with tempfile.NamedTemporaryFile(delete=False) as template_file:
template_file.write(b" " * 51200)
template_file.write(b"{}")
template_file.flush()
self.deploy_command_context.template_file = template_file.name
self.deploy_command_context.run()
@patch("boto3.Session")
def test_template_valid(self, patched_boto):
with tempfile.NamedTemporaryFile(delete=False) as template_file:
template_file.write(b"{}")
template_file.flush()
self.deploy_command_context.template_file = template_file.name
self.deploy_command_context.deploy = MagicMock()
self.deploy_command_context.run()
@patch("boto3.Session")
@patch.object(
Deployer, "create_and_wait_for_changeset",
MagicMock(side_effect=ChangeEmptyError(stack_name="stack-name")))
def test_template_valid_change_empty(self, patched_boto):
with tempfile.NamedTemporaryFile(delete=False) as template_file:
template_file.write(b"{}")
template_file.flush()
self.deploy_command_context.fail_on_empty_changeset = True
self.deploy_command_context.template_file = template_file.name
with self.assertRaises(ChangeEmptyError):
self.deploy_command_context.run()
@patch("boto3.Session")
@patch.object(
Deployer, "create_and_wait_for_changeset",
MagicMock(side_effect=ChangeEmptyError(stack_name="stack-name")))
def test_template_valid_change_empty_no_fail_on_empty_changeset(
self, patched_boto):
with tempfile.NamedTemporaryFile(delete=False) as template_file:
template_file.write(b"{}")
template_file.flush()
self.deploy_command_context.template_file = template_file.name
self.deploy_command_context.run()
@patch("boto3.Session")
@patch.object(Deployer, "create_and_wait_for_changeset",
MagicMock(return_value=({
"Id": "test"
}, "CREATE")))
@patch.object(Deployer, "execute_changeset", MagicMock())
@patch.object(Deployer, "wait_for_execute", MagicMock())
def test_template_valid_execute_changeset(self, patched_boto):
with tempfile.NamedTemporaryFile(delete=False) as template_file:
template_file.write(b"{}")
template_file.flush()
self.deploy_command_context.template_file = template_file.name
self.deploy_command_context.run()
self.assertEqual(
self.deploy_command_context.deployer.
create_and_wait_for_changeset.call_count, 1)
self.assertEqual(
self.deploy_command_context.deployer.execute_changeset.
call_count, 1)
self.assertEqual(
self.deploy_command_context.deployer.wait_for_execute.
call_count, 1)
@patch("boto3.Session")
@patch.object(Deployer, "create_and_wait_for_changeset",
MagicMock(return_value=({
"Id": "test"
}, "CREATE")))
@patch.object(Deployer, "execute_changeset", MagicMock())
@patch.object(Deployer, "wait_for_execute", MagicMock())
def test_template_valid_no_execute_changeset(self, patched_boto):
with tempfile.NamedTemporaryFile(delete=False) as template_file:
template_file.write(b"{}")
template_file.flush()
self.deploy_command_context.template_file = template_file.name
self.deploy_command_context.no_execute_changeset = True
self.deploy_command_context.run()
self.assertEqual(
self.deploy_command_context.deployer.
create_and_wait_for_changeset.call_count, 1)
self.assertEqual(
self.deploy_command_context.deployer.execute_changeset.
call_count, 0)
self.assertEqual(
self.deploy_command_context.deployer.wait_for_execute.
call_count, 0)
@patch("boto3.Session")
@patch("samcli.commands.deploy.deploy_context.auth_per_resource")
@patch(
"samcli.commands.deploy.deploy_context.SamLocalStackProvider.get_stacks"
)
@patch.object(Deployer, "create_and_wait_for_changeset",
MagicMock(return_value=({
"Id": "test"
}, "CREATE")))
@patch.object(Deployer, "execute_changeset", MagicMock())
@patch.object(Deployer, "wait_for_execute", MagicMock())
def test_template_valid_execute_changeset_with_parameters(
self, patched_get_buildable_stacks, patched_auth_required,
patched_boto):
patched_get_buildable_stacks.return_value = (Mock(), [])
patched_auth_required.return_value = [("HelloWorldFunction", False)]
with tempfile.NamedTemporaryFile(delete=False) as template_file:
template_file.write(b'{"Parameters": {"a":"b","c":"d"}}')
template_file.flush()
self.deploy_command_context.template_file = template_file.name
self.deploy_command_context.run()
self.assertEqual(
self.deploy_command_context.deployer.
create_and_wait_for_changeset.call_count, 1)
self.assertEqual(
self.deploy_command_context.deployer.
create_and_wait_for_changeset.call_args[1]["parameter_values"],
[{
"ParameterKey": "a",
"ParameterValue": "b"
}, {
"ParameterKey": "c",
"UsePreviousValue": True
}],
)
def do_cli(
template_file,
stack_name,
s3_bucket,
force_upload,
s3_prefix,
kms_key_id,
parameter_overrides,
capabilities,
no_execute_changeset,
role_arn,
notification_arns,
fail_on_empty_changeset,
use_json,
tags,
metadata,
guided,
confirm_changeset,
region,
profile,
):
from samcli.commands.package.package_context import PackageContext
from samcli.commands.deploy.deploy_context import DeployContext
from samcli.commands.deploy.guided_context import GuidedContext
if guided:
# Allow for a guided deploy to prompt and save those details.
guided_context = GuidedContext(
template_file=template_file,
stack_name=stack_name,
s3_bucket=s3_bucket,
s3_prefix=s3_prefix,
region=region,
profile=profile,
confirm_changeset=confirm_changeset,
capabilities=capabilities,
parameter_overrides=parameter_overrides,
config_section=CONFIG_SECTION,
)
guided_context.run()
print_deploy_args(
stack_name=guided_context.guided_stack_name if guided else stack_name,
s3_bucket=guided_context.guided_s3_bucket if guided else s3_bucket,
region=guided_context.guided_region if guided else region,
capabilities=guided_context.guided_capabilities
if guided else capabilities,
parameter_overrides=guided_context.guided_parameter_overrides
if guided else parameter_overrides,
confirm_changeset=guided_context.confirm_changeset
if guided else confirm_changeset,
)
with osutils.tempfile_platform_independent() as output_template_file:
with PackageContext(
template_file=template_file,
s3_bucket=guided_context.guided_s3_bucket
if guided else s3_bucket,
s3_prefix=guided_context.guided_s3_prefix
if guided else s3_prefix,
output_template_file=output_template_file.name,
kms_key_id=kms_key_id,
use_json=use_json,
force_upload=force_upload,
metadata=metadata,
on_deploy=True,
region=guided_context.guided_region if guided else region,
profile=profile,
) as package_context:
package_context.run()
with DeployContext(
template_file=output_template_file.name,
stack_name=guided_context.guided_stack_name
if guided else stack_name,
s3_bucket=guided_context.guided_s3_bucket
if guided else s3_bucket,
force_upload=force_upload,
s3_prefix=guided_context.guided_s3_prefix
if guided else s3_prefix,
kms_key_id=kms_key_id,
parameter_overrides=sanitize_parameter_overrides(
guided_context.guided_parameter_overrides)
if guided else parameter_overrides,
capabilities=guided_context.guided_capabilities
if guided else capabilities,
no_execute_changeset=no_execute_changeset,
role_arn=role_arn,
notification_arns=notification_arns,
fail_on_empty_changeset=fail_on_empty_changeset,
tags=tags,
region=guided_context.guided_region if guided else region,
profile=profile,
confirm_changeset=guided_context.confirm_changeset
if guided else confirm_changeset,
) as deploy_context:
deploy_context.run()
def do_cli(
template_file,
stack_name,
s3_bucket,
force_upload,
no_progressbar,
s3_prefix,
kms_key_id,
parameter_overrides,
capabilities,
no_execute_changeset,
role_arn,
notification_arns,
fail_on_empty_changeset,
use_json,
tags,
metadata,
guided,
confirm_changeset,
region,
profile,
signing_profiles,
resolve_s3,
config_file,
config_env,
):
from samcli.commands.package.package_context import PackageContext
from samcli.commands.deploy.deploy_context import DeployContext
from samcli.commands.deploy.guided_context import GuidedContext
from samcli.commands.deploy.exceptions import DeployResolveS3AndS3SetError
if guided:
# Allow for a guided deploy to prompt and save those details.
guided_context = GuidedContext(
template_file=template_file,
stack_name=stack_name,
s3_bucket=s3_bucket,
s3_prefix=s3_prefix,
region=region,
profile=profile,
confirm_changeset=confirm_changeset,
capabilities=capabilities,
signing_profiles=signing_profiles,
parameter_overrides=parameter_overrides,
config_section=CONFIG_SECTION,
config_env=config_env,
config_file=config_file,
)
guided_context.run()
elif resolve_s3 and bool(s3_bucket):
raise DeployResolveS3AndS3SetError()
elif resolve_s3:
s3_bucket = manage_stack(profile=profile, region=region)
click.echo(f"\n\t\tManaged S3 bucket: {s3_bucket}")
click.echo(
"\t\tA different default S3 bucket can be set in samconfig.toml")
click.echo("\t\tOr by specifying --s3-bucket explicitly.")
with osutils.tempfile_platform_independent() as output_template_file:
with PackageContext(
template_file=template_file,
s3_bucket=guided_context.guided_s3_bucket
if guided else s3_bucket,
s3_prefix=guided_context.guided_s3_prefix
if guided else s3_prefix,
output_template_file=output_template_file.name,
kms_key_id=kms_key_id,
use_json=use_json,
force_upload=force_upload,
no_progressbar=no_progressbar,
metadata=metadata,
on_deploy=True,
region=guided_context.guided_region if guided else region,
profile=profile,
signing_profiles=guided_context.signing_profiles
if guided else signing_profiles,
) as package_context:
package_context.run()
with DeployContext(
template_file=output_template_file.name,
stack_name=guided_context.guided_stack_name
if guided else stack_name,
s3_bucket=guided_context.guided_s3_bucket
if guided else s3_bucket,
force_upload=force_upload,
no_progressbar=no_progressbar,
s3_prefix=guided_context.guided_s3_prefix
if guided else s3_prefix,
kms_key_id=kms_key_id,
parameter_overrides=sanitize_parameter_overrides(
guided_context.guided_parameter_overrides)
if guided else parameter_overrides,
capabilities=guided_context.guided_capabilities
if guided else capabilities,
no_execute_changeset=no_execute_changeset,
role_arn=role_arn,
notification_arns=notification_arns,
fail_on_empty_changeset=fail_on_empty_changeset,
tags=tags,
region=guided_context.guided_region if guided else region,
profile=profile,
confirm_changeset=guided_context.confirm_changeset
if guided else confirm_changeset,
signing_profiles=guided_context.signing_profiles
if guided else signing_profiles,
) as deploy_context:
deploy_context.run()
def do_cli(
template_file,
stack_name,
s3_bucket,
force_upload,
s3_prefix,
kms_key_id,
parameter_overrides,
capabilities,
no_execute_changeset,
role_arn,
notification_arns,
fail_on_empty_changeset,
use_json,
tags,
metadata,
guided,
confirm_changeset,
region,
profile,
):
from samcli.commands.package.package_context import PackageContext
from samcli.commands.deploy.deploy_context import DeployContext
# set capabilities and changeset decision to None, before guided gets input from the user
changeset_decision = None
_capabilities = None
_parameter_overrides = None
guided_stack_name = None
guided_s3_bucket = None
guided_s3_prefix = None
guided_region = None
if guided:
try:
_parameter_override_keys = get_template_parameters(template_file=template_file)
except ValueError as ex:
LOG.debug("Failed to parse SAM template", exc_info=ex)
raise GuidedDeployFailedError(str(ex))
read_config_showcase(template_file=template_file)
guided_stack_name, guided_s3_bucket, guided_s3_prefix, guided_region, guided_profile, changeset_decision, _capabilities, _parameter_overrides, save_to_config = guided_deploy(
stack_name, s3_bucket, region, profile, confirm_changeset, _parameter_override_keys, parameter_overrides
)
if save_to_config:
save_config(
template_file,
stack_name=guided_stack_name,
s3_bucket=guided_s3_bucket,
s3_prefix=guided_s3_prefix,
region=guided_region,
profile=guided_profile,
confirm_changeset=changeset_decision,
capabilities=_capabilities,
parameter_overrides=_parameter_overrides,
)
print_deploy_args(
stack_name=guided_stack_name if guided else stack_name,
s3_bucket=guided_s3_bucket if guided else s3_bucket,
region=guided_region if guided else region,
capabilities=_capabilities if guided else capabilities,
parameter_overrides=_parameter_overrides if guided else parameter_overrides,
confirm_changeset=changeset_decision if guided else confirm_changeset,
)
with osutils.tempfile_platform_independent() as output_template_file:
with PackageContext(
template_file=template_file,
s3_bucket=guided_s3_bucket if guided else s3_bucket,
s3_prefix=guided_s3_prefix if guided else s3_prefix,
output_template_file=output_template_file.name,
kms_key_id=kms_key_id,
use_json=use_json,
force_upload=force_upload,
metadata=metadata,
on_deploy=True,
region=guided_region if guided else region,
profile=profile,
) as package_context:
package_context.run()
with DeployContext(
template_file=output_template_file.name,
stack_name=guided_stack_name if guided else stack_name,
s3_bucket=guided_s3_bucket if guided else s3_bucket,
force_upload=force_upload,
s3_prefix=guided_s3_prefix if guided else s3_prefix,
kms_key_id=kms_key_id,
parameter_overrides=sanitize_parameter_overrides(_parameter_overrides) if guided else parameter_overrides,
capabilities=_capabilities if guided else capabilities,
no_execute_changeset=no_execute_changeset,
role_arn=role_arn,
notification_arns=notification_arns,
fail_on_empty_changeset=fail_on_empty_changeset,
tags=tags,
region=guided_region if guided else region,
profile=profile,
confirm_changeset=changeset_decision if guided else confirm_changeset,
) as deploy_context:
deploy_context.run()
