extract fixtures into conftest; add docstrings

Author: vpchung

tests/conftest.py

@@ -15,19 +15,22 @@ def pytest_configure(config):
 
 @pytest.fixture(scope="module")
 def temp_dir():
+    """Creates a temporary directory for test files."""
     with tempfile.TemporaryDirectory() as tmpdir:
         yield tmpdir
 
 
 @pytest.fixture(scope="module")
 def groundtruth_dir(temp_dir):
+    """Creates a temporary groundtruth directory."""
     gt_dir = os.path.join(temp_dir, "groundtruth")
     os.makedirs(gt_dir)
     return gt_dir
 
 
 @pytest.fixture(scope="module")
 def gt_file(groundtruth_dir):
+    """Creates a dummy groundtruth file."""
     truth = pd.DataFrame(
         {
             "id": ["A_01", "A_02", "A_03"],
@@ -41,6 +44,7 @@ def gt_file(groundtruth_dir):
 
 @pytest.fixture(scope="module")
 def pred_file(temp_dir):
+    """Creates a dummy prediction file."""
     pred = pd.DataFrame(
         {
             "id": ["A_01", "A_02", "A_03"],
@@ -54,17 +58,21 @@ def pred_file(temp_dir):
 
 @pytest.fixture(scope="module")
 def valid_predictions_json():
-    return json.dumps({
-        "validation_status": "VALIDATED",
-        "validation_errors": "",
-    })
+    """Creates a dummy valid results JSON."""
+    return json.dumps(
+        {
+            "validation_status": "VALIDATED",
+            "validation_errors": "",
+        }
+    )
 
 
 @pytest.fixture(scope="module")
 def invalid_predictions_json():
-    return json.dumps({
-        "validation_status": "INVALID",
-        "validation_errors": "Something went wrong.",
-    })
-
-
+    """Creates a dummy invalid results JSON."""
+    return json.dumps(
+        {
+            "validation_status": "INVALID",
+            "validation_errors": "Something went wrong.",
+        }
+    )

tests/test_validate.py

@@ -19,8 +19,12 @@
 runner = CliRunner()
 
 
+# ----- Tests for validate() function -----
 def test_validate_valid_task_number(gt_file, pred_file):
-    """Check that the return type for validate() is a list, filter, or tuple."""
+    """
+    Test: validate() returns a list, filter, or tuple for valid
+    task number.
+    """
     task_number = 1
     errors = validate(
         task_number=task_number,
@@ -31,7 +35,7 @@ def test_validate_valid_task_number(gt_file, pred_file):
 
 
 def test_validate_invalid_task_number():
-    """Check that error message about invalid task number is returned in the list of error messages."""
+    """Test: validate() notifies about invalid task number."""
     task_number = 99999
     errors = validate(
         task_number=task_number,
@@ -41,42 +45,13 @@ def test_validate_invalid_task_number():
     assert f"Invalid challenge task number specified: `{task_number}`" in errors
 
 
-@patch("validate.extract_gt_file")
-@patch("validate.validate")
-def test_main_invalid_submission_type(
-    mock_validate, mock_extract_gt_file, groundtruth_dir, temp_dir
-):
-    invalid_file = os.path.join(temp_dir, "INVALID_predictions.txt")
-    with open(invalid_file, "w") as f:
-        f.write("foo")
-    output_file = os.path.join(temp_dir, "results.json")
-    result = runner.invoke(
-        app,
-        [
-            "-p",
-            invalid_file,
-            "-g",
-            groundtruth_dir,
-            "-t",
-            "1",
-            "-o",
-            output_file,
-        ],
-    )
-    assert result.exit_code == 0
-    assert result.stdout.strip() == "INVALID"
-    with open(output_file, "r") as f:
-        output_data = json.load(f)
-    assert output_data["validation_status"] == "INVALID"
-    mock_extract_gt_file.assert_not_called()
-    mock_validate.assert_not_called()
-
-
+# ----- Tests for main() function -----
 @patch("validate.extract_gt_file")
 @patch("validate.validate")
 def test_main_valid_submission_type(
     mock_validate, mock_extract_gt_file, gt_file, pred_file, temp_dir
 ):
+    """Test: final results should be INVALID or VALIDATED."""
     mock_extract_gt_file.return_value = gt_file
     mock_validate.return_value = []
     groundtruth_dir = os.path.dirname(gt_file)
@@ -111,26 +86,56 @@ def test_main_valid_submission_type(
         assert output_data["validation_status"] == "INVALID"
         assert not output_data["validation_errors"]
 
-    print(mock_extract_gt_file.mock_calls)
-    print(mock_validate.mock_calls)
-
     mock_extract_gt_file.assert_called_once_with(groundtruth_dir)
     mock_validate.assert_called_once_with(
         task_number=1, gt_file=gt_file, pred_file=pred_file
     )
 
 
+@patch("validate.extract_gt_file")
+@patch("validate.validate")
+def test_main_invalid_submission_type(
+    mock_validate, mock_extract_gt_file, groundtruth_dir, temp_dir
+):
+    """Test: final results should be INVALID for incorrect submission type."""
+    invalid_file = os.path.join(temp_dir, "INVALID_predictions.txt")
+    with open(invalid_file, "w") as f:
+        f.write("foo")
+    output_file = os.path.join(temp_dir, "results.json")
+    result = runner.invoke(
+        app,
+        [
+            "-p",
+            invalid_file,
+            "-g",
+            groundtruth_dir,
+            "-t",
+            "1",
+            "-o",
+            output_file,
+        ],
+    )
+    assert result.exit_code == 0
+    assert result.stdout.strip() == "INVALID"
+    with open(output_file, "r") as f:
+        output_data = json.load(f)
+    assert output_data["validation_status"] == "INVALID"
+    mock_extract_gt_file.assert_not_called()
+    mock_validate.assert_not_called()
+
+
 @patch("validate.extract_gt_file")
 @patch("validate.validate")
 def test_main_long_error_message(
     mock_validate, mock_extract_gt_file, gt_file, pred_file, temp_dir
 ):
+    """Test: validation errors should never exceed 500 characters."""
     mock_extract_gt_file.return_value = gt_file
 
     # Create a dummy string longer than 500 characters.
     long_error_message = "foo" * 500
     mock_validate.return_value = [long_error_message]
-    
+
     groundtruth_dir = os.path.dirname(gt_file)
     output_file = os.path.join(temp_dir, "results.json")