Options: call _set_defaults_from_config before _parse_config_options

_set_defaults_from_config must be called before _parse_config_options
This is due to a tricky interaction between the two methods:

(1) _set_defaults_from_config does what its name implies, it updates
the "default" property of each Option based on the value that exists
in the config.

(2)  _parse_config_options will look at each option and set it to the
default value that is _currently_ defined.  If the option does not
exist in the namespace, it will be added.  The method carefully
avoids overwriting the value of an option that is already defined in
the namespace.

Thus, if _set_defaults_from_config has not been called yet when
_parse_config_options is called, all config file options will get set
to their hardcoded defaults.  This process defines the options in the
namespace and _parse_config_options will never look at them again.

1 files changed, 18 insertions, 0 deletions

diff --git a/src/lib/Bcfg2/Options/Parser.py b/src/lib/Bcfg2/Options/Parser.py
index b8b25f710..48f3c5056 100644
--- a/src/lib/Bcfg2/Options/Parser.py
+++ b/src/lib/Bcfg2/Options/Parser.py
@@ -254,6 +254,24 @@ class Parser(argparse.ArgumentParser):
         # iteration, set defaults from config file/environment
         # variables
         _debug("Option parsing phase 3: Main parser loop")
+        # _set_defaults_from_config must be called before _parse_config_options
+        # This is due to a tricky interaction between the two methods:
+        #
+        # (1) _set_defaults_from_config does what its name implies, it updates
+        # the "default" property of each Option based on the value that exists
+        # in the config.
+        #
+        # (2)  _parse_config_options will look at each option and set it to the
+        # default value that is _currently_ defined.  If the option does not
+        # exist in the namespace, it will be added.  The method carefully
+        # avoids overwriting the value of an option that is already defined in
+        # the namespace.
+        #
+        # Thus, if _set_defaults_from_config has not been called yet when
+        # _parse_config_options is called, all config file options will get set
+        # to their hardcoded defaults.  This process defines the options in the
+        # namespace and _parse_config_options will never look at them again.
+        self._set_defaults_from_config()
         self._parse_config_options()
         while not self.parsed:
             self.parsed = True