diff options
| -rw-r--r-- | ChangeLog | 1 | ||||
| -rw-r--r-- | cloudinit/UserDataHandler.py | 4 | ||||
| -rw-r--r-- | cloudinit/__init__.py | 8 | ||||
| -rw-r--r-- | tests/unittests/test_userdata.py | 102 |
4 files changed, 113 insertions, 2 deletions
@@ -36,6 +36,7 @@ - DataSourceCloudStack: add support for CloudStack datasource [Cosmin Luta] - add option 'apt_pipelining' to address issue with S3 mirrors (LP: #948461) [Ben Howard] + - warn on non-multipart, non-handled user-data [Martin Packman] 0.6.2: - fix bug where update was not done unless update was explicitly set. It would not be run if 'upgrade' or packages were set to be installed diff --git a/cloudinit/UserDataHandler.py b/cloudinit/UserDataHandler.py index 98729056..ec914480 100644 --- a/cloudinit/UserDataHandler.py +++ b/cloudinit/UserDataHandler.py @@ -180,7 +180,7 @@ def process_includes(msg, appendmsg=None): payload = part.get_payload(decode=True) - if ctype_orig == "text/plain": + if ctype_orig in ("text/plain", "text/x-not-multipart"): ctype = type_from_startswith(payload) if ctype is None: @@ -213,7 +213,7 @@ def message_from_string(data, headers=None): else: msg[key] = val else: - mtype = headers.get("Content-Type", "text/plain") + mtype = headers.get("Content-Type", "text/x-not-multipart") maintype, subtype = mtype.split("/", 1) msg = MIMEBase(maintype, subtype, *headers) msg.set_payload(data) diff --git a/cloudinit/__init__.py b/cloudinit/__init__.py index 37447a31..3168a632 100644 --- a/cloudinit/__init__.py +++ b/cloudinit/__init__.py @@ -606,6 +606,14 @@ def partwalker_callback(pdata, ctype, filename, payload): partwalker_handle_handler(pdata, ctype, filename, payload) return if ctype not in pdata['handlers']: + if ctype == "text/x-not-multipart": + # Extract the first line or 24 bytes for displaying in the log + start = payload.split("\n", 1)[0][:24] + if start < payload: + details = "starting '%s...'" % start.encode("string-escape") + else: + details = repr(payload) + log.warning("Unhandled non-multipart userdata %s", details) return handler_handle_part(pdata['handlers'][ctype], pdata['data'], ctype, filename, payload, pdata['frequency']) diff --git a/tests/unittests/test_userdata.py b/tests/unittests/test_userdata.py new file mode 100644 index 00000000..37ad9b13 --- /dev/null +++ b/tests/unittests/test_userdata.py @@ -0,0 +1,102 @@ +"""Tests for handling of userdata within cloud init""" + +import logging +import StringIO + +from email.mime.base import MIMEBase + +from mocker import MockerTestCase + +import cloudinit +from cloudinit.DataSource import DataSource + + +instance_id = "i-testing" + + +class FakeDataSource(DataSource): + + def __init__(self, userdata): + self.metadata = {'instance-id': instance_id} + self.userdata_raw = userdata + + +class TestConsumeUserData(MockerTestCase): + + def setUp(self): + self.mock_write = self.mocker.replace("cloudinit.util.write_file", + passthrough=False) + self.mock_write(self.get_ipath("cloud_config"), "", 0600) + self.capture_log() + + def tearDown(self): + self._log.removeHandler(self._log_handler) + + @staticmethod + def get_ipath(name): + return "%s/instances/%s%s" % (cloudinit.varlibdir, instance_id, + cloudinit.pathmap[name]) + + def capture_log(self): + self.log_file = StringIO.StringIO() + self._log_handler = logging.StreamHandler(self.log_file) + self._log_handler.setLevel(logging.DEBUG) + self._log = logging.getLogger(cloudinit.logger_name) + self._log.addHandler(self._log_handler) + + def test_unhandled_type_warning(self): + """Raw text without magic is ignored but shows warning""" + self.mocker.replay() + ci = cloudinit.CloudInit() + ci.datasource = FakeDataSource("arbitrary text\n") + ci.consume_userdata() + self.assertEqual( + "Unhandled non-multipart userdata starting 'arbitrary text...'\n", + self.log_file.getvalue()) + + def test_mime_text_plain(self): + """Mime message of type text/plain is ignored without warning""" + self.mocker.replay() + ci = cloudinit.CloudInit() + message = MIMEBase("text", "plain") + message.set_payload("Just text") + ci.datasource = FakeDataSource(message.as_string()) + ci.consume_userdata() + self.assertEqual("", self.log_file.getvalue()) + + def test_shellscript(self): + """Raw text starting #!/bin/sh is treated as script""" + script = "#!/bin/sh\necho hello\n" + outpath = cloudinit.get_ipath_cur("scripts") + "/part-001" + self.mock_write(outpath, script, 0700) + self.mocker.replay() + ci = cloudinit.CloudInit() + ci.datasource = FakeDataSource(script) + ci.consume_userdata() + self.assertEqual("", self.log_file.getvalue()) + + def test_mime_text_x_shellscript(self): + """Mime message of type text/x-shellscript is treated as script""" + script = "#!/bin/sh\necho hello\n" + outpath = cloudinit.get_ipath_cur("scripts") + "/part-001" + self.mock_write(outpath, script, 0700) + self.mocker.replay() + ci = cloudinit.CloudInit() + message = MIMEBase("text", "x-shellscript") + message.set_payload(script) + ci.datasource = FakeDataSource(message.as_string()) + ci.consume_userdata() + self.assertEqual("", self.log_file.getvalue()) + + def test_mime_text_plain_shell(self): + """Mime type text/plain starting #!/bin/sh is treated as script""" + script = "#!/bin/sh\necho hello\n" + outpath = cloudinit.get_ipath_cur("scripts") + "/part-001" + self.mock_write(outpath, script, 0700) + self.mocker.replay() + ci = cloudinit.CloudInit() + message = MIMEBase("text", "plain") + message.set_payload(script) + ci.datasource = FakeDataSource(message.as_string()) + ci.consume_userdata() + self.assertEqual("", self.log_file.getvalue()) |