fix: mypy error in unit testing code

Add tests/ as another code for mypy to check.

Author: krerkkiat

pyproject.toml

@@ -21,6 +21,7 @@ dependencies = [
     "click",
     "tomli",
     "GitPython",
+    "typing_extensions >=4.12, <5",
     'importlib-metadata; python_version>="3.10"',
 ]
 
@@ -65,7 +66,7 @@ ignore-init-module-imports = true
 known-first-party = ["grading_lib"] 
 
 [tool.mypy]
-files = ["grading_lib"]
+files = ["grading_lib", "tests"]
 show_error_codes = true
 pretty = true
 strict = true

tests/test_cli.py

@@ -8,7 +8,7 @@
 from grading_lib.cli.internal import collect_autograding_tests_command
 
 
-def test_collect_autograding_tests_command():
+def test_collect_autograding_tests_command() -> None:
     runner = CliRunner()
     with runner.isolated_filesystem():
         problem_path = Path("lorem-ipsum")
@@ -46,7 +46,7 @@ def test_collect_autograding_tests_command():
             assert data["tests"][0]["name"] == "lorem-ipsum - cast some spells"
 
 
-def test_summary_command():
+def test_summary_command() -> None:
     runner = CliRunner()
 
     # When there is no problem,

tests/test_common.py

@@ -16,35 +16,35 @@
 )
 
 
-def test_is_debug_mode():
+def test_is_debug_mode() -> None:
     vals_for_true = ["1", "True", "T", "On", "ON", "t", "true"]
     for val in vals_for_true:
         os.environ["test_DEBUG"] = val
         assert is_debug_mode("test_DEBUG")
 
     vals_for_false = ["", None, "False", "false", "lorem", "0"]
-    for val in vals_for_false:
-        if val is None:
+    for v in vals_for_false:
+        if v is None:
             del os.environ["test_DEBUG"]
         else:
-            os.environ["test_DEBUG"] = val
+            os.environ["test_DEBUG"] = v
         assert is_debug_mode("test_DEBUG") is False
 
 
-def test_get_seed_from_env():
+def test_get_seed_from_env() -> None:
     """
     If value is set, should properly parse and use it.
 
     If not, the value should be the scaled time (to avoid same seed
     for multiple tests). Does not currently check if the return value is
     the scaled time.
     """
-    val = 123
-    os.environ["test_SEED"] = str(val)
-    assert get_seed_from_env("test_SEED") == val
+    val1 = 123
+    os.environ["test_SEED"] = str(val1)
+    assert get_seed_from_env("test_SEED") == val1
 
-    val = "123not-a-number"
-    os.environ["test_SEED"] = str(val)
+    val2 = "123not-a-number"
+    os.environ["test_SEED"] = str(val2)
     res = get_seed_from_env("test_SEED")
     assert isinstance(res, int)
     assert res != 0
@@ -58,7 +58,7 @@ def a_temp_file():
     f.close()
 
 
-def test_has_file_changed(a_temp_file):
+def test_has_file_changed(a_temp_file) -> None:
     path = Path(a_temp_file.name)
 
     # Take snapshot of the mtime.
@@ -75,7 +75,7 @@ def test_has_file_changed(a_temp_file):
     assert not has_file_changed(last_known_mtime, path)
 
 
-def test_populate_folder_with_filenames():
+def test_populate_folder_with_filenames() -> None:
     with tempfile.TemporaryDirectory() as tmpdir:
         tmpdir_path = Path(tmpdir)
 
@@ -98,13 +98,13 @@ def test_populate_folder_with_filenames():
         assert result_names == expected_files
 
 
-def test_run_executable():
+def test_run_executable() -> None:
     cmd_result = run_executable(["git", "version"])
     assert cmd_result.success
     assert "git version" in cmd_result.output
 
 
-def test_BaseTestCase():
+def test_BaseTestCase() -> None:
     """Tests for the BaseTestCase."""
 
     # When with_temporary_dir is not specified,
@@ -126,16 +126,16 @@ class ChildClsWithTempDir(BaseTestCase):
         instance.tearDown()
 
 
-def test_BaseTestCase_assertArchiveFileIsGzip():
+def test_BaseTestCase_assertArchiveFileIsGzip() -> None:
     class ChildClsWithTempDir(BaseTestCase):
         with_temporary_dir = True
 
     instance = ChildClsWithTempDir()
     instance.setUp()
 
     try:
-        with tempfile.TemporaryFile() as tmp_file:
+        with tempfile.NamedTemporaryFile() as tmp_file:
             with pytest.raises(AssertionError):
-                instance.assertArchiveFileIsGzip(tmp_file)
+                instance.assertArchiveFileIsGzip(tmp_file.name)
     finally:
         instance.tearDown()

tests/test_makefile.py

@@ -4,7 +4,7 @@
 
 
 @pytest.fixture
-def makefile_1():
+def makefile_1() -> str:
     """
     First line is empty and two equal signs on a var-def line.
     """
@@ -18,7 +18,7 @@ def makefile_1():
 
 
 @pytest.fixture
-def makefile_2():
+def makefile_2() -> str:
     return """
 # https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html
 
@@ -40,7 +40,7 @@ def makefile_2():
 
 
 @pytest.fixture
-def makefile_3():
+def makefile_3() -> str:
     """Continuous Makefile."""
     return """
 a: e f
@@ -52,7 +52,7 @@ def makefile_3():
 
 
 @pytest.fixture
-def makefile_var_defs():
+def makefile_var_defs() -> str:
     """
     Various variable definitions.
     """
@@ -74,7 +74,7 @@ def makefile_var_defs():
 """
 
 
-def test_makefile_from_text(makefile_1):
+def test_makefile_from_text(makefile_1: str) -> None:
     """
     A verification test for `:` showing up twice.
     """
@@ -85,7 +85,7 @@ def test_makefile_from_text(makefile_1):
         pytest.fail("Exception raises while parsing a makefile.")
 
 
-def test_makefile_from_text_2(makefile_2):
+def test_makefile_from_text_2(makefile_2) -> None:
     try:
         mk = Makefile.from_text(makefile_2)
     except Exception:
@@ -95,27 +95,39 @@ def test_makefile_from_text_2(makefile_2):
     assert not mk.rules[1].is_empty()
 
 
-def test_makefile_from_text_3(makefile_3):
+def test_makefile_from_text_3(makefile_3) -> None:
     try:
         mk = Makefile.from_text(makefile_3)
     except Exception:
         pytest.fail("Exception raises while parsing a makefile.")
 
     assert mk.has_rule("a")
-    assert mk.get_rule("a").prerequisites == ["e", "f"]
+    rule = mk.get_rule("a")
+    assert rule is not None
+    if rule:
+        assert rule.prerequisites == ["e", "f"]
 
     assert mk.has_rule("b")
-    assert mk.get_rule("b").prerequisites == ["g"]
+    rule = mk.get_rule("b")
+    assert rule is not None
+    if rule:
+        assert rule.prerequisites == ["g"]
 
     assert mk.has_rule("c")
-    assert mk.get_rule("c").prerequisites == ["h"]
-    assert not mk.get_rule("c").is_empty()
+    rule = mk.get_rule("c")
+    assert rule is not None
+    if rule:
+        assert rule.prerequisites == ["h"]
+        assert not rule.is_empty()
 
     assert mk.has_rule("d")
-    assert mk.get_rule("d").prerequisites == ["i", "j"]
+    rule = mk.get_rule("d")
+    assert rule is not None
+    if rule:
+        assert rule.prerequisites == ["i", "j"]
 
 
-def test_makefile_var_defs_parsing(makefile_var_defs):
+def test_makefile_var_defs_parsing(makefile_var_defs) -> None:
     try:
         _ = Makefile.from_text(makefile_var_defs)
     except Exception:

tests/test_repository.py

@@ -17,12 +17,12 @@ def an_empty_folder():
     temp_dir.cleanup()
 
 
-def test_Repository_init_with_an_empty_folder(an_empty_folder):
+def test_Repository_init_with_an_empty_folder(an_empty_folder) -> None:
     repo = Repository(an_empty_folder.name)
     assert isinstance(repo.working_tree_dir, Path)
 
 
-def test_Repository_create_and_add_random_file(an_empty_folder):
+def test_Repository_create_and_add_random_file(an_empty_folder) -> None:
     repo = Repository(an_empty_folder.name)
     assert isinstance(repo.working_tree_dir, Path)
 

tox.ini

@@ -7,7 +7,7 @@ env_list =
     typing
 
 [testenv]
-description = run unit tests
+description = run unit testing tests
 package = wheel
 wheel_build_env = .pkg
 deps = pytest
@@ -20,5 +20,8 @@ skip_install = true
 commands = ruff check
 
 [testenv:typing]
+description = run mypy against the codebase and unit testing code
+skip_install = true
 deps = mypy
+    pytest
 commands = mypy