Merge pull request #1318 from linsword13/abs-wm

Enforce that workflow manager should implement `get_status`

Author: douglasjacobsen

var/ramble/repos/builtin.mock/workflow_managers/info/workflow_manager.py

@@ -135,3 +135,7 @@ def _after_make_experiments(self, workspace, app_inst=None):
     )
 
     workflow_manager_family("info-workflow-manager")
+
+    def get_status(self, workspace):
+        """Return status of a given job"""
+        return None

var/ramble/repos/builtin.mock/workflow_managers/when-workflow-manager/workflow_manager.py

@@ -64,3 +64,7 @@ class WhenWorkflowManager(WorkflowManagerBase):
         description="Test required key",
         when=["+wf_man_required_key"],
     )
+
+    def get_status(self, workspace):
+        """Return status of a given job"""
+        return None

var/ramble/repos/builtin.mock/workflow_managers/wm-with-foms/workflow_manager.py

@@ -32,3 +32,7 @@ def _prepare_analysis(self, workspace):
         log_file="{experiment_run_dir}/.wm_job_info",
         fom_type=FomType.INFO,
     )
+
+    def get_status(self, workspace):
+        """Return status of a given job"""
+        return None

var/ramble/repos/builtin/base_classes/workflow-manager-base/base_class.py

@@ -7,6 +7,7 @@
 # except according to those terms.
 """Define base classes for workflow manager definitions"""
 
+import abc
 from typing import Collection, Iterator
 
 import ramble.definitions.families
@@ -97,9 +98,9 @@ def set_application(self, app_inst):
         """Set a reference to the associated app_inst"""
         self.app_inst = app_inst
 
+    @abc.abstractmethod
     def get_status(self, workspace):
         """Return status of a given job"""
-        return None
 
     def conditional_expand(self, templates: Collection[str]) -> Iterator[str]:
         """Return a (potentially empty) iterator of expanded strings

var/ramble/repos/builtin/workflow_managers/gke-mpi/workflow_manager.py

@@ -184,3 +184,7 @@ def _prepare_analysis(self, workspace):
         if os.path.exists(launcher_log):
             log_file = expander.expand_var_name("log_file")
             shutil.copy2(launcher_log, log_file)
+
+    def get_status(self, workspace):
+        """Return status of a given job"""
+        return None

var/ramble/repos/builtin/workflow_managers/user-managed/workflow_manager.py

@@ -37,3 +37,7 @@ class UserManaged(WorkflowManagerBase):
         default="{execute_experiment}",
         description="batch_submit script, mostly served as an overridable default",
     )
+
+    def get_status(self, workspace):
+        """Return status of a given job"""
+        return None