Add status=SETUP

GoogleCloudPlatform · Jan 5, 2024 · 259ee00 · 259ee00
1 parent 5ff167f
commit 259ee00
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 11 deletions.
diff --git a/lib/ramble/ramble/application.py b/lib/ramble/ramble/application.py
@@ -48,6 +48,9 @@
 from ramble.language.shared_language import SharedMeta, register_builtin
 from ramble.error import RambleError
 
+from enum import Enum
+experiment_status = Enum('experiment_status', ['UNKNOWN', 'SETUP', 'SUCCESS', 'FAILED'])
+
 
 class ApplicationBase(object, metaclass=ApplicationMeta):
     name = None
@@ -1062,7 +1065,7 @@ def _make_experiments(self, workspace):
 
         experiment_script = workspace.experiments_script
         experiment_script.write(self.expander.expand_var('{batch_submit}\n'))
-        self.set_status(status='UNKNOWN')
+        self.set_status(status=experiment_status.SETUP)
 
     def _clean_hash_variables(self, workspace, variables):
         """Cleanup variables to hash before computing the hash
@@ -1252,6 +1255,13 @@ def _analyze_experiments(self, workspace):
         injected in a workspace config.
         """
 
+        if self.get_status() == experiment_status.UNKNOWN.name:
+            logger.die(
+                f'Workspace status is {self.get_status()}\n'
+                'Make sure your workspace is fully setup with\n'
+                '    ramble workspace setup'
+            )
+
         def format_context(context_match, context_format):
 
             context_val = {}
@@ -1355,12 +1365,13 @@ def format_context(context_match, context_format):
 
         logger.debug('fom_values = %s' % fom_values)
         results['EXPERIMENT_CHAIN'] = self.chain_order.copy()
+
         if success:
-            self.set_status(status='SUCCESS')
-            results['RAMBLE_STATUS'] = 'SUCCESS'
+            self.set_status(status=experiment_status.SUCCESS)
         else:
-            self.set_status(status='FAILED')
-            results['RAMBLE_STATUS'] = 'FAILED'
+            self.set_status(status=experiment_status.FAILED)
+
+        results['RAMBLE_STATUS'] = self.get_status()
 
         if success or workspace.always_print_foms:
             results['RAMBLE_VARIABLES'] = {}
@@ -1512,7 +1523,7 @@ def read_status(self):
 
         Set this experiment's status based on the status file in the experiment
         run directory, if it exists. If it doesn't exist, set its status to
-        UNKNOWN
+        experiment_status.UNKNOWN
         """
         status_path = os.path.join(
             self.expander.expand_var_name(self.keywords.experiment_run_dir),
@@ -1525,12 +1536,15 @@ def read_status(self):
             self.variables[self.keywords.experiment_status] = \
                 status_data[self.keywords.experiment_status]
         else:
-            self.variables[self.keywords.experiment_status] = \
-                'UNKNOWN'
+            self.set_status(experiment_status.UNKNOWN)
 
-    def set_status(self, status='UNKNOWN'):
+    def set_status(self, status=experiment_status.UNKNOWN):
         """Set the status of this experiment"""
-        self.variables[self.keywords.experiment_status] = status
+        self.variables[self.keywords.experiment_status] = status.name
+
+    def get_status(self):
+        """Get the status of this experiment"""
+        return self.variables[self.keywords.experiment_status]
 
     register_phase('write_status', pipeline='analyze', depends_on=['analyze_experiments'])
     register_phase('write_status', pipeline='setup', depends_on=['make_experiments'])

diff --git a/lib/ramble/ramble/test/workspace_hashing/unsetup_workspace_cannot_analyze.py b/lib/ramble/ramble/test/workspace_hashing/unsetup_workspace_cannot_analyze.py
@@ -68,4 +68,4 @@ def test_unsetup_workspace_cannot_analyze(mutable_config,
         ws._re_read()
         with pytest.raises(RambleCommandError):
             output = workspace('analyze', global_args=['-w', workspace_name])
-            assert 'spack.lock file does not exist' in output
+            assert 'Make sure your workspace is fully setup' in output