Migrate test suite from oslotest/stestr to pytest

Remove legacy OpenStack testing infrastructure and modernize the test
suite using pytest fixtures and assertions. This simplifies dependencies
and provides a more modern testing experience.

Changes:
- Remove .stestr.conf configuration file
- Replace oslotest base classes with pytest fixtures in clibase.py
- Convert unittest assertions to pytest style (assertEqual -> assert)
- Add conftest.py with shared fixtures for mock client
- Update pyproject.toml to remove oslotest/testtools/fixtures deps
- Update tox.ini to use pytest instead of stestr

Author: tivaliy

.stestr.conf

@@ -0,0 +1,26 @@
+"""Pytest fixtures for gerritclient tests."""
+
+import shlex
+from unittest import mock
+
+import pytest
+
+from gerritclient import client
+from gerritclient import main as main_mod
+
+
+@pytest.fixture
+def mock_client():
+    """Fixture that provides a mocked gerrit client."""
+    with mock.patch.object(client, "get_client") as m_get_client:
+        m_client = mock.MagicMock()
+        m_get_client.return_value = m_client
+        yield {"get_client": m_get_client, "client": m_client}
+
+
+def exec_command(command=""):
+    """Executes gerrit with the specified arguments."""
+    argv = shlex.split(command)
+    if "--debug" not in argv:
+        argv = [*argv, "--debug"]
+    return main_mod.main(argv=argv)

gerritclient/tests/conftest.py

@@ -1,31 +1,30 @@
+"""Base class for CLI tests using pytest."""
+
 import shlex
 from unittest import mock
 
-from oslotest import base as oslo_base
+import pytest
 
 from gerritclient import client
 from gerritclient import main as main_mod
 
 
-class BaseCLITest(oslo_base.BaseTestCase):
+class BaseCLITest:
     """Base class for testing CLI."""
 
-    def setUp(self):
-        super().setUp()
-
-        self._get_client_patcher = mock.patch.object(client, "get_client")
-        self.m_get_client = self._get_client_patcher.start()
-
-        self.m_client = mock.MagicMock()
-        self.m_get_client.return_value = self.m_client
-        self.addCleanup(self._get_client_patcher.stop)
+    @pytest.fixture(autouse=True)
+    def setup_client_mock(self):
+        """Set up mocked client for each test."""
+        with mock.patch.object(client, "get_client") as m_get_client:
+            self.m_client = mock.MagicMock()
+            m_get_client.return_value = self.m_client
+            self.m_get_client = m_get_client
+            yield
 
     @staticmethod
     def exec_command(command=""):
         """Executes gerrit with the specified arguments."""
-
         argv = shlex.split(command)
         if "--debug" not in argv:
             argv = [*argv, "--debug"]
-
         return main_mod.main(argv=argv)

gerritclient/tests/unit/cli/clibase.py

@@ -1,15 +1,20 @@
+"""Tests for gerrit account commands."""
+
 import json
 from unittest import mock
 
+import pytest
+
 from gerritclient.tests.unit.cli import clibase
 from gerritclient.tests.utils import fake_account, fake_sshkeyinfo
 
 
 class TestAccountCommand(clibase.BaseCLITest):
     """Tests for gerrit account * commands."""
 
-    def setUp(self):
-        super().setUp()
+    @pytest.fixture(autouse=True)
+    def setup_account_mocks(self, setup_client_mock):
+        """Set up account-specific mocks."""
         self.m_client.get_all.return_value = fake_account.get_fake_accounts(10)
         self.m_client.get_by_id.return_value = fake_account.get_fake_account()
 
@@ -74,10 +79,9 @@ def test_account_show(self):
     @mock.patch("sys.stderr")
     def test_account_show_fail(self, mocked_stderr):
         args = "account show"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "account show: error:", mocked_stderr.write.call_args_list[-1][0][0]
-        )
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert "account show: error:" in mocked_stderr.write.call_args_list[-1][0][0]
 
     def test_account_show_w_details(self):
         account_id = "john"
@@ -125,19 +129,18 @@ def test_account_create_w_parameters_from_bad_file_format_fail(self, mocked_stde
         m_open = mock.mock_open(read_data=json.dumps(test_data))
         with mock.patch("gerritclient.common.utils.open", m_open, create=True):
             result = self.exec_command(args)
-            self.assertEqual(1, result)
+            assert result == 1
             stderr_output = "".join(
                 call[0][0] for call in mocked_stderr.write.call_args_list
             )
-            self.assertIn("Unsupported data format", stderr_output)
+            assert "Unsupported data format" in stderr_output
 
     @mock.patch("sys.stderr")
     def test_account_create_fail(self, mocked_stderr):
         args = "account create"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "account create: error:", mocked_stderr.write.call_args_list[-1][0][0]
-        )
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert "account create: error:" in mocked_stderr.write.call_args_list[-1][0][0]
 
     def test_account_set_fullname(self):
         account_id = "69"
@@ -196,10 +199,11 @@ def test_account_status_show(self):
     @mock.patch("sys.stderr")
     def test_account_status_show_fail(self, mocked_stderr):
         args = "account status show"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "run account status show: error:",
-            mocked_stderr.write.call_args_list[-1][0][0],
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert (
+            "account status show: error:"
+            in mocked_stderr.write.call_args_list[-1][0][0]
         )
 
     def test_account_status_set(self):
@@ -216,10 +220,11 @@ def test_account_status_set(self):
     @mock.patch("sys.stderr")
     def test_account_status_set_fail(self, mocked_stderr):
         args = "account status set"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "run account status set: error:",
-            mocked_stderr.write.call_args_list[-1][0][0],
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert (
+            "account status set: error:"
+            in mocked_stderr.write.call_args_list[-1][0][0]
         )
 
     def test_account_set_password(self):
@@ -287,10 +292,9 @@ def test_account_ssh_key_show(self):
     def test_account_ssh_key_show_fail(self, mocked_stderr):
         account_id = "69"
         args = f"account ssh-key show {account_id}"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "ssh-key show: error:", mocked_stderr.write.call_args_list[-1][0][0]
-        )
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert "ssh-key show: error:" in mocked_stderr.write.call_args_list[-1][0][0]
 
     def test_account_ssh_key_add(self):
         account_id = "69"
@@ -337,8 +341,9 @@ def test_account_ssh_key_add_fail_with_mutually_exclusive_params(
             "YImydZAw\u003d\u003d john.doe@example.com"
         )
         args = f'account ssh-key add {account_id} --ssh-key "{ssh_key}" --file {expected_path} '
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn("not allowed", mocked_stderr.write.call_args_list[-1][0][0])
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert "not allowed" in mocked_stderr.write.call_args_list[-1][0][0]
 
     def test_account_ssh_key_delete(self):
         account_id = "69"
@@ -403,7 +408,8 @@ def test_account_oauth_access_token_show(self):
     @mock.patch("sys.stderr")
     def test_account_oauth_access_token_fail(self, mocked_stderr):
         args = "account oauth show"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "account oauth show: error:", mocked_stderr.write.call_args_list[-1][0][0]
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert (
+            "account oauth show: error:" in mocked_stderr.write.call_args_list[-1][0][0]
         )

gerritclient/tests/unit/cli/test_account.py

@@ -1,16 +1,15 @@
 import json
 from unittest import mock
 
+import pytest
+
 from gerritclient.tests.unit.cli import clibase
 from gerritclient.tests.utils import fake_account, fake_change, fake_comment
 
 
 class TestChangeCommand(clibase.BaseCLITest):
     """Tests for gerrit change * commands."""
 
-    def setUp(self):
-        super().setUp()
-
     def test_change_list_w_single_query(self):
         query = ["status:open+is:watched"]
         args = "change list {query} --max-width 110".format(query="".join(query))
@@ -150,11 +149,11 @@ def test_change_create_bad_file_format_fail(self, mocked_stderr):
         m_open = mock.mock_open(read_data=json.dumps(test_data))
         with mock.patch("gerritclient.common.utils.open", m_open, create=True):
             result = self.exec_command(args)
-            self.assertEqual(1, result)
+            assert result == 1
             stderr_output = "".join(
                 call[0][0] for call in mocked_stderr.write.call_args_list
             )
-            self.assertIn("Unsupported data format", stderr_output)
+            assert "Unsupported data format" in stderr_output
 
     def test_change_delete(self):
         change_id = "I8473b95934b5732ac55d26311a706c9c2bde9940"
@@ -376,11 +375,9 @@ def test_change_robotcomments_list(self):
     def test_change_comments_list_w_wrong_type_fail(self, mocked_stderr):
         change_id = "I8473b95934b5732ac55d26311a706c9c2bde9940"
         args = f"change comment list {change_id} --type bad_comment"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "invalid choice: 'bad_comment'",
-            mocked_stderr.write.call_args_list[-1][0][0],
-        )
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert "invalid choice: 'bad_comment'" in mocked_stderr.write.call_args_list[-1][0][0]
 
     def test_change_consistency_check(self):
         change_id = "I8473b95934b5732ac55d26311a706c9c2bde9940"

gerritclient/tests/unit/cli/test_change.py

@@ -1,15 +1,18 @@
 import json
 from unittest import mock
 
+import pytest
+
 from gerritclient.tests.unit.cli import clibase
 from gerritclient.tests.utils import fake_account, fake_group
 
 
 class TestGroupCommand(clibase.BaseCLITest):
     """Tests for gerrit group * commands."""
 
-    def setUp(self):
-        super().setUp()
+    @pytest.fixture(autouse=True)
+    def setup_group_mocks(self, setup_client_mock):
+        """Set up group-specific mocks."""
         self.m_client.get_all.return_value = fake_group.get_fake_groups(10)
         get_fake_group = fake_group.get_fake_group()
         self.m_client.get_by_id.return_value = get_fake_group
@@ -94,19 +97,18 @@ def test_group_create_w_parameters_from_bad_file_format_fail(self, mocked_stderr
         m_open = mock.mock_open(read_data=json.dumps(test_data))
         with mock.patch("gerritclient.common.utils.open", m_open, create=True):
             result = self.exec_command(args)
-            self.assertEqual(1, result)
+            assert result == 1
             stderr_output = "".join(
                 call[0][0] for call in mocked_stderr.write.call_args_list
             )
-            self.assertIn("Unsupported data format", stderr_output)
+            assert "Unsupported data format" in stderr_output
 
     @mock.patch("sys.stderr")
     def test_group_project_fail(self, mocked_stderr):
         args = "group create"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "group create: error:", mocked_stderr.write.call_args_list[-1][0][0]
-        )
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert "group create: error:" in mocked_stderr.write.call_args_list[-1][0][0]
 
     def test_group_rename(self):
         group_id = "69"
@@ -146,10 +148,9 @@ def test_group_set_options(self):
     def test_group_set_options_fail(self, mocked_stderr):
         group_id = "69"
         args = f"group options set {group_id} --visible --no-visible"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "not allowed with argument", mocked_stderr.write.call_args_list[-1][0][0]
-        )
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert "not allowed with argument" in mocked_stderr.write.call_args_list[-1][0][0]
 
     def test_group_set_owner_group(self):
         group_id = "69"

gerritclient/tests/unit/cli/test_group.py

@@ -1,15 +1,18 @@
 import os
 from unittest import mock
 
+import pytest
+
 from gerritclient.tests.unit.cli import clibase
 from gerritclient.tests.utils import fake_plugin
 
 
 class TestPluginCommand(clibase.BaseCLITest):
     """Tests for gerrit plugin * commands."""
 
-    def setUp(self):
-        super().setUp()
+    @pytest.fixture(autouse=True)
+    def setup_plugin_mocks(self, setup_client_mock):
+        """Set up plugin-specific mocks."""
         self.m_client.get_all.return_value = fake_plugin.get_fake_plugins(10)
         get_fake_plugin = fake_plugin.get_fake_plugin(plugin_id="fake-plugin")
         self.m_client.get_by_id.return_value = get_fake_plugin
@@ -55,18 +58,16 @@ def test_plugin_disable(self):
     @mock.patch("sys.stderr")
     def test_plugin_enable_fail(self, mocked_stderr):
         args = "plugin enable"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "plugin enable: error:", mocked_stderr.write.call_args_list[-1][0][0]
-        )
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert "plugin enable: error:" in mocked_stderr.write.call_args_list[-1][0][0]
 
     @mock.patch("sys.stderr")
     def test_plugin_disable_fail(self, mocked_stderr):
         args = "plugin disable"
-        self.assertRaises(SystemExit, self.exec_command, args)
-        self.assertIn(
-            "plugin disable: error:", mocked_stderr.write.call_args_list[-1][0][0]
-        )
+        with pytest.raises(SystemExit):
+            self.exec_command(args)
+        assert "plugin disable: error:" in mocked_stderr.write.call_args_list[-1][0][0]
 
     def test_plugin_reload(self):
         plugin_id = "fake-plugin"
@@ -112,8 +113,8 @@ def test_plugin_install_w_wrong_identifier_fail(self, mocked_stderr):
         url = "http://url/path/to/plugin.jar"
         args = f"plugin install {plugin_id} --url {url}"
         result = self.exec_command(args)
-        self.assertEqual(1, result)
+        assert result == 1
         stderr_output = "".join(
             call[0][0] for call in mocked_stderr.write.call_args_list
         )
-        self.assertIn('Plugin identifier must contain ".jar"', stderr_output)
+        assert 'Plugin identifier must contain ".jar"' in stderr_output