Improve examples in testing (#63)

Author: vrslev

.github/workflows/test.yml

@@ -28,7 +28,7 @@ jobs:
           key: check-types-${{ hashFiles('pyproject.toml') }}
       - run: curl -LsSf https://astral.sh/uv/install.sh | sh
       - uses: extractions/setup-just@v2
-      - run: just install check-types
+      - run: just check-types
 
   lint:
     runs-on: ubuntu-latest
@@ -43,7 +43,7 @@ jobs:
           key: lint-${{ hashFiles('pyproject.toml') }}
       - run: curl -LsSf https://astral.sh/uv/install.sh | sh
       - uses: extractions/setup-just@v2
-      - run: just install lint
+      - run: just lint
 
   test:
     runs-on: ubuntu-latest
@@ -64,7 +64,7 @@ jobs:
           key: ${{ github.job }}-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}
       - run: curl -LsSf https://astral.sh/uv/install.sh | sh
       - uses: extractions/setup-just@v2
-      - run: just install test -vv
+      - run: just test -vv
 
   test-integration:
     runs-on: ubuntu-latest

Justfile

@@ -1,35 +1,33 @@
-default: install lint check-types test test-integration
-
-install:
-    uv lock
-    uv sync
+default: lint check-types test test-integration
 
 lint:
-    uv run -q --frozen ruff check .
-    uv run -q --frozen ruff format .
+    uv run ruff check .
+    uv run ruff format .
 
 check-types:
-    uv run -q --frozen mypy .
+    uv run mypy .
 
 test *args:
-    uv run -q --frozen pytest {{args}}
+    uv run pytest {{args}}
 
 test-integration *args:
     #!/bin/bash
     trap 'echo; docker compose down --remove-orphans' EXIT
     docker compose run --build --rm app .venv/bin/pytest tests/integration.py --no-cov {{args}}
 
 run-artemis:
+    #!/bin/bash
+    trap 'echo; docker compose down --remove-orphans' EXIT
     docker compose run --service-ports artemis
 
 run-consumer:
-    ARTEMIS_HOST=0.0.0.0 uv run -q --frozen python testing/consumer.py
+    uv run testing/consumer.py
 
 run-producer:
-    ARTEMIS_HOST=0.0.0.0 uv run -q --frozen python testing/producer.py
+    uv run testing/producer.py
 
 publish:
     rm -rf dist/*
-    uv tool run --from build python -m build --installer uv
-    uv tool run twine check dist/*
-    uv tool run twine upload dist/* --username __token__ --password $PYPI_TOKEN
+    uvx --from build python -m build --installer uv
+    uvx twine check dist/*
+    uvx twine upload dist/* --username __token__ --password $PYPI_TOKEN

README.md

@@ -121,3 +121,7 @@ Also, I want to pointed out that:
 - Protocol parsing is inspired by [aiostomp](https://github.com/pedrokiefer/aiostomp/blob/3449dcb53f43e5956ccc7662bb5b7d76bc6ef36b/aiostomp/protocol.py) (meaning: consumed by me and refactored from).
 - stompman is tested and used with [Artemis ActiveMQ](https://activemq.apache.org/components/artemis/).
 - Specification says that headers in CONNECT and CONNECTED frames shouldn't be escaped for backwards compatibility. stompman escapes headers in CONNECT frame (outcoming), but does not unescape headers in CONNECTED (outcoming).
+
+### Examples
+
+See producer and consumer examples in [testing/](./testing/).

testing/consumer.py

@@ -1,15 +1,34 @@
 import asyncio
+import os
 
 import stompman
-from tests.integration import CONNECTION_PARAMETERS
 
+server = stompman.ConnectionParameters(
+    host=os.environ.get("ARTEMIS_HOST", "0.0.0.0"),  # noqa: S104
+    port=61616,
+    login="admin",
+    passcode=":=123",
+)
 
-async def main() -> None:
-    async def handle_message(frame: stompman.MessageFrame) -> None:  # noqa: RUF029
-        print(frame)  # noqa: T201
 
-    async with stompman.Client(servers=[CONNECTION_PARAMETERS]) as client:
-        await client.subscribe("DLQ", handler=handle_message, on_suppressed_exception=print)
+async def handle_message(message_frame: stompman.MessageFrame) -> None:
+    message_content = message_frame.body.decode()
+
+    if "Hi" not in message_content:
+        error_message = "Producer is not friendly :("
+        raise ValueError(error_message)
+
+    await asyncio.sleep(0.1)
+    print(f"received and processed friendly message: {message_content}")  # noqa: T201
+
+
+def handle_suppressed_exception(exception: Exception, message_frame: stompman.MessageFrame) -> None:
+    print(f"caught an exception, perhaps, producer is not friendly: {message_frame.body=!r} {exception=}")  # noqa: T201
+
+
+async def main() -> None:
+    async with stompman.Client(servers=[server]) as client:
+        await client.subscribe("DLQ", handler=handle_message, on_suppressed_exception=handle_suppressed_exception)
 
 
 if __name__ == "__main__":

testing/producer.py

@@ -1,15 +1,29 @@
 import asyncio
+import os
 
 import stompman
-from tests.integration import CONNECTION_PARAMETERS
+
+server = stompman.ConnectionParameters(
+    host=os.environ.get("ARTEMIS_HOST", "0.0.0.0"),  # noqa: S104
+    port=61616,
+    login="admin",
+    passcode=":=123",
+)
 
 
 async def main() -> None:
-    async with stompman.Client(servers=[CONNECTION_PARAMETERS]) as client, client.begin() as transaction:
-        for _ in range(10):
-            await transaction.send(body=b"hi there!", destination="DLQ")
-        await asyncio.sleep(3)
-        await transaction.send(body=b"hi there!", destination="DLQ")
+    async with stompman.Client([server]) as client:
+        await client.send(b"Hi!", "DLQ")
+        print("Said hi")  # noqa: T201
+
+        async with client.begin() as transaction:
+            for index in range(5):
+                await transaction.send(b"Hi from transaction! " + str(index).encode(), "DLQ")
+                print(f"Said hi in transaction ({index})")  # noqa: T201
+                await asyncio.sleep(0.3)
+
+        await client.send(b"Mu-ha-ha!", "DLQ")
+        print("Laughed evilly")  # noqa: T201
 
 
 if __name__ == "__main__":