Result status comparison (#1578)

* improve result status comparison

* add changelog

* add tests

* add tests for not equal comparison

---------

Co-authored-by: Alejandro Esquivel <[email protected]>

.pre-commit-config.yaml

@@ -43,7 +43,6 @@ repos:
     rev: 23.1.0
     hooks:
       - id: black
-        language_version: python3.8
 
   - repo: https://github.com/PyCQA/flake8
     rev: 6.0.0

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [UNRELEASED]
 
+### Authors
+
+- Madhur Tandon <[email protected]>
+
+### Fixed
+
+- Result status comparison
+
 ## [0.221.0-rc.0] - 2023-04-17
 
 ### Authors

covalent/_shared_files/util_classes.py

@@ -37,6 +37,16 @@ def __bool__(self):
     def __str__(self) -> str:
         return self.STATUS
 
+    def __eq__(self, __value: object) -> bool:
+        if isinstance(__value, self.__class__):
+            return self.STATUS == __value.STATUS
+        elif isinstance(__value, str):
+            return self.STATUS == __value
+        return False
+
+    def __ne__(self, __value: object) -> bool:
+        return not self.__eq__(__value)
+
 
 class RESULT_STATUS:
     NEW_OBJECT = Status("NEW_OBJECT")

covalent/triggers/base.py

@@ -167,7 +167,7 @@ def trigger(self) -> None:
 
         status = self._get_status()
 
-        if status == str(Result.NEW_OBJ) or status is None:
+        if status == Result.NEW_OBJ or status is None:
             # To continue the pending dispatch
             same_dispatch_id = self._do_redispatch(True)
             app_log.debug(f"Initiating run for pending dispatch_id: {same_dispatch_id}")

tests/covalent_dispatcher_tests/_service/app_test.py

@@ -212,7 +212,7 @@ def test_get_result(mocker, client, test_db_file):
     response = client.get(f"/api/result/{DISPATCH_ID}")
     result = response.json()
     assert result["id"] == DISPATCH_ID
-    assert result["status"] == str(Result.COMPLETED)
+    assert result["status"] == Result.COMPLETED
     os.remove("/tmp/testdb.sqlite")
 
 

tests/covalent_tests/results_manager_tests/results_test.py

@@ -141,6 +141,14 @@ def test_str_result(result_2, mocker):
     assert "task_1" in s
 
 
+def test_result_status_comparison(result_2, mocker):
+    """Test result.status __eq__ and __ne__ methods"""
+    assert result_2.status == "NEW_OBJECT"
+    assert result_2.status == Result.NEW_OBJ
+    assert result_2.status != "COMPLETED"
+    assert result_2.status != Result.COMPLETED
+
+
 def test_result_root_dispatch_id(result_1):
     """Test the `root_dispatch_id` property`"""
 

tests/functional_tests/basic_dispatcher_test.py

@@ -102,7 +102,7 @@ def outer_lattice(y):
     rm._delete_result(dispatch_id, results_dir="/tmp/results")
 
     assert result_object.error == ""
-    assert result_object.status == str(result_object.COMPLETED)
+    assert result_object.status == result_object.COMPLETED
 
     assert output == 25
 

tests/functional_tests/workflow_stack_test.py

@@ -924,10 +924,10 @@ def failing_workflow(x, y):
     dispatch_id = ct.dispatch(failing_workflow)(1, 0)
     result = ct.get_result(dispatch_id, wait=True)
     assert result.result is None
-    assert str(result.status) == "FAILED"
+    assert result.status == "FAILED"
 
     redispatch_id = ct.redispatch(dispatch_id=dispatch_id, reuse_previous_results=True)(1, 1)
     result = ct.get_result(redispatch_id, wait=True)
     assert int(result.result) == 1
-    assert str(result.status) == "COMPLETED"
+    assert result.status == "COMPLETED"
     assert result.get_node_result(0)["start_time"] == result.get_node_result(0)["end_time"]