Move fixture

End users should not be consuming from the effectively private tests
modules.

Change-Id: Ie319d0362497513ffc45ff44bf9533c33b8f865e
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

oslo_privsep/test/fixture.py

@@ -0,0 +1,62 @@
+# Copyright 2015 Rackspace Inc.
+#
+#    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.
+
+import logging
+import os
+import sys
+from typing import Any
+
+import fixtures
+from oslo_config import fixture as cfg_fixture
+
+from oslo_privsep import priv_context
+
+LOG = logging.getLogger(__name__)
+
+
+class UnprivilegedPrivsepFixture(fixtures.Fixture):
+    def __init__(
+        self,
+        context: priv_context.PrivContext,
+        config_override: dict[str, Any],
+    ) -> None:
+        self.context = context
+        self.config_override = config_override
+
+    def setUp(self) -> None:
+        super().setUp()
+
+        self.conf = self.useFixture(cfg_fixture.Config()).conf
+        self.conf.set_override(
+            'capabilities', [], group=self.context.cfg_section
+        )
+        for k in ('user', 'group'):
+            self.conf.set_override(k, None, group=self.context.cfg_section)
+        for k, v in self.config_override.items():
+            self.conf.set_override(k, v, group='privsep')
+
+        orig_pid = os.getpid()
+        try:
+            self.context.start(method=priv_context.Method.FORK)
+        except Exception as e:
+            # py3 unittest/testtools/something catches fatal
+            # exceptions from child processes and tries to treat them
+            # like regular non-fatal test failures.  Here we attempt
+            # to undo that.
+            if os.getpid() == orig_pid:
+                raise
+            LOG.exception(e)
+            sys.exit(1)
+
+        self.addCleanup(self.context.stop)

oslo_privsep/tests/fixture.py

@@ -1,62 +1,25 @@
-# Copyright 2015 Rackspace Inc.
+# 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
 #
-#    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
 #
-#         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.
+# 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.
 
-import logging
-import os
-import sys
-from typing import Any
+import warnings
 
-import fixtures
-from oslo_config import fixture as cfg_fixture
+from oslo_privsep.test.fixture import UnprivilegedPrivsepFixture
 
-from oslo_privsep import priv_context
+__all__ = [
+    'UnprivilegedPrivsepFixture',
+]
 
-LOG = logging.getLogger(__name__)
-
-
-class UnprivilegedPrivsepFixture(fixtures.Fixture):
-    def __init__(
-        self,
-        context: priv_context.PrivContext,
-        config_override: dict[str, Any],
-    ) -> None:
-        self.context = context
-        self.config_override = config_override
-
-    def setUp(self) -> None:
-        super().setUp()
-
-        self.conf = self.useFixture(cfg_fixture.Config()).conf
-        self.conf.set_override(
-            'capabilities', [], group=self.context.cfg_section
-        )
-        for k in ('user', 'group'):
-            self.conf.set_override(k, None, group=self.context.cfg_section)
-        for k, v in self.config_override.items():
-            self.conf.set_override(k, v, group='privsep')
-
-        orig_pid = os.getpid()
-        try:
-            self.context.start(method=priv_context.Method.FORK)
-        except Exception as e:
-            # py3 unittest/testtools/something catches fatal
-            # exceptions from child processes and tries to treat them
-            # like regular non-fatal test failures.  Here we attempt
-            # to undo that.
-            if os.getpid() == orig_pid:
-                raise
-            LOG.exception(e)
-            sys.exit(1)
-
-        self.addCleanup(self.context.stop)
+warnings.warn(
+    'The oslo_privsep.tests.fixture module has been moved to '
+    'oslo_privsep.test.fixture. Please update your imports.',
+    DeprecationWarning,
+)

oslo_privsep/tests/testctx.py

@@ -17,8 +17,8 @@ import os
 from oslotest import base
 
 from oslo_privsep import priv_context
+from oslo_privsep.test import fixture
 import oslo_privsep.tests
-from oslo_privsep.tests import fixture
 
 
 context = priv_context.PrivContext(