Expose fixtures through oslo_log.fixture

Expose the fixtures through the package import instead of requiring the
user to import each module.

Add documentation for the fixtures.

Change-Id: Ic96a030c45853406c2b77740b26d168cb8882f5c

doc/source/api/fixtures.rst

@@ -0,0 +1,9 @@
+==================
+ oslo_log.fixture
+==================
+
+.. module:: oslo_log.fixture
+
+.. autofunction:: oslo_log.fixture.get_logging_handle_error_fixture
+
+.. autoclass:: oslo_log.fixture.SetLogLevel

oslo_log/fixture/__init__.py

@@ -0,0 +1,16 @@
+# All Rights Reserved.
+#
+# 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 .logging_error import get_logging_handle_error_fixture
+from .setlevel import SetLogLevel

oslo_log/fixture/logging_error.py

@@ -18,8 +18,11 @@ import fixtures
 def get_logging_handle_error_fixture():
     """returns a fixture to make logging raise formatting exceptions.
 
-    Usage:
+    To use::
-    self.useFixture(logging.get_logging_handle_error_fixture())
+
+      from oslo_log import fixture as log_fixture
+
+      self.useFixture(log_fixture.get_logging_handle_error_fixture())
     """
     return fixtures.MonkeyPatch('logging.Handler.handleError',
                                 _handleError)

oslo_log/fixture/setlevel.py

@@ -23,7 +23,9 @@ class SetLogLevel(fixtures.Fixture):
 
     To use::
 
-      self.setFixture(['myapp.foo'], logging.DEBUG)
+      from oslo_log import fixture as log_fixture
+
+      self.useFixture(log_fixture.SetLogLevel(['myapp.foo'], logging.DEBUG))
 
     :param logger_names: Sequence of logger names, as would be passed
                          to getLogger().

oslo_log/tests/unit/fixture/test_logging_error.py

@@ -11,7 +11,7 @@
 #    under the License.
 
 
-from oslo_log.fixture import logging_error
+from oslo_log import fixture
 from oslo_log import log as logging
 from oslotest import base as test_base
 
@@ -21,7 +21,7 @@ LOG = logging.getLogger(__name__)
 class TestLoggingFixture(test_base.BaseTestCase):
     def test_logging_handle_error(self):
         LOG.error('pid of first child is %(foo)s', 1)
-        self.useFixture(logging_error.get_logging_handle_error_fixture())
+        self.useFixture(fixture.get_logging_handle_error_fixture())
         self.assertRaises(TypeError,
                           LOG.error,
                           'pid of first child is %(foo)s',

oslo_log/tests/unit/fixture/test_setlevel.py

@@ -12,7 +12,7 @@
 
 import logging
 
-from oslo_log.fixture import setlevel
+from oslo_log import fixture
 from oslotest import base as test_base
 
 
@@ -21,7 +21,7 @@ class TestSetLevelFixture(test_base.BaseTestCase):
     def test_unset_before(self):
         logger = logging.getLogger('no-such-logger-unset')
         self.assertEqual(logging.NOTSET, logger.level)
-        fix = setlevel.SetLogLevel(['no-such-logger-unset'], logging.DEBUG)
+        fix = fixture.SetLogLevel(['no-such-logger-unset'], logging.DEBUG)
         with fix:
             self.assertEqual(logging.DEBUG, logger.level)
         self.assertEqual(logging.NOTSET, logger.level)
@@ -30,7 +30,7 @@ class TestSetLevelFixture(test_base.BaseTestCase):
         logger = logging.getLogger('no-such-logger-set')
         logger.setLevel(logging.ERROR)
         self.assertEqual(logging.ERROR, logger.level)
-        fix = setlevel.SetLogLevel(['no-such-logger-set'], logging.DEBUG)
+        fix = fixture.SetLogLevel(['no-such-logger-set'], logging.DEBUG)
         with fix:
             self.assertEqual(logging.DEBUG, logger.level)
         self.assertEqual(logging.ERROR, logger.level)