[PATCH 1/3] Config: reimplementation parsing hierarchy

[Ondrej Lichtner]

From: Ondrej Lichtner <olichtne(a)redhat.com&gt;

This commit changes how we parse the config files. We still use the
ConfigParser for the direct parsing of the files, but the way we
transform its output is changed.

First of all the initialization chooses which scheme should be used.
This means that the options atribute is initialized in a particular way.
The main change is in the deepest point in the hierarchy of this
attribute. Previously we only stored the value of an option, but now
after this change the specific option is a dictionary consisting of
value, additive flag, method used for value handling, and the name used
in the configuration file.

This change allows us to replace the long switch statements for
something more compact. This means we no longer used separate methods
for different sections.

These changes however require all the option handling functions to
accept the same number of arguments. That means I had to add the
options cfg_path to some of these functions.

The reasoning behind this change is that if we are to be adding more and
more options the previous switch scheme would be getting more and more
unreadable. Another point is that the name of the option will be needed
to create the file itself at the first launch.

Signed-off-by: Ondrej Lichtner <olichtne(a)redhat.com&gt;
---
 Common/Config.py | 172 ++++++++++++++++++++++++++-----------------------------
 1 file changed, 82 insertions(+), 90 deletions(-)

diff --git a/Common/Config.py b/Common/Config.py
index 9cd18b0..4a4905b 100644
--- a/Common/Config.py
+++ b/Common/Config.py
@@ -30,33 +30,64 @@ class Config():
 
         self._scheme = scheme
         if self._scheme == "controller":
-            self.init_controller()
+            self.controller_scheme()
         elif self._scheme == "slave":
-            self.init_slave()
+            self.slave_scheme()
         else:
             msg = "Unknow scheme: '%s', can't set up
configuration"\
                     % self._scheme
             raise ConfigError(msg)
 
-    def init_controller(self):
+    def controller_scheme(self):
         self.options['log'] = dict()
-        self.options['log']['path'] = os.path.abspath(os.path.join(
-                os.path.dirname(sys.argv[0]), './Logs'))
+        self.options['log']['path'] = {\
+                "value" : os.path.abspath(os.path.join(
+                    os.path.dirname(sys.argv[0]), './Logs')),
+                "additive" : False,
+                "action" : self.optionPath,
+                "name" : "path"}
 
         self.options['environment'] = dict()
-        self.options['environment']['mac_pool_range'] = \
-                ['52:54:01:00:00:01', '52:54:01:FF:FF:FF']
-        self.options['environment']['rpcport'] = DefaultRPCPort
-        self.options['environment']['pool_dirs'] = []
-        self.options['environment']['tool_dirs'] = []
-        self.options['environment']['module_dirs'] = []
-
-    def init_slave(self):
+        self.options['environment']['mac_pool_range'] = {\
+                "value" : ['52:54:01:00:00:01',
'52:54:01:FF:FF:FF'],
+                "additive" : False,
+                "action" : self.optionMacRange,
+                "name" : "mac_pool_range"}
+        self.options['environment']['rpcport'] = {\
+                "value" : DefaultRPCPort,
+                "additive" : False,
+                "action" : self.optionPort,
+                "name" : "rpcport"}
+        self.options['environment']['pool_dirs'] = {\
+                "value" : [],
+                "additive" : True,
+                "action" : self.optionDirList,
+                "name" : "machine_pool_dirs"}
+        self.options['environment']['tool_dirs'] = {\
+                "value" : [],
+                "additive" : True,
+                "action" : self.optionDirList,
+                "name" : "test_tool_dirs"}
+        self.options['environment']['module_dirs'] = {\
+                "value" : [],
+                "additive" : True,
+                "action" : self.optionDirList,
+                "name" : "test_module_dirs"}
+
+    def slave_scheme(self):
         self.options['cache'] = dict()
-        self.options['cache']['dir'] = os.path.abspath(os.path.join(
-                os.path.dirname(sys.argv[0]), './cache'))
-
-        self.options['cache']['expiration_period'] = 7*24*60*60 # 1 week
+        self.options['cache']['dir'] = {\
+                "value" : os.path.abspath(os.path.join(
+                    os.path.dirname(sys.argv[0]), './cache')),
+                "additive" : False,
+                "action" : self.optionPath,
+                "name" : "cache_dir"}
+
+        self.options['cache']['expiration_period'] = {\
+                "value" : 7*24*60*60, # 1 week
+                "additive" : False,
+                "action" : self.optionTimeval,
+                "name" : "expiration_period"}
 
     def get_config(self):
         return self.options
@@ -72,7 +103,7 @@ class Config():
         if option not in sect:
             msg = 'Unknown option: %s in section: %s' % (option, section)
             raise ConfigError(msg)
-        return sect[option]
+        return sect[option]["value"]
 
     def load_config(self, path):
         '''Parse and load the config file'''
@@ -83,90 +114,51 @@ class Config():
 
         sections = parser._sections
 
-        if self._scheme == "controller":
-            self.sectionsCntl(sections, abs_path)
-        elif self._scheme == "slave":
-            self.sectionsSlave(sections, abs_path)
-        else:
-            msg = "Unknow scheme: '%s', can't parse sections." \
-                    % self._scheme
-            raise ConfigError(msg)
+        self.handleSections(sections, abs_path)
 
-    def sectionsCntl(self, sections, path):
+    def handleSections(self, sections, path):
         for section in sections:
-            if section == "log":
-                self.sectionLogs(sections[section], path)
-            elif section == "environment":
-                self.sectionEnvironment(sections[section], path)
+            if section in self.options:
+                self.handleOptions(section, sections[section], path)
             else:
                 msg = "Unknown section: %s" % section
                 raise ConfigError(msg)
 
-    def sectionsSlave(self, sections, path):
-        for section in sections:
-            if section == "cache":
-                self.sectionCache(sections[section], path)
-            else:
-                msg = "Unknown section: %s" % section
-                raise ConfigError(msg)
-
-    def sectionLogs(self, config, cfg_path):
-        section = self.options['log']
+    def handleOptions(self, section_name, config, cfg_path):
+        section = self.options[section_name]
 
         config.pop('__name__', None)
-        for option in config:
-            if option == 'path':
-                section['path'] = self.optionPath(config[option], cfg_path)
+        for opt in config:
+            option = self._find_option_by_name(section, opt)
+            if option != None:
+                if option[1]: #additive?
+                    option[0]["value"] +=\
+                            option[0]["action"](config[opt], cfg_path)
+                else:
+                    option[0]["value"] =\
+                            option[0]["action"](config[opt], cfg_path)
             else:
-                msg = "Unknown option: %s in section log" % option
+                msg = "Unknown option: %s in section %s" % (opt, section_name)
                 raise ConfigError(msg)
 
-    def sectionCache(self, config, cfg_path):
-        section = self.options['cache']
-
-        config.pop('__name__', None)
-        for option in config:
-            if option == 'cache_dir':
-                section['dir'] = self.optionPath(config[option], cfg_path)
-            elif option == 'expiration_period':
-                value = self.optionTimeval(config[option])
-                section['expiration_period'] = value
-            else:
-                msg = "Unknown option: %s in section cache" % option
-                raise ConfigError(msg)
+    def _find_option_by_name(self, section, opt_name):
+        match = re.match(r'^(\w*)(\s+\+)$', opt_name)
+        if match != None:
+            additive = True
+            opt_name = match.groups()[0]
+        else:
+            additive = False
 
-    def sectionEnvironment(self, config, cfg_path):
-        section = self.options['environment']
+        for option in section.itervalues():
+            if option["name"] == opt_name:
+                if (not option["additive"]) and additive:
+                    msg = "Operator += cannot be used in option %s" % opt_name
+                    raise ConfigError(msg)
+                return (option, additive)
 
-        config.pop('__name__', None)
-        for option in config:
-            if option == 'mac_pool_range':
-                section['mac_pool_range'] = self.optionMacRange(config[option])
-            elif option == 'rpcport':
-                section['rpcport'] = self.optionPort(config[option])
-            elif option == 'machine_pool_dirs':
-                section['pool_dirs'] = self.optionDirList(config[option],
-                                                           cfg_path)
-            elif re.match(r'^machine_pool_dirs\s+\+$', option):
-                section['pool_dirs'] += self.optionDirList(config[option],
-                                                           cfg_path)
-            elif option == 'test_module_dirs':
-                section['module_dirs'] = self.optionDirList(config[option],
-                                                           cfg_path)
-            elif re.match(r'^test_module_dirs\s+\+$', option):
-                section['module_dirs'] += self.optionDirList(config[option],
-                                                           cfg_path)
-            elif option == 'test_tool_dirs':
-                section['tool_dirs'] = self.optionDirList(config[option],
-                                                           cfg_path)
-            elif re.match(r'^test_tool_dirs\s+\+$', option):
-                section['tool_dirs'] += self.optionDirList(config[option],
-                                                           cfg_path)
-            else:
-                msg = "Unknown option: %s in section environment" % option
-                raise ConfigError(msg)
+        return None
 
-    def optionPort(self, option):
+    def optionPort(self, option, cfg_path):
         try:
             int(option)
         except ValueError:
@@ -180,7 +172,7 @@ class Config():
         norm_path = os.path.normpath(abs_path)
         return norm_path
 
-    def optionMacRange(self, option):
+    def optionMacRange(self, option, cfg_path):
         vals = option.split()
         if len(vals) != 2:
             msg = "Option mac_pool_range expects 2"\
@@ -206,7 +198,7 @@ class Config():
 
         return dirs
 
-    def optionTimeval(self, option):
+    def optionTimeval(self, option, cfg_path):
         timeval_re = "^(([0-9]+)days?)?\s*(([0-9]+)hours?)?\s*" \
                      "(([0-9]+)minutes?)?\s*(([0-9]+)seconds?)?$"
         timeval_match = re.match(timeval_re, option)
-- 
1.7.11.7

[PATCH 2/3] Config: add method dump_config

[Ondrej Lichtner]

From: Ondrej Lichtner <olichtne(a)redhat.com&gt;

This patch adds a method that returns the currently loaded config values
in a .ini file formatted string. In the future it will be used to create
the config file in users home directory.

I decided to dump all config values and use the '=' operator. Using the
'+=' where it can be used would make more sense but it would be more
complicated to implement and I currently don't see any pretty way to do
it. But I might change this in the future.

Signed-off-by: Ondrej Lichtner <olichtne(a)redhat.com&gt;
---
 Common/Config.py | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/Common/Config.py b/Common/Config.py
index 4a4905b..56269b8 100644
--- a/Common/Config.py
+++ b/Common/Config.py
@@ -218,3 +218,25 @@ class Config():
             raise ConfigError(msg)
 
         return timeval
+
+    def dump_config(self):
+        string = ""
+        for section in self.options:
+            string += "[%s]\n" % section
+            for option in self.options[section]:
+                val = self.value_to_string(section, option)
+                opt_name = self.options[section][option]["name"]
+                string += "%s = %s\n" % (opt_name, val)
+
+        return string
+
+    def value_to_string(self, section, option):
+        string = ""
+        value = self.options[section][option]["value"]
+
+        if type(value) == list:
+            string = " ".join(value)
+        else:
+            string = str(value)
+
+        return string
-- 
1.7.11.7

[PATCH 3/3] nettestctl: create user config file at first launch

[Ondrej Lichtner]

From: Ondrej Lichtner <olichtne(a)redhat.com&gt;

The controller detets its first launch by searching for a configuration
file in the users home directory. If it doesn't exist it creates it and
fills it with values that are currently loaded. Using this configuration
file is not yet fully functional as it requires the correct values to be
loaded from the system-wide configuration file /etc/lnst-ctl.conf which
will be added at a later date.

Signed-off-by: Ondrej Lichtner <olichtne(a)redhat.com&gt;
---
 nettestctl.py | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/nettestctl.py b/nettestctl.py
index e97733c..416e0ab 100755
--- a/nettestctl.py
+++ b/nettestctl.py
@@ -106,7 +106,15 @@ def main():
         config.load_config(gitcfg)
     else:
         config.load_config('/etc/lnst-ctl.conf')
-        config.load_config('~/.lnst/lnst-ctl.conf')
+        usr_cfg = os.path.expanduser('~/.lnst/lnst-ctl.conf')
+        if os.path.isfile(usr_cfg):
+            config.load_config(usr_cfg)
+        else:
+            if not os.path.isdir(os.path.dirname(usr_cfg)):
+                os.makedirs(os.path.dirname(usr_cfg))
+            with open(usr_cfg, 'w') as f:
+                f.write(config.dump_config())
+
 
     debug = 0
     recipe_path = None
-- 
1.7.11.7