From c3e070de802ebc0f44722d4238f5447b93cc9fac Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Tue, 3 Sep 2013 23:51:51 -0700 Subject: Review adjustments. --- cloudinit/config/cc_seed_random.py | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 cloudinit/config/cc_seed_random.py (limited to 'cloudinit/config') diff --git a/cloudinit/config/cc_seed_random.py b/cloudinit/config/cc_seed_random.py new file mode 100644 index 00000000..5d9890d5 --- /dev/null +++ b/cloudinit/config/cc_seed_random.py @@ -0,0 +1,36 @@ +# vi: ts=4 expandtab +# +# Copyright (C) 2013 Yahoo! Inc. +# +# Author: Joshua Harlow +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3, as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from cloudinit.settings import PER_INSTANCE + +frequency = PER_INSTANCE + + +def handle(name, cfg, cloud, log, _args): + random_seed = None + # Prefer metadata over cfg for random_seed + for src in (cloud.datasource.metadata, cfg): + if not src: + continue + tmp_random_seed = src.get('random_seed') + if tmp_random_seed and isinstance(tmp_random_seed, (str, basestring)): + random_seed = tmp_random_seed + break + if random_seed: + log.debug("%s: setting random seed", name) + cloud.distro.set_random_seed(random_seed) -- cgit v1.2.3 From e058913486519c2a9e036aad95f6e029dbc89966 Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Fri, 6 Sep 2013 23:46:27 -0700 Subject: Add jsonschema for namespaced and verifiable module configuration checking as well as make most of the module logic happen in the module itself instead of interacting with the distro object. --- Requires | 4 ++ cloudinit/config/cc_seed_random.py | 94 +++++++++++++++++++++++++++++++++----- cloudinit/distros/__init__.py | 10 ---- cloudinit/exceptions.py | 21 +++++++++ 4 files changed, 107 insertions(+), 22 deletions(-) create mode 100644 cloudinit/exceptions.py (limited to 'cloudinit/config') diff --git a/Requires b/Requires index f19c9691..b00dd58e 100644 --- a/Requires +++ b/Requires @@ -34,3 +34,7 @@ boto # For patching pieces of cloud-config together jsonpatch + +# For validating that a config modules needed configuration specified +# in a correct format that the module can understand +jsonschema diff --git a/cloudinit/config/cc_seed_random.py b/cloudinit/config/cc_seed_random.py index 5d9890d5..acacb8f7 100644 --- a/cloudinit/config/cc_seed_random.py +++ b/cloudinit/config/cc_seed_random.py @@ -16,21 +16,91 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +import base64 +from StringIO import StringIO + +import jsonschema +from jsonschema import exceptions as js_exc + +from cloudinit import exceptions as exc from cloudinit.settings import PER_INSTANCE +from cloudinit import util frequency = PER_INSTANCE +schema = { + 'type': 'object', + 'properties': { + "random_seed": { + "type": "object", + "oneOf": [ + {"$ref": "#/definitions/random_seed"}, + ], + }, + }, + "required": ["random_seed"], + "additionalProperties": True, + "definitions": { + 'random_seed': { + 'type': 'object', + "properties" : { + 'data': { + 'type': "string", + }, + 'file': { + 'type': 'string', + }, + 'encoding': { + "enum": ["base64", 'gzip', 'b64', 'gz', ''], + }, + }, + "additionalProperties": True, + }, + }, +} + + +def validate(cfg): + """Method that can be used to ask if the given configuration will be + accepted as valid by this module, without having to actually activate this + module.""" + try: + jsonschema.validate(cfg, schema) + except js_exc.ValidationError as e: + raise exc.FormatValidationError("Invalid configuration: %s" % str(e)) + + +def _decode(data, encoding=None): + if not encoding: + return data + if not data: + return '' + if encoding.lower() in ['base64', 'b64']: + return base64.b64decode(data) + elif encoding.lower() in ['gzip', 'gz']: + return util.decomp_gzip(data, quiet=False) + else: + raise IOError("Unknown random_seed encoding: %s" % (encoding)) def handle(name, cfg, cloud, log, _args): - random_seed = None - # Prefer metadata over cfg for random_seed - for src in (cloud.datasource.metadata, cfg): - if not src: - continue - tmp_random_seed = src.get('random_seed') - if tmp_random_seed and isinstance(tmp_random_seed, (str, basestring)): - random_seed = tmp_random_seed - break - if random_seed: - log.debug("%s: setting random seed", name) - cloud.distro.set_random_seed(random_seed) + if not cfg or "random_seed" not in cfg: + log.debug(("Skipping module named %s, " + "no 'random_seed' configuration found"), name) + return + + validate(cfg) + my_cfg = cfg['random_seed'] + seed_path = my_cfg.get('file', '/dev/urandom') + seed_buf = StringIO() + seed_buf.write(_decode(my_cfg.get('data', ''), + encoding=my_cfg.get('encoding'))) + + metadata = cloud.datasource.metadata + if metadata and 'random_seed' in metadata: + seed_buf.write(metadata['random_seed']) + + seed_data = seed_buf.getvalue() + if len(seed_data): + log.debug("%s: adding %s bytes of random seed entrophy to %s", name, + len(seed_data), seed_path) + util.append_file(seed_path, seed_data) diff --git a/cloudinit/distros/__init__.py b/cloudinit/distros/__init__.py index 5642b529..74e95797 100644 --- a/cloudinit/distros/__init__.py +++ b/cloudinit/distros/__init__.py @@ -52,7 +52,6 @@ class Distro(object): ci_sudoers_fn = "/etc/sudoers.d/90-cloud-init-users" hostname_conf_fn = "/etc/hostname" tz_zone_dir = "/usr/share/zoneinfo" - random_seed_fn = '/dev/urandom' def __init__(self, name, cfg, paths): self._paths = paths @@ -170,15 +169,6 @@ class Distro(object): distros.extend(OSFAMILIES[family]) return distros - def set_random_seed(self, seed): - if not self.random_seed_fn or not os.path.exists(self.random_seed_fn): - raise IOError("No random seed filename provided for %s" - % (self.name)) - if not seed: - raise IOError("Unable to set empty random seed") - # Ensure we only write 512 bytes worth - util.append_file(self.random_seed_fn, seed[0:512]) - def update_hostname(self, hostname, fqdn, prev_hostname_fn): applying_hostname = hostname diff --git a/cloudinit/exceptions.py b/cloudinit/exceptions.py new file mode 100644 index 00000000..c09d15b1 --- /dev/null +++ b/cloudinit/exceptions.py @@ -0,0 +1,21 @@ +# vi: ts=4 expandtab +# +# Copyright (C) 2013 Yahoo! Inc. +# +# Author: Joshua Harlow +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3, as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + + +class FormatValidationError(Exception): + pass -- cgit v1.2.3 From 2ee2d10a042c96160e4745431d1d0c25904b5d88 Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Fri, 6 Sep 2013 23:54:51 -0700 Subject: Ensure validate checks key existence. --- cloudinit/config/cc_seed_random.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'cloudinit/config') diff --git a/cloudinit/config/cc_seed_random.py b/cloudinit/config/cc_seed_random.py index acacb8f7..592d253f 100644 --- a/cloudinit/config/cc_seed_random.py +++ b/cloudinit/config/cc_seed_random.py @@ -63,6 +63,8 @@ def validate(cfg): """Method that can be used to ask if the given configuration will be accepted as valid by this module, without having to actually activate this module.""" + if not cfg or "random_seed" not in cfg: + return try: jsonschema.validate(cfg, schema) except js_exc.ValidationError as e: -- cgit v1.2.3 From e56659253c4284be4c78d373d3f0a1deab9bd201 Mon Sep 17 00:00:00 2001 From: Joshua Harlow Date: Sun, 8 Sep 2013 22:36:28 -0700 Subject: Add test + remove jsonschema (for now) --- Requires | 4 - cloudinit/config/cc_seed_random.py | 53 +------- .../test_handler/test_handler_seed_random.py | 150 +++++++++++++++++++++ 3 files changed, 153 insertions(+), 54 deletions(-) create mode 100644 tests/unittests/test_handler/test_handler_seed_random.py (limited to 'cloudinit/config') diff --git a/Requires b/Requires index b00dd58e..f19c9691 100644 --- a/Requires +++ b/Requires @@ -34,7 +34,3 @@ boto # For patching pieces of cloud-config together jsonpatch - -# For validating that a config modules needed configuration specified -# in a correct format that the module can understand -jsonschema diff --git a/cloudinit/config/cc_seed_random.py b/cloudinit/config/cc_seed_random.py index 592d253f..22a31f29 100644 --- a/cloudinit/config/cc_seed_random.py +++ b/cloudinit/config/cc_seed_random.py @@ -19,64 +19,18 @@ import base64 from StringIO import StringIO -import jsonschema -from jsonschema import exceptions as js_exc - -from cloudinit import exceptions as exc from cloudinit.settings import PER_INSTANCE from cloudinit import util frequency = PER_INSTANCE -schema = { - 'type': 'object', - 'properties': { - "random_seed": { - "type": "object", - "oneOf": [ - {"$ref": "#/definitions/random_seed"}, - ], - }, - }, - "required": ["random_seed"], - "additionalProperties": True, - "definitions": { - 'random_seed': { - 'type': 'object', - "properties" : { - 'data': { - 'type': "string", - }, - 'file': { - 'type': 'string', - }, - 'encoding': { - "enum": ["base64", 'gzip', 'b64', 'gz', ''], - }, - }, - "additionalProperties": True, - }, - }, -} - - -def validate(cfg): - """Method that can be used to ask if the given configuration will be - accepted as valid by this module, without having to actually activate this - module.""" - if not cfg or "random_seed" not in cfg: - return - try: - jsonschema.validate(cfg, schema) - except js_exc.ValidationError as e: - raise exc.FormatValidationError("Invalid configuration: %s" % str(e)) def _decode(data, encoding=None): - if not encoding: - return data if not data: return '' - if encoding.lower() in ['base64', 'b64']: + if not encoding or encoding.lower() in ['raw']: + return data + elif encoding.lower() in ['base64', 'b64']: return base64.b64decode(data) elif encoding.lower() in ['gzip', 'gz']: return util.decomp_gzip(data, quiet=False) @@ -90,7 +44,6 @@ def handle(name, cfg, cloud, log, _args): "no 'random_seed' configuration found"), name) return - validate(cfg) my_cfg = cfg['random_seed'] seed_path = my_cfg.get('file', '/dev/urandom') seed_buf = StringIO() diff --git a/tests/unittests/test_handler/test_handler_seed_random.py b/tests/unittests/test_handler/test_handler_seed_random.py new file mode 100644 index 00000000..458b0028 --- /dev/null +++ b/tests/unittests/test_handler/test_handler_seed_random.py @@ -0,0 +1,150 @@ + # Copyright (C) 2013 Hewlett-Packard Development Company, L.P. +# +# Author: Juerg Haefliger +# +# Based on test_handler_set_hostname.py +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 3, as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from cloudinit.config import cc_seed_random + +import base64 +import tempfile +import gzip + +from StringIO import StringIO + +from cloudinit import cloud +from cloudinit import distros +from cloudinit import helpers +from cloudinit import util + +from cloudinit.sources import DataSourceNone + +from tests.unittests import helpers as t_help + +import logging + +LOG = logging.getLogger(__name__) + + +class TestRandomSeed(t_help.TestCase): + def setUp(self): + super(TestRandomSeed, self).setUp() + self._seed_file = tempfile.mktemp() + + def tearDown(self): + util.del_file(self._seed_file) + + def _compress(self, text): + contents = StringIO() + gz_fh = gzip.GzipFile(mode='wb', fileobj=contents) + gz_fh.write(text) + gz_fh.close() + return contents.getvalue() + + def _get_cloud(self, distro, metadata=None): + paths = helpers.Paths({}) + cls = distros.fetch(distro) + ubuntu_distro = cls(distro, {}, paths) + ds = DataSourceNone.DataSourceNone({}, ubuntu_distro, paths) + if metadata: + ds.metadata = metadata + return cloud.Cloud(ds, paths, {}, ubuntu_distro, None) + + def test_append_random(self): + cfg = { + 'random_seed': { + 'file': self._seed_file, + 'data': 'tiny-tim-was-here', + } + } + cc_seed_random.handle('test', cfg, self._get_cloud('ubuntu'), LOG, []) + contents = util.load_file(self._seed_file) + self.assertEquals("tiny-tim-was-here", contents) + + def test_append_random_unknown_encoding(self): + data = self._compress("tiny-toe") + cfg = { + 'random_seed': { + 'file': self._seed_file, + 'data': data, + 'encoding': 'special_encoding', + } + } + self.assertRaises(IOError, cc_seed_random.handle, 'test', cfg, + self._get_cloud('ubuntu'), LOG, []) + + def test_append_random_gzip(self): + data = self._compress("tiny-toe") + cfg = { + 'random_seed': { + 'file': self._seed_file, + 'data': data, + 'encoding': 'gzip', + } + } + cc_seed_random.handle('test', cfg, self._get_cloud('ubuntu'), LOG, []) + contents = util.load_file(self._seed_file) + self.assertEquals("tiny-toe", contents) + + def test_append_random_gz(self): + data = self._compress("big-toe") + cfg = { + 'random_seed': { + 'file': self._seed_file, + 'data': data, + 'encoding': 'gz', + } + } + cc_seed_random.handle('test', cfg, self._get_cloud('ubuntu'), LOG, []) + contents = util.load_file(self._seed_file) + self.assertEquals("big-toe", contents) + + def test_append_random_base64(self): + data = base64.b64encode('bubbles') + cfg = { + 'random_seed': { + 'file': self._seed_file, + 'data': data, + 'encoding': 'base64', + } + } + cc_seed_random.handle('test', cfg, self._get_cloud('ubuntu'), LOG, []) + contents = util.load_file(self._seed_file) + self.assertEquals("bubbles", contents) + + def test_append_random_b64(self): + data = base64.b64encode('kit-kat') + cfg = { + 'random_seed': { + 'file': self._seed_file, + 'data': data, + 'encoding': 'b64', + } + } + cc_seed_random.handle('test', cfg, self._get_cloud('ubuntu'), LOG, []) + contents = util.load_file(self._seed_file) + self.assertEquals("kit-kat", contents) + + def test_append_random_metadata(self): + cfg = { + 'random_seed': { + 'file': self._seed_file, + 'data': 'tiny-tim-was-here', + } + } + c = self._get_cloud('ubuntu', {'random_seed': '-so-was-josh'}) + cc_seed_random.handle('test', cfg, c, LOG, []) + contents = util.load_file(self._seed_file) + self.assertEquals('tiny-tim-was-here-so-was-josh', contents) -- cgit v1.2.3