Add unit tests on setup_reproduce and setup_manifests_unchanged.

Author: Qian-HuiChen

src/model_config_tests/exp_test_helper.py

@@ -128,10 +128,7 @@ def setup_manifests_unchanged(self):
                     f"{'='*10}STDOUT{'='*10}\n {setup_result.stdout}\n"
                     f"{'='*10}STDERR{'='*10}\n {setup_result.stderr}\n"
                 )
-            elif "error" in setup_result.stderr.lower():
-                warnings.warn(
-                    f"Payu setup existed safely with errors in stderr:\n{setup_result.stderr}. Proceeding to modification check."
-                )
+
             result = sp.run(
                 ["git", "diff", "--name-only", "manifests/"],
                 capture_output=True,

tests/test_exp_test_helper.py

@@ -1,7 +1,7 @@
 import shutil
 import subprocess
 from pathlib import Path
-from unittest.mock import Mock, patch
+from unittest.mock import MagicMock, Mock, patch
 
 import pytest
 import yaml
@@ -556,3 +556,74 @@ def test_experiments_check_experiment_error(tmp_path):
     )
     with pytest.raises(RuntimeError, match=error_msg):
         exps.check_experiment("error_exp")
+
+
+@patch("subprocess.run")
+def test_setup_reproduce_error(mock_run, exp):
+    """Test that payu setup --repro fails raises an error and return to original work directory"""
+    # Mock the payu setup --repro to fail
+    mock_result = MagicMock()
+    mock_result.returncode = 1
+    mock_result.stderr = "MD5 mismatch"
+    mock_result.stdout = "Check manifest"
+    mock_run.return_value = mock_result
+
+    with pytest.raises(RuntimeError) as excinfo:
+        exp.setup_reproduce()
+
+        assert (
+            f"Failed to run payu setup with --reproduce. Error: {mock_result.stderr}"
+            in str(excinfo.value)
+        )
+        assert f"Full output: {mock_result.stdout}" in str(excinfo.value)
+
+        # assert returning to the original work directory
+        assert Path.cwd() == exp.control_path
+
+
+@patch("subprocess.run")
+def test_setup_manifests_unchanged_fail_setup(mock_run, exp):
+    """Test that an error is raised when payu setup fails in setup_manifests_unchanged()"""
+    # Mock the payu setup --repro to fail with unchanged manifests
+    mock_result = MagicMock()
+    mock_result.returncode = 1
+    mock_result.stderr = "Setup failed"
+    mock_result.stdout = "Payu setup output"
+    mock_run.return_value = mock_result
+
+    with pytest.raises(RuntimeError) as excinfo:
+        exp.setup_manifests_unchanged()
+
+        assert "Error during payu setup." in str(excinfo.value)
+        assert f"{'='*10}STDOUT{'='*10}\n {mock_result.stdout}\n" in str(excinfo.value)
+
+        # assert returning to the original work directory
+        assert Path.cwd() == exp.control_path
+
+
+@patch("subprocess.run")
+def test_setup_manifests_unchanged_show_changes(mock_run, exp):
+    """Test that when manifests are changed, the `git diff` results are printed to stdout"""
+    # Mock the `payu setup` succeed first
+    setup_success = MagicMock(returncode=0, stdout="Payu setup succeeded")
+
+    # Then mock the `git diff --name-only` to show which files are changed
+    git_diff_name_only = MagicMock(returncode=1, stdout="manifests/input.yaml")
+
+    # Mock the `git diff` to show the detailed changes in the file
+    git_diff_output = (
+        "--- a/manifests/input.yaml\n+++ b/manifests/input.yaml\n+new line\n-old line"
+    )
+    git_diff_run = MagicMock(returncode=0, stdout=git_diff_output)
+
+    # Run these mocks in sequence
+    mock_run.side_effect = [setup_success, git_diff_name_only, git_diff_run]
+
+    with pytest.raises(RuntimeError) as excinfo:
+        exp.setup_manifests_unchanged()
+
+        assert "Modifications are detected in file:\n" in str(excinfo.value)
+        assert git_diff_output in str(excinfo.value)
+
+        # assert returning to the original work directory
+        assert Path.cwd() == exp.control_path