feat(data-classes): support for code pipeline job event

[michaelbrewer]

Issue #, if available:

https://github.com/awslabs/aws-lambda-powertools-python/issues/414

Description of changes:

Add support for CodePipeline Job event data class

Code example based on the docs:

• Sample Python function that uses an AWS CloudFormation template

from aws_lambda_powertools import Logger
from aws_lambda_powertools.utilities.data_classes import CodePipelineJobEvent
logger = Logger()
def lambda_handler(event, context):
    """The Lambda function handler
    If a continuing job then checks the CloudFormation stack status
    and updates the job accordingly.
    If a new job then kick of an update or creation of the target
    CloudFormation stack.
    """
    event: CodePipelineJobEvent = CodePipelineJobEvent(event)
    # Extract the Job ID
    job_id = event.get_id
    # Extract the params
    params: dict = event.decoded_user_parameters
    stack = params["stack"]
    artifact_name = params["artifact"]
    template_file = params["file"]
    try:
        if event.data.continuation_token:
            # If we're continuing then the create/update has already been triggered
            # we just need to check if it has finished.
            check_stack_update_status(job_id, stack)
        else:
            # down from S3 using the credentials
            template = event.get_artifact(artifact_name, template_file)
            # Kick off a stack update or create
            start_update_or_create(job_id, stack, template)
    except Exception as e:
        # If any other exceptions which we didn't expect are raised
        # then fail the job and log the exception message.
        logger.exception("Function failed due to exception.")
        put_job_failure(job_id, "Function exception: " + str(e))
    logger.debug("Function complete.")
    return "Complete."

Checklist

• Meet tenets criteria
• Update tests
• Update docs
• Helper functions
• PR title follows conventional commit semantics

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[codecov-commenter]

Codecov Report

Merging #416 (93f92a7) into develop (93fad02) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##           develop     #416    +/-   ##
=========================================
  Coverage    99.89%   99.90%            
=========================================
  Files          101      102     +1     
  Lines         3996     4117   +121     
  Branches       199      204     +5     
=========================================
+ Hits          3992     4113   +121     
  Misses           1        1            
  Partials         3        3            

Impacted Files	Coverage Δ
...mbda_powertools/utilities/data_classes/__init__.py	100.00% <100.00%> (ø)
.../utilities/data_classes/code_pipeline_job_event.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 93fad02...93f92a7. Read the comment docs.

[heitorlessa]

Lemme know when it's ready. I think you mentioned about adding an UTF decode before finalizing the implementation

[michaelbrewer]

@heitorlessa i added some docs for this. So i think it is ready :)

[michaelbrewer]

@jplock if you want to have a look too

[michaelbrewer]

@heitorlessa anything missing here?

[heitorlessa]

Hey! I’ll look it over tomorrow ;-) I’d like to make a minor release tomorrow to get this out to everyone - it’d be nice to have some UX examples in the PR description to make it easier to release and make this stand out

…

On Thu, 13 May 2021 at 18:46, Michael Brewer ***@***.***> wrote: @heitorlessa <https://github.com/heitorlessa> anything missing here? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#416 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZPQBEBAEN2TUJRV23FCX3TNP67XANCNFSM44B4Z45A> .

[heitorlessa]

Thanks a lot for working on this!

Note to self - Find a better name for this utility in 2.0, something like event source