Merge branch 'testing-of-argument-parsing-logic' into 'main'

Add tests that check our argument parsing logic (and fix bug)

See merge request !113

pyproject.toml

@@ -7,7 +7,7 @@ name = "mpsd_software_manager"
 authors = [{name = "SSU-Computational Science (Fangohr et al)", email = "ssu-cs@mpsd.mpg.de"}]
 license = {file = "LICENSE"}
 classifiers = ["License :: OSI Approved :: MIT License"]
-version = "2023.6.27"
+version = "2023.7.6"
 readme = "README.rst"
 requires-python = ">=3.9"
 dependencies = [

src/mpsd_software_manager/mpsd_software.py

@@ -1394,7 +1394,7 @@ def main():
     root_dir = get_root_dir()
 
     # set up logging filename: we record activities that change the installation
-    if args.action in ["init", "install", "reinstall", "remove"]:
+    if args.action in ["init", "install", "prepare", "reinstall", "remove"]:
         log_file = get_log_file_path(
             args.release,
             args.action,

tests/test_mpsd_software.py

@@ -572,6 +572,90 @@ def test_get_available_releases():
         assert isinstance(release, str)
 
 
+def test_argument_parsing_logic(mocker):
+    """Test to find errors in argparse logic.
+
+    Strategy:
+
+    In each of the tests below, we are setting the sys.argv to simulate the
+    input from the command line, and in each instance, we ensure that the
+    mocked function get the arguments as expected. The function is mocked not
+    to carry out any activity.
+
+    """
+
+    # pretend we have a rootdir defined
+    mock = mocker.patch(
+        "mpsd_software_manager.mpsd_software.get_root_dir", return_value=Path(".")
+    )
+
+    sys.argv = ["mpsd-software-tests", "init"]
+    mock = mocker.patch(
+        "mpsd_software_manager.mpsd_software.initialise_environment", return_value=None
+    )
+    with pytest.raises(SystemExit):
+        mod.main()
+    call_argument = mock.call_args[0][0]
+    assert isinstance(call_argument, Path)
+
+    ### available
+    sys.argv = ["mpsd-software-tests", "available"]
+    mock = mocker.patch(
+        "mpsd_software_manager.mpsd_software.get_available_releases", return_value=None
+    )
+    with pytest.raises(SystemExit):
+        mod.main()
+
+    sys.argv = ["mpsd-software-tests", "available", "dev-23a"]
+    mock = mocker.patch(
+        "mpsd_software_manager.mpsd_software.get_available_package_sets",
+        return_value=None,
+    )
+    mod.main()
+    call_argument = mock.call_args[0][0]
+    assert call_argument == "dev-23a"
+
+    ### prepare
+    sys.argv = ["mpsd-software-tests", "prepare", "dev-23a"]
+    mock = mocker.patch(
+        "mpsd_software_manager.mpsd_software.prepare_environment", return_value=None
+    )
+    mod.main()
+    call_argument = mock.call_args[0][0]
+    assert call_argument == "dev-23a"
+
+    ### install
+    mock = mocker.patch(
+        "mpsd_software_manager.mpsd_software.install_environment", return_value=None
+    )
+    sys.argv = ["mpsd-software-tests", "install", "dev-23a", "foss2022a-mpi"]
+    mod.main()
+    assert mock.call_args[0][0] == "dev-23a"
+    assert mock.call_args[0][1] == ["foss2022a-mpi"]
+
+    sys.argv = [
+        "mpsd-software-tests",
+        "install",
+        "23b",
+        "foss2022a-mpi",
+        "foss2022a-serial",
+    ]
+    mod.main()
+    assert mock.call_args[0][0] == "23b"
+    assert mock.call_args[0][1] == ["foss2022a-mpi", "foss2022a-serial"]
+
+    ### status
+    mock = mocker.patch(
+        "mpsd_software_manager.mpsd_software.environment_status", return_value=None
+    )
+    sys.argv = ["mpsd-software-tests", "status", "dev-23a"]
+    mod.main()
+    assert mock.call_args[0][0] == "dev-23a"
+
+    ### remove (argparse doesn't allow this yet.
+    ### Copy from 'install' when the time has come.)
+
+
 def test_interface(tmp_path):
     """Test other things (not implemented yet)."""
     pass