Merge lp:~thomir-deactivatedaccount/adt-cloud-worker/trunk-export-payload-metadata into lp:adt-cloud-worker

[Thomi Richards]

Add the nova-metadata file to the results tarball, which contains some metadata from the test request payload.

Add the nova-metadata file to the results tarball, which contains some metadata from the test request payload.

[lp:~thomir-deactivatedaccount/adt-cloud-worker/trunk-export-payload-metadata]

28. By Thomi Richards on 2015-03-19

Merge trunk, resolve conflicts.

[Celso Providelo (cprov)]

Thanks for implementing this.

review: Approve

[Paul Larson (pwlars)]

+1

review: Approve

=== modified file 'adt_cloud_worker/__init__.py'
--- adt_cloud_worker/__init__.py	2015-03-19 02:37:02 +0000
+++ adt_cloud_worker/__init__.py	2015-03-19 03:09:10 +0000
@@ -99,6 +99,7 @@
                 arguments = _make_adt_argument_list(adt_kwargs)
 
                 body['exit_code'] = run_adt(arguments)
+                _create_run_metadata_file(result_dir, body)
                 tarball_path = _create_tarball_from_directory(
                     result_dir,
                     'results_{}'.format(body['request_id'])
@@ -123,6 +124,30 @@
             logger.info('Done!')
 
 
+def _create_run_metadata_file(directory, request):
+    """Create a metadata file in 'directory' with some of the data from 'request'
+
+    We want to make sure that, as (potentially confidential) items are added to
+    the request that we don't blindly add them to the metadata file, so we
+    have a whitelist of keys we allow.
+
+    """
+    key_whitelist = [
+        'apt_pocket',
+        'architecture',
+        'exit_code',
+        'nova_image',
+        'package_name',
+        'platform',
+        'request_id',
+        'series',
+    ]
+    with open(os.path.join(directory, 'nova-metadata'), 'w') as outfile:
+        for key in key_whitelist:
+            if key in request:
+                outfile.write("{}\t{}\n".format(key, request[key]))
+
+
 def _validate_request_contents(request):
     """Validates that 'request' contains everything we need to process it.
 
 
=== modified file 'adt_cloud_worker/tests/test_cloud_worker.py'
--- adt_cloud_worker/tests/test_cloud_worker.py	2015-03-19 02:10:42 +0000
+++ adt_cloud_worker/tests/test_cloud_worker.py	2015-03-19 03:09:10 +0000
@@ -19,7 +19,10 @@
 import tempfile
 import tarfile
 
-from fixtures import Fixture
+from fixtures import (
+    Fixture,
+    TempDir,
+)
 import testtools
 from testtools.matchers import (
     FileExists,
@@ -32,6 +35,7 @@
     _make_adt_argument_list,
     _set_nova_environment_variables,
     _validate_request_contents,
+    _create_run_metadata_file,
 )
 
 
@@ -192,3 +196,37 @@
         _validate_request_contents(
             dict(nova_image='foo', request_id='123', package_name='librepng')
         )
+
+
+class TestMetadataFileCreation(testtools.TestCase):
+
+    def assertRequestResultsInFileContents(self, request, expected_contents):
+        with TempDir() as t:
+            _create_run_metadata_file(t.path, request)
+            expected_path = os.path.join(t.path, 'nova-metadata')
+
+            self.assertThat(
+                expected_path,
+                FileExists()
+            )
+            with open(expected_path) as infile:
+                contents = infile.read()
+            self.assertEquals(contents, expected_contents)
+
+    def test_ignores_non_whitelisted_keys(self):
+        self.assertRequestResultsInFileContents(
+            dict(secret="Wouldn't you like to know!"),
+            ''
+        )
+
+    def test_writes_exit_code(self):
+        self.assertRequestResultsInFileContents(
+            dict(exit_code='100'),
+            'exit_code\t100\n'
+        )
+
+    def test_writes_multiple_whitelisted_keys(self):
+        self.assertRequestResultsInFileContents(
+            dict(series='trusty', exit_code='100'),
+            'exit_code\t100\nseries\ttrusty\n'
+        )