refactor: inspect_image test

Author: natthan-pigoux

tests/test_singularity.py

@@ -1,5 +1,6 @@
 """Tests to find local Singularity image."""
 
+import json
 import shutil
 import subprocess
 from pathlib import Path
@@ -202,10 +203,6 @@ def test_singularity_inspect_image(tmp_path: Path, monkeypatch: pytest.MonkeyPat
     repo_path = workdir / "container_repo"
     image_path = repo_path / "alpine"
 
-    # test path does not exists
-    res_inspect = _inspect_singularity_image(str(image_path))
-    assert res_inspect is False
-
     # test image exists
     repo_path.mkdir()
     cmd = [
@@ -217,14 +214,36 @@ def test_singularity_inspect_image(tmp_path: Path, monkeypatch: pytest.MonkeyPat
     ]
     build = subprocess.run(cmd, capture_output=True, text=True)
     if build.returncode == 0:
-        # Verify the path is a container image
+        # Verify the path is a correct container image
         res_inspect = _inspect_singularity_image(image_path)
         assert res_inspect is True
 
-    # test wrong subprocess call
+        # test wrong json output
+        def mock_subprocess_run(*args, **kwargs):
+            class Result:
+                returncode = 0
+                stdout = "not-json"
+
+            return Result()
+
+        monkeypatch.setattr("cwltool.singularity.run", mock_subprocess_run)
+        res_inspect = _inspect_singularity_image(image_path)
+        assert res_inspect is False
+    else:
+        pytest.skip(f"singularity sandbox image build didn't worked: {build.stderr}")
+
+
+def test_singularity_sandbox_image_not_exists():
+    image_path = "/tmp/not_existing/image"
+    res_inspect = _inspect_singularity_image(image_path)
+    assert res_inspect is False
+
+
+def test_inspect_image_wrong_sb_call(monkeypatch: pytest.MonkeyPatch):
+
     def mock_failed_subprocess(*args, **kwargs):
         raise subprocess.CalledProcessError(returncode=1, cmd=args[0])
-    
+
     monkeypatch.setattr("cwltool.singularity.run", mock_failed_subprocess)
-    res_inspect = _inspect_singularity_image(str(image_path))
-    assert res_inspect is False
+    res_inspect = _inspect_singularity_image("/tmp/container_repo/alpine")
+    assert res_inspect is False

tests/test_tmpdir.py

@@ -288,7 +288,7 @@ def test_dockerfile_singularity_build(monkeypatch: pytest.MonkeyPatch, tmp_path:
 @needs_singularity
 def test_singularity_get_image_from_sandbox(monkeypatch: pytest.MonkeyPatch, tmp_path: Path):
     """Test that SingularityCommandLineJob.get_image correctly handle sandbox image."""
-    
+
     (tmp_path / "out").mkdir(exist_ok=True)
     tmp_outdir_prefix = tmp_path / "out"
     (tmp_path / "3").mkdir(exist_ok=True)
@@ -330,7 +330,9 @@ def test_singularity_get_image_from_sandbox(monkeypatch: pytest.MonkeyPatch, tmp
     image_path.mkdir()
 
     # directory exists but is not an image
-    monkeypatch.setattr("cwltool.singularity._inspect_singularity_image", lambda *args, **kwargs: False)
+    monkeypatch.setattr(
+        "cwltool.singularity._inspect_singularity_image", lambda *args, **kwargs: False
+    )
     req = {"class": "DockerRequirement", "dockerPull": f"{image_path}"}
     res = SingularityCommandLineJob(
         builder, {}, CommandLineTool.make_path_mapper, [], [], ""
@@ -344,9 +346,11 @@ def test_singularity_get_image_from_sandbox(monkeypatch: pytest.MonkeyPatch, tmp
     assert res is False
 
     # directory exists and is an image:
-    monkeypatch.setattr("cwltool.singularity._inspect_singularity_image", lambda *args, **kwargs: True)
+    monkeypatch.setattr(
+        "cwltool.singularity._inspect_singularity_image", lambda *args, **kwargs: True
+    )
     req = {"class": "DockerRequirement", "dockerPull": f"{image_path}"}
-    res =  SingularityCommandLineJob(
+    res = SingularityCommandLineJob(
         builder, {}, CommandLineTool.make_path_mapper, [], [], ""
     ).get_image(
         req,