#305 - extract calypso-sim into a standalone MQTT simulator crate

.github/workflows/calypso-sim-ci.yml

@@ -0,0 +1,47 @@
+name: calypso-sim CI
+
+# calypso-sim is a detached workspace, so the top-level `cargo *--all` in
+# rust-ci.yml never reaches it. Build/check it here, but only when the sim
+# crate — or a path-dependency it pulls in (the daedalus/calypso-cangen libs,
+# or the CAN spec submodule) — actually changes, to avoid running on every PR.
+on:
+  push:
+    branches:
+      - main
+      - Develop
+    paths: &sim-paths
+      - 'calypso-sim/**'
+      - 'libs/daedalus/**'
+      - 'libs/calypso-cangen/**'
+      - 'Odyssey-Definitions'
+      - '.github/workflows/calypso-sim-ci.yml'
+  pull_request:
+    branches:
+      - main
+      - Develop
+    paths: *sim-paths
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: calypso-sim
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          submodules: recursive
+      - name: Build
+        run: cargo build --all --verbose
+      - name: Test
+        run: cargo test --verbose
+      - name: Fmt
+        # NOT `--all`: cargo-fmt with `--all` walks this crate's path deps
+        # (../libs/*) up into the main `calypso` workspace and tries to format
+        # its members — including `src/lib.rs`, whose `mod proto` resolves to a
+        # generated file the sim CI never builds. Plain `cargo fmt` stays scoped
+        # to calypso-sim's own module tree.
+        run: cargo fmt --check
+      - name: Clippy
+        run: cargo clippy --verbose --all -- -D warnings

.gitignore

@@ -25,3 +25,7 @@ serverdata.rs
 
 # private testing 
 /privatetest/
+
+# AI things
+.claude
+CLAUDE.md

Dockerfile

@@ -4,15 +4,21 @@ WORKDIR /usr/src/calypso
 COPY . .
 
 RUN git submodule update --init
-RUN apt-get update && apt-get install -y libssl-dev build-essential cmake 
+RUN apt-get update && apt-get install -y libssl-dev build-essential cmake
 RUN cargo install --path .
+# The simulator was extracted into the standalone `calypso-sim` crate (its own
+# detached workspace), so build it separately and install its binary as
+# `simulate` to preserve the historical entry point that downstream compose
+# files invoke (Argos `compose.calypso.yml` relies on the default CMD below;
+# Argos `compose.calypso.debug.sim.yml` and Nero use `command: ["simulate"]`).
+RUN cargo install --path ./calypso-sim
 
 FROM debian:bookworm-slim
 RUN apt update
 RUN apt install openssl -y
 
 COPY --from=builder /usr/local/cargo/bin/calypso /usr/local/bin/calypso
-COPY --from=builder /usr/local/cargo/bin/simulate /usr/local/bin/simulate
+COPY --from=builder /usr/local/cargo/bin/calypso-sim /usr/local/bin/simulate
 
 CMD ["simulate"]
 

README.md

@@ -30,13 +30,6 @@ Ex. `cansend vcan0 702#01010101FFFFFFFF`
 Now view calypso interpret the can message and broadcast it on `mqttui`
 
 
-### Simulation Mode
-#### Run from build
-- Same setup as above, then use the entry point `simulate` instead of `main`
-- ```cargo run --bin simulate```
-- ```cargo run --bin simulate  -- -u localhost:1883```
-
-#### Run from Docker
-- ```docker pull ghcr.io/northeastern-electric-racing/calypso:Develop```
-- ```docker run -d --rm --network host ghcr.io/northeastern-electric-racing/calypso:Develop```
-- ```docker run -d --rm -e CALYPSO_SIREN_HOST_URL=127.0.0.1:1883 --network host ghcr.io/northeastern-electric-racing/calypso:Develop```
+### Simulation
+
+The MQTT simulator lives in [`calypso-sim/`](calypso-sim/) as its own standalone crate. See [calypso-sim/README.md](calypso-sim/README.md) for usage.