x/cloud-init
Code Issues Proposed changes

Convert helpers.py and test_data.py from mocker to mock.

Browse Source
This commit is contained in:
Barry Warsaw 2015-01-22 15:41:52 -05:00
parent 5d1edaff81
commit 01b8fc3de3
3 changed files with 97 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
tests/unittests/helpers.py
View File

@ -1,7 +1,17 @@
import os import os
import sys import sys
import tempfile
import unittest import unittest
try:
from unittest import mock
except ImportError:
import mock
try:
from contextlib import ExitStack
except ImportError:
from contextlib2 import ExitStack
from cloudinit import helpers as ch from cloudinit import helpers as ch
from cloudinit import util from cloudinit import util
@ -111,7 +121,11 @@ def retarget_many_wrapper(new_base, am, old_func):
class ResourceUsingTestCase(unittest.TestCase): class ResourceUsingTestCase(unittest.TestCase):
def __init__(self, methodName="runTest"): ## def __init__(self, methodName="runTest"):
## self.resource_path = None
def setUp(self):
unittest.TestCase.setUp(self)
self.resource_path = None self.resource_path = None
def resourceLocation(self, subname=None): def resourceLocation(self, subname=None):
@ -139,17 +153,23 @@ class ResourceUsingTestCase(unittest.TestCase):
return fh.read() return fh.read()
def getCloudPaths(self): def getCloudPaths(self):
tmpdir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, tmpdir)
cp = ch.Paths({ cp = ch.Paths({
'cloud_dir': self.makeDir(), 'cloud_dir': tmpdir,
'templates_dir': self.resourceLocation(), 'templates_dir': self.resourceLocation(),
}) })
return cp return cp
class FilesystemMockingTestCase(ResourceUsingTestCase): class FilesystemMockingTestCase(ResourceUsingTestCase):
def __init__(self, methodName="runTest"): ## def __init__(self, methodName="runTest"):
ResourceUsingTestCase.__init__(self, methodName) ## ResourceUsingTestCase.__init__(self, methodName)
self.patched_funcs = []
def setUp(self):
ResourceUsingTestCase.setUp(self)
self.patched_funcs = ExitStack()
self.addCleanup(self.patched_funcs.close)
def replicateTestRoot(self, example_root, target_root): def replicateTestRoot(self, example_root, target_root):
real_root = self.resourceLocation() real_root = self.resourceLocation()
@ -163,15 +183,6 @@ class FilesystemMockingTestCase(ResourceUsingTestCase):
make_path = util.abs_join(make_path, f) make_path = util.abs_join(make_path, f)
shutil.copy(real_path, make_path) shutil.copy(real_path, make_path)
def tearDown(self):
self.restore()
ResourceUsingTestCase.tearDown(self)
def restore(self):
for (mod, f, func) in self.patched_funcs:
setattr(mod, f, func)
self.patched_funcs = []
def patchUtils(self, new_root): def patchUtils(self, new_root):
patch_funcs = { patch_funcs = {
util: [('write_file', 1), util: [('write_file', 1),
@ -188,8 +199,8 @@ class FilesystemMockingTestCase(ResourceUsingTestCase):
for (f, am) in funcs: for (f, am) in funcs:
func = getattr(mod, f) func = getattr(mod, f)
trap_func = retarget_many_wrapper(new_root, am, func) trap_func = retarget_many_wrapper(new_root, am, func)
setattr(mod, f, trap_func) self.patched_funcs.enter_context(
self.patched_funcs.append((mod, f, func)) mock.patch.object(mod, f, trap_func))
# Handle subprocess calls # Handle subprocess calls
func = getattr(util, 'subp') func = getattr(util, 'subp')
@ -197,16 +208,15 @@ class FilesystemMockingTestCase(ResourceUsingTestCase):
def nsubp(*_args, **_kwargs): def nsubp(*_args, **_kwargs):
return ('', '') return ('', '')
setattr(util, 'subp', nsubp) self.patched_funcs.enter_context(
self.patched_funcs.append((util, 'subp', func)) mock.patch.object(util, 'subp', nsubp))
def null_func(*_args, **_kwargs): def null_func(*_args, **_kwargs):
return None return None
for f in ['chownbyid', 'chownbyname']: for f in ['chownbyid', 'chownbyname']:
func = getattr(util, f) self.patched_funcs.enter_context(
setattr(util, f, null_func) mock.patch.object(util, f, null_func))
self.patched_funcs.append((util, f, func))
def patchOS(self, new_root): def patchOS(self, new_root):
patch_funcs = { patch_funcs = {
@ -217,8 +227,8 @@ class FilesystemMockingTestCase(ResourceUsingTestCase):
for f in funcs: for f in funcs:
func = getattr(mod, f) func = getattr(mod, f)
trap_func = retarget_many_wrapper(new_root, 1, func) trap_func = retarget_many_wrapper(new_root, 1, func)
setattr(mod, f, trap_func) self.patched_funcs.enter_context(
self.patched_funcs.append((mod, f, func)) mock.patch.object(mod, f, trap_func))
class HttprettyTestCase(TestCase): class HttprettyTestCase(TestCase):

110
tests/unittests/test_data.py
View File

@ -3,6 +3,13 @@
import gzip import gzip
import logging import logging
import os import os
import shutil
import tempfile
try:
from unittest import mock
except ImportError:
import mock
from six import BytesIO, StringIO from six import BytesIO, StringIO
@ -43,9 +50,9 @@ class TestConsumeUserData(helpers.FilesystemMockingTestCase):
self._log_handler = None self._log_handler = None
def tearDown(self): def tearDown(self):
helpers.FilesystemMockingTestCase.tearDown(self)
if self._log_handler and self._log: if self._log_handler and self._log:
self._log.removeHandler(self._log_handler) self._log.removeHandler(self._log_handler)
helpers.FilesystemMockingTestCase.tearDown(self)
def _patchIn(self, root): def _patchIn(self, root):
self.restore() self.restore()
@ -71,7 +78,8 @@ class TestConsumeUserData(helpers.FilesystemMockingTestCase):
ci = stages.Init() ci = stages.Init()
ci.datasource = FakeDataSource(blob) ci.datasource = FakeDataSource(blob)
new_root = self.makeDir() new_root = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, new_root)
self.patchUtils(new_root) self.patchUtils(new_root)
self.patchOS(new_root) self.patchOS(new_root)
ci.fetch() ci.fetch()
@ -99,7 +107,8 @@ class TestConsumeUserData(helpers.FilesystemMockingTestCase):
{ "op": "add", "path": "/foo", "value": "quxC" } { "op": "add", "path": "/foo", "value": "quxC" }
] ]
''' '''
new_root = self.makeDir() new_root = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, new_root)
self._patchIn(new_root) self._patchIn(new_root)
initer = stages.Init() initer = stages.Init()
initer.datasource = FakeDataSource(user_blob, vendordata=vendor_blob) initer.datasource = FakeDataSource(user_blob, vendordata=vendor_blob)
@ -138,7 +147,8 @@ class TestConsumeUserData(helpers.FilesystemMockingTestCase):
{ "op": "add", "path": "/foo", "value": "quxC" } { "op": "add", "path": "/foo", "value": "quxC" }
] ]
''' '''
new_root = self.makeDir() new_root = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, new_root)
self._patchIn(new_root) self._patchIn(new_root)
initer = stages.Init() initer = stages.Init()
initer.datasource = FakeDataSource(user_blob, vendordata=vendor_blob) initer.datasource = FakeDataSource(user_blob, vendordata=vendor_blob)
@ -184,7 +194,8 @@ c: d
ci = stages.Init() ci = stages.Init()
ci.datasource = FakeDataSource(str(message)) ci.datasource = FakeDataSource(str(message))
new_root = self.makeDir() new_root = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, new_root)
self.patchUtils(new_root) self.patchUtils(new_root)
self.patchOS(new_root) self.patchOS(new_root)
ci.fetch() ci.fetch()
@ -214,7 +225,8 @@ name: user
run: run:
- z - z
''' '''
new_root = self.makeDir() new_root = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, new_root)
self._patchIn(new_root) self._patchIn(new_root)
initer = stages.Init() initer = stages.Init()
initer.datasource = FakeDataSource(user_blob, vendordata=vendor_blob) initer.datasource = FakeDataSource(user_blob, vendordata=vendor_blob)
@ -249,7 +261,8 @@ vendor_data:
enabled: True enabled: True
prefix: /bin/true prefix: /bin/true
''' '''
new_root = self.makeDir() new_root = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, new_root)
self._patchIn(new_root) self._patchIn(new_root)
initer = stages.Init() initer = stages.Init()
initer.datasource = FakeDataSource(user_blob, vendordata=vendor_blob) initer.datasource = FakeDataSource(user_blob, vendordata=vendor_blob)
@ -309,7 +322,8 @@ p: 1
paths = c_helpers.Paths({}, ds=FakeDataSource('')) paths = c_helpers.Paths({}, ds=FakeDataSource(''))
cloud_cfg = handlers.cloud_config.CloudConfigPartHandler(paths) cloud_cfg = handlers.cloud_config.CloudConfigPartHandler(paths)
new_root = self.makeDir() new_root = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, new_root)
self.patchUtils(new_root) self.patchUtils(new_root)
self.patchOS(new_root) self.patchOS(new_root)
cloud_cfg.handle_part(None, handlers.CONTENT_START, None, None, None, cloud_cfg.handle_part(None, handlers.CONTENT_START, None, None, None,
@ -374,7 +388,8 @@ c: 4
message.attach(gzip_part(base_content2)) message.attach(gzip_part(base_content2))
ci = stages.Init() ci = stages.Init()
ci.datasource = FakeDataSource(str(message)) ci.datasource = FakeDataSource(str(message))
new_root = self.makeDir() new_root = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, new_root)
self.patchUtils(new_root) self.patchUtils(new_root)
self.patchOS(new_root) self.patchOS(new_root)
ci.fetch() ci.fetch()
@ -394,17 +409,15 @@ c: 4
message.set_payload("Just text") message.set_payload("Just text")
ci.datasource = FakeDataSource(message.as_string()) ci.datasource = FakeDataSource(message.as_string())
mock_write = self.mocker.replace("cloudinit.util.write_file", with mock.patch('cloudinit.util.write_file') as mockobj:
passthrough=False) log_file = self.capture_log(logging.WARNING)
mock_write(ci.paths.get_ipath("cloud_config"), "", 0o600) ci.fetch()
self.mocker.replay() ci.consume_data()
self.assertIn(
log_file = self.capture_log(logging.WARNING) "Unhandled unknown content-type (text/plain)",
ci.fetch() log_file.getvalue())
ci.consume_data() mockobj.assert_called_once_with(
self.assertIn( ci.paths.get_ipath("cloud_config"), "", 0o600)
"Unhandled unknown content-type (text/plain)",
log_file.getvalue())
def test_shellscript(self): def test_shellscript(self):
"""Raw text starting #!/bin/sh is treated as script.""" """Raw text starting #!/bin/sh is treated as script."""
@ -413,16 +426,17 @@ c: 4
ci.datasource = FakeDataSource(script) ci.datasource = FakeDataSource(script)
outpath = os.path.join(ci.paths.get_ipath_cur("scripts"), "part-001") outpath = os.path.join(ci.paths.get_ipath_cur("scripts"), "part-001")
mock_write = self.mocker.replace("cloudinit.util.write_file",
passthrough=False)
mock_write(ci.paths.get_ipath("cloud_config"), "", 0o600)
mock_write(outpath, script, 0o700)
self.mocker.replay()
log_file = self.capture_log(logging.WARNING) with mock.patch('cloudinit.util.write_file') as mockobj:
ci.fetch() log_file = self.capture_log(logging.WARNING)
ci.consume_data() ci.fetch()
self.assertEqual("", log_file.getvalue()) ci.consume_data()
self.assertEqual("", log_file.getvalue())
mockobj.assert_has_calls([
mock.call(outpath, script, 0o700),
mock.call(ci.paths.get_ipath("cloud_config"), "", 0o600),
])
def test_mime_text_x_shellscript(self): def test_mime_text_x_shellscript(self):
"""Mime message of type text/x-shellscript is treated as script.""" """Mime message of type text/x-shellscript is treated as script."""
@ -433,16 +447,17 @@ c: 4
ci.datasource = FakeDataSource(message.as_string()) ci.datasource = FakeDataSource(message.as_string())
outpath = os.path.join(ci.paths.get_ipath_cur("scripts"), "part-001") outpath = os.path.join(ci.paths.get_ipath_cur("scripts"), "part-001")
mock_write = self.mocker.replace("cloudinit.util.write_file",
passthrough=False)
mock_write(ci.paths.get_ipath("cloud_config"), "", 0o600)
mock_write(outpath, script, 0o700)
self.mocker.replay()
log_file = self.capture_log(logging.WARNING) with mock.patch('cloudinit.util.write_file') as mockobj:
ci.fetch() log_file = self.capture_log(logging.WARNING)
ci.consume_data() ci.fetch()
self.assertEqual("", log_file.getvalue()) ci.consume_data()
self.assertEqual("", log_file.getvalue())
mockobj.assert_has_calls([
mock.call(outpath, script, 0o700),
mock.call(ci.paths.get_ipath("cloud_config"), "", 0o600),
])
def test_mime_text_plain_shell(self): def test_mime_text_plain_shell(self):
"""Mime type text/plain starting #!/bin/sh is treated as script.""" """Mime type text/plain starting #!/bin/sh is treated as script."""
@ -453,13 +468,14 @@ c: 4
ci.datasource = FakeDataSource(message.as_string()) ci.datasource = FakeDataSource(message.as_string())
outpath = os.path.join(ci.paths.get_ipath_cur("scripts"), "part-001") outpath = os.path.join(ci.paths.get_ipath_cur("scripts"), "part-001")
mock_write = self.mocker.replace("cloudinit.util.write_file",
passthrough=False)
mock_write(outpath, script, 0o700)
mock_write(ci.paths.get_ipath("cloud_config"), "", 0o600)
self.mocker.replay()
log_file = self.capture_log(logging.WARNING) with mock.patch('cloudinit.util.write_file') as mockobj:
ci.fetch() log_file = self.capture_log(logging.WARNING)
ci.consume_data() ci.fetch()
self.assertEqual("", log_file.getvalue()) ci.consume_data()
self.assertEqual("", log_file.getvalue())
mockobj.assert_has_calls([
mock.call(outpath, script, 0o700),
mock.call(ci.paths.get_ipath("cloud_config"), "", 0o600),
])

2
tox.ini
View File

@ -3,7 +3,7 @@ envlist = py26,py27,py34
recreate = True recreate = True
[testenv] [testenv]
commands = python -m nose -v tests commands = python -m nose tests
deps = deps =
contextlib2 contextlib2
httpretty>=0.7.1 httpretty>=0.7.1