test: add test cases

Fix Repository throws exception when given a folder as path.

Author: krerkkiat

grading_lib/repository.py

@@ -29,7 +29,7 @@ def __init__(self, path: str | Path, *args, **kwargs):
         if isinstance(path, str):
             path = Path(path)
 
-        if "".join(path.suffixes) == ".tar.gz":
+        if path.is_file() and "".join(path.suffixes) == ".tar.gz":
             if sys.version_info < (3, 12, 0):
                 self.temp_dir = tempfile.TemporaryDirectory()
             else:

tests/test_cli.py

@@ -3,6 +3,7 @@
 
 from click.testing import CliRunner
 
+from grading_lib.cli import summary_command
 from grading_lib.cli.internal import collect_autograding_tests_command
 
 
@@ -39,3 +40,41 @@ def test_collect_autograding_tests_command():
             data = json.load(f)
             assert len(data["tests"]) == 1
             assert data["tests"][0]["name"] == "lorem-ipsum - cast some spells"
+
+
+def test_summary_command():
+    runner = CliRunner()
+
+    # When there is no problem,
+    result = runner.invoke(summary_command)
+    assert result.exit_code == 0
+    assert "Problem Count: 0" in result.output
+    assert "Total Points: 0.0" in result.output
+
+    # When there is one problem,
+    with runner.isolated_filesystem():
+        problem_path = Path("lorem-ipsum")
+        problem_path.mkdir()
+
+        with open(problem_path / "problem.toml", "w") as f:
+            f.write("""
+[problem]
+name = "lorem-ipsum"
+difficulty = 1
+objective = "Example problem for testing the cli command"
+
+[problem.tests.test-1]
+name = "cast some spells"
+setup = ""
+run = "python scripts/grade.py -k cast"
+input = ""
+output = ""
+comparison = "included"
+timeout = 10
+points = 25
+""")
+
+        result = runner.invoke(summary_command)
+        assert result.exit_code == 0
+        assert "Problem Count: 1" in result.output
+        assert "Total Points: 25.0" in result.output

tests/test_common.py

@@ -7,9 +7,12 @@
 
 from grading_lib import is_debug_mode
 from grading_lib.common import (
+    BaseTestCase,
     get_mtime_as_datetime,
     get_seed_from_env,
     has_file_changed,
+    populate_folder_with_filenames,
+    run_executable,
 )
 
 
@@ -29,10 +32,23 @@ def test_is_debug_mode():
 
 
 def test_get_seed_from_env():
+    """
+    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
 
+    val = "123not-a-number"
+    os.environ["test_SEED"] = str(val)
+    res = get_seed_from_env("test_SEED")
+    assert isinstance(res, int)
+    assert res != 0
+
 
 @pytest.fixture
 def a_temp_file():
@@ -45,9 +61,80 @@ def a_temp_file():
 def test_has_file_changed(a_temp_file):
     path = Path(a_temp_file.name)
 
+    # Take snapshot of the mtime.
     last_known_mtime = get_mtime_as_datetime(path)
     assert not has_file_changed(last_known_mtime, path)
 
-    time.sleep(2)
+    # Modify the mtime and test.
+    time.sleep(1.2)
     path.touch()
     assert has_file_changed(last_known_mtime, path)
+
+    # Take another snapshot.
+    last_known_mtime = get_mtime_as_datetime(str(path))
+    assert not has_file_changed(last_known_mtime, path)
+
+
+def test_populate_folder_with_filenames():
+    with tempfile.TemporaryDirectory() as tmpdir:
+        tmpdir_path = Path(tmpdir)
+
+        with pytest.raises(ValueError):
+            (tmpdir_path / "a.txt").touch()
+            populate_folder_with_filenames(tmpdir_path / "a.txt", ["a", "b", "c"])
+
+        with pytest.raises(ValueError):
+            populate_folder_with_filenames(tmpdir_path / "src", ["a", "b", "c"])
+
+    with tempfile.TemporaryDirectory() as tmpdir:
+        tmpdir_path = Path(tmpdir)
+
+        expected_files = ["a", "b", "c"]
+        populate_folder_with_filenames(tmpdir, expected_files)
+
+        result_names = [item.name for item in tmpdir_path.iterdir()]
+
+        assert result_names == expected_files
+
+
+def test_run_executable():
+    cmd_result = run_executable(["git", "version"])
+    assert cmd_result.success
+    assert "git version" in cmd_result.output
+
+
+def test_BaseTestCase():
+    """Tests for the BaseTestCase."""
+
+    # When with_temporary_dir is not specified,
+    class ChildClsWithoutTempDir(BaseTestCase):
+        pass
+
+    assert ChildClsWithoutTempDir.with_temporary_dir is False
+
+    # When with_temporary_dir is specified,
+    class ChildClsWithTempDir(BaseTestCase):
+        with_temporary_dir = True
+
+    instance = ChildClsWithTempDir()
+    instance.setUp()
+    try:
+        assert instance.temporary_dir is not None
+        assert isinstance(instance.temporary_dir_path, Path)
+    finally:
+        instance.tearDown()
+
+
+def test_BaseTestCase_assertArchiveFileIsGzip():
+    class ChildClsWithTempDir(BaseTestCase):
+        with_temporary_dir = True
+
+    instance = ChildClsWithTempDir()
+    instance.setUp()
+
+    try:
+        with tempfile.TemporaryFile() as tmp_file:
+            with pytest.raises(AssertionError):
+                instance.assertArchiveFileIsGzip(tmp_file)
+    finally:
+        instance.tearDown()

tests/test_repository.py

@@ -0,0 +1,34 @@
+import sys
+import tempfile
+from pathlib import Path
+
+import pytest
+
+from grading_lib.repository import Repository
+
+
+@pytest.fixture
+def an_empty_folder():
+    if sys.version_info < (3, 12, 0):
+        temp_dir = tempfile.TemporaryDirectory()
+    else:
+        temp_dir = tempfile.TemporaryDirectory(delete=False)
+    yield temp_dir
+    temp_dir.cleanup()
+
+
+def test_Repository_init(an_empty_folder):
+    repo = Repository(an_empty_folder.name)
+    assert isinstance(repo.working_tree_dir, Path)
+
+
+def test_Repository_create_and_add_random_file(an_empty_folder):
+    repo = Repository(an_empty_folder.name)
+    assert isinstance(repo.working_tree_dir, Path)
+
+    repo.create_and_add_random_file(name="a.txt")
+    assert len(repo.repo.index.entries) == 1
+    assert next(iter(repo.repo.index.entries.keys()))[0] == "a.txt"
+
+    repo.create_and_add_random_file()
+    assert len(repo.repo.index.entries) == 2