Merge ~smoser/cloud-init:fix/leaked-tmpfiles-in-configdrive-test into cloud-init:master

[Scott Moser]

tests: remove leaked tmp files in config drive tests.

Make sure that some temporary files used by the config drive tests get
cleaned up properly.

[Server Team CI bot (server-team-bot)]

FAILED: Continuous integration, rev:d06d7d2a77eaf7c535aa9e9139d84d8ad8ed863e
https://jenkins.ubuntu.com/server/job/cloud-init-ci/609/
Executed test runs:
    SUCCESS: Checkout
    FAILED: Unit & Style Tests

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/609/rebuild

review: Needs Fixing (continuous-integration)

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:2392e07130938fa4d18451172a0259762e570a6c
https://jenkins.ubuntu.com/server/job/cloud-init-ci/610/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    SUCCESS: MAAS Compatability Testing
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/610/rebuild

review: Approve (continuous-integration)

[Ryan Harper (raharper)]

LGTM

review: Approve

[Chad Smith (chad.smith)]

+1. I thought about also adding the unittest name to the prefix of the tmp_dir created, but I realize out test infrastructure cleans that up automatically, so we really wouldn't get any bang for our buck as I don't expect our unittests with prefixes to not cleanup.

review: Approve

diff --git a/tests/unittests/test_datasource/test_configdrive.py b/tests/unittests/test_datasource/test_configdrive.py
index 9849788..6ef5a35 100644
--- a/tests/unittests/test_datasource/test_configdrive.py
+++ b/tests/unittests/test_datasource/test_configdrive.py
@@ -3,9 +3,6 @@
 from copy import copy, deepcopy
 import json
 import os
-import shutil
-import six
-import tempfile
 
 from cloudinit import helpers
 from cloudinit.net import eni
@@ -15,7 +12,7 @@ from cloudinit.sources import DataSourceConfigDrive as ds
 from cloudinit.sources.helpers import openstack
 from cloudinit import util
 
-from cloudinit.tests.helpers import TestCase, ExitStack, mock
+from cloudinit.tests.helpers import CiTestCase, ExitStack, mock, populate_dir
 
 
 PUBKEY = u'ssh-rsa AAAAB3NzaC1....sIkJhq8wdX+4I3A4cYbYP ubuntu@server-460\n'
@@ -223,12 +220,11 @@ CFG_DRIVE_FILES_V2 = {
     'openstack/2015-10-15/network_data.json': json.dumps(NETWORK_DATA)}
 
 
-class TestConfigDriveDataSource(TestCase):
+class TestConfigDriveDataSource(CiTestCase):
 
     def setUp(self):
         super(TestConfigDriveDataSource, self).setUp()
-        self.tmp = tempfile.mkdtemp()
-        self.addCleanup(shutil.rmtree, self.tmp)
+        self.tmp = self.tmp_dir()
 
     def test_ec2_metadata(self):
         populate_dir(self.tmp, CFG_DRIVE_FILES_V2)
@@ -469,31 +465,27 @@ class TestConfigDriveDataSource(TestCase):
     @mock.patch('cloudinit.sources.DataSourceConfigDrive.on_first_boot')
     def test_pubkeys_v2(self, on_first_boot):
         """Verify that public-keys work in config-drive-v2."""
-        populate_dir(self.tmp, CFG_DRIVE_FILES_V2)
-        myds = cfg_ds_from_dir(self.tmp)
+        myds = cfg_ds_from_dir(self.tmp, files=CFG_DRIVE_FILES_V2)
         self.assertEqual(myds.get_public_ssh_keys(),
                          [OSTACK_META['public_keys']['mykey']])
 
 
-class TestNetJson(TestCase):
+class TestNetJson(CiTestCase):
     def setUp(self):
         super(TestNetJson, self).setUp()
-        self.tmp = tempfile.mkdtemp()
-        self.addCleanup(shutil.rmtree, self.tmp)
+        self.tmp = self.tmp_dir()
         self.maxDiff = None
 
     @mock.patch('cloudinit.sources.DataSourceConfigDrive.on_first_boot')
     def test_network_data_is_found(self, on_first_boot):
         """Verify that network_data is present in ds in config-drive-v2."""
-        populate_dir(self.tmp, CFG_DRIVE_FILES_V2)
-        myds = cfg_ds_from_dir(self.tmp)
+        myds = cfg_ds_from_dir(self.tmp, files=CFG_DRIVE_FILES_V2)
         self.assertIsNotNone(myds.network_json)
 
     @mock.patch('cloudinit.sources.DataSourceConfigDrive.on_first_boot')
     def test_network_config_is_converted(self, on_first_boot):
         """Verify that network_data is converted and present on ds object."""
-        populate_dir(self.tmp, CFG_DRIVE_FILES_V2)
-        myds = cfg_ds_from_dir(self.tmp)
+        myds = cfg_ds_from_dir(self.tmp, files=CFG_DRIVE_FILES_V2)
         network_config = openstack.convert_net_json(NETWORK_DATA,
                                                     known_macs=KNOWN_MACS)
         self.assertEqual(myds.network_config, network_config)
@@ -598,11 +590,10 @@ class TestNetJson(TestCase):
             self.assertEqual(out_data, conv_data)
 
 
-class TestConvertNetworkData(TestCase):
+class TestConvertNetworkData(CiTestCase):
     def setUp(self):
         super(TestConvertNetworkData, self).setUp()
-        self.tmp = tempfile.mkdtemp()
-        self.addCleanup(shutil.rmtree, self.tmp)
+        self.tmp = self.tmp_dir()
 
     def _getnames_in_config(self, ncfg):
         return set([n['name'] for n in ncfg['config']
@@ -724,15 +715,18 @@ class TestConvertNetworkData(TestCase):
         self.assertEqual(expected, config_name2mac)
 
 
-def cfg_ds_from_dir(seed_d):
-    tmp = tempfile.mkdtemp()
-    cfg_ds = ds.DataSourceConfigDrive(settings.CFG_BUILTIN, None,
-                                      helpers.Paths({'run_dir': tmp}))
-    cfg_ds.seed_dir = seed_d
+def cfg_ds_from_dir(base_d, files=None):
+    run = os.path.join(base_d, "run")
+    os.mkdir(run)
+    cfg_ds = ds.DataSourceConfigDrive(
+        settings.CFG_BUILTIN, None, helpers.Paths({'run_dir': run}))
+    cfg_ds.seed_dir = os.path.join(base_d, "seed")
+    if files:
+        populate_dir(cfg_ds.seed_dir, files)
     cfg_ds.known_macs = KNOWN_MACS.copy()
     if not cfg_ds.get_data():
         raise RuntimeError("Data source did not extract itself from"
-                           " seed directory %s" % seed_d)
+                           " seed directory %s" % cfg_ds.seed_dir)
     return cfg_ds
 
 
@@ -750,17 +744,4 @@ def populate_ds_from_read_config(cfg_ds, source, results):
         cfg_ds.network_json, known_macs=KNOWN_MACS)
 
 
-def populate_dir(seed_dir, files):
-    for (name, content) in files.items():
-        path = os.path.join(seed_dir, name)
-        dirname = os.path.dirname(path)
-        if not os.path.isdir(dirname):
-            os.makedirs(dirname)
-        if isinstance(content, six.text_type):
-            mode = "w"
-        else:
-            mode = "wb"
-        with open(path, mode) as fp:
-            fp.write(content)
-
 # vi: ts=4 expandtab