-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract the logic of managing SAM cloudformation stack from the the S… (
#2740) * Extract the logic of managing SAM cloudformation stack from the the S3-bucket bootstrap logic * Move ManagedStackError class to the module 'managed_cloudformation_stack'
- Loading branch information
Showing
5 changed files
with
381 additions
and
347 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| """ | ||
| Bootstrap's user's development environment by creating cloud resources required by SAM CLI | ||
| """ | ||
|
|
||
| import logging | ||
|
|
||
| import boto3 | ||
|
|
||
| import click | ||
|
|
||
| from botocore.config import Config | ||
| from botocore.exceptions import ClientError, BotoCoreError, NoRegionError, NoCredentialsError, ProfileNotFound | ||
|
|
||
| from samcli.commands.exceptions import UserException, CredentialsError, RegionError | ||
|
|
||
|
|
||
| SAM_CLI_STACK_PREFIX = "aws-sam-cli-managed-" | ||
| LOG = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| class ManagedStackError(UserException): | ||
| def __init__(self, ex): | ||
| self.ex = ex | ||
| message_fmt = f"Failed to create managed resources: {ex}" | ||
| super().__init__(message=message_fmt.format(ex=self.ex)) | ||
|
|
||
|
|
||
| def manage_stack(profile, region, stack_name, template_body): | ||
| try: | ||
| if profile: | ||
| session = boto3.Session(profile_name=profile, region_name=region if region else None) | ||
| cloudformation_client = session.client("cloudformation") | ||
| else: | ||
| cloudformation_client = boto3.client( | ||
| "cloudformation", config=Config(region_name=region if region else None) | ||
| ) | ||
| except ProfileNotFound as ex: | ||
| raise CredentialsError( | ||
| f"Error Setting Up Managed Stack Client: the provided AWS name profile '{profile}' is not found. " | ||
| "please check the documentation for setting up a named profile: " | ||
| "https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html" | ||
| ) from ex | ||
| except NoCredentialsError as ex: | ||
| raise CredentialsError( | ||
| "Error Setting Up Managed Stack Client: Unable to resolve credentials for the AWS SDK for Python client. " | ||
| "Please see their documentation for options to pass in credentials: " | ||
| "https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html" | ||
| ) from ex | ||
| except NoRegionError as ex: | ||
| raise RegionError( | ||
| "Error Setting Up Managed Stack Client: Unable to resolve a region. " | ||
| "Please provide a region via the --region parameter or by the AWS_REGION environment variable." | ||
| ) from ex | ||
| return _create_or_get_stack(cloudformation_client, stack_name, template_body) | ||
|
|
||
|
|
||
| def _create_or_get_stack(cloudformation_client, stack_name, template_body): | ||
| try: | ||
| ds_resp = cloudformation_client.describe_stacks(StackName=stack_name) | ||
| stacks = ds_resp["Stacks"] | ||
| stack = stacks[0] | ||
| click.echo("\n\tLooking for resources needed for deployment: Found!") | ||
| _check_sanity_of_stack(stack, stack_name) | ||
| return stack["Outputs"] | ||
| except ClientError: | ||
| click.echo("\n\tLooking for resources needed for deployment: Not found.") | ||
|
|
||
| try: | ||
| stack = _create_stack( | ||
| cloudformation_client, stack_name, template_body | ||
| ) # exceptions are not captured from subcommands | ||
| _check_sanity_of_stack(stack, stack_name) | ||
| return stack["Outputs"] | ||
| except (ClientError, BotoCoreError) as ex: | ||
| LOG.debug("Failed to create managed resources", exc_info=ex) | ||
| raise ManagedStackError(str(ex)) from ex | ||
|
|
||
|
|
||
| def _check_sanity_of_stack(stack, stack_name): | ||
| tags = stack.get("Tags", None) | ||
| outputs = stack.get("Outputs", None) | ||
|
|
||
| # For some edge cases, stack could be in invalid state | ||
| # Check if stack information contains the Tags and Outputs as we expected | ||
| if tags is None or outputs is None: | ||
| stack_state = stack.get("StackStatus", None) | ||
| msg = ( | ||
| f"Stack {stack_name} is missing Tags and/or Outputs information and therefore not in a " | ||
| f"healthy state (Current state:{stack_state}). Failing as the stack was likely not created " | ||
| f"by the AWS SAM CLI" | ||
| ) | ||
| raise UserException(msg) | ||
|
|
||
| # Sanity check for non-none stack? Sanity check for tag? | ||
| try: | ||
| sam_cli_tag = next(t for t in tags if t["Key"] == "ManagedStackSource") | ||
| if not sam_cli_tag["Value"] == "AwsSamCli": | ||
| msg = ( | ||
| "Stack " | ||
| + stack_name | ||
| + " ManagedStackSource tag shows " | ||
| + sam_cli_tag["Value"] | ||
| + " which does not match the AWS SAM CLI generated tag value of AwsSamCli. " | ||
| "Failing as the stack was likely not created by the AWS SAM CLI." | ||
| ) | ||
| raise UserException(msg) | ||
| except StopIteration as ex: | ||
| msg = ( | ||
| "Stack " + stack_name + " exists, but the ManagedStackSource tag is missing. " | ||
| "Failing as the stack was likely not created by the AWS SAM CLI." | ||
| ) | ||
| raise UserException(msg) from ex | ||
|
|
||
|
|
||
| def _create_stack(cloudformation_client, stack_name, template_body): | ||
| click.echo("\tCreating the required resources...") | ||
| change_set_name = "InitialCreation" | ||
| change_set_resp = cloudformation_client.create_change_set( | ||
| StackName=stack_name, | ||
| TemplateBody=template_body, | ||
| Tags=[{"Key": "ManagedStackSource", "Value": "AwsSamCli"}], | ||
| ChangeSetType="CREATE", | ||
| ChangeSetName=change_set_name, # this must be unique for the stack, but we only create so that's fine | ||
| ) | ||
| stack_id = change_set_resp["StackId"] | ||
| change_waiter = cloudformation_client.get_waiter("change_set_create_complete") | ||
| change_waiter.wait( | ||
| ChangeSetName=change_set_name, StackName=stack_name, WaiterConfig={"Delay": 15, "MaxAttempts": 60} | ||
| ) | ||
| cloudformation_client.execute_change_set(ChangeSetName=change_set_name, StackName=stack_name) | ||
| stack_waiter = cloudformation_client.get_waiter("stack_create_complete") | ||
| stack_waiter.wait(StackName=stack_id, WaiterConfig={"Delay": 15, "MaxAttempts": 60}) | ||
| ds_resp = cloudformation_client.describe_stacks(StackName=stack_name) | ||
| stacks = ds_resp["Stacks"] | ||
| click.echo("\tSuccessfully created!") | ||
| return stacks[0] |
Oops, something went wrong.