P3: wire serve end to end, integration tests, unit file, README
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YShymaPrXmc3KYRUg2HMSs
This commit is contained in:
1 parent
936efaf97e
commit
acedb9522e
10 files changed
+637
-16
No files matched your search
@@ -0,0 +1,145 @@
|
|||||||
|
# skyg-linux-tracker
|
||||||
|
|
||||||
|
A small, read-only monitor for a single Linux host. One binary, `slinuxm`, serves:
|
||||||
|
|
||||||
|
- a REST API (with Server-Sent Events for follow endpoints),
|
||||||
|
- an MCP server (Streamable HTTP) so agents can inspect the host,
|
||||||
|
- optional OpenTelemetry export (metrics and logs over OTLP).
|
||||||
|
|
||||||
|
Data sources are systemd (D-Bus), the journal (libsystemd) and the Docker Engine API (unix socket). Nothing here can start, stop or modify anything.
|
||||||
|
|
||||||
|
## Build
|
||||||
|
|
||||||
|
```sh
|
||||||
|
devenv shell # toolchain, pkg-config, libsystemd, otelcol-contrib
|
||||||
|
cargo build --release # target/release/slinuxm
|
||||||
|
```
|
||||||
|
|
||||||
|
Without devenv you need a Rust toolchain, `pkg-config` and the libsystemd development files.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo install -m 0755 target/release/slinuxm /usr/local/bin/slinuxm
|
||||||
|
sudo useradd --system --no-create-home --shell /usr/sbin/nologin skyg
|
||||||
|
sudo install -m 0644 config.example.toml /etc/skyg-linux-tracker.toml # then edit
|
||||||
|
sudo install -m 0644 systemd/skyg-linux-tracker.service /etc/systemd/system/
|
||||||
|
sudo systemctl daemon-reload
|
||||||
|
sudo systemctl enable --now skyg-linux-tracker
|
||||||
|
```
|
||||||
|
|
||||||
|
The unit runs as the `skyg` user with `SupplementaryGroups=systemd-journal` and a private `StateDirectory` (`/var/lib/skyg-linux-tracker`, mode 0700) holding the token database. Its sandbox options are listed in the unit file.
|
||||||
|
|
||||||
|
### Config
|
||||||
|
|
||||||
|
See `config.example.toml`; every value shown is the default. Precedence, lowest to highest: defaults, config file, `SKYG_*` environment variables (nesting with `__`, for example `SKYG_SERVER__PORT`), CLI flags. `slinuxm --print-config` prints the effective configuration with secrets redacted.
|
||||||
|
|
||||||
|
Startup refuses `auth.enabled = false` on a non-loopback `server.bind`.
|
||||||
|
|
||||||
|
## Tokens
|
||||||
|
|
||||||
|
All `/api/v1/*` and `/mcp` requests need `Authorization: Bearer <token>`. `/healthz` is public. Tokens are stored hashed (sha256) in SQLite, and the plaintext is shown once.
|
||||||
|
|
||||||
|
Run the token CLI **as the service user** so the database keeps the right owner and mode:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo -u skyg slinuxm token create my-laptop --config /etc/skyg-linux-tracker.toml
|
||||||
|
sudo -u skyg slinuxm token list --config /etc/skyg-linux-tracker.toml
|
||||||
|
sudo -u skyg slinuxm token revoke my-laptop --config /etc/skyg-linux-tracker.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
Revocation takes effect immediately; no restart is needed.
|
||||||
|
|
||||||
|
## REST
|
||||||
|
|
||||||
|
Base: `http://127.0.0.1:9109`. Errors are `{"error":{"code","message"}}`.
|
||||||
|
|
||||||
|
| Route | Notes |
|
||||||
|
|---|---|
|
||||||
|
| `GET /healthz` | public, `{"status":"ok","version":...}` |
|
||||||
|
| `GET /api/v1/systemd/units?state=failed` | `state` is an active state (`failed`, `active`, ...) |
|
||||||
|
| `GET /api/v1/systemd/units/{name}` | one unit with details |
|
||||||
|
| `GET /api/v1/systemd/timers` | |
|
||||||
|
| `GET /api/v1/journal?unit=&priority=err&lines=100` | priority by name or number |
|
||||||
|
| `GET /api/v1/journal/follow?unit=&priority=` | SSE, event `journal` |
|
||||||
|
| `GET /api/v1/docker/ps` | `503` when Docker is unavailable |
|
||||||
|
| `GET /api/v1/docker/containers/{name}` | |
|
||||||
|
| `GET /api/v1/docker/containers/{name}/logs?tail=&since=&follow=0\|1` | JSON, or SSE with events `stdout`/`stderr` |
|
||||||
|
|
||||||
|
```sh
|
||||||
|
TOKEN=slinuxm_...
|
||||||
|
curl -H "Authorization: Bearer $TOKEN" 'http://127.0.0.1:9109/api/v1/systemd/units?state=failed'
|
||||||
|
curl -N -H "Authorization: Bearer $TOKEN" 'http://127.0.0.1:9109/api/v1/journal/follow?priority=err'
|
||||||
|
```
|
||||||
|
|
||||||
|
## MCP
|
||||||
|
|
||||||
|
Endpoint: `http://127.0.0.1:9109/mcp` (Streamable HTTP). Eight tools (`list_systemd_units`, `get_systemd_unit`, `list_systemd_timers`, `get_journal_logs`, `tail_journal`, `list_containers`, `get_container`, `get_container_logs`), two prompts (`diagnose_unit`, `container_health_report`) and two resources (`systemd://units/failed`, `docker://containers`). Log content is untrusted data and is labelled as such in tool results.
|
||||||
|
|
||||||
|
Generic client config (header-capable clients):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"linux-tracker": {
|
||||||
|
"url": "http://127.0.0.1:9109/mcp",
|
||||||
|
"headers": { "Authorization": "Bearer slinuxm_..." }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Claude Code: `claude mcp add --transport http linux-tracker http://127.0.0.1:9109/mcp --header "Authorization: Bearer $TOKEN"`.
|
||||||
|
|
||||||
|
Inspector: `npx @modelcontextprotocol/inspector`, transport Streamable HTTP, add the bearer header.
|
||||||
|
|
||||||
|
Raw handshake with curl:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
curl -si -X POST http://127.0.0.1:9109/mcp \
|
||||||
|
-H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' \
|
||||||
|
-H 'Accept: application/json, text/event-stream' \
|
||||||
|
-d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"curl","version":"0"}}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Origin and Host checks
|
||||||
|
|
||||||
|
`/mcp` validates `Origin` and `Host` to defend against DNS rebinding from browsers. Loopback names, `server.bind` and the configured port are accepted by default. Requests without an `Origin` header (non-browser clients) pass this check, so the bearer token remains the real gate. If you bind to `0.0.0.0` or serve behind a name, add the names clients use to `server.allowed_hosts` (for example `["monitor.lan:9109"]`) and any browser origins to `server.allowed_origins`. Terminate TLS in a reverse proxy if the host is reachable beyond a trusted network; the server itself speaks plain HTTP.
|
||||||
|
|
||||||
|
## Docker access
|
||||||
|
|
||||||
|
Reading the Docker socket directly requires group `docker`, which is root-equivalent. The unit file has this commented out. Prefer a read-only socket proxy that allows only `GET /containers/*`, `/events` and `/version`, for example [tecnativa/docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) with `CONTAINERS=1 EVENTS=1 POST=0`, exposed as a unix socket (or loopback TCP through a socat bridge), then:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[sources]
|
||||||
|
docker_socket = "/run/docker-proxy/docker.sock"
|
||||||
|
```
|
||||||
|
|
||||||
|
If the socket is missing or unreadable, Docker routes return `503` and everything else keeps working.
|
||||||
|
|
||||||
|
## OpenTelemetry
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[otel]
|
||||||
|
enabled = true
|
||||||
|
endpoint = "http://localhost:4317" # gRPC; or http://localhost:4318 with protocol = "http/protobuf"
|
||||||
|
export_logs = true
|
||||||
|
```
|
||||||
|
|
||||||
|
Metrics are polled every `metrics_interval_secs` (systemd unit active/failed/restarts and timer next elapse; container running/healthy/uptime/restarts). Logs fan out from the journal and from Docker containers. For a local collector with a debug exporter: `devenv up` (runs `otelcol-contrib --config dev/otelcol.yaml`). On SIGTERM pending records are flushed before exit.
|
||||||
|
|
||||||
|
## Verifying a release binary
|
||||||
|
|
||||||
|
```sh
|
||||||
|
ldd /usr/local/bin/slinuxm # libc, libm, libgcc_s, libsystemd and its dependencies only
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo test
|
||||||
|
cargo clippy --all-targets -- -D warnings
|
||||||
|
cargo fmt --check
|
||||||
|
```
|
||||||
|
|
||||||
|
The integration tests in `tests/` start the real router on an ephemeral port with fake sources. Design notes live in `plan.md` and `plan/`.
|
||||||
@@ -96,9 +96,9 @@ Design: [`plan.md`](plan.md) · Review fixes: [`plan/review.md`](plan/review.md)
|
|||||||
|
|
||||||
## Phase 3 — Integration & hardening · [card](plan/workstreams/P3-integration.md)
|
## Phase 3 — Integration & hardening · [card](plan/workstreams/P3-integration.md)
|
||||||
|
|
||||||
- [ ] **I1** `main.rs` wiring: protected router (`/api/v1` + `/mcp` + auth) merged with the public `/healthz`, `TraceLayer`, SIGTERM/SIGINT leading to cancel, drain and OTel flush
|
- [x] **I1** `main.rs` wiring: protected router (`/api/v1` + `/mcp` + auth) merged with the public `/healthz`, `TraceLayer`, SIGTERM/SIGINT leading to cancel, drain and OTel flush
|
||||||
- [ ] **I2** Automated negative tests (Verification #6)
|
- [x] **I2** Automated negative tests (Verification #6)
|
||||||
- [ ] **I3** `systemd/skyg-linux-tracker.service` running `slinuxm serve`: `StateDirectory=`, `ProtectSystem=strict`, `NoNewPrivileges`, `SupplementaryGroups=systemd-journal`, docker group commented (DEC-6)
|
- [x] **I3** `systemd/skyg-linux-tracker.service` running `slinuxm serve`: `StateDirectory=`, `ProtectSystem=strict`, `NoNewPrivileges`, `SupplementaryGroups=systemd-journal`, docker group commented (DEC-6)
|
||||||
- [ ] **I4** README: install, config reference, token workflow, MCP client setup, hardened docker option
|
- [x] **I4** README: install, config reference, token workflow, MCP client setup, hardened docker option
|
||||||
- [ ] **I5** Release build: `ldd` shows only libc + libsystemd and its deps. Record binary size.
|
- [x] **I5** Release build: `ldd` shows only libc + libsystemd and its deps. Record binary size.
|
||||||
- [ ] **I6** Full manual Verification #1–#6 from `plan.md` passes on a real host
|
- [ ] **I6** Full manual Verification #1–#6 from `plan.md` passes on a real host
|
||||||
@@ -13,6 +13,9 @@
|
|||||||
|
|
||||||
languages.rust.enable = true;
|
languages.rust.enable = true;
|
||||||
|
|
||||||
|
# Local OTLP collector with a debug exporter: `devenv up`.
|
||||||
|
processes.otelcol.exec = "otelcol-contrib --config dev/otelcol.yaml";
|
||||||
|
|
||||||
scripts.build.exec = ''cargo build "$@"'';
|
scripts.build.exec = ''cargo build "$@"'';
|
||||||
scripts.run.exec = ''cargo run -- "$@"'';
|
scripts.run.exec = ''cargo run -- "$@"'';
|
||||||
scripts.token.exec = ''cargo run -- token "$@"'';
|
scripts.token.exec = ''cargo run -- token "$@"'';
|
||||||
|
|||||||
+1
-1
@@ -53,5 +53,5 @@ Move a card by cutting its row into another column. Keep the card's own **Status
|
|||||||
|---|---|---|
|
|---|---|---|
|
||||||
| M0 Skeleton | `slinuxm serve --print-config` works. Clippy and tests are clean. No openssl. | 🟨 in review |
|
| M0 Skeleton | `slinuxm serve --print-config` works. Clippy and tests are clean. No openssl. | 🟨 in review |
|
||||||
| M1 Sources live | All four Phase 1 examples run against a real host | ⬜ |
|
| M1 Sources live | All four Phase 1 examples run against a real host | ⬜ |
|
||||||
| M2 Surfaces | Verification #3, #4 and #5 pass | ⬜ |
|
| M2 Surfaces | Verification #3, #4 and #5 pass | 🟨 #3 and #4 verified live on 2026-10-15; #5 (OTel smoke test) not run, no otelcol-contrib binary |
|
||||||
| M3 Release | Verification #1–#6 pass. Unit file and README shipped. | ⬜ |
|
| M3 Release | Verification #1–#6 pass. Unit file and README shipped. | ⬜ |
|
||||||
@@ -57,3 +57,5 @@ Tick these in [`TODO.md`](../../TODO.md).
|
|||||||
## Log
|
## Log
|
||||||
|
|
||||||
- 2026-10-15: Card created.
|
- 2026-10-15: Card created.
|
||||||
|
- 2026-10-15: Implemented on `p3/integration`. I1-I5 done; I6 partial. Router assembly lives in `src/server.rs` (`build_router`, `serve_listener`) so tests and `main` share it. Shutdown: signal -> cancel token -> graceful serve ends -> await exporter handles -> `guard.shutdown().await` -> close pool. `token` subcommand does not init telemetry. Unit uses a static `User=skyg` (not DynamicUser) so `sudo -u skyg slinuxm token ...` hits the same DB. I2: 8 tests in `tests/integration.rs` (raw HTTP client, no new deps). Release binary 19 MB; `ldd`: libsystemd, libgcc_s, libm, libc only.
|
||||||
|
- I6 live results (release binary, loopback, real token via CLI, real systemd/journal/docker on this host): #1 build/tests pass; #2 serve + token create pass; #3 REST incl. `curl -N` journal SSE pass (docker log follow SSE not exercised live); #4 MCP initialize, tools/list, prompts/list, resources/list, 5 tool calls, no-token 401, bad Origin 403 pass via curl (MCP Inspector not run; not all 8 tools called); #5 OTel NOT RUN (otelcol-contrib not on PATH, devenv shell not started via `devenv up`); #6 pass via tests (401, auth-off+0.0.0.0 refuses, SIGTERM with open SSE exits 0 in <1s); missing-docker-socket 503 covered by WS-E fake test, not live. Unit file not installed on a clean host (only `systemd-analyze verify`, which cannot fully run here).
|
||||||
@@ -9,6 +9,7 @@ pub mod config;
|
|||||||
pub mod db;
|
pub mod db;
|
||||||
pub mod error;
|
pub mod error;
|
||||||
pub mod mcp;
|
pub mod mcp;
|
||||||
|
pub mod server;
|
||||||
pub mod sources;
|
pub mod sources;
|
||||||
pub mod state;
|
pub mod state;
|
||||||
pub mod telemetry;
|
pub mod telemetry;
|
||||||
+51
-10
@@ -1,15 +1,18 @@
|
|||||||
//! `slinuxm` entry point: parse CLI, load layered config, dispatch.
|
//! `slinuxm` entry point: parse CLI, load layered config, dispatch.
|
||||||
//!
|
|
||||||
//! Phase 3 (I1) replaces the body of `serve` with the real wiring.
|
|
||||||
|
|
||||||
use std::net::IpAddr;
|
use std::net::IpAddr;
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
|
|
||||||
use anyhow::{bail, Context, Result};
|
use std::net::SocketAddr;
|
||||||
|
|
||||||
|
use anyhow::{Context, Result};
|
||||||
use clap::{Parser, Subcommand};
|
use clap::{Parser, Subcommand};
|
||||||
|
use tokio_util::sync::CancellationToken;
|
||||||
|
|
||||||
use skyg_linux_tracker::auth::tokens::{self, TokenCmd};
|
use skyg_linux_tracker::auth::tokens::{self, TokenCmd};
|
||||||
use skyg_linux_tracker::config::{CliOverrides, Config};
|
use skyg_linux_tracker::config::{CliOverrides, Config};
|
||||||
|
use skyg_linux_tracker::state::AppState;
|
||||||
|
use skyg_linux_tracker::{db, server, telemetry};
|
||||||
|
|
||||||
#[derive(Debug, Parser)]
|
#[derive(Debug, Parser)]
|
||||||
#[command(name = "slinuxm", version, about = "Read-only Linux system monitor")]
|
#[command(name = "slinuxm", version, about = "Read-only Linux system monitor")]
|
||||||
@@ -97,11 +100,49 @@ async fn main() -> Result<()> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async fn serve(config: Config) -> Result<()> {
|
async fn serve(config: Config) -> Result<()> {
|
||||||
// Phase 3 (I1): telemetry::init, db::open, AppState::live, router wiring,
|
let guard = telemetry::init(&config).context("initialising telemetry")?;
|
||||||
// graceful shutdown. Until then, config validation is all `serve` does.
|
let db = if config.auth.enabled {
|
||||||
bail!(
|
Some(db::open(&config).await?)
|
||||||
"server wiring is not implemented yet (P3 I1); config is valid, bind = {}:{}",
|
} else {
|
||||||
config.server.bind,
|
tracing::warn!("auth is disabled: all endpoints are open (loopback only)");
|
||||||
config.server.port
|
None
|
||||||
)
|
};
|
||||||
|
let addr = SocketAddr::new(config.server.bind, config.server.port);
|
||||||
|
let listener = tokio::net::TcpListener::bind(addr)
|
||||||
|
.await
|
||||||
|
.with_context(|| format!("binding {addr}"))?;
|
||||||
|
|
||||||
|
let shutdown = CancellationToken::new();
|
||||||
|
let state = AppState::live(config, db, shutdown.clone());
|
||||||
|
let exporters = telemetry::spawn_exporters(state.clone());
|
||||||
|
let pool = state.db.clone();
|
||||||
|
let app = server::build_router(state);
|
||||||
|
|
||||||
|
let signal_token = shutdown.clone();
|
||||||
|
tokio::spawn(async move {
|
||||||
|
wait_for_signal().await;
|
||||||
|
tracing::info!("shutdown signal received");
|
||||||
|
signal_token.cancel();
|
||||||
|
});
|
||||||
|
|
||||||
|
let result = server::serve_listener(listener, app, shutdown.clone()).await;
|
||||||
|
// Reached on signal or server error: stop everything, then flush OTel.
|
||||||
|
shutdown.cancel();
|
||||||
|
for h in exporters {
|
||||||
|
let _ = h.await;
|
||||||
|
}
|
||||||
|
guard.shutdown().await;
|
||||||
|
if let Some(pool) = pool {
|
||||||
|
pool.close().await;
|
||||||
|
}
|
||||||
|
result
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn wait_for_signal() {
|
||||||
|
use tokio::signal::unix::{signal, SignalKind};
|
||||||
|
let mut term = signal(SignalKind::terminate()).expect("SIGTERM handler");
|
||||||
|
tokio::select! {
|
||||||
|
_ = term.recv() => {}
|
||||||
|
_ = tokio::signal::ctrl_c() => {}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
//! Router assembly and the serve loop (P3). `build_router` is used by both
|
||||||
|
//! `slinuxm serve` and the integration tests.
|
||||||
|
|
||||||
|
use anyhow::{Context, Result};
|
||||||
|
use axum::routing::get;
|
||||||
|
use axum::Router;
|
||||||
|
use tokio_util::sync::CancellationToken;
|
||||||
|
use tower_http::trace::TraceLayer;
|
||||||
|
|
||||||
|
use crate::state::AppState;
|
||||||
|
use crate::{api, auth, mcp};
|
||||||
|
|
||||||
|
/// `/healthz` public; `/api/v1/*` and `/mcp` behind the auth layer.
|
||||||
|
pub fn build_router(state: AppState) -> Router {
|
||||||
|
let protected = Router::new()
|
||||||
|
.nest("/api/v1", api::router(state.clone()))
|
||||||
|
.nest_service("/mcp", mcp::service(state.clone()))
|
||||||
|
.layer(auth::layer(state));
|
||||||
|
Router::new()
|
||||||
|
.route("/healthz", get(api::healthz))
|
||||||
|
.merge(protected)
|
||||||
|
.layer(TraceLayer::new_for_http())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Serve `app` on `listener` until `shutdown` is cancelled.
|
||||||
|
pub async fn serve_listener(
|
||||||
|
listener: tokio::net::TcpListener,
|
||||||
|
app: Router,
|
||||||
|
shutdown: CancellationToken,
|
||||||
|
) -> Result<()> {
|
||||||
|
let addr = listener.local_addr().context("local_addr")?;
|
||||||
|
tracing::info!(%addr, "listening");
|
||||||
|
axum::serve(listener, app)
|
||||||
|
.with_graceful_shutdown(async move { shutdown.cancelled().await })
|
||||||
|
.await
|
||||||
|
.context("server error")
|
||||||
|
}
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=skyg-linux-tracker: read-only systemd, journal and Docker monitor (REST, MCP, OTel)
|
||||||
|
After=network.target docker.service
|
||||||
|
Wants=docker.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
ExecStart=/usr/local/bin/slinuxm serve --config /etc/skyg-linux-tracker.toml
|
||||||
|
Restart=on-failure
|
||||||
|
RestartSec=5
|
||||||
|
TimeoutStopSec=15
|
||||||
|
|
||||||
|
# Dedicated user, created beforehand: useradd --system --no-create-home \
|
||||||
|
# --shell /usr/sbin/nologin skyg
|
||||||
|
# A static user (not DynamicUser) so `sudo -u skyg slinuxm token ...` can open
|
||||||
|
# the same token database the service uses.
|
||||||
|
User=skyg
|
||||||
|
Group=skyg
|
||||||
|
# Read the journal. The tracker never writes to it.
|
||||||
|
SupplementaryGroups=systemd-journal
|
||||||
|
# WARNING: membership of the docker group is root-equivalent on the host (the
|
||||||
|
# Docker API can start privileged containers). Prefer pointing
|
||||||
|
# sources.docker_socket at a read-only socket proxy (see README) and leave this
|
||||||
|
# commented out. Uncomment only if you accept that risk (DEC-6).
|
||||||
|
#SupplementaryGroups=docker
|
||||||
|
|
||||||
|
# /var/lib/skyg-linux-tracker, owned by the service user, mode 0700.
|
||||||
|
StateDirectory=skyg-linux-tracker
|
||||||
|
StateDirectoryMode=0700
|
||||||
|
|
||||||
|
# Hardening
|
||||||
|
NoNewPrivileges=yes
|
||||||
|
ProtectSystem=strict
|
||||||
|
ProtectHome=yes
|
||||||
|
PrivateTmp=yes
|
||||||
|
PrivateDevices=yes
|
||||||
|
ProtectKernelTunables=yes
|
||||||
|
ProtectKernelModules=yes
|
||||||
|
ProtectControlGroups=yes
|
||||||
|
ProtectClock=yes
|
||||||
|
RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6
|
||||||
|
RestrictNamespaces=yes
|
||||||
|
RestrictRealtime=yes
|
||||||
|
LockPersonality=yes
|
||||||
|
MemoryDenyWriteExecute=yes
|
||||||
|
SystemCallArchitectures=native
|
||||||
|
CapabilityBoundingSet=
|
||||||
|
AmbientCapabilities=
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
@@ -0,0 +1,341 @@
|
|||||||
|
//! Integration tests (P3 I2): the real assembled router on an ephemeral port
|
||||||
|
//! with fake sources, plus the real binary for startup and SIGTERM checks.
|
||||||
|
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use skyg_linux_tracker::auth::tokens;
|
||||||
|
use skyg_linux_tracker::config::Config;
|
||||||
|
use skyg_linux_tracker::server;
|
||||||
|
use skyg_linux_tracker::sources::fake::fake_state;
|
||||||
|
use sqlx::sqlite::SqlitePoolOptions;
|
||||||
|
use tokio::io::{AsyncReadExt, AsyncWriteExt};
|
||||||
|
use tokio::net::{TcpListener, TcpStream};
|
||||||
|
use tokio_util::sync::CancellationToken;
|
||||||
|
|
||||||
|
struct Harness {
|
||||||
|
port: u16,
|
||||||
|
token: String,
|
||||||
|
shutdown: CancellationToken,
|
||||||
|
join: tokio::task::JoinHandle<anyhow::Result<()>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn start(auth: bool) -> Harness {
|
||||||
|
let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
|
||||||
|
let port = listener.local_addr().unwrap().port();
|
||||||
|
let mut config = Config::default();
|
||||||
|
config.server.port = port;
|
||||||
|
config.auth.enabled = auth;
|
||||||
|
let mut state = fake_state(config);
|
||||||
|
let mut token = String::new();
|
||||||
|
if auth {
|
||||||
|
let pool = SqlitePoolOptions::new()
|
||||||
|
.max_connections(1)
|
||||||
|
.connect("sqlite::memory:")
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
skyg_linux_tracker::db::migrate(&pool).await.unwrap();
|
||||||
|
token = tokens::create(&pool, "test").await.unwrap();
|
||||||
|
state.db = Some(pool);
|
||||||
|
}
|
||||||
|
let shutdown = state.shutdown.clone();
|
||||||
|
let app = server::build_router(state);
|
||||||
|
let join = tokio::spawn(server::serve_listener(listener, app, shutdown.clone()));
|
||||||
|
Harness {
|
||||||
|
port,
|
||||||
|
token,
|
||||||
|
shutdown,
|
||||||
|
join,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Minimal HTTP/1.1 client: sends one request with `Connection: close` and
|
||||||
|
/// reads until EOF or `wait` elapses. Returns (status, lowercase headers, body).
|
||||||
|
async fn http(
|
||||||
|
port: u16,
|
||||||
|
method: &str,
|
||||||
|
path: &str,
|
||||||
|
headers: &[(&str, &str)],
|
||||||
|
body: Option<&str>,
|
||||||
|
wait: Duration,
|
||||||
|
) -> (u16, String, String) {
|
||||||
|
let mut s = TcpStream::connect(("127.0.0.1", port)).await.unwrap();
|
||||||
|
let mut req =
|
||||||
|
format!("{method} {path} HTTP/1.1\r\nHost: 127.0.0.1:{port}\r\nConnection: close\r\n");
|
||||||
|
for (k, v) in headers {
|
||||||
|
req.push_str(&format!("{k}: {v}\r\n"));
|
||||||
|
}
|
||||||
|
if let Some(b) = body {
|
||||||
|
req.push_str(&format!("Content-Length: {}\r\n", b.len()));
|
||||||
|
}
|
||||||
|
req.push_str("\r\n");
|
||||||
|
if let Some(b) = body {
|
||||||
|
req.push_str(b);
|
||||||
|
}
|
||||||
|
s.write_all(req.as_bytes()).await.unwrap();
|
||||||
|
let mut buf = Vec::new();
|
||||||
|
let _ = tokio::time::timeout(wait, async {
|
||||||
|
let mut chunk = [0u8; 4096];
|
||||||
|
loop {
|
||||||
|
match s.read(&mut chunk).await {
|
||||||
|
Ok(0) | Err(_) => break,
|
||||||
|
Ok(n) => buf.extend_from_slice(&chunk[..n]),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.await;
|
||||||
|
let text = String::from_utf8_lossy(&buf).into_owned();
|
||||||
|
let (head, body) = text.split_once("\r\n\r\n").unwrap_or((&text, ""));
|
||||||
|
let status = head
|
||||||
|
.split_whitespace()
|
||||||
|
.nth(1)
|
||||||
|
.and_then(|s| s.parse().ok())
|
||||||
|
.unwrap_or(0);
|
||||||
|
(status, head.to_lowercase(), body.to_owned())
|
||||||
|
}
|
||||||
|
|
||||||
|
const SHORT: Duration = Duration::from_secs(2);
|
||||||
|
|
||||||
|
async fn get(h: &Harness, path: &str, bearer: bool) -> (u16, String, String) {
|
||||||
|
let auth = format!("Bearer {}", h.token);
|
||||||
|
let hdrs: Vec<(&str, &str)> = if bearer {
|
||||||
|
vec![("Authorization", auth.as_str())]
|
||||||
|
} else {
|
||||||
|
vec![]
|
||||||
|
};
|
||||||
|
http(h.port, "GET", path, &hdrs, None, SHORT).await
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn auth_and_healthz() {
|
||||||
|
let h = start(true).await;
|
||||||
|
assert_eq!(get(&h, "/healthz", false).await.0, 200);
|
||||||
|
let (st, head, body) = get(&h, "/api/v1/systemd/units", false).await;
|
||||||
|
assert_eq!(st, 401);
|
||||||
|
assert!(head.contains("www-authenticate: bearer"));
|
||||||
|
assert!(body.contains("unauthorized"));
|
||||||
|
assert_eq!(
|
||||||
|
http(
|
||||||
|
h.port,
|
||||||
|
"GET",
|
||||||
|
"/api/v1/systemd/units",
|
||||||
|
&[("Authorization", "Bearer slinuxm_nope")],
|
||||||
|
None,
|
||||||
|
SHORT
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.0,
|
||||||
|
401
|
||||||
|
);
|
||||||
|
let (st, _, body) = get(&h, "/api/v1/systemd/units", true).await;
|
||||||
|
assert_eq!(st, 200);
|
||||||
|
assert!(body.contains("ssh") || body.contains(".service"), "{body}");
|
||||||
|
// /mcp is protected too.
|
||||||
|
let (st, _, _) = http(
|
||||||
|
h.port,
|
||||||
|
"POST",
|
||||||
|
"/mcp",
|
||||||
|
&[("Content-Type", "application/json")],
|
||||||
|
Some("{}"),
|
||||||
|
SHORT,
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
assert_eq!(st, 401);
|
||||||
|
h.shutdown.cancel();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rest_routes() {
|
||||||
|
let h = start(true).await;
|
||||||
|
for p in [
|
||||||
|
"/api/v1/systemd/units",
|
||||||
|
"/api/v1/systemd/units?state=failed",
|
||||||
|
"/api/v1/systemd/timers",
|
||||||
|
"/api/v1/journal?lines=5",
|
||||||
|
"/api/v1/journal?priority=err",
|
||||||
|
"/api/v1/docker/ps",
|
||||||
|
] {
|
||||||
|
assert_eq!(get(&h, p, true).await.0, 200, "{p}");
|
||||||
|
}
|
||||||
|
assert_eq!(get(&h, "/api/v1/journal?lines=0", true).await.0, 400);
|
||||||
|
assert_eq!(get(&h, "/api/v1/nope", true).await.0, 404);
|
||||||
|
h.shutdown.cancel();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn sse_streams_and_ends_on_shutdown() {
|
||||||
|
let h = start(false).await;
|
||||||
|
let (st, head, body) = http(
|
||||||
|
h.port,
|
||||||
|
"GET",
|
||||||
|
"/api/v1/journal/follow",
|
||||||
|
&[("Accept", "text/event-stream")],
|
||||||
|
None,
|
||||||
|
Duration::from_millis(800),
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
assert_eq!(st, 200);
|
||||||
|
assert!(head.contains("text/event-stream"));
|
||||||
|
assert!(
|
||||||
|
body.contains("event: journal") || body.contains("data:"),
|
||||||
|
"{body}"
|
||||||
|
);
|
||||||
|
h.shutdown.cancel();
|
||||||
|
let r = tokio::time::timeout(Duration::from_secs(5), h.join).await;
|
||||||
|
assert!(r.is_ok(), "server did not stop after shutdown");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn open_sse_client_does_not_block_shutdown() {
|
||||||
|
let h = start(false).await;
|
||||||
|
let mut s = TcpStream::connect(("127.0.0.1", h.port)).await.unwrap();
|
||||||
|
s.write_all(
|
||||||
|
format!(
|
||||||
|
"GET /api/v1/journal/follow HTTP/1.1\r\nHost: 127.0.0.1:{}\r\nAccept: text/event-stream\r\n\r\n",
|
||||||
|
h.port
|
||||||
|
)
|
||||||
|
.as_bytes(),
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
let mut buf = [0u8; 1024];
|
||||||
|
let _ = tokio::time::timeout(Duration::from_millis(500), s.read(&mut buf)).await;
|
||||||
|
h.shutdown.cancel();
|
||||||
|
let r = tokio::time::timeout(Duration::from_secs(5), h.join).await;
|
||||||
|
assert!(r.is_ok(), "graceful shutdown hung on an open SSE client");
|
||||||
|
}
|
||||||
|
|
||||||
|
const MCP_HEADERS: [(&str, &str); 2] = [
|
||||||
|
("Content-Type", "application/json"),
|
||||||
|
("Accept", "application/json, text/event-stream"),
|
||||||
|
];
|
||||||
|
|
||||||
|
fn init_body() -> &'static str {
|
||||||
|
r#"{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-03-26","capabilities":{},"clientInfo":{"name":"it","version":"0"}}}"#
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn mcp_initialize_and_tools_list() {
|
||||||
|
let h = start(true).await;
|
||||||
|
let auth = format!("Bearer {}", h.token);
|
||||||
|
let mut hdrs: Vec<(&str, &str)> = MCP_HEADERS.to_vec();
|
||||||
|
hdrs.push(("Authorization", auth.as_str()));
|
||||||
|
let (st, head, body) = http(
|
||||||
|
h.port,
|
||||||
|
"POST",
|
||||||
|
"/mcp",
|
||||||
|
&hdrs,
|
||||||
|
Some(init_body()),
|
||||||
|
Duration::from_secs(2),
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
assert_eq!(st, 200, "{head}\n{body}");
|
||||||
|
assert!(body.contains("serverInfo"), "{body}");
|
||||||
|
let sid = head
|
||||||
|
.lines()
|
||||||
|
.find_map(|l| l.strip_prefix("mcp-session-id: "))
|
||||||
|
.expect("session id")
|
||||||
|
.trim()
|
||||||
|
.to_owned();
|
||||||
|
|
||||||
|
let mut h2 = hdrs.clone();
|
||||||
|
h2.push(("Mcp-Session-Id", sid.as_str()));
|
||||||
|
let (st, _, _) = http(
|
||||||
|
h.port,
|
||||||
|
"POST",
|
||||||
|
"/mcp",
|
||||||
|
&h2,
|
||||||
|
Some(r#"{"jsonrpc":"2.0","method":"notifications/initialized"}"#),
|
||||||
|
SHORT,
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
assert_eq!(st, 202);
|
||||||
|
let (st, _, body) = http(
|
||||||
|
h.port,
|
||||||
|
"POST",
|
||||||
|
"/mcp",
|
||||||
|
&h2,
|
||||||
|
Some(r#"{"jsonrpc":"2.0","id":2,"method":"tools/list"}"#),
|
||||||
|
SHORT,
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
assert_eq!(st, 200);
|
||||||
|
assert!(body.contains("list_systemd_units"), "{body}");
|
||||||
|
assert!(body.contains("get_container_logs"), "{body}");
|
||||||
|
h.shutdown.cancel();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn mcp_bad_origin_is_forbidden() {
|
||||||
|
let h = start(true).await;
|
||||||
|
let auth = format!("Bearer {}", h.token);
|
||||||
|
let mut hdrs: Vec<(&str, &str)> = MCP_HEADERS.to_vec();
|
||||||
|
hdrs.push(("Authorization", auth.as_str()));
|
||||||
|
hdrs.push(("Origin", "http://evil.example"));
|
||||||
|
let (st, _, _) = http(h.port, "POST", "/mcp", &hdrs, Some(init_body()), SHORT).await;
|
||||||
|
assert_eq!(st, 403);
|
||||||
|
h.shutdown.cancel();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn nonloopback_without_auth_exits_nonzero() {
|
||||||
|
let out = std::process::Command::new(env!("CARGO_BIN_EXE_slinuxm"))
|
||||||
|
.args(["serve", "--auth-enabled", "false", "--bind", "0.0.0.0"])
|
||||||
|
.env_remove("SKYG_CONFIG")
|
||||||
|
.output()
|
||||||
|
.unwrap();
|
||||||
|
assert!(!out.status.success());
|
||||||
|
let err = String::from_utf8_lossy(&out.stderr);
|
||||||
|
assert!(err.contains("auth.enabled = false"), "{err}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sigterm_with_open_sse_client_exits_promptly() {
|
||||||
|
use std::io::{Read, Write};
|
||||||
|
use std::net::TcpStream as StdStream;
|
||||||
|
let port = {
|
||||||
|
let l = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
|
||||||
|
l.local_addr().unwrap().port()
|
||||||
|
};
|
||||||
|
let mut child = std::process::Command::new(env!("CARGO_BIN_EXE_slinuxm"))
|
||||||
|
.args(["serve", "--auth-enabled", "false", "--bind", "127.0.0.1"])
|
||||||
|
.args(["--port", &port.to_string()])
|
||||||
|
.stderr(std::process::Stdio::null())
|
||||||
|
.spawn()
|
||||||
|
.unwrap();
|
||||||
|
let mut conn = None;
|
||||||
|
for _ in 0..50 {
|
||||||
|
if let Ok(c) = StdStream::connect(("127.0.0.1", port)) {
|
||||||
|
conn = Some(c);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
std::thread::sleep(Duration::from_millis(100));
|
||||||
|
}
|
||||||
|
let mut conn = conn.expect("server did not start");
|
||||||
|
conn.set_read_timeout(Some(Duration::from_millis(500)))
|
||||||
|
.unwrap();
|
||||||
|
write!(
|
||||||
|
conn,
|
||||||
|
"GET /api/v1/journal/follow HTTP/1.1\r\nHost: 127.0.0.1:{port}\r\nAccept: text/event-stream\r\n\r\n"
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
let mut buf = [0u8; 512];
|
||||||
|
let _ = conn.read(&mut buf);
|
||||||
|
let pid = child.id().to_string();
|
||||||
|
assert!(std::process::Command::new("kill")
|
||||||
|
.args(["-TERM", &pid])
|
||||||
|
.status()
|
||||||
|
.unwrap()
|
||||||
|
.success());
|
||||||
|
let start = std::time::Instant::now();
|
||||||
|
loop {
|
||||||
|
if let Some(st) = child.try_wait().unwrap() {
|
||||||
|
assert!(st.success(), "exit status {st}");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
if start.elapsed() > Duration::from_secs(5) {
|
||||||
|
let _ = child.kill();
|
||||||
|
panic!("process did not exit within 5s of SIGTERM");
|
||||||
|
}
|
||||||
|
std::thread::sleep(Duration::from_millis(50));
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in new issue
Block a user