Preparing for final release of 0.0.1

Author: krrg

README.md

@@ -22,8 +22,4 @@ if __name__ == "__main__":
     agent.run(host='127.0.0.1', port=9002)
 ```
 
-## TODO:
-* Add automated tests of our SPOP protocol implementation
-* Our target runtime was Python 3.8 or above, but it is possible this implementation could work with earlier versions.
-* Better debug logging / crash handling.
-* Document a recommended deployment strategy.
+

example/agent.py

@@ -9,7 +9,7 @@
 
 @agent.handler("earth-to-mars")
 async def handle_earth_to_mars(src: IPv4Address, req_host: str):
-    return AckPayload().set_txn_var("bubbles", str(src) + req_host)
+    return AckPayload().set_txn_var("transmission_src", str(src) + req_host)
 
 
 if __name__ == "__main__":

example/haproxy/haproxy.cfg

@@ -9,15 +9,15 @@ defaults
 
 frontend http
     bind 0.0.0.0:9000
-
-    filter spoe engine python_spoa config /usr/local/etc/haproxy/python_spoa.spoe.conf
-    http-response set-header X-bubbles %[var(txn.iprep.bubbles)]
-
     default_backend application_server
 
 backend application_server
     mode http
     balance roundrobin
+
+    filter spoe engine python_spoa config /usr/local/etc/haproxy/python_spoa.spoe.conf
+    http-response set-header X-Planetary-Transmission %[var(txn.iprep.transmission_src)]
+
     server web1 127.0.0.1:9001 check
 
 backend python_spoa

example/haproxy/python_spoa.spoe.conf

@@ -10,4 +10,4 @@ spoe-agent python_spoa
 
 spoe-message earth-to-mars
     args src=src req_host=req.fhdr(host)
-    event on-frontend-http-request
+    event on-backend-http-request

haproxyspoa/spoa_payloads.py

@@ -52,8 +52,8 @@ def write_list_of_actions(actions: list) -> bytes:
     buffer = io.BytesIO()
 
     for action in actions:
-        _type = int.to_bytes(action.type, 1, byteorder='big', signed=False)
-        num_args = int.to_bytes(len(action.args), 1, byteorder='big', signed=False)
+        _type = bytes([action.type])
+        num_args = bytes([len(action.args)])
 
         buffer.write(_type)
         buffer.write(num_args)

haproxyspoa/spoa_server.py

@@ -16,7 +16,7 @@
 
 
 class SpoaConnection:
-    
+
     def __init__(self, writer: asyncio.StreamWriter, handlers):
         self.logger = FlowIdLoggerAdapter(logger, {"flow_id": secrets.token_hex(4)})
         self.handlers = handlers
@@ -33,7 +33,7 @@ async def handle_haproxy_notify(self, frame: Frame):
                 response_futures.append(handler(**notify_payload.messages[msg_key]))
 
         self.logger.info(f"Found {len(response_futures)} matching handlers, awaiting response...")
-        ack_payloads: List[AckPayload] = await asyncio.gather(*response_futures)
+        ack_payloads = await asyncio.gather(*response_futures)
         ack = AckPayload.create_from_all(*ack_payloads)
         payload = ack.to_bytes()
 
@@ -93,7 +93,7 @@ def wrapper(*args, **kwargs):
 
     async def handle_connection(self, reader: asyncio.StreamReader, writer: asyncio.StreamWriter):
         conn = SpoaConnection(writer, self.handlers)
-        
+
         haproxy_hello_frame = await Frame.read_frame(reader)
 
         if not haproxy_hello_frame.headers.is_haproxy_hello():

release.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+python3 setup.py bdist_wheel
+twine check dist/*
+twine upload dist/*

tests/__init__.py

@@ -0,0 +1,47 @@
+import io
+import ipaddress
+import unittest
+
+from haproxyspoa.spoa_data_types import write_string, write_typed_autodetect
+from haproxyspoa.spoa_payloads import write_kv_list, parse_kv_list, parse_list_of_messages
+
+
+class TestPayloadParsing(unittest.TestCase):
+
+    def test_write_read_list_of_messages(self):
+        buffer = io.BytesIO()
+
+        message_name = "solar_system_communication"
+        num_args = 4
+        args = {
+            "mercury": write_typed_autodetect(ipaddress.IPv4Address("192.168.1.23")),
+            "venus": write_typed_autodetect(123456789),
+            "earth": write_typed_autodetect("looks like a marble"),
+            "mars": write_typed_autodetect(True),
+        }
+
+        buffer.write(write_string(message_name))
+        buffer.write(bytes([num_args]))
+        buffer.write(write_kv_list(args))
+
+        self.assertEqual(
+            buffer.getvalue(),
+            b'\x1asolar_system_communication\x04\x07mercury\x06\xc0\xa8\x01\x17\x05venus\x04\xf5\xc2\xf8\xd5\x02'
+            b'\x05earth\x08\x13looks like a marble\x04mars\x04\x01',
+        )
+
+        buffer.seek(0)
+        messages = parse_list_of_messages(buffer)
+
+        self.assertEqual(messages, {
+            "solar_system_communication": {
+                "mercury": ipaddress.IPv4Address("192.168.1.23"),
+                "venus": 123456789,
+                "earth": "looks like a marble",
+                "mars": 1
+            }
+        })
+
+
+if __name__ == '__main__':
+    unittest.main()