From 7b82d051e2c133a1280a8255de19e859bd087cd7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20F=C3=B6rster?= <f.foerster@d-opt.com>
Date: Wed, 5 Mar 2025 15:26:39 +0100
Subject: [PATCH] add shortcut to success state

---
 src/delta_barth/errors.py |  9 ++++++++-
 tests/test_errors.py      | 25 +++++++++++++------------
 2 files changed, 21 insertions(+), 13 deletions(-)

diff --git a/src/delta_barth/errors.py b/src/delta_barth/errors.py
index 4bb579d..941033d 100644
--- a/src/delta_barth/errors.py
+++ b/src/delta_barth/errors.py
@@ -41,10 +41,17 @@ class StateHandler:
     @property
     def pipe_states(self) -> DataPipeStates:
         assert self._pipe_states is not None, (
-            "tried to access not parsed data pipeline errors"
+            "tried to access not parsed data pipeline states"
         )
         return self._pipe_states
 
+    @property
+    def SUCCESS(self) -> Status:
+        assert self._pipe_states is not None, (
+            "tried to access not parsed data pipeline states"
+        )
+        return self.pipe_states.SUCCESS
+
     def _parse_data_pipe_states(self) -> None:
         if self._pipe_states is not None:
             return
diff --git a/tests/test_errors.py b/tests/test_errors.py
index 540c663..f6068d3 100644
--- a/tests/test_errors.py
+++ b/tests/test_errors.py
@@ -14,19 +14,20 @@ from delta_barth.types import DelBarApiError, Status
 def test_state_handler_parsing():
     predef_errs = errors.DATA_PIPELINE_STATUS_DESCR
 
-    err_hdlr = delta_barth._management.StateHandler()
-    assert err_hdlr.pipe_states is not None
-    parsed_pipe_errs = err_hdlr.pipe_states
-    parsed_pipe_errs = asdict(parsed_pipe_errs)
+    state_hdlr = delta_barth._management.StateHandler()
+    assert state_hdlr.pipe_states is not None
+    parsed_pipe_states = state_hdlr.pipe_states
+    assert parsed_pipe_states.SUCCESS == state_hdlr.SUCCESS
+    parsed_pipe_states = asdict(parsed_pipe_states)
 
     for err in predef_errs:
-        dopt_err = cast(Status, parsed_pipe_errs[err[0]])
+        dopt_err = cast(Status, parsed_pipe_states[err[0]])
         assert isinstance(dopt_err, Status)
         assert dopt_err.code == err[1]
         assert dopt_err.description == err[2]
         assert dopt_err.message == ""
 
-    err_hdlr._parse_data_pipe_states()
+    state_hdlr._parse_data_pipe_states()
 
 
 def test_state_handler_internal():
@@ -34,8 +35,8 @@ def test_state_handler_internal():
     MESSAGE = "an error occurred"
     ERR_CODE = 101
 
-    err_hdlr = delta_barth._management.StateHandler()
-    new_err = err_hdlr.error(
+    state_hdlr = delta_barth._management.StateHandler()
+    new_err = state_hdlr.error(
         description=DESCRIPTION,
         message=MESSAGE,
         code=ERR_CODE,
@@ -46,14 +47,14 @@ def test_state_handler_internal():
     # failure cases
     err_code = 50  # default lower bound: 100
     with pytest.raises(ValueError):
-        new_err = err_hdlr.error(
+        new_err = state_hdlr.error(
             description=DESCRIPTION,
             message=MESSAGE,
             code=err_code,
         )
     err_code = 500  # default upper bound: 400
     with pytest.raises(ValueError):
-        new_err = err_hdlr.error(
+        new_err = state_hdlr.error(
             description=DESCRIPTION,
             message=MESSAGE,
             code=err_code,
@@ -66,8 +67,8 @@ def test_state_handler_api_error():
     assert api_err.status_code == 401
     assert api_err.message == "test case"
 
-    err_hdlr = delta_barth._management.StateHandler()
-    new_err = err_hdlr.api_error(error=api_err)
+    state_hdlr = delta_barth._management.StateHandler()
+    new_err = state_hdlr.api_error(error=api_err)
     assert new_err.code == DEFAULT_API_ERR_CODE
     assert "API-Server" in new_err.description
     assert new_err.message != MESSAGE