diff --git a/lib/cdist/core/object.py b/lib/cdist/core/object.py index 081b3e56..c136390e 100644 --- a/lib/cdist/core/object.py +++ b/lib/cdist/core/object.py @@ -1,292 +1,37 @@ +# -*- coding: utf-8 -*- +# +# 2010-2011 Steven Armstrong (steven-cdist at armstrong.cc) +# +# This file is part of cdist. +# +# cdist is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# cdist 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 cdist. If not, see . +# +# + import os -import tempfile -# FIXME: change these to match your environment -os.environ['__cdist_base_dir'] = '/home/sar/vcs/cdist' -# FIXME: testing against the cache, change path -os.environ['__cdist_out_dir'] = '/home/sar/vcs/cdist/cache/sans-asteven-02.ethz.ch/out' - - -''' -cd /path/to/dir/with/this/file -ipython - - -In [1]: import oo - -In [2]: t = oo.Type('__mkfs') - -In [3]: t. -t.base_dir t.is_install t.list_type_names t.name t.path -t.explorers t.is_singleton t.list_types t.optional_parameters t.required_parameters - -In [3]: t.path -Out[3]: '/home/sar/vcs/cdist/conf/type/__mkfs' - -In [4]: t.required_parameters -Out[4]: ['type'] - -In [5]: t.optional_parameters -Out[5]: ['device', 'options', 'blocks'] - -In [6]: t.is -t.is_install t.is_singleton - -In [6]: t.is_singleton -Out[6]: False - -In [7]: o = oo.Object(t, 'dev/sda1') - -In [8]: o. -o.base_dir o.list_object_names o.list_type_names o.parameter o.qualified_name o.type -o.changed o.list_objects o.object_id o.path o.requirements - -In [8]: o.pa -o.parameter o.path - -In [8]: o.path -Out[8]: '/home/sar/vcs/cdist/cache/sans-asteven-02.ethz.ch/out/object/__mkfs/dev/sda1/.cdist' - -In [9]: o.changed -Out[9]: False - -In [10]: o.changed = True - -In [11]: # creates /home/sar/vcs/cdist/cache/sans-asteven-02.ethz.ch/out/object/__mkfs/dev/sda1/.cdist/changed - -In [12]: o.changed -Out[12]: True - -In [13]: o.changed = False - -In [14]: # removes /home/sar/vcs/cdist/cache/sans-asteven-02.ethz.ch/out/object/__mkfs/dev/sda1/.cdist/changed - -In [15]: - - ------ - -In [1]: import oo - -In [2]: oo.Type. -oo.Type.base_dir oo.Type.is_install oo.Type.list_type_names oo.Type.mro oo.Type.path -oo.Type.explorers oo.Type.is_singleton oo.Type.list_types oo.Type.optional_parameters oo.Type.required_parameters - -In [2]: oo.Type.list -oo.Type.list_type_names oo.Type.list_types - -In [2]: oo.Type.list_type_names() -Out[2]: -['__addifnosuchline', - '__apt_ppa', - '__apt_update_index', - '__autofs_map', - '__autofs_master', - '__debconf_set_selections', - '__directory', - '__file', - '__group', - '__issue', - '__key_value', - '__link', - '__mkfs', - '__motd', - '__package', - '__package_apt', - '__package_pacman', - '__package_pkg_openbsd', - '__package_rubygem', - '__package_yum', - '__partition_msdos', - '__partition_msdos_apply', - '__postgres_database', - '__postgres_role', - '__process', - '__removeline', - '__ssh_authorized_key', - '__timezone', - '__user'] - -In [3]: list(oo.Type.list_types()) -Out[3]: -[, - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , - ] - -In [4]: - -In [4]: oo.Object. -oo.Object.base_dir oo.Object.changed oo.Object.list_object_names oo.Object.list_objects oo.Object.list_type_names oo.Object.mro oo.Object.path - -In [4]: oo.Object.list -oo.Object.list_object_names oo.Object.list_objects oo.Object.list_type_names - -In [4]: oo.Object.list_ob -oo.Object.list_object_names oo.Object.list_objects - -In [4]: oo.Object.list_object_names() -Out[4]: - -In [5]: list(oo.Object.list_object_names()) -Out[5]: -['__mkfs/dev/sda1', - '__mkfs/dev/sda2', - '__mkfs/dev/sda5', - '__mkfs/dev/sda6', - '__mkfs/dev/sda7', - '__partition_msdos/dev/sda1', - '__partition_msdos/dev/sda2', - '__partition_msdos/dev/sda3', - '__partition_msdos/dev/sda5', - '__partition_msdos/dev/sda6', - '__partition_msdos/dev/sda7', - '__partition_msdos_apply/singleton'] - -In [6]: list(oo.Object.list_objects()) -Out[6]: -[, - , - , - , - , - , - , - , - , - , - , - ] - -In [7]: - - -''' - -class Type(object): - - @staticmethod - def base_dir(): - """Return the absolute path to the top level directory where types - are defined. - - Requires the environment variable '__cdist_base_dir' to be set. - - """ - return os.path.join( - os.environ['__cdist_base_dir'], - 'conf', - 'type' - ) - - @classmethod - def list_types(cls): - """Return a list of type instances""" - for type_name in cls.list_type_names(): - yield cls(type_name) - - @classmethod - def list_type_names(cls): - """Return a list of type names""" - return os.listdir(cls.base_dir()) - - - def __init__(self, name): - self.name = name - self.__explorers = None - self.__required_parameters = None - self.__optional_parameters = None - - def __repr__(self): - return '' % self.name - - @property - def path(self): - return os.path.join( - self.base_dir(), - self.name - ) - - @property - def is_singleton(self): - """Check whether a type is a singleton.""" - return os.path.isfile(os.path.join(self.path, "singleton")) - - @property - def is_install(self): - """Check whether a type is used for installation (if not: for configuration)""" - return os.path.isfile(os.path.join(self.path, "install")) - - @property - def explorers(self): - """Return a list of available explorers""" - if not self.__explorers: - try: - self.__explorers = os.listdir(os.path.join(self.path, "explorer")) - except EnvironmentError as e: - # error ignored - self.__explorers = [] - return self.__explorers - - @property - def required_parameters(self): - """Return a list of required parameters""" - if not self.__required_parameters: - parameters = [] - try: - with open(os.path.join(self.path, "parameter", "required")) as fd: - for line in fd: - parameters.append(line.strip()) - except EnvironmentError as e: - # error ignored - pass - finally: - self.__required_parameters = parameters - return self.__required_parameters - - @property - def optional_parameters(self): - """Return a list of optional parameters""" - if not self.__optional_parameters: - parameters = [] - try: - with open(os.path.join(self.path, "parameter", "optional")) as fd: - for line in fd: - parameters.append(line.strip()) - except EnvironmentError as e: - # error ignored - pass - finally: - self.__optional_parameters = parameters - return self.__optional_parameters +import cdist class Object(object): + """Represents a cdist object. + + All interaction with objects in cdist should be done through this class. + Directly accessing an object through the file system from python code is + a bug. + + """ @staticmethod def base_dir(): @@ -296,10 +41,14 @@ class Object(object): Requires the environment variable '__cdist_out_dir' to be set. """ - base_dir = os.path.join( - os.environ['__cdist_out_dir'], - 'object' - ) + try: + base_dir = os.path.join( + os.environ['__cdist_out_dir'], + 'object' + ) + except KeyError as e: + raise cdist.MissingEnvironmentVariableError(e.args[0]) + # FIXME: should directory be created elsewhere? if not os.path.isdir(base_dir): os.mkdir(base_dir)