runway.cfngin.actions.diff module

CFNgin diff action.

class runway.cfngin.actions.diff.DictValue(key: str, old_value: _OV, new_value: _NV)[source]

Bases: Generic[runway.cfngin.actions.diff._OV, runway.cfngin.actions.diff._NV]

Used to create a diff of two dictionaries.

Instantiate class.

__eq__(other: object)bool[source]

Compare if self is equal to another object.

changes()List[str][source]

Return changes to represent the diff between old and new value.

Returns

Representation of the change (if any) between old and new value.

status()str[source]

Status of changes between the old value and new value.

runway.cfngin.actions.diff.diff_dictionaries(old_dict: Dict[str, _OV], new_dict: Dict[str, _NV])Tuple[int, List[DictValue[_OV, _NV]]][source]

Calculate the diff two single dimension dictionaries.

Parameters
  • old_dict – Old dictionary.

  • new_dict – New dictionary.

Returns

Number of changed records and the DictValue object containing the changes.

runway.cfngin.actions.diff.format_params_diff(parameter_diff: List[DictValue[Any, Any]])str[source]

Handle the formatting of differences in parameters.

Parameters

parameter_diff – A list of DictValue detailing the differences between two dicts returned by diff_dictionaries().

Returns

A formatted string that represents a parameter diff

runway.cfngin.actions.diff.diff_parameters(old_params: Dict[str, _OV], new_params: Dict[str, _NV])List[DictValue[_OV, _NV]][source]

Compare the old vs. new parameters and returns a “diff”.

If there are no changes, we return an empty list.

Parameters
  • old_params – old paramters

  • new_params – new parameters

Returns

A list of differences.

class runway.cfngin.actions.diff.Action(context: CfnginContext, provider_builder: Optional[ProviderBuilder] = None, cancel: Optional[threading.Event] = None)[source]

Bases: runway.cfngin.actions.deploy.Action

Responsible for diffing CloudFormation stacks in AWS and locally.

Generates the deploy plan based on stack dependencies (these dependencies are determined automatically based on references to output values from other stacks).

The plan is then used to create a changeset for a stack using a generated template based on the current config.

Instantiate class.

Parameters
  • context – The context for the current run.

  • provider_builder – An object that will build a provider that will be interacted with in order to perform the necessary actions.

  • cancel – Cancel handler.

run(*, concurrency: int = 0, dump: Union[bool, str] = False, force: bool = False, outline: bool = False, tail: bool = False, **_kwargs: typing.Any)None[source]

Kicks off the diffing of the stacks in the stack_definitions.

pre_run(*, dump: Union[bool, str] = False, outline: bool = False, **_Action__kwargs: typing.Any)None[source]

Any steps that need to be taken prior to running the action.

Handle CFNgin bucket access denied & not existing.

post_run(*, dump: Union[bool, str] = False, outline: bool = False, **_Action__kwargs: typing.Any)None[source]

Do nothing.

static build_parameters(stack: Stack, provider_stack: Optional[StackTypeDef] = None)List[ParameterTypeDef][source]

Build the CloudFormation Parameters for our stack.

Parameters
  • stack – A CFNgin stack.

  • provider_stack – An optional CFNgin provider object.

Returns

The parameters for the given stack

build_provider()Provider

Build a CFNgin provider.

ensure_cfn_bucket()None

CloudFormation bucket where templates will be stored.

execute(**kwargs: typing.Any)None

Run the action with pre and post steps.

property provider

Return a generic provider using the default region.

Used for running things like hooks.

s3_stack_push(blueprint: Blueprint, force: bool = False)str

Push the rendered blueprint’s template to S3.

Verifies that the template doesn’t already exist in S3 before pushing.

Returns

URL to the template in S3.

stack_template_url(blueprint: Blueprint)str

S3 URL for CloudFormation template object.