end of day commit before i lose my marbles entirely

Author: rerpha

.gitignore

@@ -50,6 +50,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+coverage_html_report/
 
 # Translations
 *.mo

pyproject.toml

@@ -25,6 +25,29 @@ dev = [
     "pyright",
     "ruff",
     "pytest",
+    "pytest-cov"
 ]
 
+[tool.coverage.run]
+branch = true
+source = ["src"]
+
+[tool.coverage.report]
+fail_under = 100
+exclude_lines = [
+  "pragma: no cover",
+  "if TYPE_CHECKING:",
+  "if typing.TYPE_CHECKING:",
+  "@abstractmethod",
+]
+omit = ["main.py"]
+
+
+[tool.coverage.html]
+directory = "coverage_html_report"
+
+[tool.pytest.ini_options]
+testpaths = "tests"
+addopts = "--cov --cov-report=html -vv"
+
 [tool.setuptools_scm]

src/saluki/consume.py

@@ -39,8 +39,7 @@ def consume(
 
     if go_forwards:
         if offset is None:
-            logger.error("Can't go forwards without an offset")
-            return
+            raise ValueError("Can't go forwards without an offset")
         start = offset
     else:
         if offset is not None:

src/saluki/listen.py

@@ -32,8 +32,6 @@ def listen(broker: str, topic: str, partition: int | None = None) -> None:
             _deserialise_and_print_messages([msg], partition)
     except KeyboardInterrupt:
         logger.debug("finished listening")
-    except Exception:
-        logger.exception("Got exception while listening:")
     finally:
         logger.debug(f"closing consumer {c}")
         c.close()

tests/test_consume.py

@@ -1,7 +1,16 @@
-# test that tries go_forwards with no offset
+from unittest.mock import patch
+
+import pytest
+
+from saluki.consume import consume
+
+@patch("saluki.consume.Consumer")
+def test_go_forwards_with_no_offset_raises(_):
+    with pytest.raises(ValueError):
+        consume("broker", "topic", go_forwards=True, offset=None)
 
 # test that tries going forwards that consumes from offset
 
 # test that checks start offset
 
-# test that catches exception
+# test that catches exception

tests/test_listen.py

@@ -0,0 +1,32 @@
+from unittest.mock import MagicMock
+
+from confluent_kafka import TopicPartition
+
+from saluki.listen import listen
+from unittest import mock
+
+def test_listen_with_partition_assigns_to_partition():
+    expected_partition = 123
+    topic = "sometopic"
+    with (
+        mock.patch(
+            "saluki.listen._deserialise_and_print_messages",
+            side_effect=KeyboardInterrupt,
+        ),
+        mock.patch("saluki.listen.Consumer") as c,
+    ):
+        listen("somebroker", "sometopic", partition=expected_partition)
+        assert c.return_value.assign.call_args[0][0][0].topic == topic
+        assert c.return_value.assign.call_args[0][0][0].partition == expected_partition
+
+
+def test_keyboard_interrupt_causes_consumer_to_close():
+    with (
+        mock.patch(
+            "saluki.listen._deserialise_and_print_messages",
+            side_effect=KeyboardInterrupt,
+        ),
+        mock.patch("saluki.listen.Consumer") as c,
+    ):
+        listen("somebroker", "sometopic")
+        c.return_value.close.assert_called_once()

tests/test_utils.py

@@ -13,6 +13,7 @@
 
 # test _parse_timestamp
 
+
 def test_uri_with_broker_name_and_topic_successfully_split():
     test_broker = "localhost"
     test_topic = "some_topic"