WIP: Various improments to rust/python srpc interop library

rust/lib/srpc/client/Cargo.toml

@@ -1,36 +1,55 @@
 [package]
 name = "srpc_client"
-version = "0.1.1"
+version = "0.2.0"
 edition = "2021"
 
 [lib]
 name = "srpc_client"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-tokio = { version = "1.0", features = ["full"] }
+async-trait = "0.1"
+bytes = "1"
+futures = "0.3"
+tokio = { version = "1", features = ["full"] }
 openssl = "0.10"
-serde_json = "1.0"
+serde = {version = "1", features = ["derive"]}
+serde_json = "1"
 tokio-openssl = "0.6"
+tokio-util = { version = "0.7", features = ["codec"] }
+tracing = "0.1"
+tracing-subscriber = { version = "0.3", features = ["env-filter", "fmt"] }
 
 [dependencies.pyo3]
-version = "0.18"
+version = "0.23"
 features = ["extension-module"]
 optional = true
 
-[dependencies.pyo3-asyncio]
-version = "0.18"
-features = ["tokio-runtime"]
+[dependencies.pyo3-async-runtimes]
+version = "0.23"
+features = ["attributes", "tokio-runtime"]
 optional = true
 
 [features]
 default = []
-python = ["pyo3", "pyo3-asyncio"]
+python = ["pyo3", "pyo3-async-runtimes"]
 
 [[example]]
 name = "rust_client_example"
 path = "examples/rust_client_example.rs"
 required-features = []
 
+[[example]]
+name = "rust_client_example2"
+path = "examples/rust_client_example2.rs"
+required-features = []
+
+[[example]]
+name = "rust_client_example3"
+path = "examples/rust_client_example3.rs"
+required-features = []
+
 [dev-dependencies]
-tokio = { version = "1.0", features = ["full", "macros"] }
+rstest = "0.23.0"
+test-log = { version = "0.2.16", features = ["trace", "color"] }
+tokio = { version = "1", features = ["full", "macros", "test-util"] }

rust/lib/srpc/client/examples/python_client_example.py

@@ -2,19 +2,33 @@
 This example demonstrates how to use the srpc_client Python bindings.
 
 To run this example:
-1. Build the Rust library: maturin build --features python
-2. Install the wheel: pip install target/wheels/srpc_client-*.whl
-3. Run this script: python examples/python_client_example.py
+1. Build and install the Rust python library: maturin develop --features python
+3. Run this script:
+    RUST_LOG=trace \
+    EXAMPLE_1_SRPC_SERVER_HOST=<host> \
+    EXAMPLE_1_SRPC_SERVER_PORT=<port> \
+    EXAMPLE_1_SRPC_SERVER_ENPOINT=<srpc endpoint> \
+    EXAMPLE_1_SRPC_SERVER_CERT=<path to .cert> \
+    EXAMPLE_1_SRPC_SERVER_KEY=<path to .key> \
+    python examples/python_client_example.py
 """
 
 import asyncio
 import json
-from srpc_client import SrpcClient
+import os
+from srpc_client import SrpcClientConfig
+
 
 async def main():
-    client = SrpcClient("<Hostname or IP of hypervisor>", 6976, "/_SRPC_/TLS/JSON", "<Path to Keymaster Certificate file>", "<Path to Keymaster Key file>")
-
-    await client.connect()
+    client = SrpcClientConfig(
+        os.environ["EXAMPLE_1_SRPC_SERVER_HOST"],
+        int(os.environ["EXAMPLE_1_SRPC_SERVER_PORT"]),
+        os.environ["EXAMPLE_1_SRPC_SERVER_ENPOINT"],
+        os.environ["EXAMPLE_1_SRPC_SERVER_CERT"],
+        os.environ["EXAMPLE_1_SRPC_SERVER_KEY"],
+    )
+
+    client = await client.connect()
     print("Connected to server")
 
     message = "Hypervisor.StartVm\n"
@@ -25,9 +39,7 @@ async def main():
     for response in responses:
         print(f"Received response: {response}")
 
-    json_payload = {
-        "IpAddress": "<IP Address of VM>"
-    }
+    json_payload = {"IpAddress": "<IP Address of VM>"}
     json_string = json.dumps(json_payload)
     await client.send_json(json_string)
     print(f"Sent JSON payload: {json_payload}")
@@ -36,5 +48,6 @@ async def main():
     for json_response in json_responses:
         print(f"Received JSON response: {json.loads(json_response)}")
 
+
 if __name__ == "__main__":
     asyncio.run(main())

rust/lib/srpc/client/examples/python_client_example2.py

@@ -0,0 +1,57 @@
+"""
+This example demonstrates how to use the srpc_client Python bindings.
+
+To run this example:
+1. Build and install the Rust python library: maturin develop --features python
+3. Run this script:
+    RUST_LOG=trace \
+    EXAMPLE_2_SRPC_SERVER_HOST=<host> \
+    EXAMPLE_2_SRPC_SERVER_PORT=<port> \
+    EXAMPLE_2_SRPC_SERVER_ENPOINT=<srpc endpoint> \
+    EXAMPLE_2_SRPC_SERVER_CERT=<path to .cert> \
+    EXAMPLE_2_SRPC_SERVER_KEY=<path to .key> \
+    python examples/python_client_example2.py
+"""
+
+import asyncio
+import json
+import os
+from srpc_client import SrpcClientConfig
+
+
+async def main():
+    print("Starting client..")
+
+    # Create a new ClientConfig instance
+    client = SrpcClientConfig(
+        os.environ["EXAMPLE_2_SRPC_SERVER_HOST"],
+        int(os.environ["EXAMPLE_2_SRPC_SERVER_PORT"]),
+        os.environ["EXAMPLE_2_SRPC_SERVER_ENPOINT"],
+        os.environ["EXAMPLE_2_SRPC_SERVER_CERT"],
+        os.environ["EXAMPLE_2_SRPC_SERVER_KEY"],
+    )
+
+    # Connect to the server
+    client = await client.connect()
+    print("Connected to server")
+
+    # Send a message
+    message = "Hypervisor.GetUpdates\n"
+    print(f"Sending message: {message}")
+    await client.send_message(message)
+    print(f"Sent message: {message}")
+
+    # Receive an empty response
+    print("Waiting for empty string response...")
+    responses = await client.receive_message(expect_empty=True, should_continue=False)
+    async for response in responses:
+        print(f"Received response: {response}")
+
+    # Receive responses
+    responses = await client.receive_json_cb(should_continue=lambda _: True)
+    async for response in responses:
+        print(f"Received response: {json.loads(response)}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

rust/lib/srpc/client/examples/python_client_example3.py

@@ -0,0 +1,95 @@
+"""
+This example demonstrates how to use the srpc_client Python bindings.
+
+To run this example:
+1. Build and install the Rust python library: maturin develop --features python
+3. Run this script:
+    RUST_LOG=trace \
+    EXAMPLE_3_SRPC_SERVER_HOST=<host> \
+    EXAMPLE_3_SRPC_SERVER_PORT=<port> \
+    EXAMPLE_3_SRPC_SERVER_ENPOINT=<srpc endpoint> \
+    EXAMPLE_3_SRPC_SERVER_CERT=<path to .cert> \
+    EXAMPLE_3_SRPC_SERVER_KEY=<path to .key> \
+    python examples/python_client_example3.py
+"""
+
+import asyncio
+import json
+import os
+from srpc_client import SrpcClientConfig
+
+
+async def main():
+    print("Starting client..")
+
+    # Create a new ClientConfig instance
+    client = SrpcClientConfig(
+        os.environ["EXAMPLE_3_SRPC_SERVER_HOST"],
+        int(os.environ["EXAMPLE_3_SRPC_SERVER_PORT"]),
+        os.environ["EXAMPLE_3_SRPC_SERVER_ENPOINT"],
+        os.environ["EXAMPLE_3_SRPC_SERVER_CERT"],
+        os.environ["EXAMPLE_3_SRPC_SERVER_KEY"],
+    )
+
+    # Connect to the server
+    client = await client.connect()
+    print("Connected to server")
+
+    message = "Hypervisor.ListVMs\n"
+
+    # Send a message
+    print(f"Sending message: {message}")
+    await client.send_message(message)
+    print(f"Sent message: {message}")
+
+    # Receive an empty response
+    print("Waiting for empty string response...")
+    responses = await client.receive_message(expect_empty=True, should_continue=False)
+    async for response in responses:
+        print(f"Received response: {response}")
+
+    # Send a JSON message
+    payload = json.dumps(
+        {
+            "IgnoreStateMask": 0,
+            "OwnerGroups": [],
+            "OwnerUsers": [],
+            "Sort": True,
+            "VmTagsToMatch": {},
+        }
+    )
+    print(f"Sending payload: {payload}")
+    await client.send_json(payload)
+    print(f"Sent payload: {payload}")
+
+    # Receive an empty response
+    print("Waiting for empty string response for payload...")
+    responses = await client.receive_message(expect_empty=True, should_continue=False)
+    async for response in responses:
+        print(f"Received response: {response}")
+
+    # Receive responses
+    print("Waiting for response...")
+    responses = await client.receive_json_cb(should_continue=lambda _: False)
+    async for response in responses:
+        print(f"Received response: {json.loads(response)}")
+
+    # Use RequestReply
+    print(f"Sending request_reply: {message}")
+    res = await client.request_reply(
+        message,
+        json.dumps(
+            {
+                "IgnoreStateMask": 0,
+                "OwnerGroups": [],
+                "OwnerUsers": [],
+                "Sort": True,
+                "VmTagsToMatch": {},
+            }
+        ),
+    )
+    print(f"Sent request_reply: {message}, got reply: {res}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

rust/lib/srpc/client/examples/python_client_example4.py

@@ -0,0 +1,54 @@
+"""
+This example demonstrates how to use the srpc_client Python bindings.
+
+To run this example:
+1. Build and install the Rust python library: maturin develop --features python
+3. Run this script:
+    RUST_LOG=trace \
+    EXAMPLE_4_SRPC_SERVER_HOST=<host> \
+    EXAMPLE_4_SRPC_SERVER_PORT=<port> \
+    EXAMPLE_4_SRPC_SERVER_ENPOINT=<srpc endpoint> \
+    EXAMPLE_4_SRPC_SERVER_CERT=<path to .cert> \
+    EXAMPLE_4_SRPC_SERVER_KEY=<path to .key> \
+    python examples/python_client_example4.py
+"""
+
+import asyncio
+import json
+import os
+from srpc_client import SrpcClientConfig
+
+
+async def main():
+    print("Starting client..")
+
+    # Create a new ClientConfig instance
+    client = SrpcClientConfig(
+        os.environ["EXAMPLE_4_SRPC_SERVER_HOST"],
+        int(os.environ["EXAMPLE_4_SRPC_SERVER_PORT"]),
+        os.environ["EXAMPLE_4_SRPC_SERVER_ENPOINT"],
+        os.environ["EXAMPLE_4_SRPC_SERVER_CERT"],
+        os.environ["EXAMPLE_4_SRPC_SERVER_KEY"],
+    )
+
+    # Connect to the server
+    client = await client.connect()
+    print("Connected to server")
+
+    # Send a message
+    message = "Hypervisor.GetUpdates\n"
+    print(f"Calling server with message: {message}")
+    conn = await client.call(message)
+    response = await conn.decode()
+    print(f"Received response: {json.loads(response)}")
+    await conn.close()
+
+    print(f"Calling server with message again: {message}")
+    conn2 = await client.call(message)
+    response = await conn2.decode()
+    print(f"Received response: {json.loads(response)}")
+    await conn2.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())