From 338c1f2d017ef449211dac9ec6937aee401f71e9 Mon Sep 17 00:00:00 2001
From: Ghe Rivero <ghe.rivero@hp.com>
Date: Thu, 19 Mar 2015 18:39:54 +0100
Subject: [PATCH] Adopt config generator

oslo.config.generator has been removed from olso-incubator so
we need to adopt it in order to generated up-to-date config
files.
Changes introduced:
- Move config/generator.py from openstack.common to ironic.common
- Update config generator to use new style list_opts discovery
- Split _print_opt function to reduce complexity and pass pep8 tests

Change-Id: I397504bf0604a86082f26e46952720117611f3a8
---
 etc/ironic/ironic.conf.sample                 | 112 ++++++++++--------
 .../config_generator}/__init__.py             |   0
 .../config_generator}/generator.py            |  78 +++++++-----
 tools/config/generate_sample.sh               |   2 +-
 4 files changed, 115 insertions(+), 77 deletions(-)
 rename ironic/{openstack/common/config => common/config_generator}/__init__.py (100%)
 rename ironic/{openstack/common/config => common/config_generator}/generator.py (83%)

diff --git a/etc/ironic/ironic.conf.sample b/etc/ironic/ironic.conf.sample
index 65c943efa3..73aee55071 100644
--- a/etc/ironic/ironic.conf.sample
+++ b/etc/ironic/ironic.conf.sample
@@ -10,7 +10,7 @@
 #rpc_zmq_bind_address=*
 
 # MatchMaker driver. (string value)
-#rpc_zmq_matchmaker=oslo_messaging._drivers.matchmaker.MatchMakerLocalhost
+#rpc_zmq_matchmaker=local
 
 # ZeroMQ receiver listening port. (integer value)
 #rpc_zmq_port=9501
@@ -43,8 +43,9 @@
 # Size of RPC thread pool. (integer value)
 #rpc_thread_pool_size=64
 
-# Driver or drivers to handle sending notifications. (multi
-# valued)
+# The Drivers(s) to handle sending notifications. Possible
+# values are messaging, messagingv2, routing,log, test, noop
+# (multi valued)
 #notification_driver=
 
 # AMQP topic used for OpenStack notifications. (list value)
@@ -172,7 +173,7 @@
 
 # Directory where the ironic python module is installed.
 # (string value)
-#pybasedir=/usr/lib/python/site-packages/ironic
+#pybasedir=/usr/lib/python/site-packages/ironic/ironic
 
 # Directory where ironic binaries are installed. (string
 # value)
@@ -247,43 +248,10 @@
 # of default WARNING level). (boolean value)
 #verbose=false
 
-# Log output to standard error. (boolean value)
-#use_stderr=true
 
-# Format string to use for log messages with context. (string
-# value)
-#logging_context_format_string=%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s
-
-# Format string to use for log messages without context.
-# (string value)
-#logging_default_format_string=%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
-
-# Data to append to log format when level is DEBUG. (string
-# value)
-#logging_debug_format_suffix=%(funcName)s %(pathname)s:%(lineno)d
-
-# Prefix each line of exception output with this format.
-# (string value)
-#logging_exception_prefix=%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s
-
-# List of logger=LEVEL pairs. (list value)
-#default_log_levels=amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN
-
-# Enables or disables publication of error events. (boolean
-# value)
-#publish_errors=false
-
-# Enables or disables fatal status of deprecations. (boolean
-# value)
-#fatal_deprecations=false
-
-# The format for an instance that is passed with the log
-# message. (string value)
-#instance_format="[instance: %(uuid)s] "
-
-# The format for an instance UUID that is passed with the log
-# message. (string value)
-#instance_uuid_format="[instance: %(uuid)s] "
+#
+# Options defined in ironic.openstack.common.log
+#
 
 # The name of a logging configuration file. This file is
 # appended to any existing logging configuration files. For
@@ -329,6 +297,54 @@
 #syslog_log_facility=LOG_USER
 
 
+#
+# Options defined in ironic.openstack.common.log
+#
+
+# Log output to standard error. (boolean value)
+#use_stderr=true
+
+
+#
+# Options defined in ironic.openstack.common.log
+#
+
+# Format string to use for log messages with context. (string
+# value)
+#logging_context_format_string=%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s
+
+# Format string to use for log messages without context.
+# (string value)
+#logging_default_format_string=%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
+
+# Data to append to log format when level is DEBUG. (string
+# value)
+#logging_debug_format_suffix=%(funcName)s %(pathname)s:%(lineno)d
+
+# Prefix each line of exception output with this format.
+# (string value)
+#logging_exception_prefix=%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s
+
+# List of logger=LEVEL pairs. (list value)
+#default_log_levels=amqp=WARN,amqplib=WARN,boto=WARN,qpid=WARN,sqlalchemy=WARN,suds=INFO,oslo.messaging=INFO,iso8601=WARN,requests.packages.urllib3.connectionpool=WARN,urllib3.connectionpool=WARN,websocket=WARN,keystonemiddleware=WARN,routes.middleware=WARN,stevedore=WARN
+
+# Enables or disables publication of error events. (boolean
+# value)
+#publish_errors=false
+
+# Enables or disables fatal status of deprecations. (boolean
+# value)
+#fatal_deprecations=false
+
+# The format for an instance that is passed with the log
+# message. (string value)
+#instance_format="[instance: %(uuid)s] "
+
+# The format for an instance UUID that is passed with the log
+# message. (string value)
+#instance_uuid_format="[instance: %(uuid)s] "
+
+
 #
 # Options defined in ironic.openstack.common.periodic_task
 #
@@ -499,8 +515,8 @@
 # ceilometer via the notification bus. (integer value)
 #send_sensor_data_interval=600
 
-# List of comma separated meter types which need to be sent
-# to Ceilometer. The default value, "ALL", is a special value
+# List of comma separated meter types which need to be sent to
+# Ceilometer. The default value, "ALL", is a special value
 # meaning send all the sensor data. (list value)
 #send_sensor_data_types=ALL
 
@@ -1060,7 +1076,7 @@
 #memcache_pool_maxsize=10
 
 # (Optional) Socket timeout in seconds for communicating with
-# a memcache server. (integer value)
+# a memcached server. (integer value)
 #memcache_pool_socket_timeout=3
 
 # (Optional) Number of seconds a connection to memcached is
@@ -1068,11 +1084,11 @@
 #memcache_pool_unused_timeout=60
 
 # (Optional) Number of seconds that an operation will wait to
-# get a memcache client connection from the pool. (integer
+# get a memcached client connection from the pool. (integer
 # value)
 #memcache_pool_conn_get_timeout=10
 
-# (Optional) Use the advanced (eventlet safe) memcache client
+# (Optional) Use the advanced (eventlet safe) memcached client
 # pool. The advanced pool will only work under python 2.x.
 # (boolean value)
 #memcache_use_advanced_pool=false
@@ -1252,8 +1268,8 @@
 # Debug: dump AMQP frames to stdout (boolean value)
 #trace=false
 
-# CA certificate PEM file for verifing server certificate
-# (string value)
+# CA certificate PEM file to verify server certificate (string
+# value)
 #ssl_ca_file=
 
 # Identifying certificate PEM file to present to clients
@@ -1279,6 +1295,7 @@
 #
 
 # Use durable queues in AMQP. (boolean value)
+# Deprecated group/name - [DEFAULT]/amqp_durable_queues
 # Deprecated group/name - [DEFAULT]/rabbit_durable_queues
 #amqp_durable_queues=false
 
@@ -1337,6 +1354,7 @@
 #
 
 # Use durable queues in AMQP. (boolean value)
+# Deprecated group/name - [DEFAULT]/amqp_durable_queues
 # Deprecated group/name - [DEFAULT]/rabbit_durable_queues
 #amqp_durable_queues=false
 
diff --git a/ironic/openstack/common/config/__init__.py b/ironic/common/config_generator/__init__.py
similarity index 100%
rename from ironic/openstack/common/config/__init__.py
rename to ironic/common/config_generator/__init__.py
diff --git a/ironic/openstack/common/config/generator.py b/ironic/common/config_generator/generator.py
similarity index 83%
rename from ironic/openstack/common/config/generator.py
rename to ironic/common/config_generator/generator.py
index 2bdfac33d9..b0b34efcea 100644
--- a/ironic/openstack/common/config/generator.py
+++ b/ironic/common/config_generator/generator.py
@@ -17,6 +17,9 @@
 
 """Extracts OpenStack config option info from module(s)."""
 
+# NOTE(GheRivero): Copied from oslo_incubator before getting removed in
+#  Change-Id: If15b77d31a8c615aad8fca30f6dd9928da2d08bb
+
 from __future__ import print_function
 
 import argparse
@@ -27,7 +30,7 @@ import socket
 import sys
 import textwrap
 
-from oslo.config import cfg
+from oslo_config import cfg
 import six
 import stevedore.named
 
@@ -183,6 +186,18 @@ def _list_opts(obj):
                 not isinstance(o, cfg.SubCommandOpt))
 
     opts = list()
+
+    if 'list_opts' in dir(obj):
+        group_opts = getattr(obj, 'list_opts')()
+        # NOTE(GheRivero): Options without a defined group,
+        # must be registered to the DEFAULT section
+        fixed_list = []
+        for section, opts in group_opts:
+            if not section:
+                section = 'DEFAULT'
+            fixed_list.append((section, opts))
+        return fixed_list
+
     for attr_str in dir(obj):
         attr_obj = getattr(obj, attr_str)
         if is_opt(attr_obj):
@@ -272,40 +287,45 @@ def _print_opt(opt):
     try:
         if opt_default is None:
             print('#%s=<None>' % opt_name)
-        elif opt_type == STROPT:
-            assert(isinstance(opt_default, six.string_types))
-            print('#%s=%s' % (opt_name, _sanitize_default(opt_name,
-                                                          opt_default)))
-        elif opt_type == BOOLOPT:
-            assert(isinstance(opt_default, bool))
-            print('#%s=%s' % (opt_name, str(opt_default).lower()))
-        elif opt_type == INTOPT:
-            assert(isinstance(opt_default, int) and
-                   not isinstance(opt_default, bool))
-            print('#%s=%s' % (opt_name, opt_default))
-        elif opt_type == FLOATOPT:
-            assert(isinstance(opt_default, float))
-            print('#%s=%s' % (opt_name, opt_default))
-        elif opt_type == LISTOPT:
-            assert(isinstance(opt_default, list))
-            print('#%s=%s' % (opt_name, ','.join(opt_default)))
-        elif opt_type == DICTOPT:
-            assert(isinstance(opt_default, dict))
-            opt_default_strlist = [str(key) + ':' + str(value)
-                                   for (key, value) in opt_default.items()]
-            print('#%s=%s' % (opt_name, ','.join(opt_default_strlist)))
-        elif opt_type == MULTISTROPT:
-            assert(isinstance(opt_default, list))
-            if not opt_default:
-                opt_default = ['']
-            for default in opt_default:
-                print('#%s=%s' % (opt_name, default))
+        else:
+            _print_type(opt_type, opt_name, opt_default)
         print('')
     except Exception:
         sys.stderr.write('Error in option "%s"\n' % opt_name)
         sys.exit(1)
 
 
+def _print_type(opt_type, opt_name, opt_default):
+    if opt_type == STROPT:
+        assert(isinstance(opt_default, six.string_types))
+        print('#%s=%s' % (opt_name, _sanitize_default(opt_name,
+                                                          opt_default)))
+    elif opt_type == BOOLOPT:
+        assert(isinstance(opt_default, bool))
+        print('#%s=%s' % (opt_name, str(opt_default).lower()))
+    elif opt_type == INTOPT:
+        assert(isinstance(opt_default, int) and
+               not isinstance(opt_default, bool))
+        print('#%s=%s' % (opt_name, opt_default))
+    elif opt_type == FLOATOPT:
+        assert(isinstance(opt_default, float))
+        print('#%s=%s' % (opt_name, opt_default))
+    elif opt_type == LISTOPT:
+        assert(isinstance(opt_default, list))
+        print('#%s=%s' % (opt_name, ','.join(opt_default)))
+    elif opt_type == DICTOPT:
+        assert(isinstance(opt_default, dict))
+        opt_default_strlist = [str(key) + ':' + str(value)
+                                   for (key, value) in opt_default.items()]
+        print('#%s=%s' % (opt_name, ','.join(opt_default_strlist)))
+    elif opt_type == MULTISTROPT:
+        assert(isinstance(opt_default, list))
+        if not opt_default:
+            opt_default = ['']
+        for default in opt_default:
+            print('#%s=%s' % (opt_name, default))
+
+
 def main():
     generate(sys.argv[1:])
 
diff --git a/tools/config/generate_sample.sh b/tools/config/generate_sample.sh
index 99b46aa667..5fc53dc77a 100755
--- a/tools/config/generate_sample.sh
+++ b/tools/config/generate_sample.sh
@@ -121,7 +121,7 @@ export EVENTLET_NO_GREENDNS=yes
 
 OS_VARS=$(set | sed -n '/^OS_/s/=[^=]*$//gp' | xargs)
 [ "$OS_VARS" ] && eval "unset \$OS_VARS"
-DEFAULT_MODULEPATH=ironic.openstack.common.config.generator
+DEFAULT_MODULEPATH=ironic.common.config_generator.generator
 MODULEPATH=${MODULEPATH:-$DEFAULT_MODULEPATH}
 OUTPUTFILE=$OUTPUTDIR/$PACKAGENAME.conf.sample
 python -m $MODULEPATH $MODULES $LIBRARIES $FILES > $OUTPUTFILE