Merge pull request #538 from effigies/fix/restore_license_check_arg

FIX: Restore and deprecate license argument to ``check_valid_fs_license``

Author: oesteban

niworkflows/utils/misc.py

@@ -289,7 +289,7 @@ def pass_dummy_scans(algo_dummy_scans, dummy_scans=None):
     return dummy_scans
 
 
-def check_valid_fs_license():
+def check_valid_fs_license(lic=None):
     """
     Run ``mri_convert`` to assess FreeSurfer access to a license.
 
@@ -304,6 +304,13 @@ def check_valid_fs_license():
     from tempfile import TemporaryDirectory
     from pkg_resources import resource_filename
 
+    if lic is not None:
+        import warnings
+        warnings.warn("The license argument has been deprecated, has no effect, and will be "
+                      "removed in 1.3.0. Please set the environment if needed before calling "
+                      "this function without arguments.",
+                      DeprecationWarning)
+
     with TemporaryDirectory() as tmpdir:
         # quick FreeSurfer command
         _cmd = (

niworkflows/utils/tests/test_misc.py

@@ -34,8 +34,9 @@ def test_fs_license_check(stdout, rc, valid):
         assert check_valid_fs_license() is valid
 
 
-@pytest.mark.skipif(not os.getenv("FS_LICENSE"), reason="No FS license found")
-def test_fs_license_check2(monkeypatch):
+@pytest.mark.skipif(shutil.which('mri_convert') is None, reason="FreeSurfer not installed")
+@pytest.mark.xfail(not os.getenv("FS_LICENSE"), reason="No FS license found")
+def test_fs_license_check2():
     """Execute the canary itself."""
     assert check_valid_fs_license() is True
 
@@ -46,3 +47,12 @@ def test_fs_license_check3(monkeypatch):
         m.delenv("FS_LICENSE", raising=False)
         m.delenv("FREESURFER_HOME", raising=False)
         assert check_valid_fs_license() is False
+
+
+def test_fs_license_check_deprecated_arg():
+    """Execute the canary with passed license."""
+    with mock.patch("subprocess.run") as mocked_run:
+        mocked_run.return_value.stdout = b""
+        mocked_run.return_value.returncode = 0
+        with pytest.deprecated_call():
+            check_valid_fs_license(lic="Any non-None value")