move nova.common.deprecated to openstack-common

Fixes bug #1070511

nova has a common deprecation path which lets you turn
deprecation warnings into fatal errors via config. Make
this a function of the openstack common log to make it
available to other projects in a standard way.

Include exception directly in logging module.

Update exception to work correctly now that it's not
based off of nova's exception class.

Change-Id: I699e776c99c429e60dfb5cd6c0cdbb661bae0ce8

2 files changed, 71 insertions, 0 deletions

diff --git a/openstack/common/log.py b/openstack/common/log.py
index 783ff2d..6cb3dfc 100644
--- a/openstack/common/log.py
+++ b/openstack/common/log.py
@@ -76,6 +76,9 @@ log_opts = [
     cfg.BoolOpt('publish_errors',
                 default=False,
                 help='publish error events'),
+    cfg.BoolOpt('fatal_deprecations',
+                default=False,
+                help='make deprecations fatal'),
 
     # NOTE(mikal): there are two options here because sometimes we are handed
     # a full instance (and could include more information), and other times we
@@ -170,6 +173,14 @@ class ContextAdapter(logging.LoggerAdapter):
     def audit(self, msg, *args, **kwargs):
         self.log(logging.AUDIT, msg, *args, **kwargs)
 
+    def deprecated(self, msg, *args, **kwargs):
+        stdmsg = _("Deprecated Config: %s") % msg
+        if CONF.fatal_deprecations:
+            self.critical(stdmsg, *args, **kwargs)
+            raise DeprecatedConfig(msg=stdmsg)
+        else:
+            self.warn(stdmsg, *args, **kwargs)
+
     def process(self, msg, kwargs):
         if 'extra' not in kwargs:
             kwargs['extra'] = {}
@@ -450,3 +461,10 @@ class ColorHandler(logging.StreamHandler):
     def format(self, record):
         record.color = self.LEVEL_COLORS[record.levelno]
         return logging.StreamHandler.format(self, record)
+
+
+class DeprecatedConfig(Exception):
+    message = _("Fatal call to deprecated config: %(msg)s")
+
+    def __init__(self, msg):
+        super(Exception, self).__init__(self.message % dict(msg=msg))
diff --git a/tests/unit/test_deprecated.py b/tests/unit/test_deprecated.py
new file mode 100644
index 0000000..770a7b9
--- /dev/null
+++ b/tests/unit/test_deprecated.py
@@ -0,0 +1,53 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+#
+#    Copyright 2010 OpenStack LLC
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from openstack.common import cfg
+from openstack.common import log as logging
+from tests import utils as test_utils
+
+LOG = logging.getLogger(__name__)
+
+
+class DeprecatedConfigTestCase(test_utils.BaseTestCase):
+    def setUp(self):
+        super(DeprecatedConfigTestCase, self).setUp()
+        self.warnbuffer = ""
+        self.critbuffer = ""
+
+        def warn_log(msg):
+            self.warnbuffer = msg
+
+        def critical_log(msg):
+            self.critbuffer = msg
+
+        self.stubs.Set(LOG, 'warn', warn_log)
+        self.stubs.Set(LOG, 'critical', critical_log)
+
+    def test_deprecated(self):
+        LOG.deprecated('test')
+        self.assertEqual(self.warnbuffer, 'Deprecated Config: test')
+
+    def test_deprecated_fatal(self):
+        self.config(fatal_deprecations=True)
+        self.assertRaises(logging.DeprecatedConfig,
+                          LOG.deprecated, "test2")
+        self.assertEqual(self.critbuffer, 'Deprecated Config: test2')
+
+    def test_deprecated_logs_only_once(self):
+        LOG.deprecated('only once!')
+        LOG.deprecated('only once!')
+        LOG.deprecated('only once!')
+        self.assertEqual(self.warnbuffer, 'Deprecated Config: only once!')