class TestGuidedContext(TestCase):
def setUp(self):
self.gc = GuidedContext(
template_file="template",
stack_name="test",
s3_bucket="s3_b",
s3_prefix="s3_p",
confirm_changeset=True,
region="region",
)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
def test_guided_prompts_check_defaults(self, patched_manage_stack, patched_confirm, patched_prompt):
# Series of inputs to confirmations so that full range of questions are asked.
patched_confirm.side_effect = [True, False, "", True]
patched_manage_stack.return_value = "managed_s3_stack"
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Save arguments to samconfig.toml{self.gc.end_bold}", default=True),
]
self.assertEqual(expected_confirmation_calls, patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}", default="test", type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}", default="region", type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}", default=["CAPABILITY_IAM"], type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
def setUp(self):
self.gc = GuidedContext(
template_file="template",
stack_name="test",
s3_bucket="s3_b",
s3_prefix="s3_p",
confirm_changeset=True,
region="region",
)
def setUp(self):
self.gc = GuidedContext(
template_file="template",
stack_name="test",
s3_bucket="s3_b",
s3_prefix="s3_p",
confirm_changeset=True,
region="region",
image_repository=None,
image_repositories={"HelloWorldFunction": "image-repo"},
)
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()
class TestGuidedContext(TestCase):
def setUp(self):
self.gc = GuidedContext(
template_file="template",
stack_name="test",
s3_bucket="s3_b",
s3_prefix="s3_p",
confirm_changeset=True,
region="region",
)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_defaults_non_public_resources(
self,
patched_signer_config_per_function,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [
("HelloWorldFunction", True),
]
patched_confirm.side_effect = [True, False, "", True]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}", default=True),
]
self.assertEqual(expected_confirmation_calls, patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}", default="test", type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}", default="region", type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}", default=["CAPABILITY_IAM"], type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_defaults_public_resources(
self,
patched_signer_config_per_function,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}", default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}", default=True),
]
self.assertEqual(expected_confirmation_calls, patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}", default="test", type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}", default="region", type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}", default=["CAPABILITY_IAM"], type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@parameterized.expand(
[
param((("CAPABILITY_IAM",),)),
param((("CAPABILITY_AUTO_EXPAND",),)),
param(
(
(
"CAPABILITY_AUTO_EXPAND",
"CAPABILITY_IAM",
),
)
),
]
)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_with_given_capabilities(
self,
given_capabilities,
patched_signer_config_per_function,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
patched_signer_config_per_function.return_value = ({}, {})
self.gc.capabilities = given_capabilities
# Series of inputs to confirmations so that full range of questions are asked.
patched_confirm.side_effect = [True, False, "", True]
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}", default=True),
]
self.assertEqual(expected_confirmation_calls, patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_capabilities = list(given_capabilities[0])
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}", default="test", type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}", default="region", type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}", default=expected_capabilities, type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_configuration_file_prompt_calls(
self,
patched_signer_config_per_function,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, True, ""]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}", default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}", default=True),
]
self.assertEqual(expected_confirmation_calls, patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}", default="test", type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}", default="region", type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}", default=["CAPABILITY_IAM"], type=ANY),
call(
f"\t{self.gc.start_bold}SAM configuration file{self.gc.end_bold}",
default="samconfig.toml",
type=click.STRING,
),
call(
f"\t{self.gc.start_bold}SAM configuration environment{self.gc.end_bold}",
default="default",
type=click.STRING,
),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_parameter_from_template(
self,
patched_signer_config_per_function,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
parameter_override_from_template = {"MyTestKey": {"Default": "MyTemplateDefaultVal"}}
self.gc.parameter_overrides_from_cmdline = {}
self.gc.guided_prompts(parameter_override_keys=parameter_override_from_template)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}", default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}", default=True),
]
self.assertEqual(expected_confirmation_calls, patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}", default="test", type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}", default="region", type=click.STRING),
call(
f"\t{self.gc.start_bold}Parameter MyTestKey{self.gc.end_bold}",
default="MyTemplateDefaultVal",
type=click.STRING,
),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}", default=["CAPABILITY_IAM"], type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_parameter_from_cmd_or_config(
self,
patched_signer_config_per_function,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
parameter_override_from_template = {"MyTestKey": {"Default": "MyTemplateDefaultVal"}}
self.gc.parameter_overrides_from_cmdline = {"MyTestKey": "OverridedValFromCmdLine", "NotUsedKey": "NotUsedVal"}
self.gc.guided_prompts(parameter_override_keys=parameter_override_from_template)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}", default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}", default=True),
]
self.assertEqual(expected_confirmation_calls, patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}", default="test", type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}", default="region", type=click.STRING),
call(
f"\t{self.gc.start_bold}Parameter MyTestKey{self.gc.end_bold}",
default="OverridedValFromCmdLine",
type=click.STRING,
),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}", default=["CAPABILITY_IAM"], type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@parameterized.expand(
[
(False, ({"MyFunction1"}, {})),
(True, ({"MyFunction1"}, {})),
(True, ({"MyFunction1", "MyFunction2"}, {})),
(True, ({"MyFunction1"}, {"MyLayer1": {"MyFunction1"}})),
(True, ({"MyFunction1"}, {"MyLayer1": {"MyFunction1"}, "MyLayer2": {"MyFunction1"}})),
]
)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.code_signer_utils.prompt")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_with_code_signing(
self,
given_sign_packages_flag,
given_code_signing_configs,
patched_signer_config_per_function,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_code_signer_prompt,
patched_confirm,
patched_prompt,
):
patched_signer_config_per_function.return_value = given_code_signing_configs
# Series of inputs to confirmations so that full range of questions are asked.
patched_confirm.side_effect = [True, False, given_sign_packages_flag, "", True]
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}", default=True),
call(f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}", default=True),
call(
f"\t{self.gc.start_bold}Do you want to sign your code?{self.gc.end_bold}",
default=True,
),
call(f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}", default=True),
]
self.assertEqual(expected_confirmation_calls, patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}", default="test", type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}", default="region", type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}", default=["CAPABILITY_IAM"], type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
if given_sign_packages_flag:
# we are going to expect prompts for functions and layers for each one of them,
# so multiply the number of prompt calls
number_of_functions = len(given_code_signing_configs[0])
number_of_layers = len(given_code_signing_configs[1])
expected_code_sign_calls = [
call(f"\t{self.gc.start_bold}Signing Profile Name{self.gc.end_bold}", default=None, type=click.STRING),
call(
f"\t{self.gc.start_bold}Signing Profile Owner Account ID (optional){self.gc.end_bold}",
default="",
type=click.STRING,
show_default=False,
),
]
expected_code_sign_calls = expected_code_sign_calls * (number_of_functions + number_of_layers)
self.assertEqual(expected_code_sign_calls, patched_code_signer_prompt.call_args_list)
class TestGuidedContext(TestCase):
def setUp(self):
self.gc = GuidedContext(
template_file="template",
stack_name="test",
s3_bucket="s3_b",
s3_prefix="s3_p",
confirm_changeset=True,
region="region",
image_repository=None,
image_repositories={"HelloWorldFunction": "image-repo"},
)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_defaults_non_public_resources_zips(
self,
patched_signer_config_per_function,
patched_transform_template,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
patched_transform_template.return_value = {}
patched_get_template_artifacts_format.return_value = [ZIP]
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [
("HelloWorldFunction", True),
]
patched_confirm.side_effect = [True, False, "", True]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_defaults_public_resources_zips(
self,
patched_signer_config_per_function,
patched_transform_template,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
patched_signer_config_per_function.return_value = (None, None)
patched_transform_template.return_value = {}
patched_get_template_artifacts_format.return_value = [ZIP]
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_function_resource_ids"
)
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.click.secho")
@patch("samcli.commands.deploy.guided_context.tag_translation")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_defaults_public_resources_images(
self,
patched_signer_config_per_function,
patched_tag_translation,
patched_click_secho,
patched_transform_template,
patched_get_template_artifacts_format,
mock_get_template_function_resource_ids,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
mock_get_template_function_resource_ids.return_value = [
"HelloWorldFunction"
]
patched_signer_config_per_function.return_value = (None, None)
patched_tag_translation.return_value = "helloworld-123456-v1"
patched_transform_template.return_value = MagicMock(
functions={
"HelloWorldFunction":
MagicMock(packagetype=IMAGE, imageuri="helloworld:v1")
})
patched_get_template_artifacts_format.return_value = [IMAGE]
patched_prompt.side_effect = [
"sam-app",
"region",
"123456789012.dkr.ecr.region.amazonaws.com/myrepo",
"CAPABILITY_IAM",
]
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(
f"\t{self.gc.start_bold}Image Repository for HelloWorldFunction{self.gc.end_bold}",
default="image-repo",
),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
# Now to check click secho outputs
print(expected_prompt_calls)
print(patched_prompt.call_args_list)
expected_click_secho_calls = [
call(
f"\t helloworld:v1 to be pushed to 123456789012.dkr.ecr.region.amazonaws.com/myrepo:helloworld-123456-v1"
),
call(nl=True),
call(
"\t#Shows you resources changes to be deployed and require a 'Y' to initiate deploy"
),
call(
"\t#SAM needs permission to be able to create roles to connect to the resources in your template"
),
]
self.assertEqual(expected_click_secho_calls,
patched_click_secho.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch(
"samcli.commands.deploy.guided_context.get_template_function_resource_ids"
)
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.click.secho")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_defaults_public_resources_images_ecr_url(
self,
patched_signer_config_per_function,
patched_click_secho,
patched_transform_template,
mock_get_template_function_resource_ids,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
mock_get_template_function_resource_ids.return_value = [
"HelloWorldFunction"
]
patched_transform_template.return_value = MagicMock(
functions={
"HelloWorldFunction":
MagicMock(
packagetype=IMAGE,
imageuri="123456789012.dkr.ecr.region.amazonaws.com/myrepo"
)
})
patched_get_template_artifacts_format.return_value = [IMAGE]
patched_prompt.side_effect = [
"sam-app",
"region",
"123456789012.dkr.ecr.region.amazonaws.com/myrepo",
"CAPABILITY_IAM",
]
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(
f"\t{self.gc.start_bold}Image Repository for HelloWorldFunction{self.gc.end_bold}",
default="image-repo",
),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
# Now to check click secho outputs and no references to images pushed.
expected_click_secho_calls = [
call(nl=True),
call(
"\t#Shows you resources changes to be deployed and require a 'Y' to initiate deploy"
),
call(
"\t#SAM needs permission to be able to create roles to connect to the resources in your template"
),
]
self.assertEqual(expected_click_secho_calls,
patched_click_secho.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch(
"samcli.commands.deploy.guided_context.get_template_function_resource_ids"
)
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.click.secho")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_images_no_image_uri(
self,
patched_signer_config_per_function,
patched_click_secho,
patched_transform_template,
mock_get_template_function_resource_ids,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
mock_get_template_function_resource_ids.return_value = [
"HelloWorldFunction"
]
# Set ImageUri to be None, the sam app was never built.
patched_transform_template.return_value = MagicMock(functions={
"HelloWorldFunction":
MagicMock(packagetype=IMAGE, imageuri=None)
})
patched_get_template_artifacts_format.return_value = [IMAGE]
patched_prompt.side_effect = [
"sam-app",
"region",
"123456789012.dkr.ecr.region.amazonaws.com/myrepo",
"CAPABILITY_IAM",
]
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
with self.assertRaises(GuidedDeployFailedError):
self.gc.guided_prompts(parameter_override_keys=None)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch(
"samcli.commands.deploy.guided_context.get_template_function_resource_ids"
)
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.click.secho")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_images_blank_image_repository(
self,
patched_signer_config_per_function,
patched_click_secho,
patched_transform_template,
mock_get_template_function_resource_ids,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
mock_get_template_function_resource_ids.return_value = [
"HelloWorldFunction"
]
patched_transform_template.return_value = MagicMock(
functions={
"HelloWorldFunction":
MagicMock(packagetype=IMAGE, imageuri="mysamapp:v1")
})
patched_get_template_artifacts_format.return_value = [IMAGE]
# set Image repository to be blank.
patched_prompt.side_effect = [
"sam-app",
"region",
"",
]
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
with self.assertRaises(GuidedDeployFailedError):
self.gc.guided_prompts(parameter_override_keys=None)
@parameterized.expand([
param((("CAPABILITY_IAM", ), )),
param((("CAPABILITY_AUTO_EXPAND", ), )),
param(((
"CAPABILITY_AUTO_EXPAND",
"CAPABILITY_IAM",
), )),
])
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_with_given_capabilities(
self,
given_capabilities,
patched_signer_config_per_function,
patched_transform_template,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
patched_signer_config_per_function.return_value = ({}, {})
self.gc.capabilities = given_capabilities
# Series of inputs to confirmations so that full range of questions are asked.
patched_confirm.side_effect = [True, False, "", True]
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_capabilities = list(given_capabilities[0])
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=expected_capabilities,
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_configuration_file_prompt_calls(
self,
patched_signer_config_per_function,
patched_transform_template,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
patched_transform_template.return_value = {}
patched_get_template_artifacts_format.return_value = [ZIP]
patched_signer_config_per_function.return_value = ({}, {})
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, True, ""]
patched_manage_stack.return_value = "managed_s3_stack"
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
call(
f"\t{self.gc.start_bold}SAM configuration file{self.gc.end_bold}",
default="samconfig.toml",
type=click.STRING,
),
call(
f"\t{self.gc.start_bold}SAM configuration environment{self.gc.end_bold}",
default="default",
type=click.STRING,
),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_parameter_from_template(
self,
patched_signer_config_per_function,
patched_transform_template,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
patched_transform_template.return_value = {}
patched_get_template_artifacts_format.return_value = [ZIP]
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
patched_signer_config_per_function.return_value = ({}, {})
parameter_override_from_template = {
"MyTestKey": {
"Default": "MyTemplateDefaultVal"
}
}
self.gc.parameter_overrides_from_cmdline = {}
self.gc.guided_prompts(
parameter_override_keys=parameter_override_from_template)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(
f"\t{self.gc.start_bold}Parameter MyTestKey{self.gc.end_bold}",
default="MyTemplateDefaultVal",
type=click.STRING,
),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_parameter_from_cmd_or_config(
self,
patched_signer_config_per_function,
patched_transform_template,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
patched_transform_template.return_value = {}
patched_get_template_artifacts_format.return_value = [ZIP]
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_signer_config_per_function.return_value = ({}, {})
patched_manage_stack.return_value = "managed_s3_stack"
parameter_override_from_template = {
"MyTestKey": {
"Default": "MyTemplateDefaultVal"
}
}
self.gc.parameter_overrides_from_cmdline = {
"MyTestKey": "OverridedValFromCmdLine",
"NotUsedKey": "NotUsedVal"
}
self.gc.guided_prompts(
parameter_override_keys=parameter_override_from_template)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(
f"\t{self.gc.start_bold}Parameter MyTestKey{self.gc.end_bold}",
default="OverridedValFromCmdLine",
type=click.STRING,
),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@parameterized.expand([
(False, ({"MyFunction1"}, {})),
(True, ({"MyFunction1"}, {})),
(True, ({"MyFunction1", "MyFunction2"}, {})),
(True, ({"MyFunction1"}, {
"MyLayer1": {"MyFunction1"}
})),
(True, ({"MyFunction1"}, {
"MyLayer1": {"MyFunction1"},
"MyLayer2": {"MyFunction1"}
})),
])
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.code_signer_utils.prompt")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch("samcli.commands.deploy.guided_context.transform_template")
def test_guided_prompts_with_code_signing(
self,
given_sign_packages_flag,
given_code_signing_configs,
patched_transform_template,
patched_get_template_artifacts_format,
patched_signer_config_per_function,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_code_signer_prompt,
patched_confirm,
patched_prompt,
):
# given_sign_packages_flag = True
# given_code_signing_configs = ({"MyFunction1"}, {"MyLayer1": {"MyFunction1"}, "MyLayer2": {"MyFunction1"}})
patched_transform_template.return_value = {}
patched_get_template_artifacts_format.return_value = [ZIP]
patched_signer_config_per_function.return_value = given_code_signing_configs
# Series of inputs to confirmations so that full range of questions are asked.
patched_confirm.side_effect = [
True, False, given_sign_packages_flag, "", True
]
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Do you want to sign your code?{self.gc.end_bold}",
default=True,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
if given_sign_packages_flag:
# we are going to expect prompts for functions and layers for each one of them,
# so multiply the number of prompt calls
number_of_functions = len(given_code_signing_configs[0])
number_of_layers = len(given_code_signing_configs[1])
expected_code_sign_calls = [
call(
f"\t{self.gc.start_bold}Signing Profile Name{self.gc.end_bold}",
default=None,
type=click.STRING),
call(
f"\t{self.gc.start_bold}Signing Profile Owner Account ID (optional){self.gc.end_bold}",
default="",
type=click.STRING,
show_default=False,
),
]
expected_code_sign_calls = expected_code_sign_calls * (
number_of_functions + number_of_layers)
self.assertEqual(expected_code_sign_calls,
patched_code_signer_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.get_session")
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
@patch(
"samcli.commands.deploy.guided_context.get_template_artifacts_format")
@patch("samcli.commands.deploy.guided_context.transform_template")
@patch("samcli.commands.deploy.guided_context.signer_config_per_function")
def test_guided_prompts_check_default_config_region(
self,
patched_signer_config_per_function,
patched_transform_template,
patched_get_template_artifacts_format,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
patched_get_session,
):
patched_transform_template.return_value = {}
patched_get_template_artifacts_format.return_value = [ZIP]
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, True, ""]
patched_signer_config_per_function.return_value = ({}, {})
patched_manage_stack.return_value = "managed_s3_stack"
patched_get_session.return_value.get_config_variable.return_value = "default_config_region"
# setting the default region to None
self.gc.region = None
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(
f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="default_config_region",
type=click.STRING,
),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
call(
f"\t{self.gc.start_bold}SAM configuration file{self.gc.end_bold}",
default="samconfig.toml",
type=click.STRING,
),
call(
f"\t{self.gc.start_bold}SAM configuration environment{self.gc.end_bold}",
default="default",
type=click.STRING,
),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
class TestGuidedContext(TestCase):
def setUp(self):
self.gc = GuidedContext(
template_file="template",
stack_name="test",
s3_bucket="s3_b",
s3_prefix="s3_p",
confirm_changeset=True,
region="region",
)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
def test_guided_prompts_check_defaults_non_public_resources(
self, patched_get_template_data, patchedauth_per_resource,
patched_manage_stack, patched_confirm, patched_prompt):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [
("HelloWorldFunction", True),
]
patched_confirm.side_effect = [True, False, "", True]
patched_manage_stack.return_value = "managed_s3_stack"
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
def test_guided_prompts_check_defaults_public_resources(
self, patched_get_template_data, patchedauth_per_resource,
patched_manage_stack, patched_confirm, patched_prompt):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@parameterized.expand([
param((("CAPABILITY_IAM", ), )),
param((("CAPABILITY_AUTO_EXPAND", ), )),
param(((
"CAPABILITY_AUTO_EXPAND",
"CAPABILITY_IAM",
), )),
])
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
def test_guided_prompts_with_given_capabilities(
self,
given_capabilities,
patched_get_template_data,
patchedauth_per_resource,
patched_manage_stack,
patched_confirm,
patched_prompt,
):
self.gc.capabilities = given_capabilities
# Series of inputs to confirmations so that full range of questions are asked.
patched_confirm.side_effect = [True, False, "", True]
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
# Now to check for all the defaults on prompts.
expected_capabilities = list(given_capabilities[0])
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=expected_capabilities,
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
def test_guided_prompts_check_configuration_file_prompt_calls(
self, patched_get_template_data, patchedauth_per_resource,
patched_manage_stack, patched_confirm, patched_prompt):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, True, ""]
patched_manage_stack.return_value = "managed_s3_stack"
self.gc.guided_prompts(parameter_override_keys=None)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
call(
f"\t{self.gc.start_bold}SAM configuration file{self.gc.end_bold}",
default="samconfig.toml",
type=click.STRING,
),
call(
f"\t{self.gc.start_bold}SAM configuration environment{self.gc.end_bold}",
default="default",
type=click.STRING,
),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
def test_guided_prompts_check_parameter_from_template(
self, patched_get_template_data, patchedauth_per_resource,
patched_manage_stack, patched_confirm, patched_prompt):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
parameter_override_from_template = {
"MyTestKey": {
"Default": "MyTemplateDefaultVal"
}
}
self.gc.parameter_overrides_from_cmdline = {}
self.gc.guided_prompts(
parameter_override_keys=parameter_override_from_template)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(
f"\t{self.gc.start_bold}Parameter MyTestKey{self.gc.end_bold}",
default="MyTemplateDefaultVal",
type=click.STRING,
),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)
@patch("samcli.commands.deploy.guided_context.prompt")
@patch("samcli.commands.deploy.guided_context.confirm")
@patch("samcli.commands.deploy.guided_context.manage_stack")
@patch("samcli.commands.deploy.guided_context.auth_per_resource")
@patch("samcli.commands.deploy.guided_context.get_template_data")
def test_guided_prompts_check_parameter_from_cmd_or_config(
self, patched_get_template_data, patchedauth_per_resource,
patched_manage_stack, patched_confirm, patched_prompt):
# Series of inputs to confirmations so that full range of questions are asked.
patchedauth_per_resource.return_value = [("HelloWorldFunction", False)]
patched_confirm.side_effect = [True, False, True, False, ""]
patched_manage_stack.return_value = "managed_s3_stack"
parameter_override_from_template = {
"MyTestKey": {
"Default": "MyTemplateDefaultVal"
}
}
self.gc.parameter_overrides_from_cmdline = {
"MyTestKey": "OverridedValFromCmdLine",
"NotUsedKey": "NotUsedVal"
}
self.gc.guided_prompts(
parameter_override_keys=parameter_override_from_template)
# Now to check for all the defaults on confirmations.
expected_confirmation_calls = [
call(
f"\t{self.gc.start_bold}Confirm changes before deploy{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}Allow SAM CLI IAM role creation{self.gc.end_bold}",
default=True),
call(
f"\t{self.gc.start_bold}HelloWorldFunction may not have authorization defined, Is this okay?{self.gc.end_bold}",
default=False,
),
call(
f"\t{self.gc.start_bold}Save arguments to configuration file{self.gc.end_bold}",
default=True),
]
self.assertEqual(expected_confirmation_calls,
patched_confirm.call_args_list)
expected_prompt_calls = [
call(f"\t{self.gc.start_bold}Stack Name{self.gc.end_bold}",
default="test",
type=click.STRING),
call(f"\t{self.gc.start_bold}AWS Region{self.gc.end_bold}",
default="region",
type=click.STRING),
call(
f"\t{self.gc.start_bold}Parameter MyTestKey{self.gc.end_bold}",
default="OverridedValFromCmdLine",
type=click.STRING,
),
call(f"\t{self.gc.start_bold}Capabilities{self.gc.end_bold}",
default=["CAPABILITY_IAM"],
type=ANY),
]
self.assertEqual(expected_prompt_calls, patched_prompt.call_args_list)