Source code for runway.core.components._deployment

"""Runway deployment object."""
import logging
import sys
from typing import (  # noqa pylint: disable=W

import six

from ..._logging import PrefixAdaptor
from ...cfngin.exceptions import UnresolvedVariable
from ...config import FutureDefinition, VariablesDefinition
from ...util import cached_property, merge_dicts, merge_nested_environment_dicts
from ..providers import aws
from ._module import Module

if sys.version_info.major > 2:
    import concurrent.futures

    from ...config import DeploymentDefinition  # pylint: disable=W
    from ...context import Context  # pylint: disable=W

LOGGER = logging.getLogger(__name__.replace("._", "."))

[docs]class Deployment(object): """Runway deployment.""" def __init__( self, context, # type: Context definition, # type: DeploymentDefinition future=None, # type: Optional[FutureDefinition] variables=None, # type: VariablesDefinition ): # type: (...) -> None """Instantiate class. Args: context (Context): Runway context object. definition (DeploymentDefinition): A single deployment definition. future (Optional[FutureDefinition]): Future functionality configuration. variables (VariablesDefinition): Runway variables. """ self._future = future or FutureDefinition() self._variables = variables or VariablesDefinition() self.definition = definition self.ctx = context = self.logger = PrefixAdaptor(, LOGGER) self.__merge_env_vars() @property def account_alias_config(self): # type: () -> Optional[str] """Parse the definition to get the correct AWS account alias configuration. Returns: Optional[str]: Expected AWS account alias for the current context. """ if isinstance(self.definition.account_alias, six.string_types): return self.definition.account_alias if isinstance(self.definition.account_alias, dict): return self.definition.account_alias.get( return None @property def account_id_config(self): # type: () -> Optional[str] """Parse the definition to get the correct AWS account ID configuration. Returns: Optional[str]: Expected AWS account ID for the current context. """ if isinstance(self.definition.account_id, (int, six.string_types)): return str(self.definition.account_id) if isinstance(self.definition.account_id, dict): result = self.definition.account_id.get( if result: return str(result) return None @property def assume_role_config(self): # type: () -> Dict[str, Union[int, str]] """Parse the definition to get the correct assume role configuration. Returns: Dict[str, Union[int, str]]: Assume role definition for the current context. """ assume_role = self.definition.assume_role if not assume_role: self.logger.debug( "assume_role not configured for deployment: %s", ) return {} if isinstance(assume_role, dict): top_level = { "revert_on_exit": assume_role.get("post_deploy_env_revert", False), "session_name": assume_role.get("session_name"), } if assume_role.get("arn"): self.logger.debug( "role found in the top level dict: %s", assume_role["arn"] ) return dict( role_arn=assume_role["arn"], duration_seconds=assume_role.get("duration"), **top_level ) if assume_role.get( env_assume_role = assume_role[] if isinstance(env_assume_role, dict): self.logger.debug( "role found in deploy environment dict: %s", env_assume_role["arn"], ) return dict( role_arn=env_assume_role["arn"], duration_seconds=env_assume_role.get("duration"), **top_level ) self.logger.debug("role found for environment: %s", env_assume_role) return dict(role_arn=env_assume_role, **top_level) 'skipping iam:AssumeRole; no role found for deploy environment %s"...',, ) return {} self.logger.debug("role found: %s", assume_role) return {"role_arn": assume_role, "revert_on_exit": False} @property def env_vars_config(self): # type: () -> Dict[str, Any] """Parse the definition to get the correct env_vars configuration.""" try: if not self.definition.env_vars: return {} except UnresolvedVariable: self.definition._env_vars.resolve( # pylint: disable=protected-access self.ctx, variables=self._variables ) return merge_nested_environment_dicts( self.definition.env_vars,, env_root=str(self.ctx.env.root_dir), ) @cached_property def regions(self): # type: () -> List[str] """List of regions this deployment is associated with.""" return self.definition.parallel_regions or self.definition.regions @cached_property def use_async(self): # type: () -> bool """Whether to use asynchronous method.""" return bool(self.definition.parallel_regions and self.ctx.use_concurrent)
[docs] def deploy(self): # type: () -> None """Deploy the deployment. High level method for running a deployment. """ self.logger.verbose( "attempting to deploy to region(s): %s", ", ".join(self.regions) ) if self.use_async: return self.__async("deploy") return self.__sync("deploy")
[docs] def destroy(self): # type: () -> None """Destroy the deployment. High level method for running a deployment. """ self.logger.verbose( "attempting to destroy in regions(s): %s", ", ".join(self.regions) ) if self.use_async: return self.__async("destroy") return self.__sync("destroy")
[docs] def plan(self): # type: () -> None """Plan for the next deploy of the deployment. High level method for running a deployment. """ self.logger.verbose( "attempting to plan for the next deploy to region(s): %s", ", ".join(self.regions), ) if self.use_async: self.logger.notice( "processing of regions will be done in parallel during deploy/destroy" ) return self.__sync("plan")
[docs] def run(self, action, region): # type: (str, str) -> None """Run a single deployment in a single region. Low level API access to run a deployment object. Args: action (str): Action to run (deploy, destroy, plan, etc.) region (str): AWS region to run in. """ context = self.ctx.copy() if self.use_async else self.ctx context.command = action context.env.aws_region = region with aws.AssumeRole(context, **self.assume_role_config): self.definition.resolve(context, self._variables) self.validate_account_credentials(context) Module.run_list( action=action, context=context, deployment=self.definition, future=self._future, modules=self.definition.modules, variables=self._variables, )
[docs] def validate_account_credentials(self, context=None): # type: (Optional[Context]) -> None """Exit if requested deployment account doesn't match credentials. Args: context (Optional[Context]): Context object. Raises: SystemExit: AWS Account associated with the current credentials did not match the defined criteria. """ account = aws.AccountDetails(context or self.ctx) if self.account_id_config: if self.account_id_config != self.logger.error( 'current AWS account "%s" does not match ' 'required account "%s" in Runway config',, self.account_id_config, ) sys.exit(1) "verified current AWS account matches required " 'account id "%s"', self.account_id_config, ) if self.account_alias_config: if self.account_alias_config not in account.aliases: self.logger.error( 'current AWS account aliases "%s" do not match ' 'required account alias "%s" in Runway config.', ",".join(account.aliases), self.account_alias_config, ) sys.exit(1) 'verified current AWS account alias matches required alias "%s"', self.account_alias_config, )
def __merge_env_vars(self): # type: () -> None """Merge defined env_vars into context.env_vars.""" if self.env_vars_config: self.logger.verbose( "environment variable overrides are being applied to this deployment" ) self.logger.debug( "environment variable overrides: %s", self.env_vars_config ) self.ctx.env.vars = merge_dicts(self.ctx.env.vars, self.env_vars_config) def __async(self, action): # type: (str) -> None """Execute asynchronously. Args: action (str): Name of action to run. """ "processing regions in parallel... (output will be interwoven)" ) executor = concurrent.futures.ProcessPoolExecutor( max_workers=self.ctx.env.max_concurrent_regions ) futures = [ executor.submit(, *[action, region]) for region in self.regions ] concurrent.futures.wait(futures) for job in futures: job.result() # raise exceptions / exit as needed def __sync(self, action): # type: (str) -> None """Execute synchronously. Args: action (str): Name of action to run. """"processing regions sequentially...") for region in self.regions: self.logger.verbose("processing AWS region: %s", region), region)
[docs] @classmethod def run_list( cls, action, # type: str context, # type: Context deployments, # type: List[DeploymentDefinition] future, # type: FutureDefinition variables, # type: VariablesDefinition ): # type: (...) -> None """Run a list of deployments. Args: action (str): Name of action to run. context (Context): Runway context. deployments (List[DeploymentDefinition]): List of deployments to run. future (FutureDefinition): Future definition. variables (VariablesDefinition): Runway variables for lookup resolution. """ for definition in deployments: definition.resolve(context, variables=variables, pre_process=True) deployment = cls( context=context, definition=definition, future=future, variables=variables, )"")"") deployment.logger.notice("processing deployment (in progress)") if not definition.modules: deployment.logger.warning("skipped; no modules found in definition") continue cls( context=context, definition=definition, future=future, variables=variables, )[action]() deployment.logger.success("processing deployment (complete)")
def __getitem__(self, key): """Make the object subscriptable. Args: key (str): Attribute to get. Returns: Any """ return getattr(self, key)