Merge pull request #209 from yarikoptic/bf-run-stop-on-error

BF: by default stop containers-run on error, to not proceed to save

Author: yarikoptic

changelog.d/pr-209.md

@@ -0,0 +1,3 @@
+### 🐛 Bug Fixes
+
+- BF: by default stop containers-run on error, to not proceed to save.  [PR #209](https://github.com/datalad/datalad-container/pull/209) (by [@yarikoptic](https://github.com/yarikoptic))

datalad_container/containers_run.py

@@ -66,6 +66,9 @@ class ContainersRun(Interface):
 
     _params_ = _run_params
 
+    # Analogous to 'run' command - stop on first error
+    on_failure = 'stop'
+
     @staticmethod
     @datasetmethod(name='containers_run')
     @eval_results

datalad_container/tests/test_run.py

@@ -14,12 +14,14 @@
     StdOutCapture,
     WitlessRunner,
 )
+from datalad.support.exceptions import IncompleteResultsError
 from datalad.support.network import get_local_file_url
 from datalad.tests.utils_pytest import (
     assert_false,
     assert_in,
     assert_not_in_results,
     assert_raises,
+    assert_repo_status,
     assert_result_count,
     ok_,
     ok_clean_git,
@@ -34,6 +36,7 @@
     on_windows,
 )
 
+import pytest
 from datalad_container.tests.utils import add_pyscript_image
 
 testimg_url = 'shub://datalad/datalad-container:testhelper'
@@ -154,6 +157,40 @@ def assert_no_change(res, path):
     assert_no_change(res, super_ds.path)
 
 
+@with_tempfile
+@with_tree(tree={'some_container.img': "doesn't matter"})
+def test_non0_exit(path=None, local_file=None):
+    ds = Dataset(path).create()
+
+    # plug in a proper singularity image
+    ds.containers_add(
+        'mycontainer',
+        url=get_local_file_url(op.join(local_file, 'some_container.img')),
+        image='righthere',
+        call_fmt="sh -c '{cmd}'"
+    )
+    ds.save()  # record the effect in super-dataset
+    ok_clean_git(path)
+
+    # now we can run stuff in the container
+    # and because there is just one, we don't even have to name the container
+    ds.containers_run(['touch okfile'])
+    assert_repo_status(path)
+
+    # Test that regular 'run' behaves as expected -- it does not proceed to save upon error
+    with pytest.raises(IncompleteResultsError):
+        ds.run(['sh', '-c', 'touch nokfile && exit 1'])
+    assert_repo_status(path, untracked=['nokfile'])
+    (ds.pathobj / "nokfile").unlink()  # remove for the next test
+    assert_repo_status(path)
+
+    # Now test with containers-run which should behave similarly -- not save in case of error
+    with pytest.raises(IncompleteResultsError):
+        ds.containers_run(['touch nokfile && exit 1'])
+    # check - must have created the file but not saved anything since failed to run!
+    assert_repo_status(path, untracked=['nokfile'])
+
+
 @with_tempfile
 @with_tree(tree={'some_container.img': "doesn't matter"})
 def test_custom_call_fmt(path=None, local_file=None):