Merge pull request #442 from ExaWorks/use_lib_fn_to_check_status

Use `assert_completed` when possible and also change `assert_completed`

Author: hategan

docs/user_guide.rst

@@ -311,7 +311,7 @@ following example shows:
 .. literalinclude:: ../tests/user_guide/test_prelaunch.py
     :language: python
     :dedent: 4
-    :lines: 10-16
+    :lines: 12-18
 
 where the contents of ``pre_launch.sh`` is
 

tests/_test_tools.py

@@ -28,15 +28,19 @@ def _read_file(path: Optional[Path]) -> str:
         return f.read()
 
 
-def assert_completed(job: Job, status: Optional[JobStatus]) -> None:
+def assert_completed(job: Job, status: Optional[JobStatus], attached: bool = False) -> None:
     assert status is not None
     if status.state != JobState.COMPLETED:
-        assert job.spec is not None
-        stdout = _read_file(job.spec.stdout_path)
-        stderr = _read_file(job.spec.stderr_path)
-        raise AssertionError('Job not completed. Exit code: %s, Status message: %s, '
-                             'stdout: %s, stderr: %s'
-                             % (status.exit_code, status.message, stdout, stderr))
+        if not attached:
+            assert job.spec is not None
+            stdout = _read_file(job.spec.stdout_path)
+            stderr = _read_file(job.spec.stderr_path)
+            raise AssertionError('Job not completed. Exit code: %s, Status message: %s, '
+                                 'stdout: %s, stderr: %s'
+                                 % (status.exit_code, status.message, stdout, stderr))
+        else:
+            raise AssertionError('Job not completed. Exit code: %s, Status message: %s'
+                                 % (status.exit_code, status.message))
 
 
 def _get_executor_instance(ep: ExecutorTestParams, job: Optional[Job] = None) -> JobExecutor:

tests/test_executor.py

@@ -47,7 +47,7 @@ def test_attach(execparams: ExecutorTestParams) -> None:
     job2 = Job()
     ex.attach(job2, native_id)
     status2 = job2.wait(timeout=_get_timeout(execparams))
-    assert_completed(job2, status2)
+    assert_completed(job2, status2, attached=True)
     status1 = job1.wait(timeout=_get_timeout(execparams))
     assert_completed(job1, status1)
 
@@ -64,7 +64,7 @@ def test_attach2(execparams: ExecutorTestParams) -> None:
     ex2 = _get_executor_instance(execparams)
     ex2.attach(job2, native_id)
     status = job2.wait(timeout=_get_timeout(execparams))
-    assert_completed(job2, status)
+    assert_completed(job2, status, attached=True)
 
 
 def test_cancel(execparams: ExecutorTestParams) -> None:

tests/user_guide/test_prelaunch.py

@@ -1,18 +1,20 @@
 import os
 from pathlib import Path
 
-from psij import Job, JobSpec, JobExecutor, JobState
+from _test_tools import assert_completed
+from psij import Job, JobSpec, JobExecutor
 
 
 def test_user_guide_pre_launch() -> None:
     script_dir = os.path.dirname(os.path.realpath(__file__))
 
+    # START
     ex = JobExecutor.get_instance('local')
     spec = JobSpec('/bin/bash', ['-c', 'module is-loaded test'])
     spec.pre_launch = Path(script_dir) / 'pre_launch.sh'
 
     job = Job(spec)
     ex.submit(job)
     status = job.wait()
-    assert status is not None
-    assert status.state == JobState.COMPLETED
+    # END
+    assert_completed(job, status)