Merge "added deprecated.warn helper method"

nova/common/deprecated.py

@@ -0,0 +1,42 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright (c) 2012 IBM
+#
+#    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 nova import exception
+from nova import flags
+from nova import log as logging
+from nova.openstack.common import cfg
+
+LOG = logging.getLogger(__name__)
+
+deprecate_opts = [
+    cfg.BoolOpt('fatal_deprecations',
+                default=False,
+                help='make deprecations fatal')
+    ]
+FLAGS = flags.FLAGS
+FLAGS.register_opts(deprecate_opts)
+
+
+def warn(msg=""):
+    """
+    Warn of a deprecated config option that an operator has specified.
+    This should be added in the code where we've made a change in how
+    we use some operator changeable parameter to indicate that it will
+    go away in a future version of OpenStack.
+    """
+    LOG.warn(_("Deprecated Config: %s") % msg)
+    if FLAGS.fatal_deprecations:
+        raise exception.DeprecatedConfig(msg=msg)

nova/tests/test_deprecated.py

@@ -0,0 +1,40 @@
+# 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 nova.common import deprecated
+from nova import exception
+from nova import test
+
+
+class DeprecatedConfigTestCase(test.TestCase):
+    def setUp(self):
+        super(DeprecatedConfigTestCase, self).setUp()
+        self.logbuffer = ""
+
+        def local_log(msg):
+            self.logbuffer = msg
+
+        self.stubs.Set(deprecated.LOG, 'warn', local_log)
+
+    def test_deprecated(self):
+        deprecated.warn('test')
+        self.assertEqual(self.logbuffer, 'Deprecated Config: test')
+
+    def test_deprecated_fatal(self):
+        self.flags(fatal_deprecations=True)
+        self.assertRaises(exception.DeprecatedConfig,
+                          deprecated.warn, "test2")
+        self.assertEqual(self.logbuffer, 'Deprecated Config: test2')