Unescape passcode (#26)

Author: vrslev

docker-compose.yml

@@ -14,7 +14,7 @@ services:
     image: apache/activemq-artemis:2.34.0-alpine
     environment:
       ARTEMIS_USER: admin
-      ARTEMIS_PASSWORD: admin
+      ARTEMIS_PASSWORD: =123
     ports:
       - 8161:8161
       - 61616:61616

stompman/client.py

@@ -4,6 +4,7 @@
 from dataclasses import dataclass, field
 from types import TracebackType
 from typing import Any, ClassVar, NamedTuple, Self, TypedDict
+from urllib.parse import unquote
 from uuid import uuid4
 
 from stompman.connection import AbstractConnection, Connection
@@ -59,6 +60,10 @@ class ConnectionParameters:
     login: str
     passcode: str = field(repr=False)
 
+    @property
+    def unescaped_passcode(self) -> str:
+        return unquote(self.passcode)
+
     @classmethod
     def from_pydantic_multihost_hosts(cls, hosts: list[MultiHostHostLike]) -> list[Self]:
         """Create connection parameters from a list of `MultiHostUrl` objects.
@@ -168,7 +173,7 @@ async def _connection_lifespan(self) -> AsyncGenerator[None, None]:
                     "heart-beat": self.heartbeat.to_header(),
                     "host": self._connection_parameters.host,
                     "login": self._connection_parameters.login,
-                    "passcode": self._connection_parameters.passcode,
+                    "passcode": self._connection_parameters.unescaped_passcode,
                 },
             )
         )

tests/integration.py

@@ -12,7 +12,7 @@
 
 @pytest.fixture()
 def server() -> stompman.ConnectionParameters:
-    return stompman.ConnectionParameters(host=os.environ["ARTEMIS_HOST"], port=61616, login="admin", passcode="admin")
+    return stompman.ConnectionParameters(host=os.environ["ARTEMIS_HOST"], port=61616, login="admin", passcode="%3D123")
 
 
 async def test_ok(server: stompman.ConnectionParameters) -> None:

tests/test_client.py

@@ -218,9 +218,8 @@ class MockConnection(connection_class):  # type: ignore[valid-type, misc]
     monkeypatch.setattr(stompman.client, "uuid4", lambda: receipt_id)
 
     login = "login"
-    passcode = "passcode"
     async with EnrichedClient(
-        [ConnectionParameters("localhost", 10, login, passcode)], connection_class=MockConnection
+        [ConnectionParameters("localhost", 10, login, "%3Dpasscode")], connection_class=MockConnection
     ) as client:
         await asyncio.sleep(0)
 
@@ -231,7 +230,7 @@ class MockConnection(connection_class):  # type: ignore[valid-type, misc]
                 "accept-version": client.PROTOCOL_VERSION,
                 "heart-beat": client.heartbeat.to_header(),
                 "login": login,
-                "passcode": passcode,
+                "passcode": "=passcode",
             }
         ),
         connected_frame,