refactor

Author: Andrei Neagu

packages/service-library/src/servicelib/progress_bar.py

@@ -17,6 +17,7 @@
 _MIN_PROGRESS_UPDATE_PERCENT: Final[float] = 0.01
 _INITIAL_VALUE: Final[float] = -1.0
 _FINAL_VALUE: Final[float] = 1.0
+_PROGRESS_ALREADY_REACGED_MAXIMUM: Final[str] = "Progress already reached maximum of"
 
 
 @runtime_checkable
@@ -177,7 +178,7 @@ async def update(self, steps: float = 1) -> None:
             if new_steps_value > self.num_steps:
                 _logger.warning(
                     "%s",
-                    f"Progress already reached maximum of {self.num_steps=}, "
+                    f"{_PROGRESS_ALREADY_REACGED_MAXIMUM} {self.num_steps=}, "
                     f"cause: {self._current_steps=} is updated by {steps=}"
                     "TIP: sub progresses are not created correctly please check the stack trace",
                     stack_info=True,

packages/service-library/tests/test_progress_bar.py

@@ -15,6 +15,7 @@
 from servicelib.progress_bar import (
     _INITIAL_VALUE,
     _MIN_PROGRESS_UPDATE_PERCENT,
+    _PROGRESS_ALREADY_REACGED_MAXIMUM,
     ProgressBarData,
 )
 
@@ -258,7 +259,8 @@ async def test_set_progress(caplog: pytest.LogCaptureFixture, faker: Faker):
         assert root._current_steps == pytest.approx(34)  # noqa: SLF001
         await root.set_(58)
         assert root._current_steps == pytest.approx(50)  # noqa: SLF001
-        assert "already reached maximum" in caplog.messages[0]
+        assert "WARNING" in caplog.text
+        assert _PROGRESS_ALREADY_REACGED_MAXIMUM in caplog.messages[0]
         assert "TIP:" in caplog.messages[0]
 
 
@@ -269,24 +271,29 @@ async def test_reset_progress(caplog: pytest.LogCaptureFixture, faker: Faker):
         assert root.step_weights is None
         await root.set_(50)
         assert root._current_steps == pytest.approx(50)  # noqa: SLF001
-        assert "already reached maximum" not in caplog.text
+        assert "WARNING" not in caplog.text
+        assert _PROGRESS_ALREADY_REACGED_MAXIMUM not in caplog.text
         await root.set_(51)
         assert root._current_steps == pytest.approx(50)  # noqa: SLF001
-        assert "already reached maximum" in caplog.text
+        assert "WARNING" in caplog.text
+        assert _PROGRESS_ALREADY_REACGED_MAXIMUM in caplog.text
 
         caplog.clear()
         root.reset()
 
         assert root._current_steps == pytest.approx(-1)  # noqa: SLF001
-        assert "already reached maximum" not in caplog.text
+        assert "WARNING" not in caplog.text
+        assert _PROGRESS_ALREADY_REACGED_MAXIMUM not in caplog.text
 
         await root.set_(12)
         assert root._current_steps == pytest.approx(12)  # noqa: SLF001
-        assert "already reached maximum" not in caplog.text
+        assert "WARNING" not in caplog.text
+        assert _PROGRESS_ALREADY_REACGED_MAXIMUM not in caplog.text
 
         await root.set_(51)
         assert root._current_steps == pytest.approx(50)  # noqa: SLF001
-        assert "already reached maximum" in caplog.text
+        assert "WARNING" in caplog.text
+        assert _PROGRESS_ALREADY_REACGED_MAXIMUM in caplog.text
 
 
 async def test_concurrent_progress_bar(faker: Faker):
@@ -331,7 +338,7 @@ async def test_too_many_updates_does_not_raise_but_show_warning_with_stack(
         await root.update()
         await root.update()
         await root.update()
-        assert "already reached maximum" in caplog.messages[0]
+        assert _PROGRESS_ALREADY_REACGED_MAXIMUM in caplog.messages[0]
         assert "TIP:" in caplog.messages[0]