Merge pull request nipreps#1294 from jhlegarreta/AddCLIEntryPointTest

ENH: Add CLI entry point test

mriqc/cli/run.py

@@ -23,7 +23,7 @@
 """Definition of the command line interface's (CLI) entry point."""
 
 
-def main():
+def main(argv=None):
     """Entry point for MRIQC's CLI."""
     import atexit
     import gc
@@ -40,7 +40,7 @@ def main():
     config.settings.start_time = time.time()
 
     # Run parser
-    parse_args()
+    parse_args(argv)
 
     if config.execution.pdb:
         from mriqc.utils.debug import setup_exceptionhook

mriqc/tests/test_main.py

@@ -0,0 +1,64 @@
+# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
+# vi: set ft=python sts=4 ts=4 sw=4 et:
+#
+# Copyright 2024 The NiPreps Developers <[email protected]>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# We support and encourage derived works from this project, please read
+# about our expectations at
+#
+#     https://www.nipreps.org/community/licensing/
+#
+
+import sys
+
+import pytest
+
+from mriqc.__main__ import main
+
+
+@pytest.fixture(autouse=True)
+def set_command(monkeypatch):
+    with monkeypatch.context() as m:
+        m.setattr(sys, 'argv', ['mriqc'])
+        yield
+
+
+def test_help(capsys):
+    with pytest.raises(SystemExit):
+        main(['--help'])
+    captured = capsys.readouterr()
+    assert captured.out.startswith('usage: mriqc [-h]')
+
+
+def test_main(tmp_path):
+    bids_dir = tmp_path / 'data/sub-01'
+    out_path = tmp_path / 'out'
+
+    with pytest.raises(SystemExit):
+        main([str(bids_dir), str(out_path)])
+
+    analysis_level = 'participant'
+    species = 'human'
+
+    with pytest.raises(SystemExit):
+        main(
+            [
+                str(bids_dir),
+                str(out_path),
+                analysis_level,
+                '--species',
+                species,
+            ]
+        )