Remove leading slash from topics

Author: thatbudakguy

mqterm/terminal.py

@@ -7,7 +7,7 @@
 
 def format_topic(*parts):
     """Create a slash-delimited MQTT topic from a list of strings."""
-    return "/" + "/".join(part.strip("/") for part in parts if part)
+    return "/".join(part.strip("/") for part in parts if part)
 
 
 def format_properties(client_id, seq):

tests/e2e/e2e_file_ops.py

@@ -39,7 +39,7 @@
 control_client = MQTTClient(control_config, logger=control_logger)
 
 # Set up the terminal
-term = MqttTerminal(device_client, topic_prefix="/test")
+term = MqttTerminal(device_client, topic_prefix="test")
 
 
 async def send_file(buffer: BytesIO):
@@ -48,7 +48,7 @@ async def send_file(buffer: BytesIO):
     seq = 0
     props = format_properties("tty0", seq)
     await control_client.publish(
-        "/test/tty/in", "cp test.txt".encode("utf-8"), properties=props
+        "test/tty/in", "cp test.txt".encode("utf-8"), properties=props
     )
 
     # Send the file in 4-byte chunks; close when done
@@ -62,7 +62,7 @@ async def send_file(buffer: BytesIO):
             seq = -1
         props = format_properties("tty0", seq)
         logger.debug(f"Sending chunk {seq} of size {len(chunk)}: {chunk!r}")
-        await control_client.publish("/test/tty/in", chunk, properties=props)
+        await control_client.publish("test/tty/in", chunk, properties=props)
         if seq == -1:
             break
 
@@ -84,7 +84,7 @@ async def get_file(buffer: BytesIO):
     seq = 0
     props = format_properties("tty0", seq)
     await control_client.publish(
-        "/test/tty/in", "cat test.txt".encode(), properties=props
+        "test/tty/in", "cat test.txt".encode(), properties=props
     )
 
     # Wait until the received buffer gets populated with the response
@@ -107,7 +107,7 @@ async def device_handler():
 # Handler for control messages that logs and stores them
 async def control_handler(buffer):
     async for topic, payload, _retained, properties in control_client.queue:
-        if topic == "/test/tty/err":
+        if topic == "test/tty/err":
             logger.error(f"Control received error: {payload.decode('utf-8')}")
         else:
             buffer.write(payload)  # Don't decode yet
@@ -118,8 +118,8 @@ async def control_handler(buffer):
 async def main():
     # Connect all clients and the terminal
     await control_client.connect(True)
-    await control_client.subscribe("/test/tty/out")
-    await control_client.subscribe("/test/tty/err")
+    await control_client.subscribe("test/tty/out")
+    await control_client.subscribe("test/tty/err")
     await device_client.connect(True)
     await term.connect()
 

tests/test_terminal.py

@@ -3,7 +3,7 @@
 from unittest import TestCase, skip
 
 from mqterm.jobs import Job, SequentialJob
-from mqterm.terminal import MqttTerminal, format_properties
+from mqterm.terminal import MqttTerminal, format_properties, format_topic
 from tests.utils import AsyncMock, Mock, call
 
 
@@ -28,10 +28,19 @@ async def update(self, payload, seq):
     def output(self):
         return BytesIO(self.contents.encode("utf-8"))
 
+class TestFormatTopic(TestCase):
+    def test_format_topic(self):
+        """Test the format_topic function."""
+        self.assertEqual(format_topic("a", "b", "c"), "a/b/c")
+        self.assertEqual(format_topic("a", None, "c"), "a/c")
+        self.assertEqual(format_topic("", "b", None), "b")
+        self.assertEqual(format_topic("a/", "b/"), "a/b")
+        self.assertEqual(format_topic(), "")
+
 
 class TestMqttTerminal(TestCase):
     def setUp(self):
-        self.in_topic = b"/tty/in"
+        self.in_topic = b"tty/in"
         self.mqtt_client = Mock()
         self.mqtt_client.publish = Mock()
         self.term = MqttTerminal(self.mqtt_client)
@@ -67,7 +76,7 @@ def test_handle_msg_bad_seq(self):
     def test_handle_msg_wrong_topic(self):
         """MqttTerminal should ignore messages on wrong topic"""
         payload = "get_file file.txt"
-        topic = b"/wrong/topic"
+        topic = b"wrong/topic"
         self.term.update_job = AsyncMock()
         asyncio.run(
             self.term.handle_msg(topic, payload.encode("utf-8"), format_properties("localhost", -1))