Merge pull request #7 from awslabs/unzip-s3

Unzip stream of bytes from s3 and log job result in lambda

Author: Simon2228

src/codepipelinehelper.py

@@ -16,7 +16,7 @@ def put_job_success(job_id, sar_response):
         job_id {str} -- The unique ID for the job generated by AWS CodePipeline
         sar_response {dict} -- The result from invoking serverlessrepo.publish_application()
     """
-    LOG.info('Putting job success result...')
+    LOG.info('Putting job success result=%s', sar_response)
     CODEPIPELINE.put_job_success_result(
         jobId=job_id,
         executionDetails={
@@ -33,7 +33,7 @@ def put_job_failure(job_id, e):
         job_id {str} -- The unique ID for the job generated by AWS CodePipeline
         e {Exception} -- The exception from invoking serverlessrepo.publish_application()
     """
-    LOG.info('Putting job failure result...')
+    LOG.info('Putting job failure result=%s', e)
     CODEPIPELINE.put_job_failure_result(
         jobId=job_id,
         failureDetails={

src/s3helper.py

@@ -3,6 +3,8 @@
 import lambdalogging
 
 import boto3
+import zipfile
+import io
 
 LOG = lambdalogging.getLogger(__name__)
 
@@ -35,8 +37,10 @@ def get_input_artifact(event):
     key = artifact_s3_location['objectKey']
 
     response = S3.get_object(Bucket=bucket, Key=key)
-    LOG.info('{}/{} fetched. {} bytes.', bucket, key, response['ContentLength'])
-    return response.get('Body').read().decode(response['ContentLength'])
+    LOG.info('%s/%s fetched. %s bytes.', bucket, key, response['ContentLength'])
+
+    zipped_content_as_bytes = response.get('Body').read()
+    return _unzip_as_string(zipped_content_as_bytes)
 
 
 def _find_artifact_in_list(input_artifacts):
@@ -58,3 +62,18 @@ def _find_artifact_in_list(input_artifacts):
             return artifact
 
     raise RuntimeError('Unable to find the artifact with name ' + PACKAGED_TEMPLATE)
+
+
+def _unzip_as_string(data):
+    """Unzip stream of data in bytes as string.
+
+    Arguments:
+        data {bytes} -- Zipped data as bytes
+
+    Returns:
+        str -- Unzipped data as string
+
+    """
+    z = zipfile.ZipFile(io.BytesIO(data))
+    unzipped_data = z.read(z.infolist()[0])
+    return unzipped_data.decode()

test/unit/test_s3helper.py

@@ -14,30 +14,43 @@ def mock_boto3(mocker):
     return s3helper.boto3
 
 
-def test_get_input_artifact(mock_boto3):
+@pytest.fixture
+def mock_zipfile(mocker):
+    mocker.patch.object(s3helper, 'zipfile')
+    return s3helper.zipfile
+
+
+def test_get_input_artifact(mock_boto3, mock_zipfile):
+    zipped_content_as_bytes = b'zipped_packaged_template_content'
+    expected_result = 'packaged_template_content'
+
     mock_s3 = MagicMock()
     mock_boto3.client.return_value = mock_s3
-    mock_s3.get_object.return_value.get.return_value.read.return_value.decode.return_value = 'packaged_template_content'
+    mock_s3.get_object.return_value.get.return_value.read.return_value = zipped_content_as_bytes
+    mock_zipfile_object = MagicMock()
+    mock_zipfile.ZipFile.return_value = mock_zipfile_object
+    mock_zipfile_object.read.return_value = bytes(expected_result, encoding='utf-8')
 
-    s3helper.get_input_artifact(mock_codepipeline_event)
+    assert s3helper.get_input_artifact(mock_codepipeline_event) == expected_result
 
     mock_s3.get_object.assert_called_once_with(
         Bucket='sample-pipeline-artifact-store-bucket',
         Key='sample-artifact-key'
     )
 
 
-def test_get_input_artifact_unable_to_find_artifact(mock_boto3):
+def test_get_input_artifact_unable_to_find_artifact(mock_boto3, mock_zipfile):
     mock_s3 = MagicMock()
     mock_boto3.client.return_value = mock_s3
 
     with pytest.raises(RuntimeError, match='Unable to find the artifact with name ' + s3helper.PACKAGED_TEMPLATE):
         s3helper.get_input_artifact(mock_codepipeline_event_no_artifact_found)
 
     mock_s3.get_object.assert_not_called()
+    mock_zipfile.assert_not_called()
 
 
-def test_get_input_artifact_unable_to_get_artifact(mock_boto3):
+def test_get_input_artifact_unable_to_get_artifact(mock_boto3, mock_zipfile):
     exception_thrown = ClientError(
         {
             "Error": {
@@ -59,3 +72,4 @@ def test_get_input_artifact_unable_to_get_artifact(mock_boto3):
         Bucket='sample-pipeline-artifact-store-bucket',
         Key='sample-artifact-key'
     )
+    mock_zipfile.assert_not_called()