Clean up import side effects in tests

CHANGELOG.rst

@@ -33,7 +33,7 @@ Added
 * Continue introducing `pants <https://www.pantsbuild.org/docs>`_ to improve DX (Developer Experience)
   working on StackStorm, improve our security posture, and improve CI reliability thanks in part
   to pants' use of PEX lockfiles. This is not a user-facing addition.
-  #6118 #6141 #6133 #6120 #6181 #6183 #6200 #6237 #6229 #6240
+  #6118 #6141 #6133 #6120 #6181 #6183 #6200 #6237 #6229 #6240 #6241
   Contributed by @cognifloyd
 * Build of ST2 EL9 packages #6153
   Contributed by @amanda11

st2actions/tests/unit/policies/test_base.py

@@ -16,9 +16,8 @@
 from __future__ import absolute_import
 import mock
 
-from st2tests import config as test_config
-
-test_config.parse_args()
+# This import must be early for import-time side-effects.
+from st2tests.base import CleanDbTestCase, DbTestCase
 
 import st2common
 from st2common.bootstrap.policiesregistrar import register_policy_types
@@ -28,8 +27,6 @@
 from st2common.services import action as action_service
 from st2common.services import policies as policy_service
 from st2common.bootstrap import runnersregistrar as runners_registrar
-from st2tests.base import DbTestCase
-from st2tests.base import CleanDbTestCase
 from st2tests.fixtures.generic.fixture import PACK_NAME as PACK
 from st2tests.fixturesloader import FixturesLoader
 

st2actions/tests/unit/policies/test_concurrency.py

@@ -19,10 +19,9 @@
 from mock import call
 from six.moves import range
 
+# This import must be early for import-time side-effects.
 # Importing st2actions.scheduler relies on config being parsed :/
-import st2tests.config as tests_config
-
-tests_config.parse_args()
+from st2tests import DbTestCase, EventletTestCase, ExecutionDbTestCase
 
 import st2common
 from st2actions.scheduler import handler as scheduling_queue
@@ -38,8 +37,6 @@
 from st2common.transport.liveaction import LiveActionPublisher
 from st2common.transport.publishers import CUDPublisher
 from st2common.bootstrap import runnersregistrar as runners_registrar
-from st2tests import DbTestCase, EventletTestCase
-from st2tests import ExecutionDbTestCase
 import st2tests.config as tests_config
 from st2tests.fixtures.generic.fixture import PACK_NAME as PACK
 from st2tests.fixturesloader import FixturesLoader

st2actions/tests/unit/policies/test_concurrency_by_attr.py

@@ -18,10 +18,9 @@
 import mock
 from mock import call
 
+# This import must be early for import-time side-effects.
 # Importing st2actions.scheduler relies on config being parsed :/
-import st2tests.config as tests_config
-
-tests_config.parse_args()
+from st2tests import ExecutionDbTestCase, EventletTestCase
 
 import st2common
 from st2actions.scheduler import handler as scheduling_queue
@@ -36,7 +35,6 @@
 from st2common.transport.liveaction import LiveActionPublisher
 from st2common.transport.publishers import CUDPublisher
 from st2common.bootstrap import runnersregistrar as runners_registrar
-from st2tests import ExecutionDbTestCase, EventletTestCase
 import st2tests.config as tests_config
 from st2tests.fixtures.generic.fixture import PACK_NAME as PACK
 from st2tests.fixturesloader import FixturesLoader

st2actions/tests/unit/test_action_runner_worker.py

@@ -20,14 +20,17 @@
 from st2common.transport.consumers import ActionsQueueConsumer
 from st2common.models.db.liveaction import LiveActionDB
 
-from st2tests import config as test_config
-
-test_config.parse_args()
+from st2tests import config as tests_config
 
 __all__ = ["ActionsQueueConsumerTestCase"]
 
 
 class ActionsQueueConsumerTestCase(TestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        tests_config.parse_args()
+
     def test_process_right_dispatcher_is_used(self):
         handler = Mock()
         handler.message_type = LiveActionDB

st2actions/tests/unit/test_execution_cancellation.py

@@ -20,10 +20,8 @@
 
 from oslo_config import cfg
 
-# XXX: actionsensor import depends on config being setup.
-import st2tests.config as tests_config
-
-tests_config.parse_args()
+# This import must be early for import-time side-effects.
+from st2tests import ExecutionDbTestCase
 
 from st2common.constants import action as action_constants
 from st2common.models.api.action import ActionAPI
@@ -36,7 +34,6 @@
 from st2common.services import trace as trace_service
 from st2common.transport.liveaction import LiveActionPublisher
 from st2common.transport.publishers import CUDPublisher
-from st2tests import ExecutionDbTestCase
 from st2tests.fixtures.generic.fixture import PACK_NAME as PACK
 from st2tests.fixturesloader import FixturesLoader
 from st2tests.mocks.execution import MockExecutionPublisher

st2actions/tests/unit/test_executions.py

@@ -18,10 +18,8 @@
 
 import mock
 
-# XXX: actionsensor import depends on config being setup.
-import st2tests.config as tests_config
-
-tests_config.parse_args()
+# This import must be early for import-time side-effects.
+from st2tests import ExecutionDbTestCase
 
 import st2common.bootstrap.runnersregistrar as runners_registrar
 from st2common.constants import action as action_constants
@@ -46,7 +44,6 @@
 from local_runner.local_shell_command_runner import LocalShellCommandRunner
 
 from st2tests.fixtures.packs import executions as fixture
-from st2tests import ExecutionDbTestCase
 from st2tests.mocks.liveaction import MockLiveActionPublisher
 
 

st2actions/tests/unit/test_notifier.py

@@ -19,9 +19,8 @@
 import bson
 import mock
 
-import st2tests.config as tests_config
-
-tests_config.parse_args()
+# This import must be early for import-time side-effects.
+from st2tests.base import CleanDbTestCase
 
 from st2actions.notifier.notifier import Notifier
 from st2common.constants.action import LIVEACTION_COMPLETED_STATES
@@ -40,7 +39,6 @@
 from st2common.models.system.common import ResourceReference
 from st2common.util import date as date_utils
 from st2common.util import isotime
-from st2tests.base import CleanDbTestCase
 
 ACTION_TRIGGER_TYPE = INTERNAL_TRIGGER_TYPES["action"][0]
 NOTIFY_TRIGGER_TYPE = INTERNAL_TRIGGER_TYPES["action"][1]

st2actions/tests/unit/test_output_schema.py

@@ -20,12 +20,9 @@
 from python_runner import python_runner
 from orquesta_runner import orquesta_runner
 
+# This import must be early for import-time side-effects.
 import st2tests
 
-import st2tests.config as tests_config
-
-tests_config.parse_args()
-
 from st2common.bootstrap import actionsregistrar
 from st2common.bootstrap import runnersregistrar
 from st2common.constants import action as ac_const

st2actions/tests/unit/test_parallel_ssh.py

@@ -25,8 +25,6 @@
 from st2common.runners.paramiko_ssh import SSHCommandTimeoutError
 import st2tests.config as tests_config
 
-tests_config.parse_args()
-
 MOCK_STDERR_SUDO_PASSWORD_ERROR = """
 [sudo] password for bar: Sorry, try again.\n
 [sudo] password for bar:' Sorry, try again.\n
@@ -36,6 +34,11 @@
 
 
 class ParallelSSHTests(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        tests_config.parse_args()
+
     @patch("paramiko.SSHClient", Mock)
     @patch.object(
         ParamikoSSHClient,

st2actions/tests/unit/test_paramiko_remote_script_runner.py

@@ -22,8 +22,6 @@
 # before importing remote_script_runner classes.
 import st2tests.config as tests_config
 
-tests_config.parse_args()
-
 from st2common.util import jsonify
 from st2common.models.db.action import ActionDB
 from st2common.runners.parallel_ssh import ParallelSSHClient
@@ -48,6 +46,11 @@
 
 
 class ParamikoScriptRunnerTestCase(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        tests_config.parse_args()
+
     @patch("st2common.runners.parallel_ssh.ParallelSSHClient", Mock)
     @patch.object(jsonify, "json_loads", MagicMock(return_value={}))
     @patch.object(ParallelSSHClient, "run", MagicMock(return_value={}))

st2actions/tests/unit/test_paramiko_ssh.py

@@ -29,12 +29,15 @@
 from st2tests.fixturesloader import get_resources_base_path
 import st2tests.config as tests_config
 
-tests_config.parse_args()
-
 __all__ = ["ParamikoSSHClientTestCase"]
 
 
 class ParamikoSSHClientTestCase(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        tests_config.parse_args()
+
     @patch("paramiko.SSHClient", Mock)
     def setUp(self):
         """

st2actions/tests/unit/test_paramiko_ssh_runner.py

@@ -30,15 +30,18 @@
 import st2tests.config as tests_config
 from st2tests.fixturesloader import get_resources_base_path
 
-tests_config.parse_args()
-
 
 class Runner(BaseParallelSSHRunner):
     def run(self):
         pass
 
 
 class ParamikoSSHRunnerTestCase(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        tests_config.parse_args()
+
     @mock.patch("st2common.runners.paramiko_ssh_runner.ParallelSSHClient")
     def test_pre_run(self, mock_client):
         # Test case which verifies that ParamikoSSHClient is instantiated with the correct arguments

st2actions/tests/unit/test_queue_consumers.py

@@ -15,13 +15,12 @@
 
 from __future__ import absolute_import
 
-import st2tests.config as tests_config
-
-tests_config.parse_args()
-
 import mock
 from kombu.message import Message
 
+# This import must be early for import-time side-effects.
+from st2tests.base import ExecutionDbTestCase
+
 from st2actions import worker
 from st2actions.scheduler import entrypoint as scheduling
 from st2actions.scheduler import handler as scheduling_queue
@@ -35,7 +34,6 @@
 from st2common.transport.publishers import PoolPublisher
 from st2common.util import action_db as action_utils
 from st2common.util import date as date_utils
-from st2tests.base import ExecutionDbTestCase
 from st2tests.fixtures.packs.core.fixture import PACK_PATH as CORE_PACK_PATH
 
 

st2actions/tests/unit/test_remote_runners.py

@@ -13,18 +13,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# XXX: FabricRunner import depends on config being setup.
-from __future__ import absolute_import
-import st2tests.config as tests_config
-
-tests_config.parse_args()
-
 from unittest import TestCase
 
+# This import must be early for import-time side-effects.
+import st2tests.config as tests_config
+
 from st2common.models.system.action import RemoteScriptAction
 
 
 class RemoteScriptActionTestCase(TestCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        tests_config.parse_args()
+
     def test_parameter_formatting(self):
         # Only named args
         named_args = {

st2actions/tests/unit/test_runner_container.py

@@ -19,6 +19,9 @@
 
 from oslo_config import cfg
 
+# This import must be early for import-time side-effects.
+from st2tests.base import DbTestCase
+
 from st2common.constants import action as action_constants
 from st2common.runners.base import get_runner
 from st2common.exceptions.actionrunner import (
@@ -35,10 +38,6 @@
 from st2common.util import date as date_utils
 from st2common.transport.publishers import PoolPublisher
 
-from st2tests.base import DbTestCase
-import st2tests.config as tests_config
-
-tests_config.parse_args()
 from st2tests.fixtures.generic.fixture import PACK_NAME as FIXTURES_PACK
 from st2tests.fixturesloader import FixturesLoader
 

st2actions/tests/unit/test_scheduler.py

@@ -19,10 +19,6 @@
 import mock
 import eventlet
 
-from st2tests import config as test_config
-
-test_config.parse_args()
-
 import st2common
 from st2tests import ExecutionDbTestCase
 from st2tests.fixtures.generic.fixture import PACK_NAME as PACK

st2actions/tests/unit/test_scheduler_entrypoint.py

@@ -16,10 +16,6 @@
 import eventlet
 import mock
 
-from st2tests import config as test_config
-
-test_config.parse_args()
-
 from st2actions.cmd.scheduler import _run_scheduler
 from st2actions.scheduler.handler import ActionExecutionSchedulingQueueHandler
 from st2actions.scheduler.entrypoint import SchedulerEntrypoint

st2actions/tests/unit/test_scheduler_retry.py

@@ -13,19 +13,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# This import must be first for import-time side-effects.
+from st2tests.base import CleanDbTestCase
+
 import eventlet
 import mock
 import pymongo
 import uuid
 
-from st2tests import config as test_config
-
-test_config.parse_args()
-
 from st2actions.scheduler import handler
 from st2common.models.db import execution_queue as ex_q_db
 from st2common.persistence import execution_queue as ex_q_db_access
-from st2tests.base import CleanDbTestCase
 
 
 __all__ = ["SchedulerHandlerRetryTestCase"]