Fixed a bunch of unit test best practices warnings from ruff PT ruleset

Author: tleonhardt

plugins/ext_test/examples/example.py

@@ -1,11 +1,11 @@
 #
 # coding=utf-8
 # import cmd2
+import cmd2_ext_test
+
 import cmd2
 import cmd2.py_bridge
 
-import cmd2_ext_test
-
 
 class Example(cmd2.Cmd):
     """An class to show how to use a plugin"""

plugins/ext_test/tests/test_ext_test.py

@@ -1,14 +1,14 @@
 #
 # coding=utf-8
 
+import cmd2_ext_test
 import pytest
+
 from cmd2 import (
     CommandResult,
     cmd2,
 )
 
-import cmd2_ext_test
-
 ######
 #
 # define a class which implements a simple cmd2 application

tests/conftest.py

@@ -16,9 +16,7 @@
     mock,
 )
 
-from pytest import (
-    fixture,
-)
+import pytest
 
 import cmd2
 from cmd2.rl_utils import (
@@ -151,7 +149,7 @@ def run_cmd(app, cmd):
     return normalize(out), normalize(err)
 
 
-@fixture
+@pytest.fixture
 def base_app():
     return cmd2.Cmd(include_py=True, include_ipy=True)
 

tests/test_ansi.py

@@ -179,11 +179,12 @@ def test_clear_screen():
     assert ansi.clear_screen(clear_type) == f"{ansi.CSI}{clear_type}J"
 
     clear_type = -1
-    with pytest.raises(ValueError):
+    expected_err = "clear_type must in an integer from 0 to 3"
+    with pytest.raises(ValueError, match=expected_err):
         ansi.clear_screen(clear_type)
 
     clear_type = 4
-    with pytest.raises(ValueError):
+    with pytest.raises(ValueError, match=expected_err):
         ansi.clear_screen(clear_type)
 
 
@@ -192,11 +193,12 @@ def test_clear_line():
     assert ansi.clear_line(clear_type) == f"{ansi.CSI}{clear_type}K"
 
     clear_type = -1
-    with pytest.raises(ValueError):
+    expected_err = "clear_type must in an integer from 0 to 2"
+    with pytest.raises(ValueError, match=expected_err):
         ansi.clear_line(clear_type)
 
     clear_type = 3
-    with pytest.raises(ValueError):
+    with pytest.raises(ValueError, match=expected_err):
         ansi.clear_line(clear_type)
 
 
@@ -247,9 +249,10 @@ def test_rgb_bounds(r, g, b, valid):
         ansi.RgbFg(r, g, b)
         ansi.RgbBg(r, g, b)
     else:
-        with pytest.raises(ValueError):
+        expected_err = "RGB values must be integers in the range of 0 to 255"
+        with pytest.raises(ValueError, match=expected_err):
             ansi.RgbFg(r, g, b)
-        with pytest.raises(ValueError):
+        with pytest.raises(ValueError, match=expected_err):
             ansi.RgbBg(r, g, b)
 
 

tests/test_argparse_custom.py

@@ -58,26 +58,26 @@ def fake_func():
 )
 def test_apcustom_choices_callable_count(kwargs, is_valid):
     parser = Cmd2ArgumentParser()
-    try:
+    if is_valid:
         parser.add_argument('name', **kwargs)
-        assert is_valid
-    except ValueError as ex:
-        assert not is_valid
-        assert 'Only one of the following parameters' in str(ex)
+    else:
+        expected_err = 'Only one of the following parameters'
+        with pytest.raises(ValueError, match=expected_err):
+            parser.add_argument('name', **kwargs)
 
 
 @pytest.mark.parametrize('kwargs', [({'choices_provider': fake_func}), ({'completer': fake_func})])
 def test_apcustom_no_choices_callables_alongside_choices(kwargs):
+    parser = Cmd2ArgumentParser()
     with pytest.raises(TypeError) as excinfo:
-        parser = Cmd2ArgumentParser()
         parser.add_argument('name', choices=['my', 'choices', 'list'], **kwargs)
     assert 'None of the following parameters can be used alongside a choices parameter' in str(excinfo.value)
 
 
 @pytest.mark.parametrize('kwargs', [({'choices_provider': fake_func}), ({'completer': fake_func})])
 def test_apcustom_no_choices_callables_when_nargs_is_0(kwargs):
+    parser = Cmd2ArgumentParser()
     with pytest.raises(TypeError) as excinfo:
-        parser = Cmd2ArgumentParser()
         parser.add_argument('--name', action='store_true', **kwargs)
     assert 'None of the following parameters can be used on an action that takes no arguments' in str(excinfo.value)
 
@@ -126,24 +126,24 @@ def test_apcustom_nargs_range_validation(cust_app):
     ],
 )
 def test_apcustom_narg_invalid_tuples(nargs_tuple):
-    with pytest.raises(ValueError) as excinfo:
-        parser = Cmd2ArgumentParser()
+    parser = Cmd2ArgumentParser()
+    expected_err = 'Ranged values for nargs must be a tuple of 1 or 2 integers'
+    with pytest.raises(ValueError, match=expected_err):
         parser.add_argument('invalid_tuple', nargs=nargs_tuple)
-    assert 'Ranged values for nargs must be a tuple of 1 or 2 integers' in str(excinfo.value)
 
 
 def test_apcustom_narg_tuple_order():
-    with pytest.raises(ValueError) as excinfo:
-        parser = Cmd2ArgumentParser()
+    parser = Cmd2ArgumentParser()
+    expected_err = 'Invalid nargs range. The first value must be less than the second'
+    with pytest.raises(ValueError, match=expected_err):
         parser.add_argument('invalid_tuple', nargs=(2, 1))
-    assert 'Invalid nargs range. The first value must be less than the second' in str(excinfo.value)
 
 
 def test_apcustom_narg_tuple_negative():
-    with pytest.raises(ValueError) as excinfo:
-        parser = Cmd2ArgumentParser()
+    parser = Cmd2ArgumentParser()
+    expected_err = 'Negative numbers are invalid for nargs range'
+    with pytest.raises(ValueError, match=expected_err):
         parser.add_argument('invalid_tuple', nargs=(-1, 1))
-    assert 'Negative numbers are invalid for nargs range' in str(excinfo.value)
 
 
 def test_apcustom_narg_tuple_zero_base():

tests/test_cmd2.py

@@ -146,9 +146,9 @@ def test_base_shortcuts(base_app):
 
 
 def test_command_starts_with_shortcut():
-    with pytest.raises(ValueError) as excinfo:
+    expected_err = "Invalid command name 'help'"
+    with pytest.raises(ValueError, match=expected_err):
         cmd2.Cmd(shortcuts={'help': 'fake'})
-    assert "Invalid command name 'help'" in str(excinfo.value)
 
 
 def test_base_set(base_app):