streamrelay 0.1.0__tar.gz

streamrelay-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest tests/ -v

streamrelay-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+*.pyo
+.pytest_cache/
+dist/
+build/
+*.egg-info/
+.env
+*.egg

streamrelay-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,228 @@
+# Contributing & Testing Guide
+
+Three levels of testing are available, each building on the previous:
+
+1. **Unit + integration tests** — no network, no credentials, runs in < 2s
+2. **Local end-to-end** — full producer → relay → consumer on your laptop via Cloudflare tunnel
+3. **Live relay** — test against a real public relay server with authentication and encryption
+
+---
+
+## Level 1 — Unit and integration tests (no network needed)
+
+```bash
+git clone https://github.com/uicacer/streamrelay
+cd streamrelay
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+Expected output:
+```
+tests/test_crypto.py::test_round_trip                  PASSED
+tests/test_crypto.py::test_encrypted_format            PASSED
+tests/test_crypto.py::test_fresh_nonce_each_call       PASSED
+tests/test_crypto.py::test_passthrough_non_enc         PASSED
+tests/test_crypto.py::test_wrong_key_raises            PASSED
+tests/test_crypto.py::test_generate_key_length         PASSED
+tests/test_integration.py::test_basic                  PASSED
+tests/test_integration.py::test_buffering_producer_first PASSED
+tests/test_integration.py::test_encrypted              PASSED
+tests/test_integration.py::test_empty_stream           PASSED
+10 passed in ~1s
+```
+
+The integration tests spin up a real relay on `localhost:18765` and run
+producer/consumer pairs through it, including buffering and AES-256-GCM encryption.
+No HPC, no public server, no credentials required.
+
+---
+
+## Level 2 — Local end-to-end with Cloudflare Tunnel
+
+Tests the complete flow across a real network, simulating HPC and client on
+separate machines — entirely on your laptop.
+
+**Prerequisites:**
+```bash
+pip install streamrelay
+brew install cloudflared        # macOS
+# Linux: https://pkg.cloudflare.com/index.html
+```
+
+**Terminal 1 — Start the relay:**
+```bash
+streamrelay --port 8765 --secret demo-secret
+# Output: streamrelay listening on ws://0.0.0.0:8765
+```
+
+**Terminal 2 — Expose it publicly:**
+```bash
+cloudflared tunnel --url http://localhost:8765
+# Output: ... Your quick Tunnel has been created! Visit it at (it's https, not http):
+#         https://random-name.trycloudflare.com
+```
+Copy that URL and replace `https://` with `wss://` → your `RELAY_URL`.
+
+**Terminal 3 — Consumer (simulates your application):**
+```python
+# consumer_test.py
+from streamrelay import RelayConsumer
+
+RELAY_URL = "wss://random-name.trycloudflare.com"   # from Terminal 2
+CHANNEL   = "test-channel-001"
+SECRET    = "demo-secret"
+
+print("Waiting for tokens...")
+for token in RelayConsumer(RELAY_URL, CHANNEL, relay_secret=SECRET).stream():
+    print(token, end="", flush=True)
+print()  # newline after last token
+```
+```bash
+python consumer_test.py
+```
+
+**Terminal 4 — Producer (simulates the HPC compute node):**
+```python
+# producer_test.py
+from streamrelay import RelayProducer
+
+RELAY_URL = "wss://random-name.trycloudflare.com"   # same URL
+CHANNEL   = "test-channel-001"
+SECRET    = "demo-secret"
+
+with RelayProducer(RELAY_URL, CHANNEL, relay_secret=SECRET) as relay:
+    for word in ["Hello", " ", "from", " ", "the", " ", "compute", " ", "node", "!"]:
+        relay.send_token(word)
+```
+```bash
+python producer_test.py
+```
+
+You should see `Hello from the compute node!` appear token-by-token in Terminal 3
+as Terminal 4 sends each word.
+
+**What this proves:** both sides connect outbound to a public relay across the real
+internet, with shared-secret authentication, without any inbound ports open.
+
+---
+
+## Level 3 — Live relay test (authentication + encryption)
+
+Run the following script against a real relay server to verify all three security
+layers work end-to-end. Replace `RELAY_URL` and `SECRET` with your relay's values.
+
+```python
+# live_relay_test.py
+import asyncio
+import uuid
+from streamrelay import RelayProducer, RelayConsumer, generate_key
+
+
+RELAY_URL = "wss://your-relay.example.com"
+SECRET    = "your-relay-secret"
+
+
+async def test_plain():
+    """Plain streaming — no encryption."""
+    channel_id = str(uuid.uuid4())
+    received = []
+
+    async def consume():
+        async for token in RelayConsumer(RELAY_URL, channel_id, relay_secret=SECRET):
+            received.append(token)
+
+    async def produce():
+        await asyncio.sleep(0.3)
+        async with RelayProducer(RELAY_URL, channel_id, relay_secret=SECRET) as p:
+            for word in ["Hello", " ", "from", " ", "live", " ", "relay", "!"]:
+                await p._async_send_raw({"type": "token", "content": word})
+
+    await asyncio.gather(consume(), produce())
+    result = "".join(received)
+    assert result == "Hello from live relay!", f"Got: {repr(result)}"
+    print(f"[PASS] plain streaming: {repr(result)}")
+
+
+async def test_encrypted():
+    """AES-256-GCM end-to-end encryption — relay sees only ciphertext."""
+    channel_id = str(uuid.uuid4())
+    key = generate_key()
+    received = []
+
+    async def consume():
+        async for token in RelayConsumer(RELAY_URL, channel_id,
+                                         relay_secret=SECRET, encryption_key=key):
+            received.append(token)
+
+    async def produce():
+        await asyncio.sleep(0.3)
+        async with RelayProducer(RELAY_URL, channel_id,
+                                  relay_secret=SECRET, encryption_key=key) as p:
+            for word in ["encrypted", " ", "live", " ", "test"]:
+                await p._async_send_raw({"type": "token", "content": word})
+
+    await asyncio.gather(consume(), produce())
+    result = "".join(received)
+    assert result == "encrypted live test", f"Got: {repr(result)}"
+    print(f"[PASS] encrypted streaming: {repr(result)}")
+
+
+async def test_wrong_secret_rejected():
+    """Wrong secret must be rejected by the relay with code 4003."""
+    channel_id = str(uuid.uuid4())
+    try:
+        async for _ in RelayConsumer(RELAY_URL, channel_id, relay_secret="wrong"):
+            pass
+        print("[FAIL] wrong secret was not rejected")
+    except Exception as e:
+        assert "4003" in str(e) or "Forbidden" in str(e), f"Unexpected error: {e}"
+        print(f"[PASS] wrong secret rejected: {type(e).__name__}")
+
+
+async def main():
+    print(f"Testing relay: {RELAY_URL}\n")
+    await test_plain()
+    await test_encrypted()
+    await test_wrong_secret_rejected()
+    print("\nAll live relay tests passed.")
+
+
+asyncio.run(main())
+```
+
+```bash
+python live_relay_test.py
+```
+
+Expected output:
+```
+Testing relay: wss://your-relay.example.com
+
+[PASS] plain streaming: 'Hello from live relay!'
+[PASS] encrypted streaming: 'encrypted live test'
+[PASS] wrong secret rejected: ConnectionClosedError
+
+All live relay tests passed.
+```
+
+---
+
+## Development setup
+
+```bash
+git clone https://github.com/uicacer/streamrelay
+cd streamrelay
+pip install -e ".[dev,globus]"
+pytest tests/ -v
+ruff check streamrelay/
+```
+
+---
+
+## Submitting changes
+
+1. Fork the repo and create a feature branch.
+2. `pytest tests/ -v` — all 10 tests must pass.
+3. `ruff check streamrelay/` — no lint errors.
+4. Open a pull request with a description of what and why.

streamrelay-0.1.0/LICENSE

@@ -0,0 +1,153 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as defined by Section 1(a), any work of
+      authorship submitted to the Licensor for inclusion in the Work by the
+      copyright owner or by an individual or Legal Entity authorized to
+      submit on behalf of the copyright owner.
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combinations of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent proceedings against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or agreed
+      to in writing, Licensor provides the Work (and each Contributor
+      provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES
+      OR CONDITIONS OF ANY KIND, either express or implied, including,
+      without limitation, any warranties or conditions of TITLE,
+      NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any kind arising as a result of
+      this License or out of the use or inability to use the Work.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent to the Law. However, in accepting
+      such obligations, You may offer such obligations only on Your own behalf
+      and on Your sole responsibility, not on behalf of any other Contributor.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Anas Nassar, University of Illinois Chicago
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.