Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
17a50d776b
|
|||
|
550dcd1f0c
|
|||
|
cbbeaf6d67
|
|||
|
6dffb91626
|
|||
|
c63bf7b814
|
|||
|
7a9af8015e
|
|||
|
d437e6ff36
|
|||
|
93f1b726ce
|
|||
|
c58c5d3eff
|
|||
|
60e8c7f9a8
|
|||
|
272ddf17c2
|
|||
|
b0bf71aa61
|
|||
|
0cb26df68b
|
|||
|
a7c2eb1d9b
|
113
CHANGELOG.md
Normal file
113
CHANGELOG.md
Normal file
@@ -0,0 +1,113 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
## [1.6.0] - 2026-04-01
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **wfe-server**: Headless workflow server (single binary)
|
||||||
|
- gRPC API with 13 RPCs: workflow CRUD, lifecycle streaming, log streaming, log search
|
||||||
|
- HTTP webhooks: GitHub and Gitea with HMAC-SHA256 verification, configurable triggers
|
||||||
|
- OIDC/JWT authentication with JWKS discovery and asymmetric algorithm allowlist
|
||||||
|
- Static bearer token auth with constant-time comparison
|
||||||
|
- Lifecycle event broadcasting via `WatchLifecycle` server-streaming RPC
|
||||||
|
- Real-time log streaming via `StreamLogs` with follow mode and history replay
|
||||||
|
- Full-text log search via OpenSearch with `SearchLogs` RPC
|
||||||
|
- Layered config: CLI flags > env vars > TOML file
|
||||||
|
- **wfe-server-protos**: gRPC service definitions (tonic 0.14, server + client stubs)
|
||||||
|
- **wfe-core**: `LogSink` trait for real-time step output streaming
|
||||||
|
- **wfe-core**: Lifecycle publisher wired into executor (StepStarted, StepCompleted, Error, Completed, Terminated)
|
||||||
|
- **wfe**: `use_log_sink()` on `WorkflowHostBuilder`
|
||||||
|
- **wfe-yaml**: Shell step streaming mode with `tokio::select!` interleaved stdout/stderr
|
||||||
|
|
||||||
|
### Security
|
||||||
|
|
||||||
|
- JWT algorithm confusion prevention: derive algorithm from JWK, reject symmetric algorithms
|
||||||
|
- Constant-time static token comparison via `subtle` crate
|
||||||
|
- OIDC issuer HTTPS validation to prevent SSRF
|
||||||
|
- Fail-closed on OIDC discovery failure (server won't start with broken auth)
|
||||||
|
- Authenticated generic webhook endpoint
|
||||||
|
- 2MB webhook payload size limit
|
||||||
|
- Config parse errors fail loudly (no silent fallback to open defaults)
|
||||||
|
- Blocked sensitive env var injection (PATH, LD_PRELOAD, etc.) from workflow data
|
||||||
|
- Security regression tests for all critical and high findings
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Shell step streaming path now respects `timeout_ms` with `child.kill()` on timeout
|
||||||
|
- LogSink properly threaded from WorkflowHostBuilder through executor to StepExecutionContext
|
||||||
|
- LogStore.with_search() wired in server main.rs for OpenSearch indexing
|
||||||
|
- OpenSearch `index_chunk` returns Err on HTTP failure instead of swallowing it
|
||||||
|
- Webhook publish failures return 500 instead of 200
|
||||||
|
|
||||||
|
## [1.5.0] - 2026-03-29
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **wfe-rustlang**: New crate with Rust toolchain step executors
|
||||||
|
- Cargo steps: `cargo-build`, `cargo-test`, `cargo-check`, `cargo-clippy`, `cargo-fmt`, `cargo-doc`, `cargo-publish`
|
||||||
|
- External tool steps with auto-install: `cargo-audit`, `cargo-deny`, `cargo-nextest`, `cargo-llvm-cov`
|
||||||
|
- Rustup steps: `rust-install`, `rustup-toolchain`, `rustup-component`, `rustup-target`
|
||||||
|
- `cargo-doc-mdx`: generates MDX documentation from rustdoc JSON output using the `rustdoc-types` crate
|
||||||
|
- **wfe-yaml**: `rustlang` feature flag enabling all cargo/rustup step types
|
||||||
|
- **wfe-yaml**: Schema fields for Rust steps (`package`, `features`, `toolchain`, `profile`, `output_dir`, etc.)
|
||||||
|
- **wfe-containerd**: Remote daemon support via `WFE_IO_DIR` environment variable
|
||||||
|
- **wfe-containerd**: Image chain ID resolution from content store for proper rootfs snapshots
|
||||||
|
- **wfe-containerd**: Docker-default Linux capabilities for root containers
|
||||||
|
- Lima `wfe-test` VM config (Alpine + containerd + BuildKit, TCP socat proxy)
|
||||||
|
- Containerd integration tests running Rust toolchain in containers
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- **wfe-containerd**: Empty rootfs — snapshot parent now resolved from image chain ID instead of empty string
|
||||||
|
- **wfe-containerd**: FIFO deadlock with remote daemons — replaced with regular file I/O
|
||||||
|
- **wfe-containerd**: `sh: not found` — use absolute `/bin/sh` path in OCI process spec
|
||||||
|
- **wfe-containerd**: `setgroups: Operation not permitted` — grant capabilities when running as UID 0
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Lima `wfe-test` VM uses Alpine apk packages instead of GitHub release binaries
|
||||||
|
- Container tests use TCP proxy (`http://127.0.0.1:2500`) instead of Unix socket forwarding
|
||||||
|
- CI pipeline (`workflows.yaml`) updated with `wfe-rustlang` in test, package, and publish steps
|
||||||
|
|
||||||
|
879 tests. 88.8% coverage on wfe-rustlang.
|
||||||
|
|
||||||
|
## [1.4.0] - 2026-03-26
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Type-safe `when:` conditions on workflow steps with compile-time validation
|
||||||
|
- Full boolean combinator set: `all` (AND), `any` (OR), `none` (NOR), `one_of` (XOR), `not` (NOT)
|
||||||
|
- Task file includes with cycle detection
|
||||||
|
- Self-hosting CI pipeline (`workflows.yaml`) demonstrating all features
|
||||||
|
- `readFile()` op for deno runtime
|
||||||
|
- Auto-typed `##wfe[output]` annotations (bool, number conversion)
|
||||||
|
- Multi-workflow YAML files, SubWorkflow step type, typed input/output schemas
|
||||||
|
- HostContext for programmatic child workflow invocation
|
||||||
|
- BuildKit image builder and containerd container runner as standalone crates
|
||||||
|
- gRPC clients generated from official upstream proto files (tonic 0.14)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Pipeline coverage step produces valid JSON, deno reads it with `readFile()`
|
||||||
|
- Host context field added to container executor test contexts
|
||||||
|
- `.outputs.` paths resolved flat for child workflows
|
||||||
|
- Pointer status conversion for Skipped in postgres provider
|
||||||
|
|
||||||
|
629 tests. 87.7% coverage.
|
||||||
|
|
||||||
|
## [1.0.0] - 2026-03-23
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- **wfe-core**: Workflow engine with step primitives, executor, fluent builder API
|
||||||
|
- **wfe**: WorkflowHost, registry, sync runner, and purger
|
||||||
|
- **wfe-sqlite**: SQLite persistence provider
|
||||||
|
- **wfe-postgres**: PostgreSQL persistence provider
|
||||||
|
- **wfe-opensearch**: OpenSearch search index provider
|
||||||
|
- **wfe-valkey**: Valkey provider for locks, queues, and lifecycle events
|
||||||
|
- **wfe-yaml**: YAML workflow definitions with shell and deno executors
|
||||||
|
- **wfe-yaml**: Deno JS/TS runtime with sandboxed permissions, HTTP ops, npm support via esm.sh
|
||||||
|
- OpenTelemetry tracing support behind `otel` feature flag
|
||||||
|
- In-memory test support providers
|
||||||
21
Cargo.toml
21
Cargo.toml
@@ -1,9 +1,9 @@
|
|||||||
[workspace]
|
[workspace]
|
||||||
members = ["wfe-core", "wfe-sqlite", "wfe-postgres", "wfe-opensearch", "wfe-valkey", "wfe", "wfe-yaml", "wfe-buildkit", "wfe-containerd", "wfe-containerd-protos", "wfe-buildkit-protos"]
|
members = ["wfe-core", "wfe-sqlite", "wfe-postgres", "wfe-opensearch", "wfe-valkey", "wfe", "wfe-yaml", "wfe-buildkit", "wfe-containerd", "wfe-containerd-protos", "wfe-buildkit-protos", "wfe-rustlang", "wfe-server-protos", "wfe-server"]
|
||||||
resolver = "2"
|
resolver = "2"
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
version = "1.4.0"
|
version = "1.6.0"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
repository = "https://src.sunbeam.pt/studio/wfe"
|
repository = "https://src.sunbeam.pt/studio/wfe"
|
||||||
@@ -38,14 +38,15 @@ redis = { version = "0.27", features = ["tokio-comp", "connection-manager"] }
|
|||||||
opensearch = "2"
|
opensearch = "2"
|
||||||
|
|
||||||
# Internal crates
|
# Internal crates
|
||||||
wfe-core = { version = "1.4.0", path = "wfe-core" }
|
wfe-core = { version = "1.6.0", path = "wfe-core", registry = "sunbeam" }
|
||||||
wfe-sqlite = { version = "1.4.0", path = "wfe-sqlite" }
|
wfe-sqlite = { version = "1.6.0", path = "wfe-sqlite", registry = "sunbeam" }
|
||||||
wfe-postgres = { version = "1.4.0", path = "wfe-postgres" }
|
wfe-postgres = { version = "1.6.0", path = "wfe-postgres", registry = "sunbeam" }
|
||||||
wfe-opensearch = { version = "1.4.0", path = "wfe-opensearch" }
|
wfe-opensearch = { version = "1.6.0", path = "wfe-opensearch", registry = "sunbeam" }
|
||||||
wfe-valkey = { version = "1.4.0", path = "wfe-valkey" }
|
wfe-valkey = { version = "1.6.0", path = "wfe-valkey", registry = "sunbeam" }
|
||||||
wfe-yaml = { version = "1.4.0", path = "wfe-yaml" }
|
wfe-yaml = { version = "1.6.0", path = "wfe-yaml", registry = "sunbeam" }
|
||||||
wfe-buildkit = { version = "1.4.0", path = "wfe-buildkit" }
|
wfe-buildkit = { version = "1.6.0", path = "wfe-buildkit", registry = "sunbeam" }
|
||||||
wfe-containerd = { version = "1.4.0", path = "wfe-containerd" }
|
wfe-containerd = { version = "1.6.0", path = "wfe-containerd", registry = "sunbeam" }
|
||||||
|
wfe-rustlang = { version = "1.6.0", path = "wfe-rustlang", registry = "sunbeam" }
|
||||||
|
|
||||||
# YAML
|
# YAML
|
||||||
serde_yaml = "0.9"
|
serde_yaml = "0.9"
|
||||||
|
|||||||
@@ -1,18 +1,22 @@
|
|||||||
# WFE Test VM — BuildKit + containerd with host-accessible sockets
|
# WFE Test VM — Alpine + containerd + BuildKit
|
||||||
#
|
#
|
||||||
# Provides both buildkitd and containerd daemons with Unix sockets
|
# Lightweight VM for running wfe-buildkit and wfe-containerd integration tests.
|
||||||
# forwarded to the host for integration testing.
|
# Provides system-level containerd and BuildKit daemons with Unix sockets
|
||||||
|
# forwarded to the host.
|
||||||
#
|
#
|
||||||
# Usage:
|
# Usage:
|
||||||
# limactl start ./test/lima/wfe-test.yaml
|
# limactl create --name wfe-test ./test/lima/wfe-test.yaml
|
||||||
|
# limactl start wfe-test
|
||||||
#
|
#
|
||||||
# Sockets (on host after start):
|
# Sockets (on host after start):
|
||||||
# BuildKit: unix://$HOME/.lima/wfe-test/sock/buildkitd.sock
|
# BuildKit: unix://$HOME/.lima/wfe-test/buildkitd.sock
|
||||||
# containerd: unix://$HOME/.lima/wfe-test/sock/containerd.sock
|
# containerd: unix://$HOME/.lima/wfe-test/containerd.sock
|
||||||
#
|
#
|
||||||
# Verify:
|
# Run tests:
|
||||||
# BUILDKIT_HOST="unix://$HOME/.lima/wfe-test/sock/buildkitd.sock" buildctl debug workers
|
# WFE_BUILDKIT_ADDR="unix://$HOME/.lima/wfe-test/buildkitd.sock" \
|
||||||
# # containerd accessible via gRPC at unix://$HOME/.lima/wfe-test/sock/containerd.sock
|
# WFE_CONTAINERD_ADDR="unix://$HOME/.lima/wfe-test/containerd.sock" \
|
||||||
|
# cargo test -p wfe-buildkit -p wfe-containerd --test integration
|
||||||
|
# cargo test -p wfe-yaml --features rustlang,containerd --test rustlang_containerd -- --ignored
|
||||||
#
|
#
|
||||||
# Teardown:
|
# Teardown:
|
||||||
# limactl stop wfe-test
|
# limactl stop wfe-test
|
||||||
@@ -21,30 +25,117 @@
|
|||||||
message: |
|
message: |
|
||||||
WFE integration test VM is ready.
|
WFE integration test VM is ready.
|
||||||
|
|
||||||
BuildKit socket: unix://{{.Dir}}/sock/buildkitd.sock
|
containerd: http://127.0.0.1:2500 (TCP proxy, use for gRPC)
|
||||||
containerd socket: unix://{{.Dir}}/sock/containerd.sock
|
BuildKit: http://127.0.0.1:2501 (TCP proxy, use for gRPC)
|
||||||
|
|
||||||
Verify BuildKit:
|
|
||||||
BUILDKIT_HOST="unix://{{.Dir}}/sock/buildkitd.sock" buildctl debug workers
|
|
||||||
|
|
||||||
Run tests:
|
Run tests:
|
||||||
WFE_BUILDKIT_ADDR="unix://{{.Dir}}/sock/buildkitd.sock" \
|
WFE_CONTAINERD_ADDR="http://127.0.0.1:2500" \
|
||||||
WFE_CONTAINERD_ADDR="unix://{{.Dir}}/sock/containerd.sock" \
|
WFE_BUILDKIT_ADDR="http://127.0.0.1:2501" \
|
||||||
cargo nextest run -p wfe-buildkit -p wfe-containerd
|
cargo test -p wfe-yaml --features rustlang,containerd --test rustlang_containerd -- --ignored
|
||||||
|
|
||||||
minimumLimaVersion: 2.0.0
|
minimumLimaVersion: "2.0.0"
|
||||||
|
|
||||||
base: template:_images/ubuntu-lts
|
vmType: vz
|
||||||
|
mountType: virtiofs
|
||||||
|
cpus: 2
|
||||||
|
memory: 4GiB
|
||||||
|
disk: 20GiB
|
||||||
|
|
||||||
|
images:
|
||||||
|
- location: "https://dl-cdn.alpinelinux.org/alpine/v3.21/releases/cloud/nocloud_alpine-3.21.6-aarch64-uefi-cloudinit-r0.qcow2"
|
||||||
|
arch: "aarch64"
|
||||||
|
- location: "https://dl-cdn.alpinelinux.org/alpine/v3.21/releases/cloud/nocloud_alpine-3.21.6-x86_64-uefi-cloudinit-r0.qcow2"
|
||||||
|
arch: "x86_64"
|
||||||
|
|
||||||
|
mounts:
|
||||||
|
# Share /tmp so the containerd shim can access FIFOs created by the host-side executor
|
||||||
|
- location: /tmp/wfe-io
|
||||||
|
mountPoint: /tmp/wfe-io
|
||||||
|
writable: true
|
||||||
|
|
||||||
containerd:
|
containerd:
|
||||||
system: false
|
system: false
|
||||||
user: true
|
user: false
|
||||||
|
|
||||||
|
provision:
|
||||||
|
# 1. Base packages + containerd + buildkit from Alpine repos (musl-compatible)
|
||||||
|
- mode: system
|
||||||
|
script: |
|
||||||
|
#!/bin/sh
|
||||||
|
set -eux
|
||||||
|
apk update
|
||||||
|
apk add --no-cache \
|
||||||
|
curl bash coreutils findutils grep tar gzip pigz \
|
||||||
|
containerd containerd-openrc \
|
||||||
|
runc \
|
||||||
|
buildkit buildkit-openrc \
|
||||||
|
nerdctl
|
||||||
|
|
||||||
|
# 2. Start containerd
|
||||||
|
- mode: system
|
||||||
|
script: |
|
||||||
|
#!/bin/sh
|
||||||
|
set -eux
|
||||||
|
rc-update add containerd default 2>/dev/null || true
|
||||||
|
rc-service containerd start 2>/dev/null || true
|
||||||
|
# Wait for socket
|
||||||
|
for i in $(seq 1 15); do
|
||||||
|
[ -S /run/containerd/containerd.sock ] && break
|
||||||
|
sleep 1
|
||||||
|
done
|
||||||
|
chmod 666 /run/containerd/containerd.sock 2>/dev/null || true
|
||||||
|
|
||||||
|
# 3. Start BuildKit (Alpine package names the service "buildkitd")
|
||||||
|
- mode: system
|
||||||
|
script: |
|
||||||
|
#!/bin/sh
|
||||||
|
set -eux
|
||||||
|
rc-update add buildkitd default 2>/dev/null || true
|
||||||
|
rc-service buildkitd start 2>/dev/null || true
|
||||||
|
|
||||||
|
# 4. Fix socket permissions + TCP proxy for gRPC access (persists across reboots)
|
||||||
|
- mode: system
|
||||||
|
script: |
|
||||||
|
#!/bin/sh
|
||||||
|
set -eux
|
||||||
|
apk add --no-cache socat
|
||||||
|
mkdir -p /etc/local.d
|
||||||
|
cat > /etc/local.d/fix-sockets.start << 'EOF'
|
||||||
|
#!/bin/sh
|
||||||
|
# Wait for daemons
|
||||||
|
for i in $(seq 1 30); do
|
||||||
|
[ -S /run/buildkit/buildkitd.sock ] && break
|
||||||
|
sleep 1
|
||||||
|
done
|
||||||
|
# Fix permissions for Lima socket forwarding
|
||||||
|
chmod 755 /run/buildkit /run/containerd 2>/dev/null
|
||||||
|
chmod 666 /run/buildkit/buildkitd.sock /run/containerd/containerd.sock 2>/dev/null
|
||||||
|
# TCP proxy for gRPC (Lima socket forwarding breaks HTTP/2)
|
||||||
|
socat TCP4-LISTEN:2500,fork,reuseaddr UNIX-CONNECT:/run/containerd/containerd.sock &
|
||||||
|
socat TCP4-LISTEN:2501,fork,reuseaddr UNIX-CONNECT:/run/buildkit/buildkitd.sock &
|
||||||
|
EOF
|
||||||
|
chmod +x /etc/local.d/fix-sockets.start
|
||||||
|
rc-update add local default 2>/dev/null || true
|
||||||
|
/etc/local.d/fix-sockets.start
|
||||||
|
|
||||||
|
probes:
|
||||||
|
- script: |
|
||||||
|
#!/bin/sh
|
||||||
|
set -eux
|
||||||
|
sudo test -S /run/containerd/containerd.sock
|
||||||
|
sudo chmod 755 /run/containerd 2>/dev/null
|
||||||
|
sudo chmod 666 /run/containerd/containerd.sock 2>/dev/null
|
||||||
|
hint: "Waiting for containerd socket"
|
||||||
|
- script: |
|
||||||
|
#!/bin/sh
|
||||||
|
set -eux
|
||||||
|
sudo test -S /run/buildkit/buildkitd.sock
|
||||||
|
sudo chmod 755 /run/buildkit 2>/dev/null
|
||||||
|
sudo chmod 666 /run/buildkit/buildkitd.sock 2>/dev/null
|
||||||
|
hint: "Waiting for BuildKit socket"
|
||||||
|
|
||||||
portForwards:
|
portForwards:
|
||||||
# BuildKit daemon socket
|
- guestSocket: "/run/buildkit/buildkitd.sock"
|
||||||
- guestSocket: "/run/user/{{.UID}}/buildkit-default/buildkitd.sock"
|
hostSocket: "{{.Dir}}/buildkitd.sock"
|
||||||
hostSocket: "{{.Dir}}/sock/buildkitd.sock"
|
- guestSocket: "/run/containerd/containerd.sock"
|
||||||
|
hostSocket: "{{.Dir}}/containerd.sock"
|
||||||
# containerd daemon socket (rootless)
|
|
||||||
- guestSocket: "/run/user/{{.UID}}/containerd/containerd.sock"
|
|
||||||
hostSocket: "{{.Dir}}/sock/containerd.sock"
|
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ async-trait = { workspace = true }
|
|||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
thiserror = { workspace = true }
|
thiserror = { workspace = true }
|
||||||
regex = { workspace = true }
|
regex = { workspace = true }
|
||||||
wfe-buildkit-protos = { path = "../wfe-buildkit-protos" }
|
wfe-buildkit-protos = { version = "1.6.0", path = "../wfe-buildkit-protos", registry = "sunbeam" }
|
||||||
tonic = "0.14"
|
tonic = "0.14"
|
||||||
tower = { version = "0.4", features = ["util"] }
|
tower = { version = "0.4", features = ["util"] }
|
||||||
hyper-util = { version = "0.1", features = ["tokio"] }
|
hyper-util = { version = "0.1", features = ["tokio"] }
|
||||||
|
|||||||
@@ -94,6 +94,7 @@ async fn build_simple_dockerfile_via_grpc() {
|
|||||||
workflow: &instance,
|
workflow: &instance,
|
||||||
cancellation_token: cancel,
|
cancellation_token: cancel,
|
||||||
host_context: None,
|
host_context: None,
|
||||||
|
log_sink: None,
|
||||||
};
|
};
|
||||||
|
|
||||||
let result = step.run(&ctx).await.expect("build should succeed");
|
let result = step.run(&ctx).await.expect("build should succeed");
|
||||||
@@ -180,6 +181,7 @@ async fn build_with_build_args() {
|
|||||||
workflow: &instance,
|
workflow: &instance,
|
||||||
cancellation_token: cancel,
|
cancellation_token: cancel,
|
||||||
host_context: None,
|
host_context: None,
|
||||||
|
log_sink: None,
|
||||||
};
|
};
|
||||||
|
|
||||||
let result = step.run(&ctx).await.expect("build with args should succeed");
|
let result = step.run(&ctx).await.expect("build with args should succeed");
|
||||||
@@ -227,6 +229,7 @@ async fn connect_to_unavailable_daemon_returns_error() {
|
|||||||
workflow: &instance,
|
workflow: &instance,
|
||||||
cancellation_token: cancel,
|
cancellation_token: cancel,
|
||||||
host_context: None,
|
host_context: None,
|
||||||
|
log_sink: None,
|
||||||
};
|
};
|
||||||
|
|
||||||
let err = step.run(&ctx).await;
|
let err = step.run(&ctx).await;
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ description = "containerd container runner executor for WFE"
|
|||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
wfe-core = { workspace = true }
|
wfe-core = { workspace = true }
|
||||||
wfe-containerd-protos = { path = "../wfe-containerd-protos" }
|
wfe-containerd-protos = { version = "1.6.0", path = "../wfe-containerd-protos", registry = "sunbeam" }
|
||||||
tokio = { workspace = true }
|
tokio = { workspace = true }
|
||||||
serde = { workspace = true }
|
serde = { workspace = true }
|
||||||
serde_json = { workspace = true }
|
serde_json = { workspace = true }
|
||||||
@@ -21,7 +21,8 @@ tower = "0.5"
|
|||||||
hyper-util = { version = "0.1", features = ["tokio"] }
|
hyper-util = { version = "0.1", features = ["tokio"] }
|
||||||
prost-types = "0.14"
|
prost-types = "0.14"
|
||||||
uuid = { version = "1", features = ["v4"] }
|
uuid = { version = "1", features = ["v4"] }
|
||||||
libc = "0.2"
|
sha2 = "0.10"
|
||||||
|
tokio-stream = "0.1"
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
pretty_assertions = { workspace = true }
|
pretty_assertions = { workspace = true }
|
||||||
|
|||||||
@@ -1,3 +1,50 @@
|
|||||||
|
//! Containerd container executor for WFE.
|
||||||
|
//!
|
||||||
|
//! Runs workflow steps as isolated OCI containers via the containerd gRPC API.
|
||||||
|
//!
|
||||||
|
//! # Remote daemon support
|
||||||
|
//!
|
||||||
|
//! The executor creates named pipes (FIFOs) on the **local** filesystem for
|
||||||
|
//! stdout/stderr capture, then passes those paths to the containerd task spec.
|
||||||
|
//! The containerd shim opens the FIFOs from **its** side. This means the FIFO
|
||||||
|
//! paths must be accessible to both the executor process and the containerd
|
||||||
|
//! daemon.
|
||||||
|
//!
|
||||||
|
//! When containerd runs on a different machine (e.g. a Lima VM), you need:
|
||||||
|
//!
|
||||||
|
//! 1. **Shared filesystem** — mount a host directory into the VM so both sides
|
||||||
|
//! see the same FIFO files. With Lima + virtiofs:
|
||||||
|
//! ```yaml
|
||||||
|
//! # lima config
|
||||||
|
//! mounts:
|
||||||
|
//! - location: /tmp/wfe-io
|
||||||
|
//! mountPoint: /tmp/wfe-io
|
||||||
|
//! writable: true
|
||||||
|
//! ```
|
||||||
|
//!
|
||||||
|
//! 2. **`WFE_IO_DIR` env var** — point the executor at the shared directory:
|
||||||
|
//! ```sh
|
||||||
|
//! export WFE_IO_DIR=/tmp/wfe-io
|
||||||
|
//! ```
|
||||||
|
//! Without this, FIFOs are created under `std::env::temp_dir()` which is
|
||||||
|
//! only visible to the host.
|
||||||
|
//!
|
||||||
|
//! 3. **gRPC transport** — Lima's Unix socket forwarding is unreliable for
|
||||||
|
//! HTTP/2 (gRPC). Use a TCP socat proxy inside the VM instead:
|
||||||
|
//! ```sh
|
||||||
|
//! # Inside the VM:
|
||||||
|
//! socat TCP4-LISTEN:2500,fork,reuseaddr UNIX-CONNECT:/run/containerd/containerd.sock &
|
||||||
|
//! ```
|
||||||
|
//! Then connect via `WFE_CONTAINERD_ADDR=http://127.0.0.1:2500` (Lima
|
||||||
|
//! auto-forwards guest TCP ports).
|
||||||
|
//!
|
||||||
|
//! 4. **FIFO permissions** — the FIFOs are created with mode `0666` and a
|
||||||
|
//! temporarily cleared umask so the remote shim (running as root) can open
|
||||||
|
//! them through the shared mount.
|
||||||
|
//!
|
||||||
|
//! See `test/lima/wfe-test.yaml` for a complete VM configuration that sets all
|
||||||
|
//! of this up.
|
||||||
|
|
||||||
pub mod config;
|
pub mod config;
|
||||||
pub mod step;
|
pub mod step;
|
||||||
|
|
||||||
|
|||||||
@@ -11,6 +11,9 @@ use wfe_containerd_protos::containerd::services::containers::v1::{
|
|||||||
containers_client::ContainersClient, Container, CreateContainerRequest,
|
containers_client::ContainersClient, Container, CreateContainerRequest,
|
||||||
DeleteContainerRequest, container::Runtime,
|
DeleteContainerRequest, container::Runtime,
|
||||||
};
|
};
|
||||||
|
use wfe_containerd_protos::containerd::services::content::v1::{
|
||||||
|
content_client::ContentClient, ReadContentRequest,
|
||||||
|
};
|
||||||
use wfe_containerd_protos::containerd::services::images::v1::{
|
use wfe_containerd_protos::containerd::services::images::v1::{
|
||||||
images_client::ImagesClient, GetImageRequest,
|
images_client::ImagesClient, GetImageRequest,
|
||||||
};
|
};
|
||||||
@@ -134,6 +137,153 @@ impl ContainerdStep {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Resolve the snapshot chain ID for an image.
|
||||||
|
///
|
||||||
|
/// This reads the image manifest and config from the content store to
|
||||||
|
/// compute the chain ID of the topmost layer. The chain ID is used as
|
||||||
|
/// the parent snapshot when preparing a writable rootfs for a container.
|
||||||
|
///
|
||||||
|
/// Chain ID computation follows the OCI image spec:
|
||||||
|
/// chain_id[0] = diff_id[0]
|
||||||
|
/// chain_id[n] = sha256(chain_id[n-1] + " " + diff_id[n])
|
||||||
|
async fn resolve_image_chain_id(
|
||||||
|
channel: &Channel,
|
||||||
|
image: &str,
|
||||||
|
namespace: &str,
|
||||||
|
) -> Result<String, WfeError> {
|
||||||
|
use sha2::{Sha256, Digest};
|
||||||
|
|
||||||
|
// 1. Get the image record to find the manifest digest.
|
||||||
|
let mut images_client = ImagesClient::new(channel.clone());
|
||||||
|
let req = Self::with_namespace(
|
||||||
|
GetImageRequest { name: image.to_string() },
|
||||||
|
namespace,
|
||||||
|
);
|
||||||
|
let image_resp = images_client.get(req).await.map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("failed to get image '{image}': {e}"))
|
||||||
|
})?;
|
||||||
|
let img = image_resp.into_inner().image.ok_or_else(|| {
|
||||||
|
WfeError::StepExecution(format!("image '{image}' has no record"))
|
||||||
|
})?;
|
||||||
|
let target = img.target.ok_or_else(|| {
|
||||||
|
WfeError::StepExecution(format!("image '{image}' has no target descriptor"))
|
||||||
|
})?;
|
||||||
|
|
||||||
|
// The target might be an index (multi-platform) or a manifest.
|
||||||
|
// Read the content and determine based on mediaType.
|
||||||
|
let manifest_digest = target.digest.clone();
|
||||||
|
let manifest_bytes = Self::read_content(channel, &manifest_digest, namespace).await?;
|
||||||
|
let manifest_json: serde_json::Value = serde_json::from_slice(&manifest_bytes)
|
||||||
|
.map_err(|e| WfeError::StepExecution(format!("failed to parse manifest: {e}")))?;
|
||||||
|
|
||||||
|
// 2. If it's an index, pick the matching platform manifest.
|
||||||
|
let manifest_json = if manifest_json.get("manifests").is_some() {
|
||||||
|
// OCI image index — find the platform-matching manifest.
|
||||||
|
let arch = std::env::consts::ARCH;
|
||||||
|
let oci_arch = match arch {
|
||||||
|
"aarch64" => "arm64",
|
||||||
|
"x86_64" => "amd64",
|
||||||
|
other => other,
|
||||||
|
};
|
||||||
|
let manifests = manifest_json["manifests"].as_array().ok_or_else(|| {
|
||||||
|
WfeError::StepExecution("image index has no manifests array".to_string())
|
||||||
|
})?;
|
||||||
|
let platform_manifest = manifests.iter().find(|m| {
|
||||||
|
m.get("platform")
|
||||||
|
.and_then(|p| p.get("architecture"))
|
||||||
|
.and_then(|a| a.as_str())
|
||||||
|
== Some(oci_arch)
|
||||||
|
}).ok_or_else(|| {
|
||||||
|
WfeError::StepExecution(format!(
|
||||||
|
"no manifest for architecture '{oci_arch}' in image index"
|
||||||
|
))
|
||||||
|
})?;
|
||||||
|
let digest = platform_manifest["digest"].as_str().ok_or_else(|| {
|
||||||
|
WfeError::StepExecution("platform manifest has no digest".to_string())
|
||||||
|
})?;
|
||||||
|
let bytes = Self::read_content(channel, digest, namespace).await?;
|
||||||
|
serde_json::from_slice(&bytes)
|
||||||
|
.map_err(|e| WfeError::StepExecution(format!("failed to parse platform manifest: {e}")))?
|
||||||
|
} else {
|
||||||
|
manifest_json
|
||||||
|
};
|
||||||
|
|
||||||
|
// 3. Get the config digest from the manifest.
|
||||||
|
let config_digest = manifest_json["config"]["digest"]
|
||||||
|
.as_str()
|
||||||
|
.ok_or_else(|| {
|
||||||
|
WfeError::StepExecution("manifest has no config.digest".to_string())
|
||||||
|
})?;
|
||||||
|
|
||||||
|
// 4. Read the image config.
|
||||||
|
let config_bytes = Self::read_content(channel, config_digest, namespace).await?;
|
||||||
|
let config_json: serde_json::Value = serde_json::from_slice(&config_bytes)
|
||||||
|
.map_err(|e| WfeError::StepExecution(format!("failed to parse image config: {e}")))?;
|
||||||
|
|
||||||
|
// 5. Extract diff_ids and compute chain ID.
|
||||||
|
let diff_ids = config_json["rootfs"]["diff_ids"]
|
||||||
|
.as_array()
|
||||||
|
.ok_or_else(|| {
|
||||||
|
WfeError::StepExecution("image config has no rootfs.diff_ids".to_string())
|
||||||
|
})?;
|
||||||
|
|
||||||
|
if diff_ids.is_empty() {
|
||||||
|
return Err(WfeError::StepExecution(
|
||||||
|
"image has no layers (empty diff_ids)".to_string(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut chain_id = diff_ids[0]
|
||||||
|
.as_str()
|
||||||
|
.ok_or_else(|| WfeError::StepExecution("diff_id is not a string".to_string()))?
|
||||||
|
.to_string();
|
||||||
|
|
||||||
|
for diff_id in &diff_ids[1..] {
|
||||||
|
let diff = diff_id.as_str().ok_or_else(|| {
|
||||||
|
WfeError::StepExecution("diff_id is not a string".to_string())
|
||||||
|
})?;
|
||||||
|
let mut hasher = Sha256::new();
|
||||||
|
hasher.update(format!("{chain_id} {diff}"));
|
||||||
|
chain_id = format!("sha256:{:x}", hasher.finalize());
|
||||||
|
}
|
||||||
|
|
||||||
|
tracing::debug!(image = image, chain_id = %chain_id, "resolved image chain ID");
|
||||||
|
Ok(chain_id)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Read content from the containerd content store by digest.
|
||||||
|
async fn read_content(
|
||||||
|
channel: &Channel,
|
||||||
|
digest: &str,
|
||||||
|
namespace: &str,
|
||||||
|
) -> Result<Vec<u8>, WfeError> {
|
||||||
|
use tokio_stream::StreamExt;
|
||||||
|
|
||||||
|
let mut client = ContentClient::new(channel.clone());
|
||||||
|
let req = Self::with_namespace(
|
||||||
|
ReadContentRequest {
|
||||||
|
digest: digest.to_string(),
|
||||||
|
offset: 0,
|
||||||
|
size: 0, // read all
|
||||||
|
},
|
||||||
|
namespace,
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut stream = client.read(req).await.map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("failed to read content {digest}: {e}"))
|
||||||
|
})?.into_inner();
|
||||||
|
|
||||||
|
let mut data = Vec::new();
|
||||||
|
while let Some(chunk) = stream.next().await {
|
||||||
|
let chunk = chunk.map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("error reading content {digest}: {e}"))
|
||||||
|
})?;
|
||||||
|
data.extend_from_slice(&chunk.data);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(data)
|
||||||
|
}
|
||||||
|
|
||||||
/// Build a minimal OCI runtime spec as a `prost_types::Any`.
|
/// Build a minimal OCI runtime spec as a `prost_types::Any`.
|
||||||
///
|
///
|
||||||
/// The spec is serialized as JSON and wrapped in a protobuf Any with
|
/// The spec is serialized as JSON and wrapped in a protobuf Any with
|
||||||
@@ -144,7 +294,7 @@ impl ContainerdStep {
|
|||||||
) -> prost_types::Any {
|
) -> prost_types::Any {
|
||||||
// Build the args array for the process.
|
// Build the args array for the process.
|
||||||
let args: Vec<String> = if let Some(ref run) = self.config.run {
|
let args: Vec<String> = if let Some(ref run) = self.config.run {
|
||||||
vec!["sh".to_string(), "-c".to_string(), run.clone()]
|
vec!["/bin/sh".to_string(), "-c".to_string(), run.clone()]
|
||||||
} else if let Some(ref command) = self.config.command {
|
} else if let Some(ref command) = self.config.command {
|
||||||
command.clone()
|
command.clone()
|
||||||
} else {
|
} else {
|
||||||
@@ -206,13 +356,24 @@ impl ContainerdStep {
|
|||||||
"cwd": self.config.working_dir.as_deref().unwrap_or("/"),
|
"cwd": self.config.working_dir.as_deref().unwrap_or("/"),
|
||||||
});
|
});
|
||||||
|
|
||||||
// Add capabilities (minimal set).
|
// Add capabilities. When running as root, grant the default Docker
|
||||||
|
// capability set so tools like apt-get work. Non-root gets nothing.
|
||||||
|
let caps = if uid == 0 {
|
||||||
|
serde_json::json!([
|
||||||
|
"CAP_AUDIT_WRITE", "CAP_CHOWN", "CAP_DAC_OVERRIDE",
|
||||||
|
"CAP_FOWNER", "CAP_FSETID", "CAP_KILL", "CAP_MKNOD",
|
||||||
|
"CAP_NET_BIND_SERVICE", "CAP_NET_RAW", "CAP_SETFCAP",
|
||||||
|
"CAP_SETGID", "CAP_SETPCAP", "CAP_SETUID", "CAP_SYS_CHROOT",
|
||||||
|
])
|
||||||
|
} else {
|
||||||
|
serde_json::json!([])
|
||||||
|
};
|
||||||
process["capabilities"] = serde_json::json!({
|
process["capabilities"] = serde_json::json!({
|
||||||
"bounding": [],
|
"bounding": caps,
|
||||||
"effective": [],
|
"effective": caps,
|
||||||
"inheritable": [],
|
"inheritable": caps,
|
||||||
"permitted": [],
|
"permitted": caps,
|
||||||
"ambient": [],
|
"ambient": caps,
|
||||||
});
|
});
|
||||||
|
|
||||||
let spec = serde_json::json!({
|
let spec = serde_json::json!({
|
||||||
@@ -400,15 +561,11 @@ impl StepBody for ContainerdStep {
|
|||||||
WfeError::StepExecution(format!("failed to create container: {e}"))
|
WfeError::StepExecution(format!("failed to create container: {e}"))
|
||||||
})?;
|
})?;
|
||||||
|
|
||||||
// 6. Prepare snapshot to get rootfs mounts.
|
// 6. Prepare snapshot with the image's layers as parent.
|
||||||
let mut snapshots_client = SnapshotsClient::new(channel.clone());
|
let mut snapshots_client = SnapshotsClient::new(channel.clone());
|
||||||
|
|
||||||
// Get the image's chain ID to use as parent for the snapshot.
|
|
||||||
// We try to get mounts from the snapshot (already committed by image unpack).
|
|
||||||
// If snapshot already exists, use Mounts; otherwise Prepare from the image's
|
|
||||||
// snapshot key (same as container_id for our flow).
|
|
||||||
let mounts = {
|
let mounts = {
|
||||||
// First try: see if the snapshot was already prepared.
|
// First try: see if a snapshot was already prepared for this container.
|
||||||
let mounts_req = Self::with_namespace(
|
let mounts_req = Self::with_namespace(
|
||||||
MountsRequest {
|
MountsRequest {
|
||||||
snapshotter: DEFAULT_SNAPSHOTTER.to_string(),
|
snapshotter: DEFAULT_SNAPSHOTTER.to_string(),
|
||||||
@@ -420,12 +577,18 @@ impl StepBody for ContainerdStep {
|
|||||||
match snapshots_client.mounts(mounts_req).await {
|
match snapshots_client.mounts(mounts_req).await {
|
||||||
Ok(resp) => resp.into_inner().mounts,
|
Ok(resp) => resp.into_inner().mounts,
|
||||||
Err(_) => {
|
Err(_) => {
|
||||||
// Try to prepare a fresh snapshot.
|
// Resolve the image's chain ID to use as snapshot parent.
|
||||||
|
let parent = if should_check {
|
||||||
|
Self::resolve_image_chain_id(&channel, &self.config.image, namespace).await?
|
||||||
|
} else {
|
||||||
|
String::new()
|
||||||
|
};
|
||||||
|
|
||||||
let prepare_req = Self::with_namespace(
|
let prepare_req = Self::with_namespace(
|
||||||
PrepareSnapshotRequest {
|
PrepareSnapshotRequest {
|
||||||
snapshotter: DEFAULT_SNAPSHOTTER.to_string(),
|
snapshotter: DEFAULT_SNAPSHOTTER.to_string(),
|
||||||
key: container_id.clone(),
|
key: container_id.clone(),
|
||||||
parent: String::new(),
|
parent,
|
||||||
labels: HashMap::new(),
|
labels: HashMap::new(),
|
||||||
},
|
},
|
||||||
namespace,
|
namespace,
|
||||||
@@ -445,7 +608,12 @@ impl StepBody for ContainerdStep {
|
|||||||
};
|
};
|
||||||
|
|
||||||
// 7. Create FIFO paths for stdout/stderr capture.
|
// 7. Create FIFO paths for stdout/stderr capture.
|
||||||
let tmp_dir = std::env::temp_dir().join(format!("wfe-io-{container_id}"));
|
// Use WFE_IO_DIR if set (e.g., a shared mount with a remote containerd daemon),
|
||||||
|
// otherwise fall back to the system temp directory.
|
||||||
|
let io_base = std::env::var("WFE_IO_DIR")
|
||||||
|
.map(std::path::PathBuf::from)
|
||||||
|
.unwrap_or_else(|_| std::env::temp_dir());
|
||||||
|
let tmp_dir = io_base.join(format!("wfe-io-{container_id}"));
|
||||||
std::fs::create_dir_all(&tmp_dir).map_err(|e| {
|
std::fs::create_dir_all(&tmp_dir).map_err(|e| {
|
||||||
WfeError::StepExecution(format!("failed to create IO temp dir: {e}"))
|
WfeError::StepExecution(format!("failed to create IO temp dir: {e}"))
|
||||||
})?;
|
})?;
|
||||||
@@ -453,19 +621,26 @@ impl StepBody for ContainerdStep {
|
|||||||
let stdout_path = tmp_dir.join("stdout");
|
let stdout_path = tmp_dir.join("stdout");
|
||||||
let stderr_path = tmp_dir.join("stderr");
|
let stderr_path = tmp_dir.join("stderr");
|
||||||
|
|
||||||
// Create named pipes (FIFOs) for the task I/O.
|
// Create empty files for the shim to write stdout/stderr to.
|
||||||
|
// We use regular files instead of FIFOs because FIFOs don't work
|
||||||
|
// across filesystem boundaries (e.g., virtiofs mounts with Lima VMs).
|
||||||
for path in [&stdout_path, &stderr_path] {
|
for path in [&stdout_path, &stderr_path] {
|
||||||
// Remove if exists from a previous run.
|
|
||||||
let _ = std::fs::remove_file(path);
|
let _ = std::fs::remove_file(path);
|
||||||
nix_mkfifo(path).map_err(|e| {
|
std::fs::File::create(path).map_err(|e| {
|
||||||
WfeError::StepExecution(format!("failed to create FIFO {}: {e}", path.display()))
|
WfeError::StepExecution(format!("failed to create IO file {}: {e}", path.display()))
|
||||||
})?;
|
})?;
|
||||||
|
// Ensure the remote shim can write to it.
|
||||||
|
#[cfg(unix)]
|
||||||
|
{
|
||||||
|
use std::os::unix::fs::PermissionsExt;
|
||||||
|
std::fs::set_permissions(path, std::fs::Permissions::from_mode(0o666)).ok();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
let stdout_str = stdout_path.to_string_lossy().to_string();
|
let stdout_str = stdout_path.to_string_lossy().to_string();
|
||||||
let stderr_str = stderr_path.to_string_lossy().to_string();
|
let stderr_str = stderr_path.to_string_lossy().to_string();
|
||||||
|
|
||||||
// 8. Create and start task.
|
// 8. Create task.
|
||||||
let mut tasks_client = TasksClient::new(channel.clone());
|
let mut tasks_client = TasksClient::new(channel.clone());
|
||||||
|
|
||||||
let create_task_req = Self::with_namespace(
|
let create_task_req = Self::with_namespace(
|
||||||
@@ -487,17 +662,6 @@ impl StepBody for ContainerdStep {
|
|||||||
WfeError::StepExecution(format!("failed to create task: {e}"))
|
WfeError::StepExecution(format!("failed to create task: {e}"))
|
||||||
})?;
|
})?;
|
||||||
|
|
||||||
// Spawn readers for FIFOs before starting the task (FIFOs block on open
|
|
||||||
// until both ends connect).
|
|
||||||
let stdout_reader = {
|
|
||||||
let path = stdout_path.clone();
|
|
||||||
tokio::spawn(async move { read_fifo(&path).await })
|
|
||||||
};
|
|
||||||
let stderr_reader = {
|
|
||||||
let path = stderr_path.clone();
|
|
||||||
tokio::spawn(async move { read_fifo(&path).await })
|
|
||||||
};
|
|
||||||
|
|
||||||
// Start the task.
|
// Start the task.
|
||||||
let start_req = Self::with_namespace(
|
let start_req = Self::with_namespace(
|
||||||
StartRequest {
|
StartRequest {
|
||||||
@@ -555,14 +719,12 @@ impl StepBody for ContainerdStep {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
// 10. Read captured output.
|
// 10. Read captured output from files.
|
||||||
let stdout_content = stdout_reader
|
let stdout_content = tokio::fs::read_to_string(&stdout_path)
|
||||||
.await
|
.await
|
||||||
.unwrap_or_else(|_| Ok(String::new()))
|
|
||||||
.unwrap_or_default();
|
.unwrap_or_default();
|
||||||
let stderr_content = stderr_reader
|
let stderr_content = tokio::fs::read_to_string(&stderr_path)
|
||||||
.await
|
.await
|
||||||
.unwrap_or_else(|_| Ok(String::new()))
|
|
||||||
.unwrap_or_default();
|
.unwrap_or_default();
|
||||||
|
|
||||||
// 11. Cleanup: delete task, then container.
|
// 11. Cleanup: delete task, then container.
|
||||||
@@ -629,38 +791,6 @@ impl ContainerdStep {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Create a named pipe (FIFO) at the given path. This is a thin wrapper
|
|
||||||
/// around the `mkfifo` libc call, avoiding an extra dependency.
|
|
||||||
fn nix_mkfifo(path: &Path) -> std::io::Result<()> {
|
|
||||||
use std::ffi::CString;
|
|
||||||
use std::os::unix::ffi::OsStrExt;
|
|
||||||
|
|
||||||
let c_path = CString::new(path.as_os_str().as_bytes())
|
|
||||||
.map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidInput, e))?;
|
|
||||||
|
|
||||||
// SAFETY: c_path is a valid null-terminated C string and 0o622 is a
|
|
||||||
// standard FIFO permission mode.
|
|
||||||
let ret = unsafe { libc::mkfifo(c_path.as_ptr(), 0o622) };
|
|
||||||
if ret != 0 {
|
|
||||||
Err(std::io::Error::last_os_error())
|
|
||||||
} else {
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Read the entire contents of a FIFO into a String. This opens the FIFO
|
|
||||||
/// in read mode (which blocks until a writer opens the other end) and reads
|
|
||||||
/// until EOF.
|
|
||||||
async fn read_fifo(path: &Path) -> Result<String, std::io::Error> {
|
|
||||||
use tokio::io::AsyncReadExt;
|
|
||||||
|
|
||||||
let file = tokio::fs::File::open(path).await?;
|
|
||||||
let mut reader = tokio::io::BufReader::new(file);
|
|
||||||
let mut buf = String::new();
|
|
||||||
reader.read_to_string(&mut buf).await?;
|
|
||||||
Ok(buf)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
@@ -864,7 +994,7 @@ mod tests {
|
|||||||
// Deserialize and verify.
|
// Deserialize and verify.
|
||||||
let parsed: serde_json::Value = serde_json::from_slice(&spec.value).unwrap();
|
let parsed: serde_json::Value = serde_json::from_slice(&spec.value).unwrap();
|
||||||
assert_eq!(parsed["ociVersion"], "1.0.2");
|
assert_eq!(parsed["ociVersion"], "1.0.2");
|
||||||
assert_eq!(parsed["process"]["args"][0], "sh");
|
assert_eq!(parsed["process"]["args"][0], "/bin/sh");
|
||||||
assert_eq!(parsed["process"]["args"][1], "-c");
|
assert_eq!(parsed["process"]["args"][1], "-c");
|
||||||
assert_eq!(parsed["process"]["args"][2], "echo hello");
|
assert_eq!(parsed["process"]["args"][2], "echo hello");
|
||||||
assert_eq!(parsed["process"]["user"]["uid"], 65534);
|
assert_eq!(parsed["process"]["user"]["uid"], 65534);
|
||||||
@@ -1033,22 +1163,6 @@ mod tests {
|
|||||||
assert_eq!(step.config.containerd_addr, "/run/containerd/containerd.sock");
|
assert_eq!(step.config.containerd_addr, "/run/containerd/containerd.sock");
|
||||||
}
|
}
|
||||||
|
|
||||||
// ── nix_mkfifo ─────────────────────────────────────────────────────
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn mkfifo_creates_and_removes_fifo() {
|
|
||||||
let tmp = tempfile::tempdir().unwrap();
|
|
||||||
let fifo_path = tmp.path().join("test.fifo");
|
|
||||||
nix_mkfifo(&fifo_path).unwrap();
|
|
||||||
assert!(fifo_path.exists());
|
|
||||||
std::fs::remove_file(&fifo_path).unwrap();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn mkfifo_invalid_path_returns_error() {
|
|
||||||
let result = nix_mkfifo(Path::new("/nonexistent-dir/fifo"));
|
|
||||||
assert!(result.is_err());
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Integration tests that require a live containerd daemon.
|
/// Integration tests that require a live containerd daemon.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
//!
|
//!
|
||||||
//! These tests require a live containerd daemon. They are skipped when the
|
//! These tests require a live containerd daemon. They are skipped when the
|
||||||
//! socket is not available. Set `WFE_CONTAINERD_ADDR` to point to a custom
|
//! socket is not available. Set `WFE_CONTAINERD_ADDR` to point to a custom
|
||||||
//! socket, or use the default `~/.lima/wfe-test/sock/containerd.sock`.
|
//! socket, or use the default `~/.lima/wfe-test/containerd.sock`.
|
||||||
//!
|
//!
|
||||||
//! Before running, ensure the test image is pre-pulled:
|
//! Before running, ensure the test image is pre-pulled:
|
||||||
//! ctr -n default image pull docker.io/library/alpine:3.18
|
//! ctr -n default image pull docker.io/library/alpine:3.18
|
||||||
@@ -15,19 +15,27 @@ use wfe_containerd::ContainerdStep;
|
|||||||
use wfe_core::models::{ExecutionPointer, WorkflowInstance, WorkflowStep};
|
use wfe_core::models::{ExecutionPointer, WorkflowInstance, WorkflowStep};
|
||||||
use wfe_core::traits::step::{StepBody, StepExecutionContext};
|
use wfe_core::traits::step::{StepBody, StepExecutionContext};
|
||||||
|
|
||||||
/// Returns the containerd socket address if available, or None.
|
/// Returns the containerd address if available, or None.
|
||||||
|
/// Set `WFE_CONTAINERD_ADDR` to a TCP address (http://host:port) or
|
||||||
|
/// Unix socket path (unix:///path). Defaults to the Lima wfe-test
|
||||||
|
/// TCP proxy at http://127.0.0.1:2500.
|
||||||
fn containerd_addr() -> Option<String> {
|
fn containerd_addr() -> Option<String> {
|
||||||
let addr = std::env::var("WFE_CONTAINERD_ADDR").unwrap_or_else(|_| {
|
if let Ok(addr) = std::env::var("WFE_CONTAINERD_ADDR") {
|
||||||
format!(
|
if addr.starts_with("http://") || addr.starts_with("tcp://") {
|
||||||
"unix://{}/.lima/wfe-test/sock/containerd.sock",
|
return Some(addr);
|
||||||
std::env::var("HOME").unwrap_or_else(|_| "/root".to_string())
|
}
|
||||||
)
|
|
||||||
});
|
|
||||||
|
|
||||||
let socket_path = addr.strip_prefix("unix://").unwrap_or(addr.as_str());
|
let socket_path = addr.strip_prefix("unix://").unwrap_or(addr.as_str());
|
||||||
|
|
||||||
if Path::new(socket_path).exists() {
|
if Path::new(socket_path).exists() {
|
||||||
Some(addr)
|
return Some(addr);
|
||||||
|
}
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default: check if the Lima wfe-test socket exists (for lightweight tests).
|
||||||
|
let home = std::env::var("HOME").unwrap_or_else(|_| "/root".to_string());
|
||||||
|
let socket = format!("{home}/.lima/wfe-test/containerd.sock");
|
||||||
|
if Path::new(&socket).exists() {
|
||||||
|
Some(format!("unix://{socket}"))
|
||||||
} else {
|
} else {
|
||||||
None
|
None
|
||||||
}
|
}
|
||||||
@@ -67,6 +75,7 @@ fn make_context<'a>(
|
|||||||
workflow,
|
workflow,
|
||||||
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
||||||
host_context: None,
|
host_context: None,
|
||||||
|
log_sink: None,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -151,6 +160,142 @@ async fn skip_image_check_when_pull_never() {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ── Run a real container end-to-end ──────────────────────────────────
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn run_echo_hello_in_container() {
|
||||||
|
let Some(addr) = containerd_addr() else {
|
||||||
|
eprintln!("SKIP: containerd socket not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut config = minimal_config(&addr);
|
||||||
|
config.image = "docker.io/library/alpine:3.18".to_string();
|
||||||
|
config.run = Some("echo hello-from-container".to_string());
|
||||||
|
config.pull = "if-not-present".to_string();
|
||||||
|
config.user = "0:0".to_string();
|
||||||
|
config.timeout_ms = Some(30_000);
|
||||||
|
let mut step = ContainerdStep::new(config);
|
||||||
|
|
||||||
|
let mut wf_step = WorkflowStep::new(0, "containerd");
|
||||||
|
wf_step.name = Some("echo-test".to_string());
|
||||||
|
let workflow = WorkflowInstance::new("test-wf", 1, serde_json::json!({}));
|
||||||
|
let pointer = ExecutionPointer::new(0);
|
||||||
|
let ctx = make_context(&wf_step, &workflow, &pointer);
|
||||||
|
|
||||||
|
let result = step.run(&ctx).await;
|
||||||
|
match &result {
|
||||||
|
Ok(r) => {
|
||||||
|
eprintln!("SUCCESS: {:?}", r.output_data);
|
||||||
|
let data = r.output_data.as_ref().unwrap().as_object().unwrap();
|
||||||
|
let stdout = data.get("echo-test.stdout").unwrap().as_str().unwrap();
|
||||||
|
assert!(stdout.contains("hello-from-container"), "stdout: {stdout}");
|
||||||
|
}
|
||||||
|
Err(e) => panic!("container step failed: {e}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Run a container with a volume mount ──────────────────────────────
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn run_container_with_volume_mount() {
|
||||||
|
let Some(addr) = containerd_addr() else {
|
||||||
|
eprintln!("SKIP: containerd socket not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
let shared_dir = std::env::var("WFE_IO_DIR")
|
||||||
|
.unwrap_or_else(|_| "/tmp/wfe-io".to_string());
|
||||||
|
let vol_dir = format!("{shared_dir}/test-vol");
|
||||||
|
std::fs::create_dir_all(&vol_dir).unwrap();
|
||||||
|
|
||||||
|
let mut config = minimal_config(&addr);
|
||||||
|
config.image = "docker.io/library/alpine:3.18".to_string();
|
||||||
|
config.run = Some("echo hello > /mnt/test/output.txt && cat /mnt/test/output.txt".to_string());
|
||||||
|
config.pull = "if-not-present".to_string();
|
||||||
|
config.user = "0:0".to_string();
|
||||||
|
config.timeout_ms = Some(30_000);
|
||||||
|
config.volumes = vec![wfe_containerd::VolumeMountConfig {
|
||||||
|
source: vol_dir.clone(),
|
||||||
|
target: "/mnt/test".to_string(),
|
||||||
|
readonly: false,
|
||||||
|
}];
|
||||||
|
let mut step = ContainerdStep::new(config);
|
||||||
|
|
||||||
|
let mut wf_step = WorkflowStep::new(0, "containerd");
|
||||||
|
wf_step.name = Some("vol-test".to_string());
|
||||||
|
let workflow = WorkflowInstance::new("test-wf", 1, serde_json::json!({}));
|
||||||
|
let pointer = ExecutionPointer::new(0);
|
||||||
|
let ctx = make_context(&wf_step, &workflow, &pointer);
|
||||||
|
|
||||||
|
match step.run(&ctx).await {
|
||||||
|
Ok(r) => {
|
||||||
|
let data = r.output_data.as_ref().unwrap().as_object().unwrap();
|
||||||
|
let stdout = data.get("vol-test.stdout").unwrap().as_str().unwrap();
|
||||||
|
assert!(stdout.contains("hello"), "stdout: {stdout}");
|
||||||
|
}
|
||||||
|
Err(e) => panic!("container step with volume failed: {e}"),
|
||||||
|
}
|
||||||
|
|
||||||
|
std::fs::remove_dir_all(&vol_dir).ok();
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Run a container with volume mount and network (simulates install step) ──
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn run_debian_with_volume_and_network() {
|
||||||
|
let Some(addr) = containerd_addr() else {
|
||||||
|
eprintln!("SKIP: containerd socket not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
let shared_dir = std::env::var("WFE_IO_DIR")
|
||||||
|
.unwrap_or_else(|_| "/tmp/wfe-io".to_string());
|
||||||
|
let cargo_dir = format!("{shared_dir}/test-cargo");
|
||||||
|
let rustup_dir = format!("{shared_dir}/test-rustup");
|
||||||
|
std::fs::create_dir_all(&cargo_dir).unwrap();
|
||||||
|
std::fs::create_dir_all(&rustup_dir).unwrap();
|
||||||
|
|
||||||
|
let mut config = minimal_config(&addr);
|
||||||
|
config.image = "docker.io/library/debian:bookworm-slim".to_string();
|
||||||
|
config.run = Some("echo hello && ls /cargo && ls /rustup".to_string());
|
||||||
|
config.pull = "if-not-present".to_string();
|
||||||
|
config.user = "0:0".to_string();
|
||||||
|
config.network = "host".to_string();
|
||||||
|
config.timeout_ms = Some(30_000);
|
||||||
|
config.env.insert("CARGO_HOME".to_string(), "/cargo".to_string());
|
||||||
|
config.env.insert("RUSTUP_HOME".to_string(), "/rustup".to_string());
|
||||||
|
config.volumes = vec![
|
||||||
|
wfe_containerd::VolumeMountConfig {
|
||||||
|
source: cargo_dir.clone(),
|
||||||
|
target: "/cargo".to_string(),
|
||||||
|
readonly: false,
|
||||||
|
},
|
||||||
|
wfe_containerd::VolumeMountConfig {
|
||||||
|
source: rustup_dir.clone(),
|
||||||
|
target: "/rustup".to_string(),
|
||||||
|
readonly: false,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
let mut step = ContainerdStep::new(config);
|
||||||
|
|
||||||
|
let mut wf_step = WorkflowStep::new(0, "containerd");
|
||||||
|
wf_step.name = Some("debian-test".to_string());
|
||||||
|
let workflow = WorkflowInstance::new("test-wf", 1, serde_json::json!({}));
|
||||||
|
let pointer = ExecutionPointer::new(0);
|
||||||
|
let ctx = make_context(&wf_step, &workflow, &pointer);
|
||||||
|
|
||||||
|
match step.run(&ctx).await {
|
||||||
|
Ok(r) => {
|
||||||
|
eprintln!("SUCCESS: {:?}", r.output_data);
|
||||||
|
}
|
||||||
|
Err(e) => panic!("debian container with volumes failed: {e}"),
|
||||||
|
}
|
||||||
|
|
||||||
|
std::fs::remove_dir_all(&cargo_dir).ok();
|
||||||
|
std::fs::remove_dir_all(&rustup_dir).ok();
|
||||||
|
}
|
||||||
|
|
||||||
// ── Step name defaults to "unknown" when None ────────────────────────
|
// ── Step name defaults to "unknown" when None ────────────────────────
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ pub struct WorkflowExecutor {
|
|||||||
pub queue_provider: Arc<dyn QueueProvider>,
|
pub queue_provider: Arc<dyn QueueProvider>,
|
||||||
pub lifecycle: Option<Arc<dyn LifecyclePublisher>>,
|
pub lifecycle: Option<Arc<dyn LifecyclePublisher>>,
|
||||||
pub search: Option<Arc<dyn SearchIndex>>,
|
pub search: Option<Arc<dyn SearchIndex>>,
|
||||||
|
pub log_sink: Option<Arc<dyn crate::traits::LogSink>>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WorkflowExecutor {
|
impl WorkflowExecutor {
|
||||||
@@ -37,9 +38,15 @@ impl WorkflowExecutor {
|
|||||||
queue_provider,
|
queue_provider,
|
||||||
lifecycle: None,
|
lifecycle: None,
|
||||||
search: None,
|
search: None,
|
||||||
|
log_sink: None,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn with_log_sink(mut self, sink: Arc<dyn crate::traits::LogSink>) -> Self {
|
||||||
|
self.log_sink = Some(sink);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
pub fn with_lifecycle(mut self, lifecycle: Arc<dyn LifecyclePublisher>) -> Self {
|
pub fn with_lifecycle(mut self, lifecycle: Arc<dyn LifecyclePublisher>) -> Self {
|
||||||
self.lifecycle = Some(lifecycle);
|
self.lifecycle = Some(lifecycle);
|
||||||
self
|
self
|
||||||
@@ -50,6 +57,15 @@ impl WorkflowExecutor {
|
|||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Publish a lifecycle event if a publisher is configured.
|
||||||
|
async fn publish_lifecycle(&self, event: crate::models::LifecycleEvent) {
|
||||||
|
if let Some(ref publisher) = self.lifecycle {
|
||||||
|
if let Err(e) = publisher.publish(event).await {
|
||||||
|
warn!(error = %e, "failed to publish lifecycle event");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Execute a single workflow instance.
|
/// Execute a single workflow instance.
|
||||||
///
|
///
|
||||||
/// 1. Acquire lock
|
/// 1. Acquire lock
|
||||||
@@ -202,6 +218,16 @@ impl WorkflowExecutor {
|
|||||||
}
|
}
|
||||||
workflow.execution_pointers[idx].status = PointerStatus::Running;
|
workflow.execution_pointers[idx].status = PointerStatus::Running;
|
||||||
|
|
||||||
|
self.publish_lifecycle(crate::models::LifecycleEvent::new(
|
||||||
|
&workflow.id,
|
||||||
|
&workflow.workflow_definition_id,
|
||||||
|
workflow.version,
|
||||||
|
crate::models::LifecycleEventType::StepStarted {
|
||||||
|
step_id,
|
||||||
|
step_name: step.name.clone(),
|
||||||
|
},
|
||||||
|
)).await;
|
||||||
|
|
||||||
// c. Build StepExecutionContext (borrows workflow immutably).
|
// c. Build StepExecutionContext (borrows workflow immutably).
|
||||||
let cancellation_token = tokio_util::sync::CancellationToken::new();
|
let cancellation_token = tokio_util::sync::CancellationToken::new();
|
||||||
let context = StepExecutionContext {
|
let context = StepExecutionContext {
|
||||||
@@ -212,6 +238,7 @@ impl WorkflowExecutor {
|
|||||||
workflow: &workflow,
|
workflow: &workflow,
|
||||||
cancellation_token,
|
cancellation_token,
|
||||||
host_context,
|
host_context,
|
||||||
|
log_sink: self.log_sink.as_deref(),
|
||||||
};
|
};
|
||||||
|
|
||||||
// d. Call step.run(context).
|
// d. Call step.run(context).
|
||||||
@@ -238,6 +265,17 @@ impl WorkflowExecutor {
|
|||||||
has_branches = result.branch_values.is_some(),
|
has_branches = result.branch_values.is_some(),
|
||||||
"Step completed"
|
"Step completed"
|
||||||
);
|
);
|
||||||
|
|
||||||
|
self.publish_lifecycle(crate::models::LifecycleEvent::new(
|
||||||
|
&workflow.id,
|
||||||
|
&workflow.workflow_definition_id,
|
||||||
|
workflow.version,
|
||||||
|
crate::models::LifecycleEventType::StepCompleted {
|
||||||
|
step_id,
|
||||||
|
step_name: step.name.clone(),
|
||||||
|
},
|
||||||
|
)).await;
|
||||||
|
|
||||||
// e. Process the ExecutionResult.
|
// e. Process the ExecutionResult.
|
||||||
// Extract workflow_id before mutable borrow.
|
// Extract workflow_id before mutable borrow.
|
||||||
let wf_id = workflow.id.clone();
|
let wf_id = workflow.id.clone();
|
||||||
@@ -272,6 +310,15 @@ impl WorkflowExecutor {
|
|||||||
tracing::Span::current().record("step.status", "failed");
|
tracing::Span::current().record("step.status", "failed");
|
||||||
warn!(workflow_id, step_id, error = %error_msg, "Step execution failed");
|
warn!(workflow_id, step_id, error = %error_msg, "Step execution failed");
|
||||||
|
|
||||||
|
self.publish_lifecycle(crate::models::LifecycleEvent::new(
|
||||||
|
&workflow.id,
|
||||||
|
&workflow.workflow_definition_id,
|
||||||
|
workflow.version,
|
||||||
|
crate::models::LifecycleEventType::Error {
|
||||||
|
message: error_msg.clone(),
|
||||||
|
},
|
||||||
|
)).await;
|
||||||
|
|
||||||
let pointer_id = workflow.execution_pointers[idx].id.clone();
|
let pointer_id = workflow.execution_pointers[idx].id.clone();
|
||||||
execution_errors.push(ExecutionError::new(
|
execution_errors.push(ExecutionError::new(
|
||||||
workflow_id,
|
workflow_id,
|
||||||
@@ -293,6 +340,12 @@ impl WorkflowExecutor {
|
|||||||
workflow.status = new_status;
|
workflow.status = new_status;
|
||||||
if new_status == WorkflowStatus::Terminated {
|
if new_status == WorkflowStatus::Terminated {
|
||||||
workflow.complete_time = Some(Utc::now());
|
workflow.complete_time = Some(Utc::now());
|
||||||
|
self.publish_lifecycle(crate::models::LifecycleEvent::new(
|
||||||
|
&workflow.id,
|
||||||
|
&workflow.workflow_definition_id,
|
||||||
|
workflow.version,
|
||||||
|
crate::models::LifecycleEventType::Terminated,
|
||||||
|
)).await;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -321,6 +374,13 @@ impl WorkflowExecutor {
|
|||||||
workflow.status = WorkflowStatus::Complete;
|
workflow.status = WorkflowStatus::Complete;
|
||||||
workflow.complete_time = Some(Utc::now());
|
workflow.complete_time = Some(Utc::now());
|
||||||
|
|
||||||
|
self.publish_lifecycle(crate::models::LifecycleEvent::new(
|
||||||
|
&workflow.id,
|
||||||
|
&workflow.workflow_definition_id,
|
||||||
|
workflow.version,
|
||||||
|
crate::models::LifecycleEventType::Completed,
|
||||||
|
)).await;
|
||||||
|
|
||||||
// Publish completion event for SubWorkflow parents.
|
// Publish completion event for SubWorkflow parents.
|
||||||
let completion_event = Event::new(
|
let completion_event = Event::new(
|
||||||
"wfe.workflow.completed",
|
"wfe.workflow.completed",
|
||||||
|
|||||||
@@ -45,6 +45,7 @@ mod test_helpers {
|
|||||||
workflow,
|
workflow,
|
||||||
cancellation_token: CancellationToken::new(),
|
cancellation_token: CancellationToken::new(),
|
||||||
host_context: None,
|
host_context: None,
|
||||||
|
log_sink: None,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -212,6 +212,7 @@ mod tests {
|
|||||||
workflow,
|
workflow,
|
||||||
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
||||||
host_context: Some(host),
|
host_context: Some(host),
|
||||||
|
log_sink: None,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
59
wfe-core/src/traits/log_sink.rs
Normal file
59
wfe-core/src/traits/log_sink.rs
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
use async_trait::async_trait;
|
||||||
|
use chrono::{DateTime, Utc};
|
||||||
|
|
||||||
|
/// A chunk of log output from a step execution.
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
pub struct LogChunk {
|
||||||
|
pub workflow_id: String,
|
||||||
|
pub definition_id: String,
|
||||||
|
pub step_id: usize,
|
||||||
|
pub step_name: String,
|
||||||
|
pub stream: LogStreamType,
|
||||||
|
pub data: Vec<u8>,
|
||||||
|
pub timestamp: DateTime<Utc>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Whether a log chunk is from stdout or stderr.
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
|
pub enum LogStreamType {
|
||||||
|
Stdout,
|
||||||
|
Stderr,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Receives log chunks as they're produced during step execution.
|
||||||
|
///
|
||||||
|
/// Implementations can broadcast to live subscribers, persist to a database,
|
||||||
|
/// index for search, or any combination. The trait is designed to be called
|
||||||
|
/// from within step executors (shell, containerd, etc.) as lines are produced.
|
||||||
|
#[async_trait]
|
||||||
|
pub trait LogSink: Send + Sync {
|
||||||
|
async fn write_chunk(&self, chunk: LogChunk);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn log_stream_type_equality() {
|
||||||
|
assert_eq!(LogStreamType::Stdout, LogStreamType::Stdout);
|
||||||
|
assert_ne!(LogStreamType::Stdout, LogStreamType::Stderr);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn log_chunk_clone() {
|
||||||
|
let chunk = LogChunk {
|
||||||
|
workflow_id: "wf-1".to_string(),
|
||||||
|
definition_id: "def-1".to_string(),
|
||||||
|
step_id: 0,
|
||||||
|
step_name: "build".to_string(),
|
||||||
|
stream: LogStreamType::Stdout,
|
||||||
|
data: b"hello\n".to_vec(),
|
||||||
|
timestamp: Utc::now(),
|
||||||
|
};
|
||||||
|
let cloned = chunk.clone();
|
||||||
|
assert_eq!(cloned.workflow_id, "wf-1");
|
||||||
|
assert_eq!(cloned.stream, LogStreamType::Stdout);
|
||||||
|
assert_eq!(cloned.data, b"hello\n");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -69,6 +69,7 @@ mod tests {
|
|||||||
workflow: &instance,
|
workflow: &instance,
|
||||||
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
||||||
host_context: None,
|
host_context: None,
|
||||||
|
log_sink: None,
|
||||||
};
|
};
|
||||||
mw.pre_step(&ctx).await.unwrap();
|
mw.pre_step(&ctx).await.unwrap();
|
||||||
}
|
}
|
||||||
@@ -88,6 +89,7 @@ mod tests {
|
|||||||
workflow: &instance,
|
workflow: &instance,
|
||||||
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
||||||
host_context: None,
|
host_context: None,
|
||||||
|
log_sink: None,
|
||||||
};
|
};
|
||||||
let result = ExecutionResult::next();
|
let result = ExecutionResult::next();
|
||||||
mw.post_step(&ctx, &result).await.unwrap();
|
mw.post_step(&ctx, &result).await.unwrap();
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
pub mod lifecycle;
|
pub mod lifecycle;
|
||||||
pub mod lock;
|
pub mod lock;
|
||||||
|
pub mod log_sink;
|
||||||
pub mod middleware;
|
pub mod middleware;
|
||||||
pub mod persistence;
|
pub mod persistence;
|
||||||
pub mod queue;
|
pub mod queue;
|
||||||
@@ -9,6 +10,7 @@ pub mod step;
|
|||||||
|
|
||||||
pub use lifecycle::LifecyclePublisher;
|
pub use lifecycle::LifecyclePublisher;
|
||||||
pub use lock::DistributedLockProvider;
|
pub use lock::DistributedLockProvider;
|
||||||
|
pub use log_sink::{LogChunk, LogSink, LogStreamType};
|
||||||
pub use middleware::{StepMiddleware, WorkflowMiddleware};
|
pub use middleware::{StepMiddleware, WorkflowMiddleware};
|
||||||
pub use persistence::{
|
pub use persistence::{
|
||||||
EventRepository, PersistenceProvider, ScheduledCommandRepository, SubscriptionRepository,
|
EventRepository, PersistenceProvider, ScheduledCommandRepository, SubscriptionRepository,
|
||||||
|
|||||||
@@ -38,6 +38,8 @@ pub struct StepExecutionContext<'a> {
|
|||||||
pub cancellation_token: tokio_util::sync::CancellationToken,
|
pub cancellation_token: tokio_util::sync::CancellationToken,
|
||||||
/// Host context for starting child workflows. None if not available.
|
/// Host context for starting child workflows. None if not available.
|
||||||
pub host_context: Option<&'a dyn HostContext>,
|
pub host_context: Option<&'a dyn HostContext>,
|
||||||
|
/// Log sink for streaming step output. None if not configured.
|
||||||
|
pub log_sink: Option<&'a dyn super::LogSink>,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Manual Debug impl since dyn HostContext is not Debug.
|
// Manual Debug impl since dyn HostContext is not Debug.
|
||||||
@@ -50,6 +52,7 @@ impl<'a> std::fmt::Debug for StepExecutionContext<'a> {
|
|||||||
.field("step", &self.step)
|
.field("step", &self.step)
|
||||||
.field("workflow", &self.workflow)
|
.field("workflow", &self.workflow)
|
||||||
.field("host_context", &self.host_context.is_some())
|
.field("host_context", &self.host_context.is_some())
|
||||||
|
.field("log_sink", &self.log_sink.is_some())
|
||||||
.finish()
|
.finish()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
22
wfe-rustlang/Cargo.toml
Normal file
22
wfe-rustlang/Cargo.toml
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
[package]
|
||||||
|
name = "wfe-rustlang"
|
||||||
|
version.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
homepage.workspace = true
|
||||||
|
description = "Rust toolchain step executors (cargo, rustup) for WFE"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
wfe-core = { workspace = true }
|
||||||
|
tokio = { workspace = true }
|
||||||
|
serde = { workspace = true }
|
||||||
|
serde_json = { workspace = true }
|
||||||
|
async-trait = { workspace = true }
|
||||||
|
tracing = { workspace = true }
|
||||||
|
rustdoc-types = "0.38"
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
pretty_assertions = { workspace = true }
|
||||||
|
tokio = { workspace = true, features = ["test-util", "process"] }
|
||||||
|
tempfile = { workspace = true }
|
||||||
301
wfe-rustlang/src/cargo/config.rs
Normal file
301
wfe-rustlang/src/cargo/config.rs
Normal file
@@ -0,0 +1,301 @@
|
|||||||
|
use std::collections::HashMap;
|
||||||
|
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
/// Which cargo subcommand to run.
|
||||||
|
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
|
||||||
|
#[serde(rename_all = "kebab-case")]
|
||||||
|
pub enum CargoCommand {
|
||||||
|
Build,
|
||||||
|
Test,
|
||||||
|
Check,
|
||||||
|
Clippy,
|
||||||
|
Fmt,
|
||||||
|
Doc,
|
||||||
|
Publish,
|
||||||
|
Audit,
|
||||||
|
Deny,
|
||||||
|
Nextest,
|
||||||
|
LlvmCov,
|
||||||
|
DocMdx,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CargoCommand {
|
||||||
|
pub fn as_str(&self) -> &'static str {
|
||||||
|
match self {
|
||||||
|
Self::Build => "build",
|
||||||
|
Self::Test => "test",
|
||||||
|
Self::Check => "check",
|
||||||
|
Self::Clippy => "clippy",
|
||||||
|
Self::Fmt => "fmt",
|
||||||
|
Self::Doc => "doc",
|
||||||
|
Self::Publish => "publish",
|
||||||
|
Self::Audit => "audit",
|
||||||
|
Self::Deny => "deny",
|
||||||
|
Self::Nextest => "nextest",
|
||||||
|
Self::LlvmCov => "llvm-cov",
|
||||||
|
Self::DocMdx => "doc-mdx",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the subcommand arg(s) to pass to cargo.
|
||||||
|
/// Most commands are a single arg, but nextest needs "nextest run".
|
||||||
|
/// DocMdx uses `rustdoc` (the actual cargo subcommand).
|
||||||
|
pub fn subcommand_args(&self) -> Vec<&'static str> {
|
||||||
|
match self {
|
||||||
|
Self::Nextest => vec!["nextest", "run"],
|
||||||
|
Self::DocMdx => vec!["rustdoc"],
|
||||||
|
other => vec![other.as_str()],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the cargo-install package name if this is an external tool.
|
||||||
|
/// Returns `None` for built-in cargo subcommands.
|
||||||
|
pub fn install_package(&self) -> Option<&'static str> {
|
||||||
|
match self {
|
||||||
|
Self::Audit => Some("cargo-audit"),
|
||||||
|
Self::Deny => Some("cargo-deny"),
|
||||||
|
Self::Nextest => Some("cargo-nextest"),
|
||||||
|
Self::LlvmCov => Some("cargo-llvm-cov"),
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Returns the binary name to probe for availability.
|
||||||
|
pub fn binary_name(&self) -> Option<&'static str> {
|
||||||
|
match self {
|
||||||
|
Self::Audit => Some("cargo-audit"),
|
||||||
|
Self::Deny => Some("cargo-deny"),
|
||||||
|
Self::Nextest => Some("cargo-nextest"),
|
||||||
|
Self::LlvmCov => Some("cargo-llvm-cov"),
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Shared configuration for all cargo step types.
|
||||||
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||||
|
pub struct CargoConfig {
|
||||||
|
pub command: CargoCommand,
|
||||||
|
/// Rust toolchain override (e.g. "nightly", "1.78.0").
|
||||||
|
#[serde(default)]
|
||||||
|
pub toolchain: Option<String>,
|
||||||
|
/// Target package (`-p`).
|
||||||
|
#[serde(default)]
|
||||||
|
pub package: Option<String>,
|
||||||
|
/// Features to enable (`--features`).
|
||||||
|
#[serde(default)]
|
||||||
|
pub features: Vec<String>,
|
||||||
|
/// Enable all features (`--all-features`).
|
||||||
|
#[serde(default)]
|
||||||
|
pub all_features: bool,
|
||||||
|
/// Disable default features (`--no-default-features`).
|
||||||
|
#[serde(default)]
|
||||||
|
pub no_default_features: bool,
|
||||||
|
/// Build in release mode (`--release`).
|
||||||
|
#[serde(default)]
|
||||||
|
pub release: bool,
|
||||||
|
/// Compilation target triple (`--target`).
|
||||||
|
#[serde(default)]
|
||||||
|
pub target: Option<String>,
|
||||||
|
/// Build profile (`--profile`).
|
||||||
|
#[serde(default)]
|
||||||
|
pub profile: Option<String>,
|
||||||
|
/// Additional arguments appended to the command.
|
||||||
|
#[serde(default)]
|
||||||
|
pub extra_args: Vec<String>,
|
||||||
|
/// Environment variables.
|
||||||
|
#[serde(default)]
|
||||||
|
pub env: HashMap<String, String>,
|
||||||
|
/// Working directory.
|
||||||
|
#[serde(default)]
|
||||||
|
pub working_dir: Option<String>,
|
||||||
|
/// Execution timeout in milliseconds.
|
||||||
|
#[serde(default)]
|
||||||
|
pub timeout_ms: Option<u64>,
|
||||||
|
/// Output directory for generated files (e.g., MDX docs).
|
||||||
|
#[serde(default)]
|
||||||
|
pub output_dir: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use pretty_assertions::assert_eq;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn serde_round_trip_minimal() {
|
||||||
|
let config = CargoConfig {
|
||||||
|
command: CargoCommand::Build,
|
||||||
|
toolchain: None,
|
||||||
|
package: None,
|
||||||
|
features: vec![],
|
||||||
|
all_features: false,
|
||||||
|
no_default_features: false,
|
||||||
|
release: false,
|
||||||
|
target: None,
|
||||||
|
profile: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
env: HashMap::new(),
|
||||||
|
working_dir: None,
|
||||||
|
timeout_ms: None,
|
||||||
|
output_dir: None,
|
||||||
|
};
|
||||||
|
let json = serde_json::to_string(&config).unwrap();
|
||||||
|
let de: CargoConfig = serde_json::from_str(&json).unwrap();
|
||||||
|
assert_eq!(de.command, CargoCommand::Build);
|
||||||
|
assert!(de.features.is_empty());
|
||||||
|
assert!(!de.release);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn serde_round_trip_full() {
|
||||||
|
let mut env = HashMap::new();
|
||||||
|
env.insert("RUSTFLAGS".to_string(), "-D warnings".to_string());
|
||||||
|
|
||||||
|
let config = CargoConfig {
|
||||||
|
command: CargoCommand::Clippy,
|
||||||
|
toolchain: Some("nightly".to_string()),
|
||||||
|
package: Some("my-crate".to_string()),
|
||||||
|
features: vec!["feat1".to_string(), "feat2".to_string()],
|
||||||
|
all_features: false,
|
||||||
|
no_default_features: true,
|
||||||
|
release: true,
|
||||||
|
target: Some("x86_64-unknown-linux-gnu".to_string()),
|
||||||
|
profile: None,
|
||||||
|
extra_args: vec!["--".to_string(), "-D".to_string(), "warnings".to_string()],
|
||||||
|
env,
|
||||||
|
working_dir: Some("/src".to_string()),
|
||||||
|
timeout_ms: Some(60_000),
|
||||||
|
output_dir: None,
|
||||||
|
};
|
||||||
|
let json = serde_json::to_string(&config).unwrap();
|
||||||
|
let de: CargoConfig = serde_json::from_str(&json).unwrap();
|
||||||
|
assert_eq!(de.command, CargoCommand::Clippy);
|
||||||
|
assert_eq!(de.toolchain, Some("nightly".to_string()));
|
||||||
|
assert_eq!(de.package, Some("my-crate".to_string()));
|
||||||
|
assert_eq!(de.features, vec!["feat1", "feat2"]);
|
||||||
|
assert!(de.no_default_features);
|
||||||
|
assert!(de.release);
|
||||||
|
assert_eq!(de.extra_args, vec!["--", "-D", "warnings"]);
|
||||||
|
assert_eq!(de.timeout_ms, Some(60_000));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn command_as_str() {
|
||||||
|
assert_eq!(CargoCommand::Build.as_str(), "build");
|
||||||
|
assert_eq!(CargoCommand::Test.as_str(), "test");
|
||||||
|
assert_eq!(CargoCommand::Check.as_str(), "check");
|
||||||
|
assert_eq!(CargoCommand::Clippy.as_str(), "clippy");
|
||||||
|
assert_eq!(CargoCommand::Fmt.as_str(), "fmt");
|
||||||
|
assert_eq!(CargoCommand::Doc.as_str(), "doc");
|
||||||
|
assert_eq!(CargoCommand::Publish.as_str(), "publish");
|
||||||
|
assert_eq!(CargoCommand::Audit.as_str(), "audit");
|
||||||
|
assert_eq!(CargoCommand::Deny.as_str(), "deny");
|
||||||
|
assert_eq!(CargoCommand::Nextest.as_str(), "nextest");
|
||||||
|
assert_eq!(CargoCommand::LlvmCov.as_str(), "llvm-cov");
|
||||||
|
assert_eq!(CargoCommand::DocMdx.as_str(), "doc-mdx");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn command_serde_kebab_case() {
|
||||||
|
let json = r#""build""#;
|
||||||
|
let cmd: CargoCommand = serde_json::from_str(json).unwrap();
|
||||||
|
assert_eq!(cmd, CargoCommand::Build);
|
||||||
|
|
||||||
|
let serialized = serde_json::to_string(&CargoCommand::Build).unwrap();
|
||||||
|
assert_eq!(serialized, r#""build""#);
|
||||||
|
|
||||||
|
// External tools
|
||||||
|
let json = r#""llvm-cov""#;
|
||||||
|
let cmd: CargoCommand = serde_json::from_str(json).unwrap();
|
||||||
|
assert_eq!(cmd, CargoCommand::LlvmCov);
|
||||||
|
|
||||||
|
let json = r#""nextest""#;
|
||||||
|
let cmd: CargoCommand = serde_json::from_str(json).unwrap();
|
||||||
|
assert_eq!(cmd, CargoCommand::Nextest);
|
||||||
|
|
||||||
|
let json = r#""doc-mdx""#;
|
||||||
|
let cmd: CargoCommand = serde_json::from_str(json).unwrap();
|
||||||
|
assert_eq!(cmd, CargoCommand::DocMdx);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn subcommand_args_single() {
|
||||||
|
assert_eq!(CargoCommand::Build.subcommand_args(), vec!["build"]);
|
||||||
|
assert_eq!(CargoCommand::Audit.subcommand_args(), vec!["audit"]);
|
||||||
|
assert_eq!(CargoCommand::LlvmCov.subcommand_args(), vec!["llvm-cov"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn subcommand_args_nextest_has_run() {
|
||||||
|
assert_eq!(CargoCommand::Nextest.subcommand_args(), vec!["nextest", "run"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn subcommand_args_doc_mdx_uses_rustdoc() {
|
||||||
|
assert_eq!(CargoCommand::DocMdx.subcommand_args(), vec!["rustdoc"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn install_package_external_tools() {
|
||||||
|
assert_eq!(CargoCommand::Audit.install_package(), Some("cargo-audit"));
|
||||||
|
assert_eq!(CargoCommand::Deny.install_package(), Some("cargo-deny"));
|
||||||
|
assert_eq!(CargoCommand::Nextest.install_package(), Some("cargo-nextest"));
|
||||||
|
assert_eq!(CargoCommand::LlvmCov.install_package(), Some("cargo-llvm-cov"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn install_package_builtin_returns_none() {
|
||||||
|
assert_eq!(CargoCommand::Build.install_package(), None);
|
||||||
|
assert_eq!(CargoCommand::Test.install_package(), None);
|
||||||
|
assert_eq!(CargoCommand::Check.install_package(), None);
|
||||||
|
assert_eq!(CargoCommand::Clippy.install_package(), None);
|
||||||
|
assert_eq!(CargoCommand::Fmt.install_package(), None);
|
||||||
|
assert_eq!(CargoCommand::Doc.install_package(), None);
|
||||||
|
assert_eq!(CargoCommand::Publish.install_package(), None);
|
||||||
|
assert_eq!(CargoCommand::DocMdx.install_package(), None);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn binary_name_external_tools() {
|
||||||
|
assert_eq!(CargoCommand::Audit.binary_name(), Some("cargo-audit"));
|
||||||
|
assert_eq!(CargoCommand::Deny.binary_name(), Some("cargo-deny"));
|
||||||
|
assert_eq!(CargoCommand::Nextest.binary_name(), Some("cargo-nextest"));
|
||||||
|
assert_eq!(CargoCommand::LlvmCov.binary_name(), Some("cargo-llvm-cov"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn binary_name_builtin_returns_none() {
|
||||||
|
assert_eq!(CargoCommand::Build.binary_name(), None);
|
||||||
|
assert_eq!(CargoCommand::Test.binary_name(), None);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn config_defaults() {
|
||||||
|
let json = r#"{"command": "test"}"#;
|
||||||
|
let config: CargoConfig = serde_json::from_str(json).unwrap();
|
||||||
|
assert_eq!(config.command, CargoCommand::Test);
|
||||||
|
assert!(config.toolchain.is_none());
|
||||||
|
assert!(config.package.is_none());
|
||||||
|
assert!(config.features.is_empty());
|
||||||
|
assert!(!config.all_features);
|
||||||
|
assert!(!config.no_default_features);
|
||||||
|
assert!(!config.release);
|
||||||
|
assert!(config.target.is_none());
|
||||||
|
assert!(config.profile.is_none());
|
||||||
|
assert!(config.extra_args.is_empty());
|
||||||
|
assert!(config.env.is_empty());
|
||||||
|
assert!(config.working_dir.is_none());
|
||||||
|
assert!(config.timeout_ms.is_none());
|
||||||
|
assert!(config.output_dir.is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn config_with_output_dir() {
|
||||||
|
let json = r#"{"command": "doc-mdx", "output_dir": "docs/api"}"#;
|
||||||
|
let config: CargoConfig = serde_json::from_str(json).unwrap();
|
||||||
|
assert_eq!(config.command, CargoCommand::DocMdx);
|
||||||
|
assert_eq!(config.output_dir, Some("docs/api".to_string()));
|
||||||
|
}
|
||||||
|
}
|
||||||
5
wfe-rustlang/src/cargo/mod.rs
Normal file
5
wfe-rustlang/src/cargo/mod.rs
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
pub mod config;
|
||||||
|
pub mod step;
|
||||||
|
|
||||||
|
pub use config::{CargoCommand, CargoConfig};
|
||||||
|
pub use step::CargoStep;
|
||||||
532
wfe-rustlang/src/cargo/step.rs
Normal file
532
wfe-rustlang/src/cargo/step.rs
Normal file
@@ -0,0 +1,532 @@
|
|||||||
|
use async_trait::async_trait;
|
||||||
|
use wfe_core::models::ExecutionResult;
|
||||||
|
use wfe_core::traits::step::{StepBody, StepExecutionContext};
|
||||||
|
use wfe_core::WfeError;
|
||||||
|
|
||||||
|
use crate::cargo::config::{CargoCommand, CargoConfig};
|
||||||
|
|
||||||
|
pub struct CargoStep {
|
||||||
|
config: CargoConfig,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CargoStep {
|
||||||
|
pub fn new(config: CargoConfig) -> Self {
|
||||||
|
Self { config }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn build_command(&self) -> tokio::process::Command {
|
||||||
|
// DocMdx requires nightly for --output-format json.
|
||||||
|
let toolchain = if matches!(self.config.command, CargoCommand::DocMdx) {
|
||||||
|
Some(self.config.toolchain.as_deref().unwrap_or("nightly"))
|
||||||
|
} else {
|
||||||
|
self.config.toolchain.as_deref()
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut cmd = if let Some(tc) = toolchain {
|
||||||
|
let mut c = tokio::process::Command::new("rustup");
|
||||||
|
c.args(["run", tc, "cargo"]);
|
||||||
|
c
|
||||||
|
} else {
|
||||||
|
tokio::process::Command::new("cargo")
|
||||||
|
};
|
||||||
|
|
||||||
|
for arg in self.config.command.subcommand_args() {
|
||||||
|
cmd.arg(arg);
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(ref pkg) = self.config.package {
|
||||||
|
cmd.args(["-p", pkg]);
|
||||||
|
}
|
||||||
|
|
||||||
|
if !self.config.features.is_empty() {
|
||||||
|
cmd.args(["--features", &self.config.features.join(",")]);
|
||||||
|
}
|
||||||
|
|
||||||
|
if self.config.all_features {
|
||||||
|
cmd.arg("--all-features");
|
||||||
|
}
|
||||||
|
|
||||||
|
if self.config.no_default_features {
|
||||||
|
cmd.arg("--no-default-features");
|
||||||
|
}
|
||||||
|
|
||||||
|
if self.config.release {
|
||||||
|
cmd.arg("--release");
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(ref target) = self.config.target {
|
||||||
|
cmd.args(["--target", target]);
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(ref profile) = self.config.profile {
|
||||||
|
cmd.args(["--profile", profile]);
|
||||||
|
}
|
||||||
|
|
||||||
|
for arg in &self.config.extra_args {
|
||||||
|
cmd.arg(arg);
|
||||||
|
}
|
||||||
|
|
||||||
|
// DocMdx appends rustdoc-specific flags after user extra_args.
|
||||||
|
if matches!(self.config.command, CargoCommand::DocMdx) {
|
||||||
|
cmd.args(["--", "-Z", "unstable-options", "--output-format", "json"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (key, value) in &self.config.env {
|
||||||
|
cmd.env(key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(ref dir) = self.config.working_dir {
|
||||||
|
cmd.current_dir(dir);
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd.stdout(std::process::Stdio::piped());
|
||||||
|
cmd.stderr(std::process::Stdio::piped());
|
||||||
|
|
||||||
|
cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Ensures an external cargo tool is installed before running it.
|
||||||
|
/// For built-in cargo subcommands, this is a no-op.
|
||||||
|
async fn ensure_tool_available(&self) -> Result<(), WfeError> {
|
||||||
|
let (binary, package) = match (self.config.command.binary_name(), self.config.command.install_package()) {
|
||||||
|
(Some(b), Some(p)) => (b, p),
|
||||||
|
_ => return Ok(()),
|
||||||
|
};
|
||||||
|
|
||||||
|
// Probe for the binary.
|
||||||
|
let probe = tokio::process::Command::new(binary)
|
||||||
|
.arg("--version")
|
||||||
|
.stdout(std::process::Stdio::null())
|
||||||
|
.stderr(std::process::Stdio::null())
|
||||||
|
.status()
|
||||||
|
.await;
|
||||||
|
|
||||||
|
if let Ok(status) = probe {
|
||||||
|
if status.success() {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
tracing::info!(package = package, "cargo tool not found, installing");
|
||||||
|
|
||||||
|
// For llvm-cov, ensure the rustup component is present first.
|
||||||
|
if matches!(self.config.command, CargoCommand::LlvmCov) {
|
||||||
|
let component = tokio::process::Command::new("rustup")
|
||||||
|
.args(["component", "add", "llvm-tools-preview"])
|
||||||
|
.stdout(std::process::Stdio::piped())
|
||||||
|
.stderr(std::process::Stdio::piped())
|
||||||
|
.output()
|
||||||
|
.await
|
||||||
|
.map_err(|e| WfeError::StepExecution(format!(
|
||||||
|
"Failed to add llvm-tools-preview component: {e}"
|
||||||
|
)))?;
|
||||||
|
|
||||||
|
if !component.status.success() {
|
||||||
|
let stderr = String::from_utf8_lossy(&component.stderr);
|
||||||
|
return Err(WfeError::StepExecution(format!(
|
||||||
|
"Failed to add llvm-tools-preview component: {stderr}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let install = tokio::process::Command::new("cargo")
|
||||||
|
.args(["install", package])
|
||||||
|
.stdout(std::process::Stdio::piped())
|
||||||
|
.stderr(std::process::Stdio::piped())
|
||||||
|
.output()
|
||||||
|
.await
|
||||||
|
.map_err(|e| WfeError::StepExecution(format!(
|
||||||
|
"Failed to install {package}: {e}"
|
||||||
|
)))?;
|
||||||
|
|
||||||
|
if !install.status.success() {
|
||||||
|
let stderr = String::from_utf8_lossy(&install.stderr);
|
||||||
|
return Err(WfeError::StepExecution(format!(
|
||||||
|
"Failed to install {package}: {stderr}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
tracing::info!(package = package, "cargo tool installed successfully");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Post-process rustdoc JSON output into MDX files.
|
||||||
|
fn transform_rustdoc_json(
|
||||||
|
&self,
|
||||||
|
outputs: &mut serde_json::Map<String, serde_json::Value>,
|
||||||
|
) -> Result<(), WfeError> {
|
||||||
|
use crate::rustdoc::transformer::{transform_to_mdx, write_mdx_files};
|
||||||
|
|
||||||
|
// Find the JSON file in target/doc/.
|
||||||
|
let working_dir = self.config.working_dir.as_deref().unwrap_or(".");
|
||||||
|
let doc_dir = std::path::Path::new(working_dir).join("target/doc");
|
||||||
|
|
||||||
|
let json_path = std::fs::read_dir(&doc_dir)
|
||||||
|
.map_err(|e| WfeError::StepExecution(format!(
|
||||||
|
"failed to read target/doc: {e}"
|
||||||
|
)))?
|
||||||
|
.filter_map(|entry| entry.ok())
|
||||||
|
.find(|entry| {
|
||||||
|
entry.path().extension().is_some_and(|ext| ext == "json")
|
||||||
|
})
|
||||||
|
.map(|entry| entry.path())
|
||||||
|
.ok_or_else(|| WfeError::StepExecution(
|
||||||
|
"no JSON file found in target/doc/ — did rustdoc --output-format json succeed?".to_string()
|
||||||
|
))?;
|
||||||
|
|
||||||
|
tracing::info!(path = %json_path.display(), "reading rustdoc JSON");
|
||||||
|
|
||||||
|
let json_content = std::fs::read_to_string(&json_path).map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("failed to read {}: {e}", json_path.display()))
|
||||||
|
})?;
|
||||||
|
|
||||||
|
let krate: rustdoc_types::Crate = serde_json::from_str(&json_content).map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("failed to parse rustdoc JSON: {e}"))
|
||||||
|
})?;
|
||||||
|
|
||||||
|
let mdx_files = transform_to_mdx(&krate);
|
||||||
|
|
||||||
|
let output_dir = self.config.output_dir
|
||||||
|
.as_deref()
|
||||||
|
.unwrap_or("target/doc/mdx");
|
||||||
|
let output_path = std::path::Path::new(working_dir).join(output_dir);
|
||||||
|
|
||||||
|
write_mdx_files(&mdx_files, &output_path).map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("failed to write MDX files: {e}"))
|
||||||
|
})?;
|
||||||
|
|
||||||
|
let file_count = mdx_files.len();
|
||||||
|
tracing::info!(
|
||||||
|
output_dir = %output_path.display(),
|
||||||
|
file_count,
|
||||||
|
"generated MDX documentation"
|
||||||
|
);
|
||||||
|
|
||||||
|
outputs.insert(
|
||||||
|
"mdx.output_dir".to_string(),
|
||||||
|
serde_json::Value::String(output_path.to_string_lossy().to_string()),
|
||||||
|
);
|
||||||
|
outputs.insert(
|
||||||
|
"mdx.file_count".to_string(),
|
||||||
|
serde_json::Value::Number(file_count.into()),
|
||||||
|
);
|
||||||
|
let file_paths: Vec<_> = mdx_files.iter().map(|f| f.path.clone()).collect();
|
||||||
|
outputs.insert(
|
||||||
|
"mdx.files".to_string(),
|
||||||
|
serde_json::Value::Array(
|
||||||
|
file_paths.into_iter().map(serde_json::Value::String).collect(),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
impl StepBody for CargoStep {
|
||||||
|
async fn run(&mut self, context: &StepExecutionContext<'_>) -> wfe_core::Result<ExecutionResult> {
|
||||||
|
let step_name = context.step.name.as_deref().unwrap_or("unknown");
|
||||||
|
let subcmd = self.config.command.as_str();
|
||||||
|
|
||||||
|
// Ensure external tools are installed before running.
|
||||||
|
self.ensure_tool_available().await?;
|
||||||
|
|
||||||
|
tracing::info!(step = step_name, command = subcmd, "running cargo");
|
||||||
|
|
||||||
|
let mut cmd = self.build_command();
|
||||||
|
|
||||||
|
let output = if let Some(timeout_ms) = self.config.timeout_ms {
|
||||||
|
let duration = std::time::Duration::from_millis(timeout_ms);
|
||||||
|
match tokio::time::timeout(duration, cmd.output()).await {
|
||||||
|
Ok(result) => result.map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("Failed to spawn cargo {subcmd}: {e}"))
|
||||||
|
})?,
|
||||||
|
Err(_) => {
|
||||||
|
return Err(WfeError::StepExecution(format!(
|
||||||
|
"cargo {subcmd} timed out after {timeout_ms}ms"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
cmd.output()
|
||||||
|
.await
|
||||||
|
.map_err(|e| WfeError::StepExecution(format!("Failed to spawn cargo {subcmd}: {e}")))?
|
||||||
|
};
|
||||||
|
|
||||||
|
let stdout = String::from_utf8_lossy(&output.stdout).to_string();
|
||||||
|
let stderr = String::from_utf8_lossy(&output.stderr).to_string();
|
||||||
|
|
||||||
|
if !output.status.success() {
|
||||||
|
let code = output.status.code().unwrap_or(-1);
|
||||||
|
return Err(WfeError::StepExecution(format!(
|
||||||
|
"cargo {subcmd} exited with code {code}\nstdout: {stdout}\nstderr: {stderr}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut outputs = serde_json::Map::new();
|
||||||
|
outputs.insert(
|
||||||
|
format!("{step_name}.stdout"),
|
||||||
|
serde_json::Value::String(stdout),
|
||||||
|
);
|
||||||
|
outputs.insert(
|
||||||
|
format!("{step_name}.stderr"),
|
||||||
|
serde_json::Value::String(stderr),
|
||||||
|
);
|
||||||
|
|
||||||
|
// DocMdx post-processing: transform rustdoc JSON → MDX files.
|
||||||
|
if matches!(self.config.command, CargoCommand::DocMdx) {
|
||||||
|
self.transform_rustdoc_json(&mut outputs)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(ExecutionResult {
|
||||||
|
proceed: true,
|
||||||
|
output_data: Some(serde_json::Value::Object(outputs)),
|
||||||
|
..Default::default()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use crate::cargo::config::{CargoCommand, CargoConfig};
|
||||||
|
use std::collections::HashMap;
|
||||||
|
|
||||||
|
fn minimal_config(command: CargoCommand) -> CargoConfig {
|
||||||
|
CargoConfig {
|
||||||
|
command,
|
||||||
|
toolchain: None,
|
||||||
|
package: None,
|
||||||
|
features: vec![],
|
||||||
|
all_features: false,
|
||||||
|
no_default_features: false,
|
||||||
|
release: false,
|
||||||
|
target: None,
|
||||||
|
profile: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
env: HashMap::new(),
|
||||||
|
working_dir: None,
|
||||||
|
timeout_ms: None,
|
||||||
|
output_dir: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_minimal() {
|
||||||
|
let step = CargoStep::new(minimal_config(CargoCommand::Build));
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let prog = cmd.as_std().get_program().to_str().unwrap();
|
||||||
|
assert_eq!(prog, "cargo");
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["build"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_with_toolchain() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Test);
|
||||||
|
config.toolchain = Some("nightly".to_string());
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let prog = cmd.as_std().get_program().to_str().unwrap();
|
||||||
|
assert_eq!(prog, "rustup");
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["run", "nightly", "cargo", "test"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_with_package_and_features() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Check);
|
||||||
|
config.package = Some("my-crate".to_string());
|
||||||
|
config.features = vec!["feat1".to_string(), "feat2".to_string()];
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["check", "-p", "my-crate", "--features", "feat1,feat2"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_release_and_target() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Build);
|
||||||
|
config.release = true;
|
||||||
|
config.target = Some("aarch64-unknown-linux-gnu".to_string());
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["build", "--release", "--target", "aarch64-unknown-linux-gnu"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_all_flags() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Clippy);
|
||||||
|
config.all_features = true;
|
||||||
|
config.no_default_features = true;
|
||||||
|
config.profile = Some("dev".to_string());
|
||||||
|
config.extra_args = vec!["--".to_string(), "-D".to_string(), "warnings".to_string()];
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(
|
||||||
|
args,
|
||||||
|
vec!["clippy", "--all-features", "--no-default-features", "--profile", "dev", "--", "-D", "warnings"]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_fmt() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Fmt);
|
||||||
|
config.extra_args = vec!["--check".to_string()];
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["fmt", "--check"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_publish_dry_run() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Publish);
|
||||||
|
config.extra_args = vec!["--dry-run".to_string(), "--registry".to_string(), "my-reg".to_string()];
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["publish", "--dry-run", "--registry", "my-reg"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_doc() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Doc);
|
||||||
|
config.extra_args = vec!["--no-deps".to_string()];
|
||||||
|
config.release = true;
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["doc", "--release", "--no-deps"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_env_vars() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Build);
|
||||||
|
config.env.insert("RUSTFLAGS".to_string(), "-D warnings".to_string());
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let envs: Vec<_> = cmd.as_std().get_envs().collect();
|
||||||
|
assert!(envs.iter().any(|(k, v)| *k == "RUSTFLAGS" && v == &Some("-D warnings".as_ref())));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_working_dir() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Test);
|
||||||
|
config.working_dir = Some("/my/project".to_string());
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
assert_eq!(cmd.as_std().get_current_dir(), Some(std::path::Path::new("/my/project")));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_audit() {
|
||||||
|
let step = CargoStep::new(minimal_config(CargoCommand::Audit));
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["audit"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_deny() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Deny);
|
||||||
|
config.extra_args = vec!["check".to_string()];
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["deny", "check"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_nextest() {
|
||||||
|
let step = CargoStep::new(minimal_config(CargoCommand::Nextest));
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["nextest", "run"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_nextest_with_features() {
|
||||||
|
let mut config = minimal_config(CargoCommand::Nextest);
|
||||||
|
config.features = vec!["feat1".to_string()];
|
||||||
|
config.extra_args = vec!["--no-fail-fast".to_string()];
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["nextest", "run", "--features", "feat1", "--no-fail-fast"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_llvm_cov() {
|
||||||
|
let step = CargoStep::new(minimal_config(CargoCommand::LlvmCov));
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["llvm-cov"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_llvm_cov_with_args() {
|
||||||
|
let mut config = minimal_config(CargoCommand::LlvmCov);
|
||||||
|
config.extra_args = vec!["--html".to_string(), "--output-dir".to_string(), "coverage".to_string()];
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["llvm-cov", "--html", "--output-dir", "coverage"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_doc_mdx_forces_nightly() {
|
||||||
|
let step = CargoStep::new(minimal_config(CargoCommand::DocMdx));
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let prog = cmd.as_std().get_program().to_str().unwrap();
|
||||||
|
assert_eq!(prog, "rustup");
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(
|
||||||
|
args,
|
||||||
|
vec!["run", "nightly", "cargo", "rustdoc", "--", "-Z", "unstable-options", "--output-format", "json"]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_doc_mdx_with_package() {
|
||||||
|
let mut config = minimal_config(CargoCommand::DocMdx);
|
||||||
|
config.package = Some("my-crate".to_string());
|
||||||
|
config.extra_args = vec!["--no-deps".to_string()];
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(
|
||||||
|
args,
|
||||||
|
vec!["run", "nightly", "cargo", "rustdoc", "-p", "my-crate", "--no-deps", "--", "-Z", "unstable-options", "--output-format", "json"]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_command_doc_mdx_custom_toolchain() {
|
||||||
|
let mut config = minimal_config(CargoCommand::DocMdx);
|
||||||
|
config.toolchain = Some("nightly-2024-06-01".to_string());
|
||||||
|
let step = CargoStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert!(args.contains(&"nightly-2024-06-01"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn ensure_tool_builtin_is_noop() {
|
||||||
|
let step = CargoStep::new(minimal_config(CargoCommand::Build));
|
||||||
|
// Should return Ok immediately for built-in commands.
|
||||||
|
step.ensure_tool_available().await.unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn ensure_tool_already_installed_succeeds() {
|
||||||
|
// cargo-audit/nextest/etc may or may not be installed,
|
||||||
|
// but we can test with a known-installed tool: cargo itself
|
||||||
|
// is always available. Test the flow by verifying the
|
||||||
|
// built-in path returns Ok.
|
||||||
|
let step = CargoStep::new(minimal_config(CargoCommand::Check));
|
||||||
|
step.ensure_tool_available().await.unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
6
wfe-rustlang/src/lib.rs
Normal file
6
wfe-rustlang/src/lib.rs
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
pub mod cargo;
|
||||||
|
pub mod rustdoc;
|
||||||
|
pub mod rustup;
|
||||||
|
|
||||||
|
pub use cargo::{CargoCommand, CargoConfig, CargoStep};
|
||||||
|
pub use rustup::{RustupCommand, RustupConfig, RustupStep};
|
||||||
3
wfe-rustlang/src/rustdoc/mod.rs
Normal file
3
wfe-rustlang/src/rustdoc/mod.rs
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
pub mod transformer;
|
||||||
|
|
||||||
|
pub use transformer::transform_to_mdx;
|
||||||
847
wfe-rustlang/src/rustdoc/transformer.rs
Normal file
847
wfe-rustlang/src/rustdoc/transformer.rs
Normal file
@@ -0,0 +1,847 @@
|
|||||||
|
use std::collections::HashMap;
|
||||||
|
use std::path::Path;
|
||||||
|
|
||||||
|
use rustdoc_types::{Crate, Id, Item, ItemEnum, Type};
|
||||||
|
|
||||||
|
/// A generated MDX file with its relative path and content.
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
pub struct MdxFile {
|
||||||
|
/// Relative path (e.g., `my_crate/utils.mdx`).
|
||||||
|
pub path: String,
|
||||||
|
/// MDX content.
|
||||||
|
pub content: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Transform a rustdoc JSON `Crate` into a set of MDX files.
|
||||||
|
///
|
||||||
|
/// Generates one MDX file per module, with all items in that module
|
||||||
|
/// grouped by kind (structs, enums, functions, traits, etc.).
|
||||||
|
pub fn transform_to_mdx(krate: &Crate) -> Vec<MdxFile> {
|
||||||
|
let mut files = Vec::new();
|
||||||
|
let mut module_items: HashMap<String, Vec<(&Item, &str)>> = HashMap::new();
|
||||||
|
|
||||||
|
for (id, item) in &krate.index {
|
||||||
|
let module_path = resolve_module_path(krate, id);
|
||||||
|
let kind_label = item_kind_label(&item.inner);
|
||||||
|
if let Some(label) = kind_label {
|
||||||
|
module_items
|
||||||
|
.entry(module_path)
|
||||||
|
.or_default()
|
||||||
|
.push((item, label));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut paths: Vec<_> = module_items.keys().cloned().collect();
|
||||||
|
paths.sort();
|
||||||
|
|
||||||
|
for module_path in paths {
|
||||||
|
let items = &module_items[&module_path];
|
||||||
|
let content = render_module(&module_path, items, krate);
|
||||||
|
let file_path = if module_path.is_empty() {
|
||||||
|
"index.mdx".to_string()
|
||||||
|
} else {
|
||||||
|
format!("{}.mdx", module_path.replace("::", "/"))
|
||||||
|
};
|
||||||
|
files.push(MdxFile {
|
||||||
|
path: file_path,
|
||||||
|
content,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
files
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write MDX files to the output directory.
|
||||||
|
pub fn write_mdx_files(files: &[MdxFile], output_dir: &Path) -> std::io::Result<()> {
|
||||||
|
for file in files {
|
||||||
|
let path = output_dir.join(&file.path);
|
||||||
|
if let Some(parent) = path.parent() {
|
||||||
|
std::fs::create_dir_all(parent)?;
|
||||||
|
}
|
||||||
|
std::fs::write(&path, &file.content)?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn resolve_module_path(krate: &Crate, id: &Id) -> String {
|
||||||
|
if let Some(summary) = krate.paths.get(id) {
|
||||||
|
let path = &summary.path;
|
||||||
|
if path.len() > 1 {
|
||||||
|
path[..path.len() - 1].join("::")
|
||||||
|
} else if !path.is_empty() {
|
||||||
|
path[0].clone()
|
||||||
|
} else {
|
||||||
|
String::new()
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
String::new()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn item_kind_label(inner: &ItemEnum) -> Option<&'static str> {
|
||||||
|
match inner {
|
||||||
|
ItemEnum::Module(_) => Some("Modules"),
|
||||||
|
ItemEnum::Struct(_) => Some("Structs"),
|
||||||
|
ItemEnum::Enum(_) => Some("Enums"),
|
||||||
|
ItemEnum::Function(_) => Some("Functions"),
|
||||||
|
ItemEnum::Trait(_) => Some("Traits"),
|
||||||
|
ItemEnum::TypeAlias(_) => Some("Type Aliases"),
|
||||||
|
ItemEnum::Constant { .. } => Some("Constants"),
|
||||||
|
ItemEnum::Static(_) => Some("Statics"),
|
||||||
|
ItemEnum::Macro(_) => Some("Macros"),
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn render_module(module_path: &str, items: &[(&Item, &str)], krate: &Crate) -> String {
|
||||||
|
let mut out = String::new();
|
||||||
|
|
||||||
|
let title = if module_path.is_empty() {
|
||||||
|
krate
|
||||||
|
.index
|
||||||
|
.get(&krate.root)
|
||||||
|
.and_then(|i| i.name.clone())
|
||||||
|
.unwrap_or_else(|| "crate".to_string())
|
||||||
|
} else {
|
||||||
|
module_path.to_string()
|
||||||
|
};
|
||||||
|
|
||||||
|
let description = if module_path.is_empty() {
|
||||||
|
krate
|
||||||
|
.index
|
||||||
|
.get(&krate.root)
|
||||||
|
.and_then(|i| i.docs.as_ref())
|
||||||
|
.map(|d| first_sentence(d))
|
||||||
|
.unwrap_or_default()
|
||||||
|
} else {
|
||||||
|
items
|
||||||
|
.iter()
|
||||||
|
.find(|(item, kind)| {
|
||||||
|
*kind == "Modules"
|
||||||
|
&& item.name.as_deref() == module_path.split("::").last()
|
||||||
|
})
|
||||||
|
.and_then(|(item, _)| item.docs.as_ref())
|
||||||
|
.map(|d| first_sentence(d))
|
||||||
|
.unwrap_or_default()
|
||||||
|
};
|
||||||
|
|
||||||
|
out.push_str(&format!(
|
||||||
|
"---\ntitle: \"{title}\"\ndescription: \"{}\"\n---\n\n",
|
||||||
|
description.replace('"', "\\\"")
|
||||||
|
));
|
||||||
|
|
||||||
|
let mut by_kind: HashMap<&str, Vec<&Item>> = HashMap::new();
|
||||||
|
for (item, kind) in items {
|
||||||
|
by_kind.entry(kind).or_default().push(item);
|
||||||
|
}
|
||||||
|
|
||||||
|
let kind_order = [
|
||||||
|
"Modules", "Structs", "Enums", "Traits", "Functions",
|
||||||
|
"Type Aliases", "Constants", "Statics", "Macros",
|
||||||
|
];
|
||||||
|
|
||||||
|
for kind in &kind_order {
|
||||||
|
if let Some(kind_items) = by_kind.get(kind) {
|
||||||
|
let mut sorted: Vec<_> = kind_items.iter().collect();
|
||||||
|
sorted.sort_by_key(|item| &item.name);
|
||||||
|
|
||||||
|
out.push_str(&format!("## {kind}\n\n"));
|
||||||
|
|
||||||
|
for item in sorted {
|
||||||
|
render_item(&mut out, item, krate);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
out
|
||||||
|
}
|
||||||
|
|
||||||
|
fn render_item(out: &mut String, item: &Item, krate: &Crate) {
|
||||||
|
let name = item.name.as_deref().unwrap_or("_");
|
||||||
|
|
||||||
|
out.push_str(&format!("### `{name}`\n\n"));
|
||||||
|
|
||||||
|
if let Some(sig) = render_signature(item, krate) {
|
||||||
|
out.push_str("```rust\n");
|
||||||
|
out.push_str(&sig);
|
||||||
|
out.push('\n');
|
||||||
|
out.push_str("```\n\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(ref docs) = item.docs {
|
||||||
|
out.push_str(docs);
|
||||||
|
out.push_str("\n\n");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn render_signature(item: &Item, krate: &Crate) -> Option<String> {
|
||||||
|
let name = item.name.as_deref()?;
|
||||||
|
match &item.inner {
|
||||||
|
ItemEnum::Function(f) => {
|
||||||
|
let mut sig = String::new();
|
||||||
|
if f.header.is_const {
|
||||||
|
sig.push_str("const ");
|
||||||
|
}
|
||||||
|
if f.header.is_async {
|
||||||
|
sig.push_str("async ");
|
||||||
|
}
|
||||||
|
if f.header.is_unsafe {
|
||||||
|
sig.push_str("unsafe ");
|
||||||
|
}
|
||||||
|
sig.push_str("fn ");
|
||||||
|
sig.push_str(name);
|
||||||
|
if !f.generics.params.is_empty() {
|
||||||
|
sig.push('<');
|
||||||
|
let params: Vec<_> = f.generics.params.iter().map(|p| p.name.clone()).collect();
|
||||||
|
sig.push_str(¶ms.join(", "));
|
||||||
|
sig.push('>');
|
||||||
|
}
|
||||||
|
sig.push('(');
|
||||||
|
let params: Vec<_> = f
|
||||||
|
.sig
|
||||||
|
.inputs
|
||||||
|
.iter()
|
||||||
|
.map(|(pname, ty)| format!("{pname}: {}", render_type(ty, krate)))
|
||||||
|
.collect();
|
||||||
|
sig.push_str(¶ms.join(", "));
|
||||||
|
sig.push(')');
|
||||||
|
if let Some(ref output) = f.sig.output {
|
||||||
|
sig.push_str(&format!(" -> {}", render_type(output, krate)));
|
||||||
|
}
|
||||||
|
Some(sig)
|
||||||
|
}
|
||||||
|
ItemEnum::Struct(s) => {
|
||||||
|
let mut sig = String::from("pub struct ");
|
||||||
|
sig.push_str(name);
|
||||||
|
if !s.generics.params.is_empty() {
|
||||||
|
sig.push('<');
|
||||||
|
let params: Vec<_> = s.generics.params.iter().map(|p| p.name.clone()).collect();
|
||||||
|
sig.push_str(¶ms.join(", "));
|
||||||
|
sig.push('>');
|
||||||
|
}
|
||||||
|
match &s.kind {
|
||||||
|
rustdoc_types::StructKind::Unit => sig.push(';'),
|
||||||
|
rustdoc_types::StructKind::Tuple(_) => sig.push_str("(...)"),
|
||||||
|
rustdoc_types::StructKind::Plain { fields, .. } => {
|
||||||
|
sig.push_str(" { ");
|
||||||
|
let field_names: Vec<_> = fields
|
||||||
|
.iter()
|
||||||
|
.filter_map(|fid| krate.index.get(fid))
|
||||||
|
.filter_map(|f| f.name.as_deref())
|
||||||
|
.collect();
|
||||||
|
sig.push_str(&field_names.join(", "));
|
||||||
|
sig.push_str(" }");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Some(sig)
|
||||||
|
}
|
||||||
|
ItemEnum::Enum(e) => {
|
||||||
|
let mut sig = String::from("pub enum ");
|
||||||
|
sig.push_str(name);
|
||||||
|
if !e.generics.params.is_empty() {
|
||||||
|
sig.push('<');
|
||||||
|
let params: Vec<_> = e.generics.params.iter().map(|p| p.name.clone()).collect();
|
||||||
|
sig.push_str(¶ms.join(", "));
|
||||||
|
sig.push('>');
|
||||||
|
}
|
||||||
|
sig.push_str(" { ");
|
||||||
|
let variant_names: Vec<_> = e
|
||||||
|
.variants
|
||||||
|
.iter()
|
||||||
|
.filter_map(|vid| krate.index.get(vid))
|
||||||
|
.filter_map(|v| v.name.as_deref())
|
||||||
|
.collect();
|
||||||
|
sig.push_str(&variant_names.join(", "));
|
||||||
|
sig.push_str(" }");
|
||||||
|
Some(sig)
|
||||||
|
}
|
||||||
|
ItemEnum::Trait(t) => {
|
||||||
|
let mut sig = String::from("pub trait ");
|
||||||
|
sig.push_str(name);
|
||||||
|
if !t.generics.params.is_empty() {
|
||||||
|
sig.push('<');
|
||||||
|
let params: Vec<_> = t.generics.params.iter().map(|p| p.name.clone()).collect();
|
||||||
|
sig.push_str(¶ms.join(", "));
|
||||||
|
sig.push('>');
|
||||||
|
}
|
||||||
|
Some(sig)
|
||||||
|
}
|
||||||
|
ItemEnum::TypeAlias(ta) => {
|
||||||
|
Some(format!("pub type {name} = {}", render_type(&ta.type_, krate)))
|
||||||
|
}
|
||||||
|
ItemEnum::Constant { type_, const_: c } => {
|
||||||
|
Some(format!(
|
||||||
|
"pub const {name}: {} = {}",
|
||||||
|
render_type(type_, krate),
|
||||||
|
c.value.as_deref().unwrap_or("...")
|
||||||
|
))
|
||||||
|
}
|
||||||
|
ItemEnum::Macro(_) => Some(format!("macro_rules! {name} {{ ... }}")),
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn render_type(ty: &Type, krate: &Crate) -> String {
|
||||||
|
match ty {
|
||||||
|
Type::ResolvedPath(p) => {
|
||||||
|
let mut s = p.path.clone();
|
||||||
|
if let Some(ref args) = p.args {
|
||||||
|
if let rustdoc_types::GenericArgs::AngleBracketed { args, .. } = args.as_ref() {
|
||||||
|
if !args.is_empty() {
|
||||||
|
s.push('<');
|
||||||
|
let rendered: Vec<_> = args
|
||||||
|
.iter()
|
||||||
|
.map(|a| match a {
|
||||||
|
rustdoc_types::GenericArg::Type(t) => render_type(t, krate),
|
||||||
|
rustdoc_types::GenericArg::Lifetime(l) => l.clone(),
|
||||||
|
rustdoc_types::GenericArg::Const(c) => {
|
||||||
|
c.value.clone().unwrap_or_else(|| c.expr.clone())
|
||||||
|
}
|
||||||
|
rustdoc_types::GenericArg::Infer => "_".to_string(),
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
s.push_str(&rendered.join(", "));
|
||||||
|
s.push('>');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s
|
||||||
|
}
|
||||||
|
Type::Generic(name) => name.clone(),
|
||||||
|
Type::Primitive(name) => name.clone(),
|
||||||
|
Type::BorrowedRef { lifetime, is_mutable, type_ } => {
|
||||||
|
let mut s = String::from("&");
|
||||||
|
if let Some(lt) = lifetime {
|
||||||
|
s.push_str(lt);
|
||||||
|
s.push(' ');
|
||||||
|
}
|
||||||
|
if *is_mutable {
|
||||||
|
s.push_str("mut ");
|
||||||
|
}
|
||||||
|
s.push_str(&render_type(type_, krate));
|
||||||
|
s
|
||||||
|
}
|
||||||
|
Type::Tuple(types) => {
|
||||||
|
let inner: Vec<_> = types.iter().map(|t| render_type(t, krate)).collect();
|
||||||
|
format!("({})", inner.join(", "))
|
||||||
|
}
|
||||||
|
Type::Slice(ty) => format!("[{}]", render_type(ty, krate)),
|
||||||
|
Type::Array { type_, len } => format!("[{}; {}]", render_type(type_, krate), len),
|
||||||
|
Type::RawPointer { is_mutable, type_ } => {
|
||||||
|
if *is_mutable {
|
||||||
|
format!("*mut {}", render_type(type_, krate))
|
||||||
|
} else {
|
||||||
|
format!("*const {}", render_type(type_, krate))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Type::ImplTrait(bounds) => {
|
||||||
|
let rendered: Vec<_> = bounds
|
||||||
|
.iter()
|
||||||
|
.filter_map(|b| match b {
|
||||||
|
rustdoc_types::GenericBound::TraitBound { trait_, .. } => {
|
||||||
|
Some(trait_.path.clone())
|
||||||
|
}
|
||||||
|
_ => None,
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
format!("impl {}", rendered.join(" + "))
|
||||||
|
}
|
||||||
|
Type::QualifiedPath { name, self_type, trait_, .. } => {
|
||||||
|
let self_str = render_type(self_type, krate);
|
||||||
|
if let Some(t) = trait_ {
|
||||||
|
format!("<{self_str} as {}>::{name}", t.path)
|
||||||
|
} else {
|
||||||
|
format!("{self_str}::{name}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Type::DynTrait(dt) => {
|
||||||
|
let traits: Vec<_> = dt.traits.iter().map(|pb| pb.trait_.path.clone()).collect();
|
||||||
|
format!("dyn {}", traits.join(" + "))
|
||||||
|
}
|
||||||
|
Type::FunctionPointer(fp) => {
|
||||||
|
let params: Vec<_> = fp
|
||||||
|
.sig
|
||||||
|
.inputs
|
||||||
|
.iter()
|
||||||
|
.map(|(_, t)| render_type(t, krate))
|
||||||
|
.collect();
|
||||||
|
let ret = fp
|
||||||
|
.sig
|
||||||
|
.output
|
||||||
|
.as_ref()
|
||||||
|
.map(|t| format!(" -> {}", render_type(t, krate)))
|
||||||
|
.unwrap_or_default();
|
||||||
|
format!("fn({}){ret}", params.join(", "))
|
||||||
|
}
|
||||||
|
Type::Pat { type_, .. } => render_type(type_, krate),
|
||||||
|
Type::Infer => "_".to_string(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn first_sentence(docs: &str) -> String {
|
||||||
|
docs.split('\n')
|
||||||
|
.next()
|
||||||
|
.unwrap_or("")
|
||||||
|
.trim()
|
||||||
|
.trim_end_matches('.')
|
||||||
|
.to_string()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use rustdoc_types::*;
|
||||||
|
|
||||||
|
fn empty_crate() -> Crate {
|
||||||
|
Crate {
|
||||||
|
root: Id(0),
|
||||||
|
crate_version: Some("0.1.0".to_string()),
|
||||||
|
includes_private: false,
|
||||||
|
index: HashMap::new(),
|
||||||
|
paths: HashMap::new(),
|
||||||
|
external_crates: HashMap::new(),
|
||||||
|
format_version: 38,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn make_function(name: &str, params: Vec<(&str, Type)>, output: Option<Type>) -> Item {
|
||||||
|
Item {
|
||||||
|
id: Id(1),
|
||||||
|
crate_id: 0,
|
||||||
|
name: Some(name.to_string()),
|
||||||
|
span: None,
|
||||||
|
visibility: Visibility::Public,
|
||||||
|
docs: Some(format!("Documentation for {name}.")),
|
||||||
|
links: HashMap::new(),
|
||||||
|
attrs: vec![],
|
||||||
|
deprecation: None,
|
||||||
|
inner: ItemEnum::Function(Function {
|
||||||
|
sig: FunctionSignature {
|
||||||
|
inputs: params.into_iter().map(|(n, t)| (n.to_string(), t)).collect(),
|
||||||
|
output,
|
||||||
|
is_c_variadic: false,
|
||||||
|
},
|
||||||
|
generics: Generics { params: vec![], where_predicates: vec![] },
|
||||||
|
header: FunctionHeader {
|
||||||
|
is_const: false,
|
||||||
|
is_unsafe: false,
|
||||||
|
is_async: false,
|
||||||
|
abi: Abi::Rust,
|
||||||
|
},
|
||||||
|
has_body: true,
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn make_struct(name: &str) -> Item {
|
||||||
|
Item {
|
||||||
|
id: Id(2),
|
||||||
|
crate_id: 0,
|
||||||
|
name: Some(name.to_string()),
|
||||||
|
span: None,
|
||||||
|
visibility: Visibility::Public,
|
||||||
|
docs: Some(format!("A {name} struct.")),
|
||||||
|
links: HashMap::new(),
|
||||||
|
attrs: vec![],
|
||||||
|
deprecation: None,
|
||||||
|
inner: ItemEnum::Struct(Struct {
|
||||||
|
kind: StructKind::Unit,
|
||||||
|
generics: Generics { params: vec![], where_predicates: vec![] },
|
||||||
|
impls: vec![],
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn make_enum(name: &str) -> Item {
|
||||||
|
Item {
|
||||||
|
id: Id(3),
|
||||||
|
crate_id: 0,
|
||||||
|
name: Some(name.to_string()),
|
||||||
|
span: None,
|
||||||
|
visibility: Visibility::Public,
|
||||||
|
docs: Some(format!("The {name} enum.")),
|
||||||
|
links: HashMap::new(),
|
||||||
|
attrs: vec![],
|
||||||
|
deprecation: None,
|
||||||
|
inner: ItemEnum::Enum(Enum {
|
||||||
|
generics: Generics { params: vec![], where_predicates: vec![] },
|
||||||
|
variants: vec![],
|
||||||
|
has_stripped_variants: false,
|
||||||
|
impls: vec![],
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn make_trait(name: &str) -> Item {
|
||||||
|
Item {
|
||||||
|
id: Id(4),
|
||||||
|
crate_id: 0,
|
||||||
|
name: Some(name.to_string()),
|
||||||
|
span: None,
|
||||||
|
visibility: Visibility::Public,
|
||||||
|
docs: Some(format!("The {name} trait.")),
|
||||||
|
links: HashMap::new(),
|
||||||
|
attrs: vec![],
|
||||||
|
deprecation: None,
|
||||||
|
inner: ItemEnum::Trait(Trait {
|
||||||
|
is_auto: false,
|
||||||
|
is_unsafe: false,
|
||||||
|
is_dyn_compatible: true,
|
||||||
|
items: vec![],
|
||||||
|
generics: Generics { params: vec![], where_predicates: vec![] },
|
||||||
|
bounds: vec![],
|
||||||
|
implementations: vec![],
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn first_sentence_basic() {
|
||||||
|
assert_eq!(first_sentence("Hello world."), "Hello world");
|
||||||
|
assert_eq!(first_sentence("First line.\nSecond line."), "First line");
|
||||||
|
assert_eq!(first_sentence(""), "");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_primitives() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
assert_eq!(render_type(&Type::Primitive("u32".into()), &krate), "u32");
|
||||||
|
assert_eq!(render_type(&Type::Primitive("bool".into()), &krate), "bool");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_generic() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
assert_eq!(render_type(&Type::Generic("T".into()), &krate), "T");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_reference() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::BorrowedRef {
|
||||||
|
lifetime: Some("'a".into()),
|
||||||
|
is_mutable: false,
|
||||||
|
type_: Box::new(Type::Primitive("str".into())),
|
||||||
|
};
|
||||||
|
assert_eq!(render_type(&ty, &krate), "&'a str");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_mut_reference() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::BorrowedRef {
|
||||||
|
lifetime: None,
|
||||||
|
is_mutable: true,
|
||||||
|
type_: Box::new(Type::Primitive("u8".into())),
|
||||||
|
};
|
||||||
|
assert_eq!(render_type(&ty, &krate), "&mut u8");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_tuple() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::Tuple(vec![Type::Primitive("u32".into()), Type::Primitive("String".into())]);
|
||||||
|
assert_eq!(render_type(&ty, &krate), "(u32, String)");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_slice() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
assert_eq!(render_type(&Type::Slice(Box::new(Type::Primitive("u8".into()))), &krate), "[u8]");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_array() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::Array { type_: Box::new(Type::Primitive("u8".into())), len: "32".into() };
|
||||||
|
assert_eq!(render_type(&ty, &krate), "[u8; 32]");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_raw_pointer() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::RawPointer { is_mutable: true, type_: Box::new(Type::Primitive("u8".into())) };
|
||||||
|
assert_eq!(render_type(&ty, &krate), "*mut u8");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_function_signature() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let item = make_function("add", vec![("a", Type::Primitive("u32".into())), ("b", Type::Primitive("u32".into()))], Some(Type::Primitive("u32".into())));
|
||||||
|
assert_eq!(render_signature(&item, &krate).unwrap(), "fn add(a: u32, b: u32) -> u32");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_function_no_return() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let item = make_function("do_thing", vec![], None);
|
||||||
|
assert_eq!(render_signature(&item, &krate).unwrap(), "fn do_thing()");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_struct_signature() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
assert_eq!(render_signature(&make_struct("MyStruct"), &krate).unwrap(), "pub struct MyStruct;");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_enum_signature() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
assert_eq!(render_signature(&make_enum("Color"), &krate).unwrap(), "pub enum Color { }");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_trait_signature() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
assert_eq!(render_signature(&make_trait("Drawable"), &krate).unwrap(), "pub trait Drawable");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn item_kind_labels() {
|
||||||
|
assert_eq!(item_kind_label(&ItemEnum::Module(Module { is_crate: false, items: vec![], is_stripped: false })), Some("Modules"));
|
||||||
|
assert_eq!(item_kind_label(&ItemEnum::Struct(Struct { kind: StructKind::Unit, generics: Generics { params: vec![], where_predicates: vec![] }, impls: vec![] })), Some("Structs"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn transform_empty_crate() {
|
||||||
|
assert!(transform_to_mdx(&empty_crate()).is_empty());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn transform_crate_with_function() {
|
||||||
|
let mut krate = empty_crate();
|
||||||
|
let func = make_function("hello", vec![], None);
|
||||||
|
let id = Id(1);
|
||||||
|
krate.index.insert(id.clone(), func);
|
||||||
|
krate.paths.insert(id, ItemSummary { crate_id: 0, path: vec!["my_crate".into(), "hello".into()], kind: ItemKind::Function });
|
||||||
|
|
||||||
|
let files = transform_to_mdx(&krate);
|
||||||
|
assert_eq!(files.len(), 1);
|
||||||
|
assert_eq!(files[0].path, "my_crate.mdx");
|
||||||
|
assert!(files[0].content.contains("### `hello`"));
|
||||||
|
assert!(files[0].content.contains("fn hello()"));
|
||||||
|
assert!(files[0].content.contains("Documentation for hello."));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn transform_crate_with_multiple_kinds() {
|
||||||
|
let mut krate = empty_crate();
|
||||||
|
let func = make_function("do_thing", vec![], None);
|
||||||
|
krate.index.insert(Id(1), func);
|
||||||
|
krate.paths.insert(Id(1), ItemSummary { crate_id: 0, path: vec!["mc".into(), "do_thing".into()], kind: ItemKind::Function });
|
||||||
|
|
||||||
|
let st = make_struct("Widget");
|
||||||
|
krate.index.insert(Id(2), st);
|
||||||
|
krate.paths.insert(Id(2), ItemSummary { crate_id: 0, path: vec!["mc".into(), "Widget".into()], kind: ItemKind::Struct });
|
||||||
|
|
||||||
|
let files = transform_to_mdx(&krate);
|
||||||
|
assert_eq!(files.len(), 1);
|
||||||
|
let content = &files[0].content;
|
||||||
|
assert!(content.find("## Structs").unwrap() < content.find("## Functions").unwrap());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn frontmatter_escapes_quotes() {
|
||||||
|
// Put a module with quoted docs as the root so it becomes the frontmatter description.
|
||||||
|
let mut krate = empty_crate();
|
||||||
|
let root_module = Item {
|
||||||
|
id: Id(0),
|
||||||
|
crate_id: 0,
|
||||||
|
name: Some("mylib".into()),
|
||||||
|
span: None,
|
||||||
|
visibility: Visibility::Public,
|
||||||
|
docs: Some("A \"quoted\" crate.".into()),
|
||||||
|
links: HashMap::new(),
|
||||||
|
attrs: vec![],
|
||||||
|
deprecation: None,
|
||||||
|
inner: ItemEnum::Module(Module { is_crate: true, items: vec![Id(1)], is_stripped: false }),
|
||||||
|
};
|
||||||
|
krate.root = Id(0);
|
||||||
|
krate.index.insert(Id(0), root_module);
|
||||||
|
|
||||||
|
// Add a function so the module generates a file.
|
||||||
|
let func = make_function("f", vec![], None);
|
||||||
|
krate.index.insert(Id(1), func);
|
||||||
|
krate.paths.insert(Id(1), ItemSummary { crate_id: 0, path: vec!["f".into()], kind: ItemKind::Function });
|
||||||
|
|
||||||
|
let files = transform_to_mdx(&krate);
|
||||||
|
// The root module's description in frontmatter should have escaped quotes.
|
||||||
|
let index = files.iter().find(|f| f.path == "index.mdx").unwrap();
|
||||||
|
assert!(index.content.contains("\\\"quoted\\\""), "content: {}", index.content);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_resolved_path_with_args() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::ResolvedPath(rustdoc_types::Path {
|
||||||
|
path: "Option".into(),
|
||||||
|
id: Id(99),
|
||||||
|
args: Some(Box::new(rustdoc_types::GenericArgs::AngleBracketed {
|
||||||
|
args: vec![rustdoc_types::GenericArg::Type(Type::Primitive("u32".into()))],
|
||||||
|
constraints: vec![],
|
||||||
|
})),
|
||||||
|
});
|
||||||
|
assert_eq!(render_type(&ty, &krate), "Option<u32>");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_impl_trait() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::ImplTrait(vec![
|
||||||
|
rustdoc_types::GenericBound::TraitBound {
|
||||||
|
trait_: rustdoc_types::Path { path: "Display".into(), id: Id(99), args: None },
|
||||||
|
generic_params: vec![],
|
||||||
|
modifier: rustdoc_types::TraitBoundModifier::None,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
assert_eq!(render_type(&ty, &krate), "impl Display");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_dyn_trait() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::DynTrait(rustdoc_types::DynTrait {
|
||||||
|
traits: vec![rustdoc_types::PolyTrait {
|
||||||
|
trait_: rustdoc_types::Path { path: "Error".into(), id: Id(99), args: None },
|
||||||
|
generic_params: vec![],
|
||||||
|
}],
|
||||||
|
lifetime: None,
|
||||||
|
});
|
||||||
|
assert_eq!(render_type(&ty, &krate), "dyn Error");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_function_pointer() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::FunctionPointer(Box::new(rustdoc_types::FunctionPointer {
|
||||||
|
sig: FunctionSignature {
|
||||||
|
inputs: vec![("x".into(), Type::Primitive("u32".into()))],
|
||||||
|
output: Some(Type::Primitive("bool".into())),
|
||||||
|
is_c_variadic: false,
|
||||||
|
},
|
||||||
|
generic_params: vec![],
|
||||||
|
header: FunctionHeader { is_const: false, is_unsafe: false, is_async: false, abi: Abi::Rust },
|
||||||
|
}));
|
||||||
|
assert_eq!(render_type(&ty, &krate), "fn(u32) -> bool");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_const_pointer() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::RawPointer { is_mutable: false, type_: Box::new(Type::Primitive("u8".into())) };
|
||||||
|
assert_eq!(render_type(&ty, &krate), "*const u8");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_infer() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
assert_eq!(render_type(&Type::Infer, &krate), "_");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_qualified_path() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let ty = Type::QualifiedPath {
|
||||||
|
name: "Item".into(),
|
||||||
|
args: Box::new(rustdoc_types::GenericArgs::AngleBracketed { args: vec![], constraints: vec![] }),
|
||||||
|
self_type: Box::new(Type::Generic("T".into())),
|
||||||
|
trait_: Some(rustdoc_types::Path { path: "Iterator".into(), id: Id(99), args: None }),
|
||||||
|
};
|
||||||
|
assert_eq!(render_type(&ty, &krate), "<T as Iterator>::Item");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn item_kind_label_all_variants() {
|
||||||
|
// Test the remaining untested variants
|
||||||
|
assert_eq!(item_kind_label(&ItemEnum::Enum(Enum {
|
||||||
|
generics: Generics { params: vec![], where_predicates: vec![] },
|
||||||
|
variants: vec![], has_stripped_variants: false, impls: vec![],
|
||||||
|
})), Some("Enums"));
|
||||||
|
assert_eq!(item_kind_label(&ItemEnum::Trait(Trait {
|
||||||
|
is_auto: false, is_unsafe: false, is_dyn_compatible: true,
|
||||||
|
items: vec![], generics: Generics { params: vec![], where_predicates: vec![] },
|
||||||
|
bounds: vec![], implementations: vec![],
|
||||||
|
})), Some("Traits"));
|
||||||
|
assert_eq!(item_kind_label(&ItemEnum::Macro("".into())), Some("Macros"));
|
||||||
|
assert_eq!(item_kind_label(&ItemEnum::Static(rustdoc_types::Static {
|
||||||
|
type_: Type::Primitive("u32".into()),
|
||||||
|
is_mutable: false,
|
||||||
|
is_unsafe: false,
|
||||||
|
expr: String::new(),
|
||||||
|
})), Some("Statics"));
|
||||||
|
// Impl blocks should be skipped
|
||||||
|
assert_eq!(item_kind_label(&ItemEnum::Impl(rustdoc_types::Impl {
|
||||||
|
is_unsafe: false, generics: Generics { params: vec![], where_predicates: vec![] },
|
||||||
|
provided_trait_methods: vec![], trait_: None, for_: Type::Primitive("u32".into()),
|
||||||
|
items: vec![], is_negative: false, is_synthetic: false,
|
||||||
|
blanket_impl: None,
|
||||||
|
})), None);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_constant_signature() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let item = Item {
|
||||||
|
id: Id(5), crate_id: 0,
|
||||||
|
name: Some("MAX_SIZE".into()), span: None,
|
||||||
|
visibility: Visibility::Public, docs: None,
|
||||||
|
links: HashMap::new(), attrs: vec![], deprecation: None,
|
||||||
|
inner: ItemEnum::Constant {
|
||||||
|
type_: Type::Primitive("usize".into()),
|
||||||
|
const_: rustdoc_types::Constant { expr: "1024".into(), value: Some("1024".into()), is_literal: true },
|
||||||
|
},
|
||||||
|
};
|
||||||
|
assert_eq!(render_signature(&item, &krate).unwrap(), "pub const MAX_SIZE: usize = 1024");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_type_alias_signature() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let item = Item {
|
||||||
|
id: Id(6), crate_id: 0,
|
||||||
|
name: Some("Result".into()), span: None,
|
||||||
|
visibility: Visibility::Public, docs: None,
|
||||||
|
links: HashMap::new(), attrs: vec![], deprecation: None,
|
||||||
|
inner: ItemEnum::TypeAlias(rustdoc_types::TypeAlias {
|
||||||
|
type_: Type::Primitive("u32".into()),
|
||||||
|
generics: Generics { params: vec![], where_predicates: vec![] },
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
assert_eq!(render_signature(&item, &krate).unwrap(), "pub type Result = u32");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_macro_signature() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let item = Item {
|
||||||
|
id: Id(7), crate_id: 0,
|
||||||
|
name: Some("my_macro".into()), span: None,
|
||||||
|
visibility: Visibility::Public, docs: None,
|
||||||
|
links: HashMap::new(), attrs: vec![], deprecation: None,
|
||||||
|
inner: ItemEnum::Macro("macro body".into()),
|
||||||
|
};
|
||||||
|
assert_eq!(render_signature(&item, &krate).unwrap(), "macro_rules! my_macro { ... }");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn render_item_without_docs() {
|
||||||
|
let krate = empty_crate();
|
||||||
|
let mut item = make_struct("NoDocs");
|
||||||
|
item.docs = None;
|
||||||
|
let mut out = String::new();
|
||||||
|
render_item(&mut out, &item, &krate);
|
||||||
|
assert!(out.contains("### `NoDocs`"));
|
||||||
|
assert!(out.contains("pub struct NoDocs;"));
|
||||||
|
// Should not have trailing doc content
|
||||||
|
assert!(!out.contains("A NoDocs struct."));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn write_mdx_files_creates_directories() {
|
||||||
|
let tmp = tempfile::tempdir().unwrap();
|
||||||
|
let files = vec![MdxFile { path: "nested/module.mdx".into(), content: "# Test\n".into() }];
|
||||||
|
write_mdx_files(&files, tmp.path()).unwrap();
|
||||||
|
assert!(tmp.path().join("nested/module.mdx").exists());
|
||||||
|
assert_eq!(std::fs::read_to_string(tmp.path().join("nested/module.mdx")).unwrap(), "# Test\n");
|
||||||
|
}
|
||||||
|
}
|
||||||
183
wfe-rustlang/src/rustup/config.rs
Normal file
183
wfe-rustlang/src/rustup/config.rs
Normal file
@@ -0,0 +1,183 @@
|
|||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
/// Which rustup operation to perform.
|
||||||
|
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
|
||||||
|
#[serde(rename_all = "kebab-case")]
|
||||||
|
pub enum RustupCommand {
|
||||||
|
/// Install Rust via rustup-init.
|
||||||
|
Install,
|
||||||
|
/// Install a toolchain (`rustup toolchain install`).
|
||||||
|
ToolchainInstall,
|
||||||
|
/// Add a component (`rustup component add`).
|
||||||
|
ComponentAdd,
|
||||||
|
/// Add a compilation target (`rustup target add`).
|
||||||
|
TargetAdd,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl RustupCommand {
|
||||||
|
pub fn as_str(&self) -> &'static str {
|
||||||
|
match self {
|
||||||
|
Self::Install => "install",
|
||||||
|
Self::ToolchainInstall => "toolchain-install",
|
||||||
|
Self::ComponentAdd => "component-add",
|
||||||
|
Self::TargetAdd => "target-add",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Configuration for rustup step types.
|
||||||
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||||
|
pub struct RustupConfig {
|
||||||
|
pub command: RustupCommand,
|
||||||
|
/// Toolchain to install or scope components/targets to (e.g. "nightly", "1.78.0").
|
||||||
|
#[serde(default)]
|
||||||
|
pub toolchain: Option<String>,
|
||||||
|
/// Components to add (e.g. ["clippy", "rustfmt", "rust-src"]).
|
||||||
|
#[serde(default)]
|
||||||
|
pub components: Vec<String>,
|
||||||
|
/// Compilation targets to add (e.g. ["wasm32-unknown-unknown"]).
|
||||||
|
#[serde(default)]
|
||||||
|
pub targets: Vec<String>,
|
||||||
|
/// Rustup profile for initial install: "minimal", "default", or "complete".
|
||||||
|
#[serde(default)]
|
||||||
|
pub profile: Option<String>,
|
||||||
|
/// Default toolchain to set during install.
|
||||||
|
#[serde(default)]
|
||||||
|
pub default_toolchain: Option<String>,
|
||||||
|
/// Additional arguments appended to the command.
|
||||||
|
#[serde(default)]
|
||||||
|
pub extra_args: Vec<String>,
|
||||||
|
/// Execution timeout in milliseconds.
|
||||||
|
#[serde(default)]
|
||||||
|
pub timeout_ms: Option<u64>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use pretty_assertions::assert_eq;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn command_as_str() {
|
||||||
|
assert_eq!(RustupCommand::Install.as_str(), "install");
|
||||||
|
assert_eq!(RustupCommand::ToolchainInstall.as_str(), "toolchain-install");
|
||||||
|
assert_eq!(RustupCommand::ComponentAdd.as_str(), "component-add");
|
||||||
|
assert_eq!(RustupCommand::TargetAdd.as_str(), "target-add");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn command_serde_kebab_case() {
|
||||||
|
let json = r#""toolchain-install""#;
|
||||||
|
let cmd: RustupCommand = serde_json::from_str(json).unwrap();
|
||||||
|
assert_eq!(cmd, RustupCommand::ToolchainInstall);
|
||||||
|
|
||||||
|
let serialized = serde_json::to_string(&RustupCommand::ComponentAdd).unwrap();
|
||||||
|
assert_eq!(serialized, r#""component-add""#);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn serde_round_trip_install() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::Install,
|
||||||
|
toolchain: None,
|
||||||
|
components: vec![],
|
||||||
|
targets: vec![],
|
||||||
|
profile: Some("minimal".to_string()),
|
||||||
|
default_toolchain: Some("stable".to_string()),
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: Some(300_000),
|
||||||
|
};
|
||||||
|
let json = serde_json::to_string(&config).unwrap();
|
||||||
|
let de: RustupConfig = serde_json::from_str(&json).unwrap();
|
||||||
|
assert_eq!(de.command, RustupCommand::Install);
|
||||||
|
assert_eq!(de.profile, Some("minimal".to_string()));
|
||||||
|
assert_eq!(de.default_toolchain, Some("stable".to_string()));
|
||||||
|
assert_eq!(de.timeout_ms, Some(300_000));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn serde_round_trip_toolchain_install() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::ToolchainInstall,
|
||||||
|
toolchain: Some("nightly-2024-06-01".to_string()),
|
||||||
|
components: vec![],
|
||||||
|
targets: vec![],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let json = serde_json::to_string(&config).unwrap();
|
||||||
|
let de: RustupConfig = serde_json::from_str(&json).unwrap();
|
||||||
|
assert_eq!(de.command, RustupCommand::ToolchainInstall);
|
||||||
|
assert_eq!(de.toolchain, Some("nightly-2024-06-01".to_string()));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn serde_round_trip_component_add() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::ComponentAdd,
|
||||||
|
toolchain: Some("nightly".to_string()),
|
||||||
|
components: vec!["clippy".to_string(), "rustfmt".to_string(), "rust-src".to_string()],
|
||||||
|
targets: vec![],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let json = serde_json::to_string(&config).unwrap();
|
||||||
|
let de: RustupConfig = serde_json::from_str(&json).unwrap();
|
||||||
|
assert_eq!(de.command, RustupCommand::ComponentAdd);
|
||||||
|
assert_eq!(de.components, vec!["clippy", "rustfmt", "rust-src"]);
|
||||||
|
assert_eq!(de.toolchain, Some("nightly".to_string()));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn serde_round_trip_target_add() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::TargetAdd,
|
||||||
|
toolchain: Some("stable".to_string()),
|
||||||
|
components: vec![],
|
||||||
|
targets: vec!["wasm32-unknown-unknown".to_string(), "aarch64-linux-android".to_string()],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let json = serde_json::to_string(&config).unwrap();
|
||||||
|
let de: RustupConfig = serde_json::from_str(&json).unwrap();
|
||||||
|
assert_eq!(de.command, RustupCommand::TargetAdd);
|
||||||
|
assert_eq!(de.targets, vec!["wasm32-unknown-unknown", "aarch64-linux-android"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn config_defaults() {
|
||||||
|
let json = r#"{"command": "install"}"#;
|
||||||
|
let config: RustupConfig = serde_json::from_str(json).unwrap();
|
||||||
|
assert_eq!(config.command, RustupCommand::Install);
|
||||||
|
assert!(config.toolchain.is_none());
|
||||||
|
assert!(config.components.is_empty());
|
||||||
|
assert!(config.targets.is_empty());
|
||||||
|
assert!(config.profile.is_none());
|
||||||
|
assert!(config.default_toolchain.is_none());
|
||||||
|
assert!(config.extra_args.is_empty());
|
||||||
|
assert!(config.timeout_ms.is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn serde_with_extra_args() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::ToolchainInstall,
|
||||||
|
toolchain: Some("nightly".to_string()),
|
||||||
|
components: vec![],
|
||||||
|
targets: vec![],
|
||||||
|
profile: Some("minimal".to_string()),
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec!["--force".to_string()],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let json = serde_json::to_string(&config).unwrap();
|
||||||
|
let de: RustupConfig = serde_json::from_str(&json).unwrap();
|
||||||
|
assert_eq!(de.extra_args, vec!["--force"]);
|
||||||
|
}
|
||||||
|
}
|
||||||
5
wfe-rustlang/src/rustup/mod.rs
Normal file
5
wfe-rustlang/src/rustup/mod.rs
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
pub mod config;
|
||||||
|
pub mod step;
|
||||||
|
|
||||||
|
pub use config::{RustupCommand, RustupConfig};
|
||||||
|
pub use step::RustupStep;
|
||||||
357
wfe-rustlang/src/rustup/step.rs
Normal file
357
wfe-rustlang/src/rustup/step.rs
Normal file
@@ -0,0 +1,357 @@
|
|||||||
|
use async_trait::async_trait;
|
||||||
|
use wfe_core::models::ExecutionResult;
|
||||||
|
use wfe_core::traits::step::{StepBody, StepExecutionContext};
|
||||||
|
use wfe_core::WfeError;
|
||||||
|
|
||||||
|
use crate::rustup::config::{RustupCommand, RustupConfig};
|
||||||
|
|
||||||
|
pub struct RustupStep {
|
||||||
|
config: RustupConfig,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl RustupStep {
|
||||||
|
pub fn new(config: RustupConfig) -> Self {
|
||||||
|
Self { config }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn build_command(&self) -> tokio::process::Command {
|
||||||
|
match self.config.command {
|
||||||
|
RustupCommand::Install => self.build_install_command(),
|
||||||
|
RustupCommand::ToolchainInstall => self.build_toolchain_install_command(),
|
||||||
|
RustupCommand::ComponentAdd => self.build_component_add_command(),
|
||||||
|
RustupCommand::TargetAdd => self.build_target_add_command(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn build_install_command(&self) -> tokio::process::Command {
|
||||||
|
let mut cmd = tokio::process::Command::new("sh");
|
||||||
|
// Pipe rustup-init through sh with non-interactive flag.
|
||||||
|
let mut script = "curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y".to_string();
|
||||||
|
|
||||||
|
if let Some(ref profile) = self.config.profile {
|
||||||
|
script.push_str(&format!(" --profile {profile}"));
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(ref tc) = self.config.default_toolchain {
|
||||||
|
script.push_str(&format!(" --default-toolchain {tc}"));
|
||||||
|
}
|
||||||
|
|
||||||
|
for arg in &self.config.extra_args {
|
||||||
|
script.push_str(&format!(" {arg}"));
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd.arg("-c").arg(&script);
|
||||||
|
cmd.stdout(std::process::Stdio::piped());
|
||||||
|
cmd.stderr(std::process::Stdio::piped());
|
||||||
|
cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
fn build_toolchain_install_command(&self) -> tokio::process::Command {
|
||||||
|
let mut cmd = tokio::process::Command::new("rustup");
|
||||||
|
cmd.args(["toolchain", "install"]);
|
||||||
|
|
||||||
|
if let Some(ref tc) = self.config.toolchain {
|
||||||
|
cmd.arg(tc);
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(ref profile) = self.config.profile {
|
||||||
|
cmd.args(["--profile", profile]);
|
||||||
|
}
|
||||||
|
|
||||||
|
for arg in &self.config.extra_args {
|
||||||
|
cmd.arg(arg);
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd.stdout(std::process::Stdio::piped());
|
||||||
|
cmd.stderr(std::process::Stdio::piped());
|
||||||
|
cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
fn build_component_add_command(&self) -> tokio::process::Command {
|
||||||
|
let mut cmd = tokio::process::Command::new("rustup");
|
||||||
|
cmd.args(["component", "add"]);
|
||||||
|
|
||||||
|
for component in &self.config.components {
|
||||||
|
cmd.arg(component);
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(ref tc) = self.config.toolchain {
|
||||||
|
cmd.args(["--toolchain", tc]);
|
||||||
|
}
|
||||||
|
|
||||||
|
for arg in &self.config.extra_args {
|
||||||
|
cmd.arg(arg);
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd.stdout(std::process::Stdio::piped());
|
||||||
|
cmd.stderr(std::process::Stdio::piped());
|
||||||
|
cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
fn build_target_add_command(&self) -> tokio::process::Command {
|
||||||
|
let mut cmd = tokio::process::Command::new("rustup");
|
||||||
|
cmd.args(["target", "add"]);
|
||||||
|
|
||||||
|
for target in &self.config.targets {
|
||||||
|
cmd.arg(target);
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(ref tc) = self.config.toolchain {
|
||||||
|
cmd.args(["--toolchain", tc]);
|
||||||
|
}
|
||||||
|
|
||||||
|
for arg in &self.config.extra_args {
|
||||||
|
cmd.arg(arg);
|
||||||
|
}
|
||||||
|
|
||||||
|
cmd.stdout(std::process::Stdio::piped());
|
||||||
|
cmd.stderr(std::process::Stdio::piped());
|
||||||
|
cmd
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
impl StepBody for RustupStep {
|
||||||
|
async fn run(&mut self, context: &StepExecutionContext<'_>) -> wfe_core::Result<ExecutionResult> {
|
||||||
|
let step_name = context.step.name.as_deref().unwrap_or("unknown");
|
||||||
|
let subcmd = self.config.command.as_str();
|
||||||
|
|
||||||
|
tracing::info!(step = step_name, command = subcmd, "running rustup");
|
||||||
|
|
||||||
|
let mut cmd = self.build_command();
|
||||||
|
|
||||||
|
let output = if let Some(timeout_ms) = self.config.timeout_ms {
|
||||||
|
let duration = std::time::Duration::from_millis(timeout_ms);
|
||||||
|
match tokio::time::timeout(duration, cmd.output()).await {
|
||||||
|
Ok(result) => result.map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("Failed to spawn rustup {subcmd}: {e}"))
|
||||||
|
})?,
|
||||||
|
Err(_) => {
|
||||||
|
return Err(WfeError::StepExecution(format!(
|
||||||
|
"rustup {subcmd} timed out after {timeout_ms}ms"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
cmd.output()
|
||||||
|
.await
|
||||||
|
.map_err(|e| WfeError::StepExecution(format!("Failed to spawn rustup {subcmd}: {e}")))?
|
||||||
|
};
|
||||||
|
|
||||||
|
let stdout = String::from_utf8_lossy(&output.stdout).to_string();
|
||||||
|
let stderr = String::from_utf8_lossy(&output.stderr).to_string();
|
||||||
|
|
||||||
|
if !output.status.success() {
|
||||||
|
let code = output.status.code().unwrap_or(-1);
|
||||||
|
return Err(WfeError::StepExecution(format!(
|
||||||
|
"rustup {subcmd} exited with code {code}\nstdout: {stdout}\nstderr: {stderr}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut outputs = serde_json::Map::new();
|
||||||
|
outputs.insert(
|
||||||
|
format!("{step_name}.stdout"),
|
||||||
|
serde_json::Value::String(stdout),
|
||||||
|
);
|
||||||
|
outputs.insert(
|
||||||
|
format!("{step_name}.stderr"),
|
||||||
|
serde_json::Value::String(stderr),
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(ExecutionResult {
|
||||||
|
proceed: true,
|
||||||
|
output_data: Some(serde_json::Value::Object(outputs)),
|
||||||
|
..Default::default()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
fn install_config() -> RustupConfig {
|
||||||
|
RustupConfig {
|
||||||
|
command: RustupCommand::Install,
|
||||||
|
toolchain: None,
|
||||||
|
components: vec![],
|
||||||
|
targets: vec![],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_install_command_minimal() {
|
||||||
|
let step = RustupStep::new(install_config());
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let prog = cmd.as_std().get_program().to_str().unwrap();
|
||||||
|
assert_eq!(prog, "sh");
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args[0], "-c");
|
||||||
|
assert!(args[1].contains("rustup.rs"));
|
||||||
|
assert!(args[1].contains("-y"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_install_command_with_profile_and_toolchain() {
|
||||||
|
let mut config = install_config();
|
||||||
|
config.profile = Some("minimal".to_string());
|
||||||
|
config.default_toolchain = Some("nightly".to_string());
|
||||||
|
let step = RustupStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert!(args[1].contains("--profile minimal"));
|
||||||
|
assert!(args[1].contains("--default-toolchain nightly"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_install_command_with_extra_args() {
|
||||||
|
let mut config = install_config();
|
||||||
|
config.extra_args = vec!["--no-modify-path".to_string()];
|
||||||
|
let step = RustupStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert!(args[1].contains("--no-modify-path"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_toolchain_install_command() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::ToolchainInstall,
|
||||||
|
toolchain: Some("nightly-2024-06-01".to_string()),
|
||||||
|
components: vec![],
|
||||||
|
targets: vec![],
|
||||||
|
profile: Some("minimal".to_string()),
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let step = RustupStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let prog = cmd.as_std().get_program().to_str().unwrap();
|
||||||
|
assert_eq!(prog, "rustup");
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["toolchain", "install", "nightly-2024-06-01", "--profile", "minimal"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_toolchain_install_with_extra_args() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::ToolchainInstall,
|
||||||
|
toolchain: Some("stable".to_string()),
|
||||||
|
components: vec![],
|
||||||
|
targets: vec![],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec!["--force".to_string()],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let step = RustupStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["toolchain", "install", "stable", "--force"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_component_add_command() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::ComponentAdd,
|
||||||
|
toolchain: Some("nightly".to_string()),
|
||||||
|
components: vec!["clippy".to_string(), "rustfmt".to_string()],
|
||||||
|
targets: vec![],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let step = RustupStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let prog = cmd.as_std().get_program().to_str().unwrap();
|
||||||
|
assert_eq!(prog, "rustup");
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["component", "add", "clippy", "rustfmt", "--toolchain", "nightly"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_component_add_without_toolchain() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::ComponentAdd,
|
||||||
|
toolchain: None,
|
||||||
|
components: vec!["rust-src".to_string()],
|
||||||
|
targets: vec![],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let step = RustupStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["component", "add", "rust-src"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_target_add_command() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::TargetAdd,
|
||||||
|
toolchain: Some("stable".to_string()),
|
||||||
|
components: vec![],
|
||||||
|
targets: vec!["wasm32-unknown-unknown".to_string()],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let step = RustupStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let prog = cmd.as_std().get_program().to_str().unwrap();
|
||||||
|
assert_eq!(prog, "rustup");
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["target", "add", "wasm32-unknown-unknown", "--toolchain", "stable"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_target_add_multiple_targets() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::TargetAdd,
|
||||||
|
toolchain: None,
|
||||||
|
components: vec![],
|
||||||
|
targets: vec![
|
||||||
|
"wasm32-unknown-unknown".to_string(),
|
||||||
|
"aarch64-linux-android".to_string(),
|
||||||
|
],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec![],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let step = RustupStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(args, vec!["target", "add", "wasm32-unknown-unknown", "aarch64-linux-android"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn build_target_add_with_extra_args() {
|
||||||
|
let config = RustupConfig {
|
||||||
|
command: RustupCommand::TargetAdd,
|
||||||
|
toolchain: Some("nightly".to_string()),
|
||||||
|
components: vec![],
|
||||||
|
targets: vec!["x86_64-unknown-linux-musl".to_string()],
|
||||||
|
profile: None,
|
||||||
|
default_toolchain: None,
|
||||||
|
extra_args: vec!["--force".to_string()],
|
||||||
|
timeout_ms: None,
|
||||||
|
};
|
||||||
|
let step = RustupStep::new(config);
|
||||||
|
let cmd = step.build_command();
|
||||||
|
let args: Vec<_> = cmd.as_std().get_args().map(|a| a.to_str().unwrap()).collect();
|
||||||
|
assert_eq!(
|
||||||
|
args,
|
||||||
|
vec!["target", "add", "x86_64-unknown-linux-musl", "--toolchain", "nightly", "--force"]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
19
wfe-server-protos/Cargo.toml
Normal file
19
wfe-server-protos/Cargo.toml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
[package]
|
||||||
|
name = "wfe-server-protos"
|
||||||
|
version.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
homepage.workspace = true
|
||||||
|
description = "gRPC service definitions for the WFE workflow server"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
tonic = "0.14"
|
||||||
|
tonic-prost = "0.14"
|
||||||
|
prost = "0.14"
|
||||||
|
prost-types = "0.14"
|
||||||
|
|
||||||
|
[build-dependencies]
|
||||||
|
tonic-build = "0.14"
|
||||||
|
tonic-prost-build = "0.14"
|
||||||
|
prost-build = "0.14"
|
||||||
17
wfe-server-protos/build.rs
Normal file
17
wfe-server-protos/build.rs
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||||
|
let proto_files = vec!["proto/wfe/v1/wfe.proto"];
|
||||||
|
|
||||||
|
let mut prost_config = prost_build::Config::new();
|
||||||
|
prost_config.include_file("mod.rs");
|
||||||
|
|
||||||
|
tonic_prost_build::configure()
|
||||||
|
.build_server(true)
|
||||||
|
.build_client(true)
|
||||||
|
.compile_with_config(
|
||||||
|
prost_config,
|
||||||
|
&proto_files,
|
||||||
|
&["proto"],
|
||||||
|
)?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
263
wfe-server-protos/proto/wfe/v1/wfe.proto
Normal file
263
wfe-server-protos/proto/wfe/v1/wfe.proto
Normal file
@@ -0,0 +1,263 @@
|
|||||||
|
syntax = "proto3";
|
||||||
|
package wfe.v1;
|
||||||
|
|
||||||
|
import "google/protobuf/timestamp.proto";
|
||||||
|
import "google/protobuf/struct.proto";
|
||||||
|
|
||||||
|
service Wfe {
|
||||||
|
// === Definitions ===
|
||||||
|
rpc RegisterWorkflow(RegisterWorkflowRequest) returns (RegisterWorkflowResponse);
|
||||||
|
rpc ListDefinitions(ListDefinitionsRequest) returns (ListDefinitionsResponse);
|
||||||
|
|
||||||
|
// === Instances ===
|
||||||
|
rpc StartWorkflow(StartWorkflowRequest) returns (StartWorkflowResponse);
|
||||||
|
rpc GetWorkflow(GetWorkflowRequest) returns (GetWorkflowResponse);
|
||||||
|
rpc CancelWorkflow(CancelWorkflowRequest) returns (CancelWorkflowResponse);
|
||||||
|
rpc SuspendWorkflow(SuspendWorkflowRequest) returns (SuspendWorkflowResponse);
|
||||||
|
rpc ResumeWorkflow(ResumeWorkflowRequest) returns (ResumeWorkflowResponse);
|
||||||
|
rpc SearchWorkflows(SearchWorkflowsRequest) returns (SearchWorkflowsResponse);
|
||||||
|
|
||||||
|
// === Events ===
|
||||||
|
rpc PublishEvent(PublishEventRequest) returns (PublishEventResponse);
|
||||||
|
|
||||||
|
// === Streaming ===
|
||||||
|
rpc WatchLifecycle(WatchLifecycleRequest) returns (stream LifecycleEvent);
|
||||||
|
rpc StreamLogs(StreamLogsRequest) returns (stream LogEntry);
|
||||||
|
|
||||||
|
// === Search ===
|
||||||
|
rpc SearchLogs(SearchLogsRequest) returns (SearchLogsResponse);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Definitions ─────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
message RegisterWorkflowRequest {
|
||||||
|
// Raw YAML content. The server compiles it via wfe-yaml.
|
||||||
|
string yaml = 1;
|
||||||
|
// Optional config map for ((variable)) interpolation.
|
||||||
|
map<string, string> config = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
message RegisterWorkflowResponse {
|
||||||
|
repeated RegisteredDefinition definitions = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message RegisteredDefinition {
|
||||||
|
string definition_id = 1;
|
||||||
|
uint32 version = 2;
|
||||||
|
uint32 step_count = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
message ListDefinitionsRequest {}
|
||||||
|
|
||||||
|
message ListDefinitionsResponse {
|
||||||
|
repeated DefinitionSummary definitions = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message DefinitionSummary {
|
||||||
|
string id = 1;
|
||||||
|
uint32 version = 2;
|
||||||
|
string description = 3;
|
||||||
|
uint32 step_count = 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Instances ───────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
message StartWorkflowRequest {
|
||||||
|
string definition_id = 1;
|
||||||
|
uint32 version = 2;
|
||||||
|
google.protobuf.Struct data = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
message StartWorkflowResponse {
|
||||||
|
string workflow_id = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message GetWorkflowRequest {
|
||||||
|
string workflow_id = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message GetWorkflowResponse {
|
||||||
|
WorkflowInstance instance = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message CancelWorkflowRequest {
|
||||||
|
string workflow_id = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message CancelWorkflowResponse {}
|
||||||
|
|
||||||
|
message SuspendWorkflowRequest {
|
||||||
|
string workflow_id = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message SuspendWorkflowResponse {}
|
||||||
|
|
||||||
|
message ResumeWorkflowRequest {
|
||||||
|
string workflow_id = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message ResumeWorkflowResponse {}
|
||||||
|
|
||||||
|
message SearchWorkflowsRequest {
|
||||||
|
string query = 1;
|
||||||
|
WorkflowStatus status_filter = 2;
|
||||||
|
uint64 skip = 3;
|
||||||
|
uint64 take = 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
message SearchWorkflowsResponse {
|
||||||
|
repeated WorkflowSearchResult results = 1;
|
||||||
|
uint64 total = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Events ──────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
message PublishEventRequest {
|
||||||
|
string event_name = 1;
|
||||||
|
string event_key = 2;
|
||||||
|
google.protobuf.Struct data = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
message PublishEventResponse {
|
||||||
|
string event_id = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Lifecycle streaming ─────────────────────────────────────────────
|
||||||
|
|
||||||
|
message WatchLifecycleRequest {
|
||||||
|
// Empty = all workflows. Set to filter to one.
|
||||||
|
string workflow_id = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
message LifecycleEvent {
|
||||||
|
google.protobuf.Timestamp event_time = 1;
|
||||||
|
string workflow_id = 2;
|
||||||
|
string definition_id = 3;
|
||||||
|
uint32 version = 4;
|
||||||
|
LifecycleEventType event_type = 5;
|
||||||
|
// Populated for step events.
|
||||||
|
uint32 step_id = 6;
|
||||||
|
string step_name = 7;
|
||||||
|
// Populated for error events.
|
||||||
|
string error_message = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Log streaming ──────────────────────────────────────────────────
|
||||||
|
|
||||||
|
message StreamLogsRequest {
|
||||||
|
string workflow_id = 1;
|
||||||
|
// Filter to a specific step. Empty = all steps.
|
||||||
|
string step_name = 2;
|
||||||
|
// If true, keep streaming as new logs arrive (tail -f).
|
||||||
|
bool follow = 3;
|
||||||
|
}
|
||||||
|
|
||||||
|
message LogEntry {
|
||||||
|
string workflow_id = 1;
|
||||||
|
string step_name = 2;
|
||||||
|
uint32 step_id = 3;
|
||||||
|
LogStream stream = 4;
|
||||||
|
bytes data = 5;
|
||||||
|
google.protobuf.Timestamp timestamp = 6;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Log search ─────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
message SearchLogsRequest {
|
||||||
|
// Full-text search query.
|
||||||
|
string query = 1;
|
||||||
|
// Optional filters.
|
||||||
|
string workflow_id = 2;
|
||||||
|
string step_name = 3;
|
||||||
|
LogStream stream_filter = 4;
|
||||||
|
uint64 skip = 5;
|
||||||
|
uint64 take = 6;
|
||||||
|
}
|
||||||
|
|
||||||
|
message SearchLogsResponse {
|
||||||
|
repeated LogSearchResult results = 1;
|
||||||
|
uint64 total = 2;
|
||||||
|
}
|
||||||
|
|
||||||
|
message LogSearchResult {
|
||||||
|
string workflow_id = 1;
|
||||||
|
string definition_id = 2;
|
||||||
|
string step_name = 3;
|
||||||
|
string line = 4;
|
||||||
|
LogStream stream = 5;
|
||||||
|
google.protobuf.Timestamp timestamp = 6;
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─── Shared types ───────────────────────────────────────────────────
|
||||||
|
|
||||||
|
message WorkflowInstance {
|
||||||
|
string id = 1;
|
||||||
|
string definition_id = 2;
|
||||||
|
uint32 version = 3;
|
||||||
|
string description = 4;
|
||||||
|
string reference = 5;
|
||||||
|
WorkflowStatus status = 6;
|
||||||
|
google.protobuf.Struct data = 7;
|
||||||
|
google.protobuf.Timestamp create_time = 8;
|
||||||
|
google.protobuf.Timestamp complete_time = 9;
|
||||||
|
repeated ExecutionPointer execution_pointers = 10;
|
||||||
|
}
|
||||||
|
|
||||||
|
message ExecutionPointer {
|
||||||
|
string id = 1;
|
||||||
|
uint32 step_id = 2;
|
||||||
|
string step_name = 3;
|
||||||
|
PointerStatus status = 4;
|
||||||
|
google.protobuf.Timestamp start_time = 5;
|
||||||
|
google.protobuf.Timestamp end_time = 6;
|
||||||
|
uint32 retry_count = 7;
|
||||||
|
bool active = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
message WorkflowSearchResult {
|
||||||
|
string id = 1;
|
||||||
|
string definition_id = 2;
|
||||||
|
uint32 version = 3;
|
||||||
|
WorkflowStatus status = 4;
|
||||||
|
string reference = 5;
|
||||||
|
string description = 6;
|
||||||
|
google.protobuf.Timestamp create_time = 7;
|
||||||
|
}
|
||||||
|
|
||||||
|
enum WorkflowStatus {
|
||||||
|
WORKFLOW_STATUS_UNSPECIFIED = 0;
|
||||||
|
WORKFLOW_STATUS_RUNNABLE = 1;
|
||||||
|
WORKFLOW_STATUS_SUSPENDED = 2;
|
||||||
|
WORKFLOW_STATUS_COMPLETE = 3;
|
||||||
|
WORKFLOW_STATUS_TERMINATED = 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
enum PointerStatus {
|
||||||
|
POINTER_STATUS_UNSPECIFIED = 0;
|
||||||
|
POINTER_STATUS_PENDING = 1;
|
||||||
|
POINTER_STATUS_RUNNING = 2;
|
||||||
|
POINTER_STATUS_COMPLETE = 3;
|
||||||
|
POINTER_STATUS_SLEEPING = 4;
|
||||||
|
POINTER_STATUS_WAITING_FOR_EVENT = 5;
|
||||||
|
POINTER_STATUS_FAILED = 6;
|
||||||
|
POINTER_STATUS_SKIPPED = 7;
|
||||||
|
POINTER_STATUS_CANCELLED = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
enum LifecycleEventType {
|
||||||
|
LIFECYCLE_EVENT_TYPE_UNSPECIFIED = 0;
|
||||||
|
LIFECYCLE_EVENT_TYPE_STARTED = 1;
|
||||||
|
LIFECYCLE_EVENT_TYPE_COMPLETED = 2;
|
||||||
|
LIFECYCLE_EVENT_TYPE_TERMINATED = 3;
|
||||||
|
LIFECYCLE_EVENT_TYPE_SUSPENDED = 4;
|
||||||
|
LIFECYCLE_EVENT_TYPE_RESUMED = 5;
|
||||||
|
LIFECYCLE_EVENT_TYPE_ERROR = 6;
|
||||||
|
LIFECYCLE_EVENT_TYPE_STEP_STARTED = 7;
|
||||||
|
LIFECYCLE_EVENT_TYPE_STEP_COMPLETED = 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
enum LogStream {
|
||||||
|
LOG_STREAM_UNSPECIFIED = 0;
|
||||||
|
LOG_STREAM_STDOUT = 1;
|
||||||
|
LOG_STREAM_STDERR = 2;
|
||||||
|
}
|
||||||
17
wfe-server-protos/src/lib.rs
Normal file
17
wfe-server-protos/src/lib.rs
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
//! Generated gRPC stubs for the WFE workflow server API.
|
||||||
|
//!
|
||||||
|
//! Built from `proto/wfe/v1/wfe.proto`. Includes both server and client code.
|
||||||
|
//!
|
||||||
|
//! ```rust,ignore
|
||||||
|
//! use wfe_server_protos::wfe::v1::wfe_server::WfeServer;
|
||||||
|
//! use wfe_server_protos::wfe::v1::wfe_client::WfeClient;
|
||||||
|
//! ```
|
||||||
|
|
||||||
|
#![allow(clippy::all)]
|
||||||
|
#![allow(warnings)]
|
||||||
|
|
||||||
|
include!(concat!(env!("OUT_DIR"), "/mod.rs"));
|
||||||
|
|
||||||
|
pub use prost;
|
||||||
|
pub use prost_types;
|
||||||
|
pub use tonic;
|
||||||
72
wfe-server/Cargo.toml
Normal file
72
wfe-server/Cargo.toml
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
[package]
|
||||||
|
name = "wfe-server"
|
||||||
|
version.workspace = true
|
||||||
|
edition.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
repository.workspace = true
|
||||||
|
homepage.workspace = true
|
||||||
|
description = "Headless workflow server with gRPC API and HTTP webhooks"
|
||||||
|
|
||||||
|
[[bin]]
|
||||||
|
name = "wfe-server"
|
||||||
|
path = "src/main.rs"
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
# Internal
|
||||||
|
wfe-core = { workspace = true, features = ["test-support"] }
|
||||||
|
wfe = { path = "../wfe" }
|
||||||
|
wfe-yaml = { path = "../wfe-yaml", features = ["rustlang", "buildkit", "containerd"] }
|
||||||
|
wfe-server-protos = { path = "../wfe-server-protos" }
|
||||||
|
wfe-sqlite = { workspace = true }
|
||||||
|
wfe-postgres = { workspace = true }
|
||||||
|
wfe-valkey = { workspace = true }
|
||||||
|
wfe-opensearch = { workspace = true }
|
||||||
|
opensearch = { workspace = true }
|
||||||
|
|
||||||
|
# gRPC
|
||||||
|
tonic = "0.14"
|
||||||
|
tonic-health = "0.14"
|
||||||
|
prost-types = "0.14"
|
||||||
|
|
||||||
|
# HTTP (webhooks)
|
||||||
|
axum = { version = "0.8", features = ["json", "macros"] }
|
||||||
|
hyper = "1"
|
||||||
|
tower = "0.5"
|
||||||
|
|
||||||
|
# Runtime
|
||||||
|
tokio = { workspace = true }
|
||||||
|
async-trait = { workspace = true }
|
||||||
|
|
||||||
|
# Serialization
|
||||||
|
serde = { workspace = true }
|
||||||
|
serde_json = { workspace = true }
|
||||||
|
toml = "0.8"
|
||||||
|
|
||||||
|
# CLI
|
||||||
|
clap = { version = "4", features = ["derive", "env"] }
|
||||||
|
|
||||||
|
# Auth
|
||||||
|
hmac = "0.12"
|
||||||
|
sha2 = "0.10"
|
||||||
|
hex = "0.4"
|
||||||
|
jsonwebtoken = "9"
|
||||||
|
subtle = "2"
|
||||||
|
reqwest = { workspace = true }
|
||||||
|
|
||||||
|
# Observability
|
||||||
|
tracing = { workspace = true }
|
||||||
|
tracing-subscriber = { workspace = true }
|
||||||
|
chrono = { workspace = true }
|
||||||
|
uuid = { workspace = true }
|
||||||
|
|
||||||
|
# Utils
|
||||||
|
tokio-stream = "0.1"
|
||||||
|
dashmap = "6"
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
pretty_assertions = { workspace = true }
|
||||||
|
tokio = { workspace = true, features = ["test-util"] }
|
||||||
|
tempfile = { workspace = true }
|
||||||
|
rsa = { version = "0.9", features = ["pem"] }
|
||||||
|
rand = "0.8"
|
||||||
|
base64 = "0.22"
|
||||||
769
wfe-server/src/auth.rs
Normal file
769
wfe-server/src/auth.rs
Normal file
@@ -0,0 +1,769 @@
|
|||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use jsonwebtoken::{decode, Algorithm, DecodingKey, Validation};
|
||||||
|
use serde::Deserialize;
|
||||||
|
use tokio::sync::RwLock;
|
||||||
|
use tonic::{Request, Status};
|
||||||
|
|
||||||
|
use crate::config::AuthConfig;
|
||||||
|
|
||||||
|
/// Asymmetric algorithms we accept. NEVER trust the JWT header's alg claim.
|
||||||
|
/// This prevents algorithm confusion attacks (CVE-2016-5431).
|
||||||
|
const ALLOWED_ALGORITHMS: &[Algorithm] = &[
|
||||||
|
Algorithm::RS256,
|
||||||
|
Algorithm::RS384,
|
||||||
|
Algorithm::RS512,
|
||||||
|
Algorithm::ES256,
|
||||||
|
Algorithm::ES384,
|
||||||
|
Algorithm::PS256,
|
||||||
|
Algorithm::PS384,
|
||||||
|
Algorithm::PS512,
|
||||||
|
Algorithm::EdDSA,
|
||||||
|
];
|
||||||
|
|
||||||
|
/// JWT claims we validate.
|
||||||
|
#[derive(Debug, Deserialize)]
|
||||||
|
struct Claims {
|
||||||
|
#[allow(dead_code)]
|
||||||
|
sub: Option<String>,
|
||||||
|
#[allow(dead_code)]
|
||||||
|
iss: Option<String>,
|
||||||
|
#[allow(dead_code)]
|
||||||
|
aud: Option<serde_json::Value>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Cached JWKS keys fetched from the OIDC provider.
|
||||||
|
#[derive(Clone)]
|
||||||
|
struct JwksCache {
|
||||||
|
keys: Vec<jsonwebtoken::jwk::Jwk>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Auth state shared across gRPC interceptor calls.
|
||||||
|
pub struct AuthState {
|
||||||
|
pub(crate) config: AuthConfig,
|
||||||
|
jwks: RwLock<Option<JwksCache>>,
|
||||||
|
jwks_uri: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl AuthState {
|
||||||
|
/// Create auth state. If OIDC is configured, discovers the JWKS URI.
|
||||||
|
/// Panics if OIDC is configured but discovery fails (fail-closed).
|
||||||
|
pub async fn new(config: AuthConfig) -> Self {
|
||||||
|
let jwks_uri = if let Some(ref issuer) = config.oidc_issuer {
|
||||||
|
// HIGH-03: Validate issuer URL uses HTTPS in production.
|
||||||
|
if !issuer.starts_with("https://") && !issuer.starts_with("http://localhost") {
|
||||||
|
panic!(
|
||||||
|
"OIDC issuer must use HTTPS (got: {issuer}). \
|
||||||
|
Use http://localhost only for development."
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
match discover_jwks_uri(issuer).await {
|
||||||
|
Ok(uri) => {
|
||||||
|
// Validate JWKS URI also uses HTTPS (second-order SSRF prevention).
|
||||||
|
if !uri.starts_with("https://") && !uri.starts_with("http://localhost") {
|
||||||
|
panic!("JWKS URI from OIDC discovery must use HTTPS (got: {uri})");
|
||||||
|
}
|
||||||
|
tracing::info!(issuer = %issuer, jwks_uri = %uri, "OIDC discovery complete");
|
||||||
|
Some(uri)
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
// HIGH-05: Fail startup if OIDC is configured but discovery fails.
|
||||||
|
panic!("OIDC issuer configured but discovery failed: {e}");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
|
|
||||||
|
let state = Self {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(None),
|
||||||
|
jwks_uri,
|
||||||
|
};
|
||||||
|
|
||||||
|
// Pre-fetch JWKS.
|
||||||
|
if state.jwks_uri.is_some() {
|
||||||
|
state
|
||||||
|
.refresh_jwks()
|
||||||
|
.await
|
||||||
|
.expect("initial JWKS fetch failed — cannot start with OIDC enabled");
|
||||||
|
}
|
||||||
|
|
||||||
|
state
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Refresh the cached JWKS from the provider.
|
||||||
|
pub async fn refresh_jwks(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
|
||||||
|
let uri = self.jwks_uri.as_ref().ok_or("no JWKS URI")?;
|
||||||
|
let resp: JwksResponse = reqwest::get(uri).await?.json().await?;
|
||||||
|
let mut cache = self.jwks.write().await;
|
||||||
|
*cache = Some(JwksCache { keys: resp.keys });
|
||||||
|
tracing::debug!(key_count = cache.as_ref().unwrap().keys.len(), "JWKS refreshed");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Validate a request's authorization.
|
||||||
|
pub async fn check<T>(&self, request: &Request<T>) -> Result<(), Status> {
|
||||||
|
// No auth configured = open access.
|
||||||
|
if self.config.tokens.is_empty() && self.config.oidc_issuer.is_none() {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
|
||||||
|
let token = extract_bearer_token(request)?;
|
||||||
|
|
||||||
|
// CRITICAL-02: Use constant-time comparison for static tokens.
|
||||||
|
if check_static_tokens(&self.config.tokens, token) {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try JWT/OIDC validation.
|
||||||
|
if self.config.oidc_issuer.is_some() {
|
||||||
|
return self.validate_jwt_cached(token);
|
||||||
|
}
|
||||||
|
|
||||||
|
Err(Status::unauthenticated("invalid token"))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Validate a JWT against the cached JWKS (synchronous — for use in interceptors).
|
||||||
|
/// Shared logic used by both `check()` and `make_interceptor()`.
|
||||||
|
fn validate_jwt_cached(&self, token: &str) -> Result<(), Status> {
|
||||||
|
let cache = self.jwks.try_read()
|
||||||
|
.map_err(|_| Status::unavailable("JWKS refresh in progress"))?;
|
||||||
|
let jwks = cache
|
||||||
|
.as_ref()
|
||||||
|
.ok_or_else(|| Status::unavailable("JWKS not loaded"))?;
|
||||||
|
|
||||||
|
let header = jsonwebtoken::decode_header(token)
|
||||||
|
.map_err(|e| Status::unauthenticated(format!("invalid JWT header: {e}")))?;
|
||||||
|
|
||||||
|
// CRITICAL-01: Never trust the JWT header's alg claim.
|
||||||
|
// Derive the algorithm from the JWK, not the token.
|
||||||
|
let kid = header.kid.as_deref();
|
||||||
|
|
||||||
|
// MEDIUM-06: Require kid when JWKS has multiple keys.
|
||||||
|
if kid.is_none() && jwks.keys.len() > 1 {
|
||||||
|
return Err(Status::unauthenticated(
|
||||||
|
"JWT missing kid header but JWKS has multiple keys",
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
let jwk = jwks
|
||||||
|
.keys
|
||||||
|
.iter()
|
||||||
|
.find(|k| match (kid, &k.common.key_id) {
|
||||||
|
(Some(kid), Some(k_kid)) => kid == k_kid,
|
||||||
|
(None, _) if jwks.keys.len() == 1 => true,
|
||||||
|
_ => false,
|
||||||
|
})
|
||||||
|
.ok_or_else(|| Status::unauthenticated("no matching key in JWKS"))?;
|
||||||
|
|
||||||
|
let decoding_key = DecodingKey::from_jwk(jwk)
|
||||||
|
.map_err(|e| Status::unauthenticated(format!("invalid JWK: {e}")))?;
|
||||||
|
|
||||||
|
// CRITICAL-01: Use the JWK's algorithm, NOT the token header's.
|
||||||
|
let alg = jwk
|
||||||
|
.common
|
||||||
|
.key_algorithm
|
||||||
|
.and_then(|ka| key_algorithm_to_jwt_algorithm(ka))
|
||||||
|
.ok_or_else(|| {
|
||||||
|
Status::unauthenticated("JWK has no algorithm or unsupported algorithm")
|
||||||
|
})?;
|
||||||
|
|
||||||
|
// Double-check it's in our allowlist (no symmetric algorithms).
|
||||||
|
if !ALLOWED_ALGORITHMS.contains(&alg) {
|
||||||
|
return Err(Status::unauthenticated(format!(
|
||||||
|
"algorithm {alg:?} not in allowlist"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut validation = Validation::new(alg);
|
||||||
|
if let Some(ref issuer) = self.config.oidc_issuer {
|
||||||
|
validation.set_issuer(&[issuer]);
|
||||||
|
}
|
||||||
|
if let Some(ref audience) = self.config.oidc_audience {
|
||||||
|
validation.set_audience(&[audience]);
|
||||||
|
} else {
|
||||||
|
validation.validate_aud = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
decode::<Claims>(token, &decoding_key, &validation)
|
||||||
|
.map_err(|e| Status::unauthenticated(format!("JWT validation failed: {e}")))?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// CRITICAL-02: Constant-time token comparison to prevent timing attacks.
|
||||||
|
/// Public for use in webhook auth.
|
||||||
|
pub fn check_static_tokens_pub(tokens: &[String], candidate: &str) -> bool {
|
||||||
|
check_static_tokens(tokens, candidate)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn check_static_tokens(tokens: &[String], candidate: &str) -> bool {
|
||||||
|
use subtle::ConstantTimeEq;
|
||||||
|
let candidate_bytes = candidate.as_bytes();
|
||||||
|
for token in tokens {
|
||||||
|
let token_bytes = token.as_bytes();
|
||||||
|
if token_bytes.len() == candidate_bytes.len()
|
||||||
|
&& bool::from(token_bytes.ct_eq(candidate_bytes))
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
false
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Extract bearer token from gRPC metadata or HTTP Authorization header.
|
||||||
|
fn extract_bearer_token<T>(request: &Request<T>) -> Result<&str, Status> {
|
||||||
|
let auth = request
|
||||||
|
.metadata()
|
||||||
|
.get("authorization")
|
||||||
|
.and_then(|v| v.to_str().ok())
|
||||||
|
.ok_or_else(|| Status::unauthenticated("missing authorization header"))?;
|
||||||
|
|
||||||
|
auth.strip_prefix("Bearer ")
|
||||||
|
.or_else(|| auth.strip_prefix("bearer "))
|
||||||
|
.ok_or_else(|| Status::unauthenticated("expected Bearer token"))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Map JWK key algorithm to jsonwebtoken Algorithm.
|
||||||
|
fn key_algorithm_to_jwt_algorithm(
|
||||||
|
ka: jsonwebtoken::jwk::KeyAlgorithm,
|
||||||
|
) -> Option<Algorithm> {
|
||||||
|
use jsonwebtoken::jwk::KeyAlgorithm as KA;
|
||||||
|
match ka {
|
||||||
|
KA::RS256 => Some(Algorithm::RS256),
|
||||||
|
KA::RS384 => Some(Algorithm::RS384),
|
||||||
|
KA::RS512 => Some(Algorithm::RS512),
|
||||||
|
KA::ES256 => Some(Algorithm::ES256),
|
||||||
|
KA::ES384 => Some(Algorithm::ES384),
|
||||||
|
KA::PS256 => Some(Algorithm::PS256),
|
||||||
|
KA::PS384 => Some(Algorithm::PS384),
|
||||||
|
KA::PS512 => Some(Algorithm::PS512),
|
||||||
|
KA::EdDSA => Some(Algorithm::EdDSA),
|
||||||
|
_ => None, // Reject HS256, HS384, HS512 and unknown algorithms.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// OIDC discovery response (minimal — we only need jwks_uri).
|
||||||
|
#[derive(Deserialize)]
|
||||||
|
struct OidcDiscovery {
|
||||||
|
jwks_uri: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// JWKS response.
|
||||||
|
#[derive(Deserialize)]
|
||||||
|
struct JwksResponse {
|
||||||
|
keys: Vec<jsonwebtoken::jwk::Jwk>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Fetch the JWKS URI from the OIDC discovery endpoint.
|
||||||
|
async fn discover_jwks_uri(
|
||||||
|
issuer: &str,
|
||||||
|
) -> Result<String, Box<dyn std::error::Error + Send + Sync>> {
|
||||||
|
let discovery_url = format!(
|
||||||
|
"{}/.well-known/openid-configuration",
|
||||||
|
issuer.trim_end_matches('/')
|
||||||
|
);
|
||||||
|
let resp: OidcDiscovery = reqwest::get(&discovery_url).await?.json().await?;
|
||||||
|
Ok(resp.jwks_uri)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a tonic interceptor that checks auth on every request.
|
||||||
|
pub fn make_interceptor(
|
||||||
|
auth: Arc<AuthState>,
|
||||||
|
) -> impl Fn(Request<()>) -> Result<Request<()>, Status> + Clone {
|
||||||
|
move |req: Request<()>| {
|
||||||
|
let auth = auth.clone();
|
||||||
|
|
||||||
|
// No auth configured = pass through.
|
||||||
|
if auth.config.tokens.is_empty() && auth.config.oidc_issuer.is_none() {
|
||||||
|
return Ok(req);
|
||||||
|
}
|
||||||
|
|
||||||
|
let token = match extract_bearer_token(&req) {
|
||||||
|
Ok(t) => t.to_string(),
|
||||||
|
Err(e) => return Err(e),
|
||||||
|
};
|
||||||
|
|
||||||
|
// CRITICAL-02: Constant-time static token check.
|
||||||
|
if check_static_tokens(&auth.config.tokens, &token) {
|
||||||
|
return Ok(req);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check JWT via shared validate_jwt_cached (deduplicated logic).
|
||||||
|
if auth.config.oidc_issuer.is_some() {
|
||||||
|
auth.validate_jwt_cached(&token)?;
|
||||||
|
return Ok(req);
|
||||||
|
}
|
||||||
|
|
||||||
|
Err(Status::unauthenticated("invalid token"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn extract_bearer_from_metadata() {
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "Bearer mytoken".parse().unwrap());
|
||||||
|
assert_eq!(extract_bearer_token(&req).unwrap(), "mytoken");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn extract_bearer_lowercase() {
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "bearer mytoken".parse().unwrap());
|
||||||
|
assert_eq!(extract_bearer_token(&req).unwrap(), "mytoken");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn extract_bearer_missing_header() {
|
||||||
|
let req = Request::new(());
|
||||||
|
assert!(extract_bearer_token(&req).is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn extract_bearer_wrong_scheme() {
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "Basic abc".parse().unwrap());
|
||||||
|
assert!(extract_bearer_token(&req).is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn constant_time_token_check_valid() {
|
||||||
|
let tokens = vec!["secret123".to_string()];
|
||||||
|
assert!(check_static_tokens(&tokens, "secret123"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn constant_time_token_check_invalid() {
|
||||||
|
let tokens = vec!["secret123".to_string()];
|
||||||
|
assert!(!check_static_tokens(&tokens, "wrong"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn constant_time_token_check_empty() {
|
||||||
|
let tokens: Vec<String> = vec![];
|
||||||
|
assert!(!check_static_tokens(&tokens, "anything"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn constant_time_token_check_length_mismatch() {
|
||||||
|
let tokens = vec!["short".to_string()];
|
||||||
|
assert!(!check_static_tokens(&tokens, "muchlongertoken"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn no_auth_configured_allows_all() {
|
||||||
|
let state = AuthState {
|
||||||
|
config: AuthConfig::default(),
|
||||||
|
jwks: RwLock::new(None),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let req = Request::new(());
|
||||||
|
assert!(state.check(&req).await.is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn static_token_valid() {
|
||||||
|
let config = AuthConfig {
|
||||||
|
tokens: vec!["secret123".to_string()],
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(None),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "Bearer secret123".parse().unwrap());
|
||||||
|
assert!(state.check(&req).await.is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn static_token_invalid() {
|
||||||
|
let config = AuthConfig {
|
||||||
|
tokens: vec!["secret123".to_string()],
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(None),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "Bearer wrong".parse().unwrap());
|
||||||
|
assert!(state.check(&req).await.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn static_token_missing_header() {
|
||||||
|
let config = AuthConfig {
|
||||||
|
tokens: vec!["secret123".to_string()],
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(None),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let req = Request::new(());
|
||||||
|
assert!(state.check(&req).await.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn interceptor_no_auth_passes() {
|
||||||
|
let state = Arc::new(AuthState {
|
||||||
|
config: AuthConfig::default(),
|
||||||
|
jwks: RwLock::new(None),
|
||||||
|
jwks_uri: None,
|
||||||
|
});
|
||||||
|
let interceptor = make_interceptor(state);
|
||||||
|
let req = Request::new(());
|
||||||
|
assert!(interceptor(req).is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn interceptor_static_token_valid() {
|
||||||
|
let config = AuthConfig {
|
||||||
|
tokens: vec!["tok".to_string()],
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = Arc::new(AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(None),
|
||||||
|
jwks_uri: None,
|
||||||
|
});
|
||||||
|
let interceptor = make_interceptor(state);
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "Bearer tok".parse().unwrap());
|
||||||
|
assert!(interceptor(req).is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn interceptor_static_token_invalid() {
|
||||||
|
let config = AuthConfig {
|
||||||
|
tokens: vec!["tok".to_string()],
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = Arc::new(AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(None),
|
||||||
|
jwks_uri: None,
|
||||||
|
});
|
||||||
|
let interceptor = make_interceptor(state);
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "Bearer bad".parse().unwrap());
|
||||||
|
assert!(interceptor(req).is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Helper: create a test RSA key pair, JWK, and signed JWT.
|
||||||
|
fn make_test_jwt(
|
||||||
|
issuer: &str,
|
||||||
|
audience: Option<&str>,
|
||||||
|
) -> (Vec<jsonwebtoken::jwk::Jwk>, String) {
|
||||||
|
use base64::{engine::general_purpose::URL_SAFE_NO_PAD, Engine};
|
||||||
|
use rsa::RsaPrivateKey;
|
||||||
|
|
||||||
|
let mut rng = rand::thread_rng();
|
||||||
|
let private_key = RsaPrivateKey::new(&mut rng, 2048).unwrap();
|
||||||
|
let public_key = private_key.to_public_key();
|
||||||
|
|
||||||
|
use rsa::traits::PublicKeyParts;
|
||||||
|
let n = URL_SAFE_NO_PAD.encode(public_key.n().to_bytes_be());
|
||||||
|
let e = URL_SAFE_NO_PAD.encode(public_key.e().to_bytes_be());
|
||||||
|
|
||||||
|
let jwk: jsonwebtoken::jwk::Jwk = serde_json::from_value(serde_json::json!({
|
||||||
|
"kty": "RSA",
|
||||||
|
"use": "sig",
|
||||||
|
"alg": "RS256",
|
||||||
|
"kid": "test-key-1",
|
||||||
|
"n": n,
|
||||||
|
"e": e,
|
||||||
|
}))
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
use rsa::pkcs1::EncodeRsaPrivateKey;
|
||||||
|
let pem = private_key
|
||||||
|
.to_pkcs1_pem(rsa::pkcs1::LineEnding::LF)
|
||||||
|
.unwrap();
|
||||||
|
let encoding_key =
|
||||||
|
jsonwebtoken::EncodingKey::from_rsa_pem(pem.as_bytes()).unwrap();
|
||||||
|
|
||||||
|
let mut header = jsonwebtoken::Header::new(jsonwebtoken::Algorithm::RS256);
|
||||||
|
header.kid = Some("test-key-1".to_string());
|
||||||
|
|
||||||
|
#[derive(serde::Serialize)]
|
||||||
|
struct TestClaims {
|
||||||
|
sub: String,
|
||||||
|
iss: String,
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
aud: Option<String>,
|
||||||
|
exp: u64,
|
||||||
|
iat: u64,
|
||||||
|
}
|
||||||
|
|
||||||
|
let now = std::time::SystemTime::now()
|
||||||
|
.duration_since(std::time::UNIX_EPOCH)
|
||||||
|
.unwrap()
|
||||||
|
.as_secs();
|
||||||
|
|
||||||
|
let claims = TestClaims {
|
||||||
|
sub: "user@example.com".to_string(),
|
||||||
|
iss: issuer.to_string(),
|
||||||
|
aud: audience.map(String::from),
|
||||||
|
exp: now + 3600,
|
||||||
|
iat: now,
|
||||||
|
};
|
||||||
|
|
||||||
|
let token = jsonwebtoken::encode(&header, &claims, &encoding_key).unwrap();
|
||||||
|
(vec![jwk], token)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn jwt_validation_valid_token() {
|
||||||
|
let issuer = "https://auth.example.com";
|
||||||
|
let (jwks, token) = make_test_jwt(issuer, None);
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some(issuer.to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(Some(JwksCache { keys: jwks })),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", format!("Bearer {token}").parse().unwrap());
|
||||||
|
assert!(state.check(&req).await.is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn jwt_validation_wrong_issuer() {
|
||||||
|
let (jwks, token) = make_test_jwt("https://wrong-issuer.com", None);
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some("https://expected-issuer.com".to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(Some(JwksCache { keys: jwks })),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", format!("Bearer {token}").parse().unwrap());
|
||||||
|
assert!(state.check(&req).await.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn jwt_validation_with_audience() {
|
||||||
|
let issuer = "https://auth.example.com";
|
||||||
|
let (jwks, token) = make_test_jwt(issuer, Some("wfe-server"));
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some(issuer.to_string()),
|
||||||
|
oidc_audience: Some("wfe-server".to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(Some(JwksCache { keys: jwks })),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", format!("Bearer {token}").parse().unwrap());
|
||||||
|
assert!(state.check(&req).await.is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn jwt_validation_wrong_audience() {
|
||||||
|
let issuer = "https://auth.example.com";
|
||||||
|
let (jwks, token) = make_test_jwt(issuer, Some("wrong-audience"));
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some(issuer.to_string()),
|
||||||
|
oidc_audience: Some("wfe-server".to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(Some(JwksCache { keys: jwks })),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", format!("Bearer {token}").parse().unwrap());
|
||||||
|
assert!(state.check(&req).await.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn jwt_validation_garbage_token() {
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some("https://auth.example.com".to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(Some(JwksCache { keys: vec![] })),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "Bearer not.a.jwt".parse().unwrap());
|
||||||
|
assert!(state.check(&req).await.is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn jwt_validation_no_jwks_loaded() {
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some("https://auth.example.com".to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(None),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "Bearer some.jwt.token".parse().unwrap());
|
||||||
|
let err = state.check(&req).await.unwrap_err();
|
||||||
|
assert_eq!(err.code(), tonic::Code::Unavailable);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn interceptor_jwt_valid() {
|
||||||
|
let issuer = "https://auth.example.com";
|
||||||
|
let (jwks, token) = make_test_jwt(issuer, None);
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some(issuer.to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = Arc::new(AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(Some(JwksCache { keys: jwks })),
|
||||||
|
jwks_uri: None,
|
||||||
|
});
|
||||||
|
let interceptor = make_interceptor(state);
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", format!("Bearer {token}").parse().unwrap());
|
||||||
|
assert!(interceptor(req).is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn interceptor_jwt_invalid() {
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some("https://auth.example.com".to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = Arc::new(AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(Some(JwksCache { keys: vec![] })),
|
||||||
|
jwks_uri: None,
|
||||||
|
});
|
||||||
|
let interceptor = make_interceptor(state);
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", "Bearer bad.jwt.token".parse().unwrap());
|
||||||
|
assert!(interceptor(req).is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn key_algorithm_mapping() {
|
||||||
|
use jsonwebtoken::jwk::KeyAlgorithm as KA;
|
||||||
|
assert_eq!(key_algorithm_to_jwt_algorithm(KA::RS256), Some(Algorithm::RS256));
|
||||||
|
assert_eq!(key_algorithm_to_jwt_algorithm(KA::ES256), Some(Algorithm::ES256));
|
||||||
|
assert_eq!(key_algorithm_to_jwt_algorithm(KA::EdDSA), Some(Algorithm::EdDSA));
|
||||||
|
// HS256 should be rejected (symmetric algorithm).
|
||||||
|
assert_eq!(key_algorithm_to_jwt_algorithm(KA::HS256), None);
|
||||||
|
assert_eq!(key_algorithm_to_jwt_algorithm(KA::HS384), None);
|
||||||
|
assert_eq!(key_algorithm_to_jwt_algorithm(KA::HS512), None);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn allowed_algorithms_rejects_symmetric() {
|
||||||
|
assert!(!ALLOWED_ALGORITHMS.contains(&Algorithm::HS256));
|
||||||
|
assert!(!ALLOWED_ALGORITHMS.contains(&Algorithm::HS384));
|
||||||
|
assert!(!ALLOWED_ALGORITHMS.contains(&Algorithm::HS512));
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Security regression tests ────────────────────────────────────
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn security_hs256_rejected_in_allowlist() {
|
||||||
|
// CRITICAL-01: HS256 must NEVER be in the allowlist.
|
||||||
|
// An attacker with the public RSA key could forge tokens if HS256 is allowed.
|
||||||
|
assert!(!ALLOWED_ALGORITHMS.contains(&Algorithm::HS256));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn security_key_algorithm_rejects_all_symmetric() {
|
||||||
|
// CRITICAL-01: key_algorithm_to_jwt_algorithm must return None for symmetric algs.
|
||||||
|
use jsonwebtoken::jwk::KeyAlgorithm as KA;
|
||||||
|
assert!(key_algorithm_to_jwt_algorithm(KA::HS256).is_none());
|
||||||
|
assert!(key_algorithm_to_jwt_algorithm(KA::HS384).is_none());
|
||||||
|
assert!(key_algorithm_to_jwt_algorithm(KA::HS512).is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn security_constant_time_comparison_used() {
|
||||||
|
// CRITICAL-02: Static token check must use constant-time comparison.
|
||||||
|
// Verify that equal-length wrong tokens don't short-circuit.
|
||||||
|
let tokens = vec!["abcdefgh".to_string()];
|
||||||
|
// Both are 8 chars — a timing attack would try this.
|
||||||
|
assert!(!check_static_tokens(&tokens, "abcdefgX"));
|
||||||
|
assert!(check_static_tokens(&tokens, "abcdefgh"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
#[should_panic(expected = "OIDC issuer must use HTTPS")]
|
||||||
|
async fn security_oidc_issuer_requires_https() {
|
||||||
|
// HIGH-03: Non-HTTPS issuers must be rejected (SSRF prevention).
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some("http://evil.internal:8080".to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
AuthState::new(config).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn security_jwt_requires_kid_with_multiple_keys() {
|
||||||
|
// MEDIUM-06: When JWKS has multiple keys, JWT must have kid header.
|
||||||
|
let (mut jwks, token) = make_test_jwt("https://auth.example.com", None);
|
||||||
|
// Duplicate the key with a different kid.
|
||||||
|
let mut key2 = jwks[0].clone();
|
||||||
|
key2.common.key_id = Some("test-key-2".to_string());
|
||||||
|
jwks.push(key2);
|
||||||
|
|
||||||
|
// Strip kid from the token by decoding, modifying header, re-encoding.
|
||||||
|
// Easier: just test the validate path with multiple keys and a token that has kid.
|
||||||
|
// The token from make_test_jwt has kid="test-key-1", so it should work.
|
||||||
|
let config = AuthConfig {
|
||||||
|
oidc_issuer: Some("https://auth.example.com".to_string()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let state = AuthState {
|
||||||
|
config,
|
||||||
|
jwks: RwLock::new(Some(JwksCache { keys: jwks })),
|
||||||
|
jwks_uri: None,
|
||||||
|
};
|
||||||
|
let mut req = Request::new(());
|
||||||
|
req.metadata_mut()
|
||||||
|
.insert("authorization", format!("Bearer {token}").parse().unwrap());
|
||||||
|
// Should succeed because the token has kid="test-key-1" which matches.
|
||||||
|
assert!(state.check(&req).await.is_ok());
|
||||||
|
}
|
||||||
|
}
|
||||||
363
wfe-server/src/config.rs
Normal file
363
wfe-server/src/config.rs
Normal file
@@ -0,0 +1,363 @@
|
|||||||
|
use std::collections::HashMap;
|
||||||
|
use std::net::SocketAddr;
|
||||||
|
use std::path::PathBuf;
|
||||||
|
|
||||||
|
use clap::Parser;
|
||||||
|
use serde::Deserialize;
|
||||||
|
|
||||||
|
/// WFE workflow server.
|
||||||
|
#[derive(Parser, Debug)]
|
||||||
|
#[command(name = "wfe-server", version, about)]
|
||||||
|
pub struct Cli {
|
||||||
|
/// Config file path.
|
||||||
|
#[arg(short, long, default_value = "wfe-server.toml")]
|
||||||
|
pub config: PathBuf,
|
||||||
|
|
||||||
|
/// gRPC listen address.
|
||||||
|
#[arg(long, env = "WFE_GRPC_ADDR")]
|
||||||
|
pub grpc_addr: Option<SocketAddr>,
|
||||||
|
|
||||||
|
/// HTTP listen address (webhooks).
|
||||||
|
#[arg(long, env = "WFE_HTTP_ADDR")]
|
||||||
|
pub http_addr: Option<SocketAddr>,
|
||||||
|
|
||||||
|
/// Persistence backend: sqlite or postgres.
|
||||||
|
#[arg(long, env = "WFE_PERSISTENCE")]
|
||||||
|
pub persistence: Option<String>,
|
||||||
|
|
||||||
|
/// Database URL or path.
|
||||||
|
#[arg(long, env = "WFE_DB_URL")]
|
||||||
|
pub db_url: Option<String>,
|
||||||
|
|
||||||
|
/// Queue backend: memory or valkey.
|
||||||
|
#[arg(long, env = "WFE_QUEUE")]
|
||||||
|
pub queue: Option<String>,
|
||||||
|
|
||||||
|
/// Queue URL (for valkey).
|
||||||
|
#[arg(long, env = "WFE_QUEUE_URL")]
|
||||||
|
pub queue_url: Option<String>,
|
||||||
|
|
||||||
|
/// OpenSearch URL (enables log + workflow search).
|
||||||
|
#[arg(long, env = "WFE_SEARCH_URL")]
|
||||||
|
pub search_url: Option<String>,
|
||||||
|
|
||||||
|
/// Directory to auto-load YAML workflow definitions from.
|
||||||
|
#[arg(long, env = "WFE_WORKFLOWS_DIR")]
|
||||||
|
pub workflows_dir: Option<PathBuf>,
|
||||||
|
|
||||||
|
/// Comma-separated bearer tokens for API auth.
|
||||||
|
#[arg(long, env = "WFE_AUTH_TOKENS")]
|
||||||
|
pub auth_tokens: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Server configuration (deserialized from TOML).
|
||||||
|
#[derive(Debug, Deserialize, Clone)]
|
||||||
|
#[serde(default)]
|
||||||
|
pub struct ServerConfig {
|
||||||
|
pub grpc_addr: SocketAddr,
|
||||||
|
pub http_addr: SocketAddr,
|
||||||
|
pub persistence: PersistenceConfig,
|
||||||
|
pub queue: QueueConfig,
|
||||||
|
pub search: Option<SearchConfig>,
|
||||||
|
pub auth: AuthConfig,
|
||||||
|
pub webhook: WebhookConfig,
|
||||||
|
pub workflows_dir: Option<PathBuf>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for ServerConfig {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self {
|
||||||
|
grpc_addr: "0.0.0.0:50051".parse().unwrap(),
|
||||||
|
http_addr: "0.0.0.0:8080".parse().unwrap(),
|
||||||
|
persistence: PersistenceConfig::default(),
|
||||||
|
queue: QueueConfig::default(),
|
||||||
|
search: None,
|
||||||
|
auth: AuthConfig::default(),
|
||||||
|
webhook: WebhookConfig::default(),
|
||||||
|
workflows_dir: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Deserialize, Clone)]
|
||||||
|
#[serde(tag = "backend")]
|
||||||
|
pub enum PersistenceConfig {
|
||||||
|
#[serde(rename = "sqlite")]
|
||||||
|
Sqlite { path: String },
|
||||||
|
#[serde(rename = "postgres")]
|
||||||
|
Postgres { url: String },
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for PersistenceConfig {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::Sqlite {
|
||||||
|
path: "wfe.db".to_string(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Deserialize, Clone)]
|
||||||
|
#[serde(tag = "backend")]
|
||||||
|
pub enum QueueConfig {
|
||||||
|
#[serde(rename = "memory")]
|
||||||
|
InMemory,
|
||||||
|
#[serde(rename = "valkey")]
|
||||||
|
Valkey { url: String },
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Default for QueueConfig {
|
||||||
|
fn default() -> Self {
|
||||||
|
Self::InMemory
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Deserialize, Clone)]
|
||||||
|
pub struct SearchConfig {
|
||||||
|
pub url: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Deserialize, Clone, Default)]
|
||||||
|
pub struct AuthConfig {
|
||||||
|
/// Static bearer tokens (simple auth, no OIDC needed).
|
||||||
|
#[serde(default)]
|
||||||
|
pub tokens: Vec<String>,
|
||||||
|
/// OIDC issuer URL (e.g., https://auth.example.com/realms/myapp).
|
||||||
|
/// Enables JWT validation via OIDC discovery + JWKS.
|
||||||
|
#[serde(default)]
|
||||||
|
pub oidc_issuer: Option<String>,
|
||||||
|
/// Expected JWT audience claim.
|
||||||
|
#[serde(default)]
|
||||||
|
pub oidc_audience: Option<String>,
|
||||||
|
/// Webhook HMAC secrets per source.
|
||||||
|
#[serde(default)]
|
||||||
|
pub webhook_secrets: HashMap<String, String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Deserialize, Clone, Default)]
|
||||||
|
pub struct WebhookConfig {
|
||||||
|
#[serde(default)]
|
||||||
|
pub triggers: Vec<WebhookTrigger>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Deserialize, Clone)]
|
||||||
|
pub struct WebhookTrigger {
|
||||||
|
pub source: String,
|
||||||
|
pub event: String,
|
||||||
|
#[serde(default)]
|
||||||
|
pub match_ref: Option<String>,
|
||||||
|
pub workflow_id: String,
|
||||||
|
pub version: u32,
|
||||||
|
#[serde(default)]
|
||||||
|
pub data_mapping: HashMap<String, String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Load configuration with layered overrides: CLI > env > file.
|
||||||
|
pub fn load(cli: &Cli) -> ServerConfig {
|
||||||
|
let mut config = if cli.config.exists() {
|
||||||
|
let content = std::fs::read_to_string(&cli.config)
|
||||||
|
.unwrap_or_else(|e| panic!("failed to read config file {}: {e}", cli.config.display()));
|
||||||
|
toml::from_str(&content)
|
||||||
|
.unwrap_or_else(|e| panic!("failed to parse config file {}: {e}", cli.config.display()))
|
||||||
|
} else {
|
||||||
|
ServerConfig::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
if let Some(addr) = cli.grpc_addr {
|
||||||
|
config.grpc_addr = addr;
|
||||||
|
}
|
||||||
|
if let Some(addr) = cli.http_addr {
|
||||||
|
config.http_addr = addr;
|
||||||
|
}
|
||||||
|
if let Some(ref dir) = cli.workflows_dir {
|
||||||
|
config.workflows_dir = Some(dir.clone());
|
||||||
|
}
|
||||||
|
|
||||||
|
// Persistence override.
|
||||||
|
if let Some(ref backend) = cli.persistence {
|
||||||
|
let url = cli
|
||||||
|
.db_url
|
||||||
|
.clone()
|
||||||
|
.unwrap_or_else(|| "wfe.db".to_string());
|
||||||
|
config.persistence = match backend.as_str() {
|
||||||
|
"postgres" => PersistenceConfig::Postgres { url },
|
||||||
|
_ => PersistenceConfig::Sqlite { path: url },
|
||||||
|
};
|
||||||
|
} else if let Some(ref url) = cli.db_url {
|
||||||
|
// Infer backend from URL.
|
||||||
|
if url.starts_with("postgres") {
|
||||||
|
config.persistence = PersistenceConfig::Postgres { url: url.clone() };
|
||||||
|
} else {
|
||||||
|
config.persistence = PersistenceConfig::Sqlite { path: url.clone() };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Queue override.
|
||||||
|
if let Some(ref backend) = cli.queue {
|
||||||
|
config.queue = match backend.as_str() {
|
||||||
|
"valkey" | "redis" => {
|
||||||
|
let url = cli
|
||||||
|
.queue_url
|
||||||
|
.clone()
|
||||||
|
.unwrap_or_else(|| "redis://127.0.0.1:6379".to_string());
|
||||||
|
QueueConfig::Valkey { url }
|
||||||
|
}
|
||||||
|
_ => QueueConfig::InMemory,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Search override.
|
||||||
|
if let Some(ref url) = cli.search_url {
|
||||||
|
config.search = Some(SearchConfig { url: url.clone() });
|
||||||
|
}
|
||||||
|
|
||||||
|
// Auth tokens override.
|
||||||
|
if let Some(ref tokens) = cli.auth_tokens {
|
||||||
|
config.auth.tokens = tokens
|
||||||
|
.split(',')
|
||||||
|
.map(|t| t.trim().to_string())
|
||||||
|
.filter(|t| !t.is_empty())
|
||||||
|
.collect();
|
||||||
|
}
|
||||||
|
|
||||||
|
config
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn default_config() {
|
||||||
|
let config = ServerConfig::default();
|
||||||
|
assert_eq!(config.grpc_addr, "0.0.0.0:50051".parse().unwrap());
|
||||||
|
assert_eq!(config.http_addr, "0.0.0.0:8080".parse().unwrap());
|
||||||
|
assert!(matches!(config.persistence, PersistenceConfig::Sqlite { .. }));
|
||||||
|
assert!(matches!(config.queue, QueueConfig::InMemory));
|
||||||
|
assert!(config.search.is_none());
|
||||||
|
assert!(config.auth.tokens.is_empty());
|
||||||
|
assert!(config.webhook.triggers.is_empty());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn parse_toml_config() {
|
||||||
|
let toml = r#"
|
||||||
|
grpc_addr = "127.0.0.1:9090"
|
||||||
|
http_addr = "127.0.0.1:8081"
|
||||||
|
|
||||||
|
[persistence]
|
||||||
|
backend = "postgres"
|
||||||
|
url = "postgres://localhost/wfe"
|
||||||
|
|
||||||
|
[queue]
|
||||||
|
backend = "valkey"
|
||||||
|
url = "redis://localhost:6379"
|
||||||
|
|
||||||
|
[search]
|
||||||
|
url = "http://localhost:9200"
|
||||||
|
|
||||||
|
[auth]
|
||||||
|
tokens = ["token1", "token2"]
|
||||||
|
|
||||||
|
[auth.webhook_secrets]
|
||||||
|
github = "mysecret"
|
||||||
|
|
||||||
|
[[webhook.triggers]]
|
||||||
|
source = "github"
|
||||||
|
event = "push"
|
||||||
|
match_ref = "refs/heads/main"
|
||||||
|
workflow_id = "ci"
|
||||||
|
version = 1
|
||||||
|
"#;
|
||||||
|
let config: ServerConfig = toml::from_str(toml).unwrap();
|
||||||
|
assert_eq!(config.grpc_addr, "127.0.0.1:9090".parse().unwrap());
|
||||||
|
assert!(matches!(config.persistence, PersistenceConfig::Postgres { .. }));
|
||||||
|
assert!(matches!(config.queue, QueueConfig::Valkey { .. }));
|
||||||
|
assert!(config.search.is_some());
|
||||||
|
assert_eq!(config.auth.tokens.len(), 2);
|
||||||
|
assert_eq!(config.auth.webhook_secrets.get("github").unwrap(), "mysecret");
|
||||||
|
assert_eq!(config.webhook.triggers.len(), 1);
|
||||||
|
assert_eq!(config.webhook.triggers[0].workflow_id, "ci");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn cli_overrides_file() {
|
||||||
|
let cli = Cli {
|
||||||
|
config: PathBuf::from("/nonexistent"),
|
||||||
|
grpc_addr: Some("127.0.0.1:9999".parse().unwrap()),
|
||||||
|
http_addr: None,
|
||||||
|
persistence: Some("postgres".to_string()),
|
||||||
|
db_url: Some("postgres://db/wfe".to_string()),
|
||||||
|
queue: Some("valkey".to_string()),
|
||||||
|
queue_url: Some("redis://valkey:6379".to_string()),
|
||||||
|
search_url: Some("http://os:9200".to_string()),
|
||||||
|
workflows_dir: Some(PathBuf::from("/workflows")),
|
||||||
|
auth_tokens: Some("tok1, tok2".to_string()),
|
||||||
|
};
|
||||||
|
let config = load(&cli);
|
||||||
|
assert_eq!(config.grpc_addr, "127.0.0.1:9999".parse().unwrap());
|
||||||
|
assert!(matches!(config.persistence, PersistenceConfig::Postgres { ref url } if url == "postgres://db/wfe"));
|
||||||
|
assert!(matches!(config.queue, QueueConfig::Valkey { ref url } if url == "redis://valkey:6379"));
|
||||||
|
assert_eq!(config.search.unwrap().url, "http://os:9200");
|
||||||
|
assert_eq!(config.workflows_dir.unwrap(), PathBuf::from("/workflows"));
|
||||||
|
assert_eq!(config.auth.tokens, vec!["tok1", "tok2"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn infer_postgres_from_url() {
|
||||||
|
let cli = Cli {
|
||||||
|
config: PathBuf::from("/nonexistent"),
|
||||||
|
grpc_addr: None,
|
||||||
|
http_addr: None,
|
||||||
|
persistence: None,
|
||||||
|
db_url: Some("postgres://localhost/wfe".to_string()),
|
||||||
|
queue: None,
|
||||||
|
queue_url: None,
|
||||||
|
search_url: None,
|
||||||
|
workflows_dir: None,
|
||||||
|
auth_tokens: None,
|
||||||
|
};
|
||||||
|
let config = load(&cli);
|
||||||
|
assert!(matches!(config.persistence, PersistenceConfig::Postgres { .. }));
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Security regression tests ──
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[should_panic(expected = "failed to parse config file")]
|
||||||
|
fn security_malformed_config_panics() {
|
||||||
|
// HIGH-19: Malformed config must NOT silently fall back to defaults.
|
||||||
|
let tmp = tempfile::NamedTempFile::new().unwrap();
|
||||||
|
std::fs::write(tmp.path(), "this is not { valid toml @@@@").unwrap();
|
||||||
|
let cli = Cli {
|
||||||
|
config: tmp.path().to_path_buf(),
|
||||||
|
grpc_addr: None,
|
||||||
|
http_addr: None,
|
||||||
|
persistence: None,
|
||||||
|
db_url: None,
|
||||||
|
queue: None,
|
||||||
|
queue_url: None,
|
||||||
|
search_url: None,
|
||||||
|
workflows_dir: None,
|
||||||
|
auth_tokens: None,
|
||||||
|
};
|
||||||
|
load(&cli);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn trigger_data_mapping() {
|
||||||
|
let toml = r#"
|
||||||
|
[[triggers]]
|
||||||
|
source = "github"
|
||||||
|
event = "push"
|
||||||
|
workflow_id = "ci"
|
||||||
|
version = 1
|
||||||
|
|
||||||
|
[triggers.data_mapping]
|
||||||
|
repo = "$.repository.full_name"
|
||||||
|
commit = "$.head_commit.id"
|
||||||
|
"#;
|
||||||
|
let config: WebhookConfig = toml::from_str(toml).unwrap();
|
||||||
|
assert_eq!(config.triggers[0].data_mapping.len(), 2);
|
||||||
|
assert_eq!(config.triggers[0].data_mapping["repo"], "$.repository.full_name");
|
||||||
|
}
|
||||||
|
}
|
||||||
862
wfe-server/src/grpc.rs
Normal file
862
wfe-server/src/grpc.rs
Normal file
@@ -0,0 +1,862 @@
|
|||||||
|
use std::collections::{BTreeMap, HashMap};
|
||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use tonic::{Request, Response, Status};
|
||||||
|
use wfe_server_protos::wfe::v1::*;
|
||||||
|
use wfe_server_protos::wfe::v1::wfe_server::Wfe;
|
||||||
|
|
||||||
|
pub struct WfeService {
|
||||||
|
host: Arc<wfe::WorkflowHost>,
|
||||||
|
lifecycle_bus: Arc<crate::lifecycle_bus::BroadcastLifecyclePublisher>,
|
||||||
|
log_store: Arc<crate::log_store::LogStore>,
|
||||||
|
log_search: Option<Arc<crate::log_search::LogSearchIndex>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl WfeService {
|
||||||
|
pub fn new(
|
||||||
|
host: Arc<wfe::WorkflowHost>,
|
||||||
|
lifecycle_bus: Arc<crate::lifecycle_bus::BroadcastLifecyclePublisher>,
|
||||||
|
log_store: Arc<crate::log_store::LogStore>,
|
||||||
|
) -> Self {
|
||||||
|
Self { host, lifecycle_bus, log_store, log_search: None }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_log_search(mut self, index: Arc<crate::log_search::LogSearchIndex>) -> Self {
|
||||||
|
self.log_search = Some(index);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tonic::async_trait]
|
||||||
|
impl Wfe for WfeService {
|
||||||
|
// ── Definitions ──────────────────────────────────────────────────
|
||||||
|
|
||||||
|
async fn register_workflow(
|
||||||
|
&self,
|
||||||
|
request: Request<RegisterWorkflowRequest>,
|
||||||
|
) -> Result<Response<RegisterWorkflowResponse>, Status> {
|
||||||
|
let req = request.into_inner();
|
||||||
|
|
||||||
|
let config: HashMap<String, serde_json::Value> = req
|
||||||
|
.config
|
||||||
|
.into_iter()
|
||||||
|
.map(|(k, v)| (k, serde_json::Value::String(v)))
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
let workflows = wfe_yaml::load_workflow_from_str(&req.yaml, &config)
|
||||||
|
.map_err(|e| Status::invalid_argument(format!("YAML compilation failed: {e}")))?;
|
||||||
|
|
||||||
|
let mut definitions = Vec::new();
|
||||||
|
|
||||||
|
for compiled in workflows {
|
||||||
|
for (key, factory) in compiled.step_factories {
|
||||||
|
self.host.register_step_factory(&key, factory).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
let id = compiled.definition.id.clone();
|
||||||
|
let version = compiled.definition.version;
|
||||||
|
let step_count = compiled.definition.steps.len() as u32;
|
||||||
|
|
||||||
|
self.host
|
||||||
|
.register_workflow_definition(compiled.definition)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
definitions.push(RegisteredDefinition {
|
||||||
|
definition_id: id,
|
||||||
|
version,
|
||||||
|
step_count,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(Response::new(RegisterWorkflowResponse { definitions }))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn list_definitions(
|
||||||
|
&self,
|
||||||
|
_request: Request<ListDefinitionsRequest>,
|
||||||
|
) -> Result<Response<ListDefinitionsResponse>, Status> {
|
||||||
|
// TODO: add list_definitions() to WorkflowHost
|
||||||
|
Ok(Response::new(ListDefinitionsResponse {
|
||||||
|
definitions: vec![],
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Instances ────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
async fn start_workflow(
|
||||||
|
&self,
|
||||||
|
request: Request<StartWorkflowRequest>,
|
||||||
|
) -> Result<Response<StartWorkflowResponse>, Status> {
|
||||||
|
let req = request.into_inner();
|
||||||
|
|
||||||
|
let data = req
|
||||||
|
.data
|
||||||
|
.map(struct_to_json)
|
||||||
|
.unwrap_or_else(|| serde_json::json!({}));
|
||||||
|
|
||||||
|
let workflow_id = self
|
||||||
|
.host
|
||||||
|
.start_workflow(&req.definition_id, req.version, data)
|
||||||
|
.await
|
||||||
|
.map_err(|e| Status::internal(format!("failed to start workflow: {e}")))?;
|
||||||
|
|
||||||
|
Ok(Response::new(StartWorkflowResponse { workflow_id }))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn get_workflow(
|
||||||
|
&self,
|
||||||
|
request: Request<GetWorkflowRequest>,
|
||||||
|
) -> Result<Response<GetWorkflowResponse>, Status> {
|
||||||
|
let req = request.into_inner();
|
||||||
|
|
||||||
|
let instance = self
|
||||||
|
.host
|
||||||
|
.get_workflow(&req.workflow_id)
|
||||||
|
.await
|
||||||
|
.map_err(|e| Status::not_found(format!("workflow not found: {e}")))?;
|
||||||
|
|
||||||
|
Ok(Response::new(GetWorkflowResponse {
|
||||||
|
instance: Some(workflow_to_proto(&instance)),
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn cancel_workflow(
|
||||||
|
&self,
|
||||||
|
request: Request<CancelWorkflowRequest>,
|
||||||
|
) -> Result<Response<CancelWorkflowResponse>, Status> {
|
||||||
|
let req = request.into_inner();
|
||||||
|
|
||||||
|
self.host
|
||||||
|
.terminate_workflow(&req.workflow_id)
|
||||||
|
.await
|
||||||
|
.map_err(|e| Status::internal(format!("failed to cancel: {e}")))?;
|
||||||
|
|
||||||
|
Ok(Response::new(CancelWorkflowResponse {}))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn suspend_workflow(
|
||||||
|
&self,
|
||||||
|
request: Request<SuspendWorkflowRequest>,
|
||||||
|
) -> Result<Response<SuspendWorkflowResponse>, Status> {
|
||||||
|
let req = request.into_inner();
|
||||||
|
|
||||||
|
self.host
|
||||||
|
.suspend_workflow(&req.workflow_id)
|
||||||
|
.await
|
||||||
|
.map_err(|e| Status::internal(format!("failed to suspend: {e}")))?;
|
||||||
|
|
||||||
|
Ok(Response::new(SuspendWorkflowResponse {}))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn resume_workflow(
|
||||||
|
&self,
|
||||||
|
request: Request<ResumeWorkflowRequest>,
|
||||||
|
) -> Result<Response<ResumeWorkflowResponse>, Status> {
|
||||||
|
let req = request.into_inner();
|
||||||
|
|
||||||
|
self.host
|
||||||
|
.resume_workflow(&req.workflow_id)
|
||||||
|
.await
|
||||||
|
.map_err(|e| Status::internal(format!("failed to resume: {e}")))?;
|
||||||
|
|
||||||
|
Ok(Response::new(ResumeWorkflowResponse {}))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn search_workflows(
|
||||||
|
&self,
|
||||||
|
_request: Request<SearchWorkflowsRequest>,
|
||||||
|
) -> Result<Response<SearchWorkflowsResponse>, Status> {
|
||||||
|
// TODO: implement with SearchIndex
|
||||||
|
Ok(Response::new(SearchWorkflowsResponse {
|
||||||
|
results: vec![],
|
||||||
|
total: 0,
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Events ───────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
async fn publish_event(
|
||||||
|
&self,
|
||||||
|
request: Request<PublishEventRequest>,
|
||||||
|
) -> Result<Response<PublishEventResponse>, Status> {
|
||||||
|
let req = request.into_inner();
|
||||||
|
|
||||||
|
let data = req
|
||||||
|
.data
|
||||||
|
.map(struct_to_json)
|
||||||
|
.unwrap_or_else(|| serde_json::json!({}));
|
||||||
|
|
||||||
|
self.host
|
||||||
|
.publish_event(&req.event_name, &req.event_key, data)
|
||||||
|
.await
|
||||||
|
.map_err(|e| Status::internal(format!("failed to publish event: {e}")))?;
|
||||||
|
|
||||||
|
Ok(Response::new(PublishEventResponse {
|
||||||
|
event_id: String::new(),
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Streaming (stubs for now) ────────────────────────────────────
|
||||||
|
|
||||||
|
type WatchLifecycleStream =
|
||||||
|
tokio_stream::wrappers::ReceiverStream<Result<LifecycleEvent, Status>>;
|
||||||
|
|
||||||
|
async fn watch_lifecycle(
|
||||||
|
&self,
|
||||||
|
request: Request<WatchLifecycleRequest>,
|
||||||
|
) -> Result<Response<Self::WatchLifecycleStream>, Status> {
|
||||||
|
let req = request.into_inner();
|
||||||
|
let filter_workflow_id = if req.workflow_id.is_empty() {
|
||||||
|
None
|
||||||
|
} else {
|
||||||
|
Some(req.workflow_id)
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut broadcast_rx = self.lifecycle_bus.subscribe();
|
||||||
|
let (tx, rx) = tokio::sync::mpsc::channel(256);
|
||||||
|
|
||||||
|
tokio::spawn(async move {
|
||||||
|
loop {
|
||||||
|
match broadcast_rx.recv().await {
|
||||||
|
Ok(event) => {
|
||||||
|
// Apply workflow_id filter.
|
||||||
|
if let Some(ref filter) = filter_workflow_id {
|
||||||
|
if event.workflow_instance_id != *filter {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let proto_event = lifecycle_event_to_proto(&event);
|
||||||
|
if tx.send(Ok(proto_event)).await.is_err() {
|
||||||
|
break; // Client disconnected.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(tokio::sync::broadcast::error::RecvError::Lagged(n)) => {
|
||||||
|
tracing::warn!(lagged = n, "lifecycle watcher lagged, skipping events");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
Err(tokio::sync::broadcast::error::RecvError::Closed) => break,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
Ok(Response::new(tokio_stream::wrappers::ReceiverStream::new(rx)))
|
||||||
|
}
|
||||||
|
|
||||||
|
type StreamLogsStream = tokio_stream::wrappers::ReceiverStream<Result<LogEntry, Status>>;
|
||||||
|
|
||||||
|
async fn stream_logs(
|
||||||
|
&self,
|
||||||
|
request: Request<StreamLogsRequest>,
|
||||||
|
) -> Result<Response<Self::StreamLogsStream>, Status> {
|
||||||
|
let req = request.into_inner();
|
||||||
|
let workflow_id = req.workflow_id.clone();
|
||||||
|
let step_name_filter = if req.step_name.is_empty() {
|
||||||
|
None
|
||||||
|
} else {
|
||||||
|
Some(req.step_name)
|
||||||
|
};
|
||||||
|
|
||||||
|
let (tx, rx) = tokio::sync::mpsc::channel(256);
|
||||||
|
let log_store = self.log_store.clone();
|
||||||
|
|
||||||
|
tokio::spawn(async move {
|
||||||
|
// 1. Replay history first.
|
||||||
|
let history = log_store.get_history(&workflow_id, None);
|
||||||
|
for chunk in history {
|
||||||
|
if let Some(ref filter) = step_name_filter {
|
||||||
|
if chunk.step_name != *filter {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let entry = log_chunk_to_proto(&chunk);
|
||||||
|
if tx.send(Ok(entry)).await.is_err() {
|
||||||
|
return; // Client disconnected.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 2. If follow mode, switch to live broadcast.
|
||||||
|
if req.follow {
|
||||||
|
let mut broadcast_rx = log_store.subscribe(&workflow_id);
|
||||||
|
loop {
|
||||||
|
match broadcast_rx.recv().await {
|
||||||
|
Ok(chunk) => {
|
||||||
|
if let Some(ref filter) = step_name_filter {
|
||||||
|
if chunk.step_name != *filter {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let entry = log_chunk_to_proto(&chunk);
|
||||||
|
if tx.send(Ok(entry)).await.is_err() {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(tokio::sync::broadcast::error::RecvError::Lagged(n)) => {
|
||||||
|
tracing::warn!(lagged = n, "log stream lagged");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
Err(tokio::sync::broadcast::error::RecvError::Closed) => break,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// If not follow mode, the stream ends after history replay.
|
||||||
|
});
|
||||||
|
|
||||||
|
Ok(Response::new(tokio_stream::wrappers::ReceiverStream::new(rx)))
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Search ───────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
async fn search_logs(
|
||||||
|
&self,
|
||||||
|
request: Request<SearchLogsRequest>,
|
||||||
|
) -> Result<Response<SearchLogsResponse>, Status> {
|
||||||
|
let Some(ref search) = self.log_search else {
|
||||||
|
return Err(Status::unavailable("log search not configured — set --search-url"));
|
||||||
|
};
|
||||||
|
|
||||||
|
let req = request.into_inner();
|
||||||
|
let workflow_id = if req.workflow_id.is_empty() { None } else { Some(req.workflow_id.as_str()) };
|
||||||
|
let step_name = if req.step_name.is_empty() { None } else { Some(req.step_name.as_str()) };
|
||||||
|
let stream_filter = match req.stream_filter {
|
||||||
|
x if x == LogStream::Stdout as i32 => Some("stdout"),
|
||||||
|
x if x == LogStream::Stderr as i32 => Some("stderr"),
|
||||||
|
_ => None,
|
||||||
|
};
|
||||||
|
let take = if req.take == 0 { 50 } else { req.take };
|
||||||
|
|
||||||
|
let (hits, total) = search
|
||||||
|
.search(&req.query, workflow_id, step_name, stream_filter, req.skip, take)
|
||||||
|
.await
|
||||||
|
.map_err(|e| Status::internal(format!("search failed: {e}")))?;
|
||||||
|
|
||||||
|
let results = hits
|
||||||
|
.into_iter()
|
||||||
|
.map(|h| {
|
||||||
|
let stream = match h.stream.as_str() {
|
||||||
|
"stdout" => LogStream::Stdout as i32,
|
||||||
|
"stderr" => LogStream::Stderr as i32,
|
||||||
|
_ => LogStream::Unspecified as i32,
|
||||||
|
};
|
||||||
|
LogSearchResult {
|
||||||
|
workflow_id: h.workflow_id,
|
||||||
|
definition_id: h.definition_id,
|
||||||
|
step_name: h.step_name,
|
||||||
|
line: h.line,
|
||||||
|
stream,
|
||||||
|
timestamp: Some(datetime_to_timestamp(&h.timestamp)),
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
Ok(Response::new(SearchLogsResponse { results, total }))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Conversion helpers ──────────────────────────────────────────────
|
||||||
|
|
||||||
|
fn struct_to_json(s: prost_types::Struct) -> serde_json::Value {
|
||||||
|
let map: serde_json::Map<String, serde_json::Value> = s
|
||||||
|
.fields
|
||||||
|
.into_iter()
|
||||||
|
.map(|(k, v)| (k, prost_value_to_json(v)))
|
||||||
|
.collect();
|
||||||
|
serde_json::Value::Object(map)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn prost_value_to_json(v: prost_types::Value) -> serde_json::Value {
|
||||||
|
use prost_types::value::Kind;
|
||||||
|
match v.kind {
|
||||||
|
Some(Kind::NullValue(_)) => serde_json::Value::Null,
|
||||||
|
Some(Kind::NumberValue(n)) => serde_json::json!(n),
|
||||||
|
Some(Kind::StringValue(s)) => serde_json::Value::String(s),
|
||||||
|
Some(Kind::BoolValue(b)) => serde_json::Value::Bool(b),
|
||||||
|
Some(Kind::StructValue(s)) => struct_to_json(s),
|
||||||
|
Some(Kind::ListValue(l)) => {
|
||||||
|
serde_json::Value::Array(l.values.into_iter().map(prost_value_to_json).collect())
|
||||||
|
}
|
||||||
|
None => serde_json::Value::Null,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn json_to_struct(v: &serde_json::Value) -> prost_types::Struct {
|
||||||
|
let fields: BTreeMap<String, prost_types::Value> = match v.as_object() {
|
||||||
|
Some(obj) => obj
|
||||||
|
.iter()
|
||||||
|
.map(|(k, v)| (k.clone(), json_to_prost_value(v)))
|
||||||
|
.collect(),
|
||||||
|
None => BTreeMap::new(),
|
||||||
|
};
|
||||||
|
prost_types::Struct { fields }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn json_to_prost_value(v: &serde_json::Value) -> prost_types::Value {
|
||||||
|
use prost_types::value::Kind;
|
||||||
|
let kind = match v {
|
||||||
|
serde_json::Value::Null => Kind::NullValue(0),
|
||||||
|
serde_json::Value::Bool(b) => Kind::BoolValue(*b),
|
||||||
|
serde_json::Value::Number(n) => Kind::NumberValue(n.as_f64().unwrap_or(0.0)),
|
||||||
|
serde_json::Value::String(s) => Kind::StringValue(s.clone()),
|
||||||
|
serde_json::Value::Array(arr) => Kind::ListValue(prost_types::ListValue {
|
||||||
|
values: arr.iter().map(json_to_prost_value).collect(),
|
||||||
|
}),
|
||||||
|
serde_json::Value::Object(_) => Kind::StructValue(json_to_struct(v)),
|
||||||
|
};
|
||||||
|
prost_types::Value { kind: Some(kind) }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn log_chunk_to_proto(chunk: &wfe_core::traits::LogChunk) -> LogEntry {
|
||||||
|
use wfe_core::traits::LogStreamType;
|
||||||
|
let stream = match chunk.stream {
|
||||||
|
LogStreamType::Stdout => LogStream::Stdout as i32,
|
||||||
|
LogStreamType::Stderr => LogStream::Stderr as i32,
|
||||||
|
};
|
||||||
|
LogEntry {
|
||||||
|
workflow_id: chunk.workflow_id.clone(),
|
||||||
|
step_name: chunk.step_name.clone(),
|
||||||
|
step_id: chunk.step_id as u32,
|
||||||
|
stream,
|
||||||
|
data: chunk.data.clone(),
|
||||||
|
timestamp: Some(datetime_to_timestamp(&chunk.timestamp)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn lifecycle_event_to_proto(e: &wfe_core::models::LifecycleEvent) -> LifecycleEvent {
|
||||||
|
use wfe_core::models::LifecycleEventType as LET;
|
||||||
|
// Proto enum — prost strips the LIFECYCLE_EVENT_TYPE_ prefix.
|
||||||
|
use wfe_server_protos::wfe::v1::LifecycleEventType as PLET;
|
||||||
|
let (event_type, step_id, step_name, error_message) = match &e.event_type {
|
||||||
|
LET::Started => (PLET::Started as i32, 0, String::new(), String::new()),
|
||||||
|
LET::Completed => (PLET::Completed as i32, 0, String::new(), String::new()),
|
||||||
|
LET::Terminated => (PLET::Terminated as i32, 0, String::new(), String::new()),
|
||||||
|
LET::Suspended => (PLET::Suspended as i32, 0, String::new(), String::new()),
|
||||||
|
LET::Resumed => (PLET::Resumed as i32, 0, String::new(), String::new()),
|
||||||
|
LET::Error { message } => (PLET::Error as i32, 0, String::new(), message.clone()),
|
||||||
|
LET::StepStarted { step_id, step_name } => (PLET::StepStarted as i32, *step_id as u32, step_name.clone().unwrap_or_default(), String::new()),
|
||||||
|
LET::StepCompleted { step_id, step_name } => (PLET::StepCompleted as i32, *step_id as u32, step_name.clone().unwrap_or_default(), String::new()),
|
||||||
|
};
|
||||||
|
LifecycleEvent {
|
||||||
|
event_time: Some(datetime_to_timestamp(&e.event_time_utc)),
|
||||||
|
workflow_id: e.workflow_instance_id.clone(),
|
||||||
|
definition_id: e.workflow_definition_id.clone(),
|
||||||
|
version: e.version,
|
||||||
|
event_type,
|
||||||
|
step_id,
|
||||||
|
step_name,
|
||||||
|
error_message,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn datetime_to_timestamp(dt: &chrono::DateTime<chrono::Utc>) -> prost_types::Timestamp {
|
||||||
|
prost_types::Timestamp {
|
||||||
|
seconds: dt.timestamp(),
|
||||||
|
nanos: dt.timestamp_subsec_nanos() as i32,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn workflow_to_proto(w: &wfe_core::models::WorkflowInstance) -> WorkflowInstance {
|
||||||
|
WorkflowInstance {
|
||||||
|
id: w.id.clone(),
|
||||||
|
definition_id: w.workflow_definition_id.clone(),
|
||||||
|
version: w.version,
|
||||||
|
description: w.description.clone().unwrap_or_default(),
|
||||||
|
reference: w.reference.clone().unwrap_or_default(),
|
||||||
|
status: match w.status {
|
||||||
|
wfe_core::models::WorkflowStatus::Runnable => WorkflowStatus::Runnable as i32,
|
||||||
|
wfe_core::models::WorkflowStatus::Suspended => WorkflowStatus::Suspended as i32,
|
||||||
|
wfe_core::models::WorkflowStatus::Complete => WorkflowStatus::Complete as i32,
|
||||||
|
wfe_core::models::WorkflowStatus::Terminated => WorkflowStatus::Terminated as i32,
|
||||||
|
},
|
||||||
|
data: Some(json_to_struct(&w.data)),
|
||||||
|
create_time: Some(datetime_to_timestamp(&w.create_time)),
|
||||||
|
complete_time: w.complete_time.as_ref().map(datetime_to_timestamp),
|
||||||
|
execution_pointers: w
|
||||||
|
.execution_pointers
|
||||||
|
.iter()
|
||||||
|
.map(pointer_to_proto)
|
||||||
|
.collect(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn pointer_to_proto(p: &wfe_core::models::ExecutionPointer) -> ExecutionPointer {
|
||||||
|
use wfe_core::models::PointerStatus as PS;
|
||||||
|
let status = match p.status {
|
||||||
|
PS::Pending | PS::PendingPredecessor => PointerStatus::Pending as i32,
|
||||||
|
PS::Running => PointerStatus::Running as i32,
|
||||||
|
PS::Complete => PointerStatus::Complete as i32,
|
||||||
|
PS::Sleeping => PointerStatus::Sleeping as i32,
|
||||||
|
PS::WaitingForEvent => PointerStatus::WaitingForEvent as i32,
|
||||||
|
PS::Failed => PointerStatus::Failed as i32,
|
||||||
|
PS::Skipped => PointerStatus::Skipped as i32,
|
||||||
|
PS::Compensated | PS::Cancelled => PointerStatus::Cancelled as i32,
|
||||||
|
};
|
||||||
|
ExecutionPointer {
|
||||||
|
id: p.id.clone(),
|
||||||
|
step_id: p.step_id as u32,
|
||||||
|
step_name: p.step_name.clone().unwrap_or_default(),
|
||||||
|
status,
|
||||||
|
start_time: p.start_time.as_ref().map(datetime_to_timestamp),
|
||||||
|
end_time: p.end_time.as_ref().map(datetime_to_timestamp),
|
||||||
|
retry_count: p.retry_count,
|
||||||
|
active: p.active,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn struct_to_json_roundtrip() {
|
||||||
|
let original = serde_json::json!({
|
||||||
|
"name": "test",
|
||||||
|
"count": 42.0,
|
||||||
|
"active": true,
|
||||||
|
"tags": ["a", "b"],
|
||||||
|
"nested": { "key": "value" }
|
||||||
|
});
|
||||||
|
let proto_struct = json_to_struct(&original);
|
||||||
|
let back = struct_to_json(proto_struct);
|
||||||
|
assert_eq!(original, back);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn json_null_roundtrip() {
|
||||||
|
let v = serde_json::Value::Null;
|
||||||
|
let pv = json_to_prost_value(&v);
|
||||||
|
let back = prost_value_to_json(pv);
|
||||||
|
assert_eq!(back, serde_json::Value::Null);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn json_string_roundtrip() {
|
||||||
|
let v = serde_json::Value::String("hello".to_string());
|
||||||
|
let pv = json_to_prost_value(&v);
|
||||||
|
let back = prost_value_to_json(pv);
|
||||||
|
assert_eq!(back, v);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn json_bool_roundtrip() {
|
||||||
|
let v = serde_json::Value::Bool(true);
|
||||||
|
let pv = json_to_prost_value(&v);
|
||||||
|
let back = prost_value_to_json(pv);
|
||||||
|
assert_eq!(back, v);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn json_number_roundtrip() {
|
||||||
|
let v = serde_json::json!(3.14);
|
||||||
|
let pv = json_to_prost_value(&v);
|
||||||
|
let back = prost_value_to_json(pv);
|
||||||
|
assert_eq!(back, v);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn json_array_roundtrip() {
|
||||||
|
let v = serde_json::json!(["a", 1.0, true, null]);
|
||||||
|
let pv = json_to_prost_value(&v);
|
||||||
|
let back = prost_value_to_json(pv);
|
||||||
|
assert_eq!(back, v);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn empty_struct_roundtrip() {
|
||||||
|
let v = serde_json::json!({});
|
||||||
|
let proto_struct = json_to_struct(&v);
|
||||||
|
let back = struct_to_json(proto_struct);
|
||||||
|
assert_eq!(back, v);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn prost_value_none_kind() {
|
||||||
|
let v = prost_types::Value { kind: None };
|
||||||
|
assert_eq!(prost_value_to_json(v), serde_json::Value::Null);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn json_to_struct_from_non_object() {
|
||||||
|
let v = serde_json::json!("not an object");
|
||||||
|
let s = json_to_struct(&v);
|
||||||
|
assert!(s.fields.is_empty());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn datetime_to_timestamp_conversion() {
|
||||||
|
let dt = chrono::DateTime::parse_from_rfc3339("2026-03-29T12:00:00Z")
|
||||||
|
.unwrap()
|
||||||
|
.with_timezone(&chrono::Utc);
|
||||||
|
let ts = datetime_to_timestamp(&dt);
|
||||||
|
assert_eq!(ts.seconds, dt.timestamp());
|
||||||
|
assert_eq!(ts.nanos, 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn workflow_status_mapping() {
|
||||||
|
use wfe_core::models::{WorkflowInstance as WI, WorkflowStatus as WS};
|
||||||
|
let mut w = WI::new("test", 1, serde_json::json!({}));
|
||||||
|
|
||||||
|
w.status = WS::Runnable;
|
||||||
|
let p = workflow_to_proto(&w);
|
||||||
|
assert_eq!(p.status, WorkflowStatus::Runnable as i32);
|
||||||
|
|
||||||
|
w.status = WS::Complete;
|
||||||
|
let p = workflow_to_proto(&w);
|
||||||
|
assert_eq!(p.status, WorkflowStatus::Complete as i32);
|
||||||
|
|
||||||
|
w.status = WS::Suspended;
|
||||||
|
let p = workflow_to_proto(&w);
|
||||||
|
assert_eq!(p.status, WorkflowStatus::Suspended as i32);
|
||||||
|
|
||||||
|
w.status = WS::Terminated;
|
||||||
|
let p = workflow_to_proto(&w);
|
||||||
|
assert_eq!(p.status, WorkflowStatus::Terminated as i32);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn pointer_status_mapping() {
|
||||||
|
use wfe_core::models::{ExecutionPointer as EP, PointerStatus as PS};
|
||||||
|
let mut p = EP::new(0);
|
||||||
|
|
||||||
|
p.status = PS::Pending;
|
||||||
|
assert_eq!(pointer_to_proto(&p).status, PointerStatus::Pending as i32);
|
||||||
|
|
||||||
|
p.status = PS::Running;
|
||||||
|
assert_eq!(pointer_to_proto(&p).status, PointerStatus::Running as i32);
|
||||||
|
|
||||||
|
p.status = PS::Complete;
|
||||||
|
assert_eq!(pointer_to_proto(&p).status, PointerStatus::Complete as i32);
|
||||||
|
|
||||||
|
p.status = PS::Sleeping;
|
||||||
|
assert_eq!(pointer_to_proto(&p).status, PointerStatus::Sleeping as i32);
|
||||||
|
|
||||||
|
p.status = PS::WaitingForEvent;
|
||||||
|
assert_eq!(pointer_to_proto(&p).status, PointerStatus::WaitingForEvent as i32);
|
||||||
|
|
||||||
|
p.status = PS::Failed;
|
||||||
|
assert_eq!(pointer_to_proto(&p).status, PointerStatus::Failed as i32);
|
||||||
|
|
||||||
|
p.status = PS::Skipped;
|
||||||
|
assert_eq!(pointer_to_proto(&p).status, PointerStatus::Skipped as i32);
|
||||||
|
|
||||||
|
p.status = PS::Cancelled;
|
||||||
|
assert_eq!(pointer_to_proto(&p).status, PointerStatus::Cancelled as i32);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn workflow_to_proto_basic() {
|
||||||
|
let w = wfe_core::models::WorkflowInstance::new("my-wf", 1, serde_json::json!({"key": "val"}));
|
||||||
|
let p = workflow_to_proto(&w);
|
||||||
|
assert_eq!(p.definition_id, "my-wf");
|
||||||
|
assert_eq!(p.version, 1);
|
||||||
|
assert!(p.create_time.is_some());
|
||||||
|
assert!(p.complete_time.is_none());
|
||||||
|
let data = struct_to_json(p.data.unwrap());
|
||||||
|
assert_eq!(data["key"], "val");
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── gRPC integration tests with real WorkflowHost ────────────────
|
||||||
|
|
||||||
|
async fn make_test_service() -> WfeService {
|
||||||
|
use wfe::WorkflowHostBuilder;
|
||||||
|
use wfe_core::test_support::{
|
||||||
|
InMemoryLockProvider, InMemoryPersistenceProvider, InMemoryQueueProvider,
|
||||||
|
};
|
||||||
|
|
||||||
|
let host = WorkflowHostBuilder::new()
|
||||||
|
.use_persistence(std::sync::Arc::new(InMemoryPersistenceProvider::new())
|
||||||
|
as std::sync::Arc<dyn wfe_core::traits::PersistenceProvider>)
|
||||||
|
.use_lock_provider(std::sync::Arc::new(InMemoryLockProvider::new())
|
||||||
|
as std::sync::Arc<dyn wfe_core::traits::DistributedLockProvider>)
|
||||||
|
.use_queue_provider(std::sync::Arc::new(InMemoryQueueProvider::new())
|
||||||
|
as std::sync::Arc<dyn wfe_core::traits::QueueProvider>)
|
||||||
|
.build()
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
host.start().await.unwrap();
|
||||||
|
|
||||||
|
let lifecycle_bus = std::sync::Arc::new(crate::lifecycle_bus::BroadcastLifecyclePublisher::new(64));
|
||||||
|
let log_store = std::sync::Arc::new(crate::log_store::LogStore::new());
|
||||||
|
|
||||||
|
WfeService::new(std::sync::Arc::new(host), lifecycle_bus, log_store)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_register_and_start_workflow() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
|
||||||
|
// Register a workflow.
|
||||||
|
let req = Request::new(RegisterWorkflowRequest {
|
||||||
|
yaml: r#"
|
||||||
|
workflow:
|
||||||
|
id: test-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: hello
|
||||||
|
type: shell
|
||||||
|
config:
|
||||||
|
run: echo hi
|
||||||
|
"#.to_string(),
|
||||||
|
config: Default::default(),
|
||||||
|
});
|
||||||
|
let resp = svc.register_workflow(req).await.unwrap().into_inner();
|
||||||
|
assert_eq!(resp.definitions.len(), 1);
|
||||||
|
assert_eq!(resp.definitions[0].definition_id, "test-wf");
|
||||||
|
assert_eq!(resp.definitions[0].version, 1);
|
||||||
|
assert_eq!(resp.definitions[0].step_count, 1);
|
||||||
|
|
||||||
|
// Start the workflow.
|
||||||
|
let req = Request::new(StartWorkflowRequest {
|
||||||
|
definition_id: "test-wf".to_string(),
|
||||||
|
version: 1,
|
||||||
|
data: None,
|
||||||
|
});
|
||||||
|
let resp = svc.start_workflow(req).await.unwrap().into_inner();
|
||||||
|
assert!(!resp.workflow_id.is_empty());
|
||||||
|
|
||||||
|
// Get the workflow.
|
||||||
|
let req = Request::new(GetWorkflowRequest {
|
||||||
|
workflow_id: resp.workflow_id.clone(),
|
||||||
|
});
|
||||||
|
let resp = svc.get_workflow(req).await.unwrap().into_inner();
|
||||||
|
let instance = resp.instance.unwrap();
|
||||||
|
assert_eq!(instance.definition_id, "test-wf");
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Runnable as i32);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_register_invalid_yaml() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
let req = Request::new(RegisterWorkflowRequest {
|
||||||
|
yaml: "not: valid: yaml: {{{}}}".to_string(),
|
||||||
|
config: Default::default(),
|
||||||
|
});
|
||||||
|
let err = svc.register_workflow(req).await.unwrap_err();
|
||||||
|
assert_eq!(err.code(), tonic::Code::InvalidArgument);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_start_nonexistent_workflow() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
let req = Request::new(StartWorkflowRequest {
|
||||||
|
definition_id: "nonexistent".to_string(),
|
||||||
|
version: 1,
|
||||||
|
data: None,
|
||||||
|
});
|
||||||
|
let err = svc.start_workflow(req).await.unwrap_err();
|
||||||
|
assert_eq!(err.code(), tonic::Code::Internal);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_get_nonexistent_workflow() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
let req = Request::new(GetWorkflowRequest {
|
||||||
|
workflow_id: "nonexistent".to_string(),
|
||||||
|
});
|
||||||
|
let err = svc.get_workflow(req).await.unwrap_err();
|
||||||
|
assert_eq!(err.code(), tonic::Code::NotFound);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_cancel_workflow() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
|
||||||
|
// Register + start.
|
||||||
|
let req = Request::new(RegisterWorkflowRequest {
|
||||||
|
yaml: "workflow:\n id: cancel-test\n version: 1\n steps:\n - name: s\n type: shell\n config:\n run: echo ok\n".to_string(),
|
||||||
|
config: Default::default(),
|
||||||
|
});
|
||||||
|
svc.register_workflow(req).await.unwrap();
|
||||||
|
|
||||||
|
let req = Request::new(StartWorkflowRequest {
|
||||||
|
definition_id: "cancel-test".to_string(),
|
||||||
|
version: 1,
|
||||||
|
data: None,
|
||||||
|
});
|
||||||
|
let wf_id = svc.start_workflow(req).await.unwrap().into_inner().workflow_id;
|
||||||
|
|
||||||
|
// Cancel it.
|
||||||
|
let req = Request::new(CancelWorkflowRequest { workflow_id: wf_id.clone() });
|
||||||
|
svc.cancel_workflow(req).await.unwrap();
|
||||||
|
|
||||||
|
// Verify it's terminated.
|
||||||
|
let req = Request::new(GetWorkflowRequest { workflow_id: wf_id });
|
||||||
|
let instance = svc.get_workflow(req).await.unwrap().into_inner().instance.unwrap();
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Terminated as i32);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_suspend_resume_workflow() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
|
||||||
|
let req = Request::new(RegisterWorkflowRequest {
|
||||||
|
yaml: "workflow:\n id: sr-test\n version: 1\n steps:\n - name: s\n type: shell\n config:\n run: echo ok\n".to_string(),
|
||||||
|
config: Default::default(),
|
||||||
|
});
|
||||||
|
svc.register_workflow(req).await.unwrap();
|
||||||
|
|
||||||
|
let req = Request::new(StartWorkflowRequest {
|
||||||
|
definition_id: "sr-test".to_string(),
|
||||||
|
version: 1,
|
||||||
|
data: None,
|
||||||
|
});
|
||||||
|
let wf_id = svc.start_workflow(req).await.unwrap().into_inner().workflow_id;
|
||||||
|
|
||||||
|
// Suspend.
|
||||||
|
let req = Request::new(SuspendWorkflowRequest { workflow_id: wf_id.clone() });
|
||||||
|
svc.suspend_workflow(req).await.unwrap();
|
||||||
|
|
||||||
|
let req = Request::new(GetWorkflowRequest { workflow_id: wf_id.clone() });
|
||||||
|
let instance = svc.get_workflow(req).await.unwrap().into_inner().instance.unwrap();
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Suspended as i32);
|
||||||
|
|
||||||
|
// Resume.
|
||||||
|
let req = Request::new(ResumeWorkflowRequest { workflow_id: wf_id.clone() });
|
||||||
|
svc.resume_workflow(req).await.unwrap();
|
||||||
|
|
||||||
|
let req = Request::new(GetWorkflowRequest { workflow_id: wf_id });
|
||||||
|
let instance = svc.get_workflow(req).await.unwrap().into_inner().instance.unwrap();
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Runnable as i32);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_publish_event() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
let req = Request::new(PublishEventRequest {
|
||||||
|
event_name: "test.event".to_string(),
|
||||||
|
event_key: "key-1".to_string(),
|
||||||
|
data: None,
|
||||||
|
});
|
||||||
|
// Should succeed even with no waiting workflows.
|
||||||
|
svc.publish_event(req).await.unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_search_logs_not_configured() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
let req = Request::new(SearchLogsRequest {
|
||||||
|
query: "test".to_string(),
|
||||||
|
..Default::default()
|
||||||
|
});
|
||||||
|
let err = svc.search_logs(req).await.unwrap_err();
|
||||||
|
assert_eq!(err.code(), tonic::Code::Unavailable);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_list_definitions_empty() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
let req = Request::new(ListDefinitionsRequest {});
|
||||||
|
let resp = svc.list_definitions(req).await.unwrap().into_inner();
|
||||||
|
assert!(resp.definitions.is_empty());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn rpc_search_workflows_empty() {
|
||||||
|
let svc = make_test_service().await;
|
||||||
|
let req = Request::new(SearchWorkflowsRequest {
|
||||||
|
query: "test".to_string(),
|
||||||
|
..Default::default()
|
||||||
|
});
|
||||||
|
let resp = svc.search_workflows(req).await.unwrap().into_inner();
|
||||||
|
assert_eq!(resp.total, 0);
|
||||||
|
}
|
||||||
|
}
|
||||||
125
wfe-server/src/lifecycle_bus.rs
Normal file
125
wfe-server/src/lifecycle_bus.rs
Normal file
@@ -0,0 +1,125 @@
|
|||||||
|
use async_trait::async_trait;
|
||||||
|
use tokio::sync::broadcast;
|
||||||
|
use wfe_core::models::LifecycleEvent;
|
||||||
|
use wfe_core::traits::LifecyclePublisher;
|
||||||
|
|
||||||
|
/// Broadcasts lifecycle events to multiple subscribers via tokio broadcast channels.
|
||||||
|
pub struct BroadcastLifecyclePublisher {
|
||||||
|
sender: broadcast::Sender<LifecycleEvent>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl BroadcastLifecyclePublisher {
|
||||||
|
pub fn new(capacity: usize) -> Self {
|
||||||
|
let (sender, _) = broadcast::channel(capacity);
|
||||||
|
Self { sender }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn subscribe(&self) -> broadcast::Receiver<LifecycleEvent> {
|
||||||
|
self.sender.subscribe()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
impl LifecyclePublisher for BroadcastLifecyclePublisher {
|
||||||
|
async fn publish(&self, event: LifecycleEvent) -> wfe_core::Result<()> {
|
||||||
|
// Ignore send errors (no active subscribers).
|
||||||
|
let _ = self.sender.send(event);
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use wfe_core::models::LifecycleEventType;
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn publish_and_receive() {
|
||||||
|
let bus = BroadcastLifecyclePublisher::new(16);
|
||||||
|
let mut rx = bus.subscribe();
|
||||||
|
|
||||||
|
let event = LifecycleEvent::new("wf-1", "def-1", 1, LifecycleEventType::Started);
|
||||||
|
bus.publish(event.clone()).await.unwrap();
|
||||||
|
|
||||||
|
let received = rx.recv().await.unwrap();
|
||||||
|
assert_eq!(received.workflow_instance_id, "wf-1");
|
||||||
|
assert_eq!(received.event_type, LifecycleEventType::Started);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn multiple_subscribers() {
|
||||||
|
let bus = BroadcastLifecyclePublisher::new(16);
|
||||||
|
let mut rx1 = bus.subscribe();
|
||||||
|
let mut rx2 = bus.subscribe();
|
||||||
|
|
||||||
|
bus.publish(LifecycleEvent::new("wf-1", "def-1", 1, LifecycleEventType::Completed))
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let e1 = rx1.recv().await.unwrap();
|
||||||
|
let e2 = rx2.recv().await.unwrap();
|
||||||
|
assert_eq!(e1.event_type, LifecycleEventType::Completed);
|
||||||
|
assert_eq!(e2.event_type, LifecycleEventType::Completed);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn no_subscribers_does_not_error() {
|
||||||
|
let bus = BroadcastLifecyclePublisher::new(16);
|
||||||
|
// No subscribers — should not panic.
|
||||||
|
bus.publish(LifecycleEvent::new("wf-1", "def-1", 1, LifecycleEventType::Started))
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn step_events_propagate() {
|
||||||
|
let bus = BroadcastLifecyclePublisher::new(16);
|
||||||
|
let mut rx = bus.subscribe();
|
||||||
|
|
||||||
|
bus.publish(LifecycleEvent::new(
|
||||||
|
"wf-1",
|
||||||
|
"def-1",
|
||||||
|
1,
|
||||||
|
LifecycleEventType::StepStarted {
|
||||||
|
step_id: 3,
|
||||||
|
step_name: Some("build".to_string()),
|
||||||
|
},
|
||||||
|
))
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let received = rx.recv().await.unwrap();
|
||||||
|
assert_eq!(
|
||||||
|
received.event_type,
|
||||||
|
LifecycleEventType::StepStarted {
|
||||||
|
step_id: 3,
|
||||||
|
step_name: Some("build".to_string()),
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn error_events_include_message() {
|
||||||
|
let bus = BroadcastLifecyclePublisher::new(16);
|
||||||
|
let mut rx = bus.subscribe();
|
||||||
|
|
||||||
|
bus.publish(LifecycleEvent::new(
|
||||||
|
"wf-1",
|
||||||
|
"def-1",
|
||||||
|
1,
|
||||||
|
LifecycleEventType::Error {
|
||||||
|
message: "step failed".to_string(),
|
||||||
|
},
|
||||||
|
))
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let received = rx.recv().await.unwrap();
|
||||||
|
assert_eq!(
|
||||||
|
received.event_type,
|
||||||
|
LifecycleEventType::Error {
|
||||||
|
message: "step failed".to_string(),
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
529
wfe-server/src/log_search.rs
Normal file
529
wfe-server/src/log_search.rs
Normal file
@@ -0,0 +1,529 @@
|
|||||||
|
use chrono::{DateTime, Utc};
|
||||||
|
use opensearch::http::transport::Transport;
|
||||||
|
use opensearch::{IndexParts, OpenSearch, SearchParts};
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use serde_json::json;
|
||||||
|
use wfe_core::traits::{LogChunk, LogStreamType};
|
||||||
|
|
||||||
|
const LOG_INDEX: &str = "wfe-build-logs";
|
||||||
|
|
||||||
|
/// Document structure for a log line stored in OpenSearch.
|
||||||
|
#[derive(Debug, Serialize, Deserialize)]
|
||||||
|
struct LogDocument {
|
||||||
|
workflow_id: String,
|
||||||
|
definition_id: String,
|
||||||
|
step_id: usize,
|
||||||
|
step_name: String,
|
||||||
|
stream: String,
|
||||||
|
line: String,
|
||||||
|
timestamp: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl LogDocument {
|
||||||
|
fn from_chunk(chunk: &LogChunk) -> Self {
|
||||||
|
Self {
|
||||||
|
workflow_id: chunk.workflow_id.clone(),
|
||||||
|
definition_id: chunk.definition_id.clone(),
|
||||||
|
step_id: chunk.step_id,
|
||||||
|
step_name: chunk.step_name.clone(),
|
||||||
|
stream: match chunk.stream {
|
||||||
|
LogStreamType::Stdout => "stdout".to_string(),
|
||||||
|
LogStreamType::Stderr => "stderr".to_string(),
|
||||||
|
},
|
||||||
|
line: String::from_utf8_lossy(&chunk.data).trim_end().to_string(),
|
||||||
|
timestamp: chunk.timestamp.to_rfc3339(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Result from a log search query.
|
||||||
|
#[derive(Debug, Clone)]
|
||||||
|
pub struct LogSearchHit {
|
||||||
|
pub workflow_id: String,
|
||||||
|
pub definition_id: String,
|
||||||
|
pub step_name: String,
|
||||||
|
pub line: String,
|
||||||
|
pub stream: String,
|
||||||
|
pub timestamp: DateTime<Utc>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// OpenSearch-backed log search index.
|
||||||
|
pub struct LogSearchIndex {
|
||||||
|
client: OpenSearch,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl LogSearchIndex {
|
||||||
|
pub fn new(url: &str) -> wfe_core::Result<Self> {
|
||||||
|
let transport = Transport::single_node(url)
|
||||||
|
.map_err(|e| Box::new(e) as Box<dyn std::error::Error + Send + Sync>)?;
|
||||||
|
Ok(Self {
|
||||||
|
client: OpenSearch::new(transport),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create the log index if it doesn't exist.
|
||||||
|
pub async fn ensure_index(&self) -> wfe_core::Result<()> {
|
||||||
|
let exists = self
|
||||||
|
.client
|
||||||
|
.indices()
|
||||||
|
.exists(opensearch::indices::IndicesExistsParts::Index(&[LOG_INDEX]))
|
||||||
|
.send()
|
||||||
|
.await
|
||||||
|
.map_err(|e| Box::new(e) as Box<dyn std::error::Error + Send + Sync>)?;
|
||||||
|
|
||||||
|
if exists.status_code().is_success() {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
|
||||||
|
let body = json!({
|
||||||
|
"mappings": {
|
||||||
|
"properties": {
|
||||||
|
"workflow_id": { "type": "keyword" },
|
||||||
|
"definition_id": { "type": "keyword" },
|
||||||
|
"step_id": { "type": "integer" },
|
||||||
|
"step_name": { "type": "keyword" },
|
||||||
|
"stream": { "type": "keyword" },
|
||||||
|
"line": { "type": "text", "analyzer": "standard" },
|
||||||
|
"timestamp": { "type": "date" }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
let response = self
|
||||||
|
.client
|
||||||
|
.indices()
|
||||||
|
.create(opensearch::indices::IndicesCreateParts::Index(LOG_INDEX))
|
||||||
|
.body(body)
|
||||||
|
.send()
|
||||||
|
.await
|
||||||
|
.map_err(|e| Box::new(e) as Box<dyn std::error::Error + Send + Sync>)?;
|
||||||
|
|
||||||
|
if !response.status_code().is_success() {
|
||||||
|
let text = response.text().await.unwrap_or_default();
|
||||||
|
return Err(wfe_core::WfeError::Persistence(format!(
|
||||||
|
"Failed to create log index: {text}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
tracing::info!(index = LOG_INDEX, "log search index created");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Index a single log chunk.
|
||||||
|
pub async fn index_chunk(&self, chunk: &LogChunk) -> wfe_core::Result<()> {
|
||||||
|
let doc = LogDocument::from_chunk(chunk);
|
||||||
|
let body = serde_json::to_value(&doc)?;
|
||||||
|
|
||||||
|
let response = self
|
||||||
|
.client
|
||||||
|
.index(IndexParts::Index(LOG_INDEX))
|
||||||
|
.body(body)
|
||||||
|
.send()
|
||||||
|
.await
|
||||||
|
.map_err(|e| Box::new(e) as Box<dyn std::error::Error + Send + Sync>)?;
|
||||||
|
|
||||||
|
if !response.status_code().is_success() {
|
||||||
|
let text = response.text().await.unwrap_or_default();
|
||||||
|
return Err(wfe_core::WfeError::Persistence(format!(
|
||||||
|
"failed to index log chunk: {text}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Search log lines.
|
||||||
|
pub async fn search(
|
||||||
|
&self,
|
||||||
|
query: &str,
|
||||||
|
workflow_id: Option<&str>,
|
||||||
|
step_name: Option<&str>,
|
||||||
|
stream_filter: Option<&str>,
|
||||||
|
skip: u64,
|
||||||
|
take: u64,
|
||||||
|
) -> wfe_core::Result<(Vec<LogSearchHit>, u64)> {
|
||||||
|
let mut must_clauses = Vec::new();
|
||||||
|
let mut filter_clauses = Vec::new();
|
||||||
|
|
||||||
|
if !query.is_empty() {
|
||||||
|
must_clauses.push(json!({
|
||||||
|
"match": { "line": query }
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(wf_id) = workflow_id {
|
||||||
|
filter_clauses.push(json!({ "term": { "workflow_id": wf_id } }));
|
||||||
|
}
|
||||||
|
if let Some(sn) = step_name {
|
||||||
|
filter_clauses.push(json!({ "term": { "step_name": sn } }));
|
||||||
|
}
|
||||||
|
if let Some(stream) = stream_filter {
|
||||||
|
filter_clauses.push(json!({ "term": { "stream": stream } }));
|
||||||
|
}
|
||||||
|
|
||||||
|
let query_body = if must_clauses.is_empty() && filter_clauses.is_empty() {
|
||||||
|
json!({ "match_all": {} })
|
||||||
|
} else {
|
||||||
|
let mut bool_q = serde_json::Map::new();
|
||||||
|
if !must_clauses.is_empty() {
|
||||||
|
bool_q.insert("must".to_string(), json!(must_clauses));
|
||||||
|
}
|
||||||
|
if !filter_clauses.is_empty() {
|
||||||
|
bool_q.insert("filter".to_string(), json!(filter_clauses));
|
||||||
|
}
|
||||||
|
json!({ "bool": bool_q })
|
||||||
|
};
|
||||||
|
|
||||||
|
let body = json!({
|
||||||
|
"query": query_body,
|
||||||
|
"from": skip,
|
||||||
|
"size": take,
|
||||||
|
"sort": [{ "timestamp": "asc" }]
|
||||||
|
});
|
||||||
|
|
||||||
|
let response = self
|
||||||
|
.client
|
||||||
|
.search(SearchParts::Index(&[LOG_INDEX]))
|
||||||
|
.body(body)
|
||||||
|
.send()
|
||||||
|
.await
|
||||||
|
.map_err(|e| Box::new(e) as Box<dyn std::error::Error + Send + Sync>)?;
|
||||||
|
|
||||||
|
if !response.status_code().is_success() {
|
||||||
|
let text = response.text().await.unwrap_or_default();
|
||||||
|
return Err(wfe_core::WfeError::Persistence(format!(
|
||||||
|
"Log search failed: {text}"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
let resp_body: serde_json::Value = response
|
||||||
|
.json()
|
||||||
|
.await
|
||||||
|
.map_err(|e| Box::new(e) as Box<dyn std::error::Error + Send + Sync>)?;
|
||||||
|
|
||||||
|
let total = resp_body["hits"]["total"]["value"].as_u64().unwrap_or(0);
|
||||||
|
let hits = resp_body["hits"]["hits"]
|
||||||
|
.as_array()
|
||||||
|
.cloned()
|
||||||
|
.unwrap_or_default();
|
||||||
|
|
||||||
|
let results = hits
|
||||||
|
.iter()
|
||||||
|
.filter_map(|hit| {
|
||||||
|
let src = &hit["_source"];
|
||||||
|
Some(LogSearchHit {
|
||||||
|
workflow_id: src["workflow_id"].as_str()?.to_string(),
|
||||||
|
definition_id: src["definition_id"].as_str()?.to_string(),
|
||||||
|
step_name: src["step_name"].as_str()?.to_string(),
|
||||||
|
line: src["line"].as_str()?.to_string(),
|
||||||
|
stream: src["stream"].as_str()?.to_string(),
|
||||||
|
timestamp: src["timestamp"]
|
||||||
|
.as_str()
|
||||||
|
.and_then(|s| DateTime::parse_from_rfc3339(s).ok())
|
||||||
|
.map(|dt| dt.with_timezone(&Utc))
|
||||||
|
.unwrap_or_else(Utc::now),
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
|
||||||
|
Ok((results, total))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn log_document_from_chunk_stdout() {
|
||||||
|
let chunk = LogChunk {
|
||||||
|
workflow_id: "wf-1".to_string(),
|
||||||
|
definition_id: "ci".to_string(),
|
||||||
|
step_id: 0,
|
||||||
|
step_name: "build".to_string(),
|
||||||
|
stream: LogStreamType::Stdout,
|
||||||
|
data: b"compiling wfe-core\n".to_vec(),
|
||||||
|
timestamp: Utc::now(),
|
||||||
|
};
|
||||||
|
let doc = LogDocument::from_chunk(&chunk);
|
||||||
|
assert_eq!(doc.workflow_id, "wf-1");
|
||||||
|
assert_eq!(doc.stream, "stdout");
|
||||||
|
assert_eq!(doc.line, "compiling wfe-core");
|
||||||
|
assert_eq!(doc.step_name, "build");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn log_document_from_chunk_stderr() {
|
||||||
|
let chunk = LogChunk {
|
||||||
|
workflow_id: "wf-2".to_string(),
|
||||||
|
definition_id: "deploy".to_string(),
|
||||||
|
step_id: 1,
|
||||||
|
step_name: "test".to_string(),
|
||||||
|
stream: LogStreamType::Stderr,
|
||||||
|
data: b"warning: unused variable\n".to_vec(),
|
||||||
|
timestamp: Utc::now(),
|
||||||
|
};
|
||||||
|
let doc = LogDocument::from_chunk(&chunk);
|
||||||
|
assert_eq!(doc.stream, "stderr");
|
||||||
|
assert_eq!(doc.line, "warning: unused variable");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn log_document_trims_trailing_newline() {
|
||||||
|
let chunk = LogChunk {
|
||||||
|
workflow_id: "wf-1".to_string(),
|
||||||
|
definition_id: "ci".to_string(),
|
||||||
|
step_id: 0,
|
||||||
|
step_name: "build".to_string(),
|
||||||
|
stream: LogStreamType::Stdout,
|
||||||
|
data: b"line with newline\n".to_vec(),
|
||||||
|
timestamp: Utc::now(),
|
||||||
|
};
|
||||||
|
let doc = LogDocument::from_chunk(&chunk);
|
||||||
|
assert_eq!(doc.line, "line with newline");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn log_document_serializes_to_json() {
|
||||||
|
let chunk = LogChunk {
|
||||||
|
workflow_id: "wf-1".to_string(),
|
||||||
|
definition_id: "ci".to_string(),
|
||||||
|
step_id: 2,
|
||||||
|
step_name: "clippy".to_string(),
|
||||||
|
stream: LogStreamType::Stdout,
|
||||||
|
data: b"all good\n".to_vec(),
|
||||||
|
timestamp: Utc::now(),
|
||||||
|
};
|
||||||
|
let doc = LogDocument::from_chunk(&chunk);
|
||||||
|
let json = serde_json::to_value(&doc).unwrap();
|
||||||
|
assert_eq!(json["step_name"], "clippy");
|
||||||
|
assert_eq!(json["step_id"], 2);
|
||||||
|
assert!(json["timestamp"].is_string());
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── OpenSearch integration tests ────────────────────────────────
|
||||||
|
|
||||||
|
fn opensearch_url() -> Option<String> {
|
||||||
|
let url = std::env::var("WFE_SEARCH_URL")
|
||||||
|
.unwrap_or_else(|_| "http://localhost:9200".to_string());
|
||||||
|
// Quick TCP probe to check if OpenSearch is reachable.
|
||||||
|
let addr = url
|
||||||
|
.strip_prefix("http://")
|
||||||
|
.or_else(|| url.strip_prefix("https://"))
|
||||||
|
.unwrap_or("localhost:9200");
|
||||||
|
match std::net::TcpStream::connect_timeout(
|
||||||
|
&addr.parse().ok()?,
|
||||||
|
std::time::Duration::from_secs(1),
|
||||||
|
) {
|
||||||
|
Ok(_) => Some(url),
|
||||||
|
Err(_) => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn make_test_chunk(
|
||||||
|
workflow_id: &str,
|
||||||
|
step_name: &str,
|
||||||
|
stream: LogStreamType,
|
||||||
|
line: &str,
|
||||||
|
) -> LogChunk {
|
||||||
|
LogChunk {
|
||||||
|
workflow_id: workflow_id.to_string(),
|
||||||
|
definition_id: "test-def".to_string(),
|
||||||
|
step_id: 0,
|
||||||
|
step_name: step_name.to_string(),
|
||||||
|
stream,
|
||||||
|
data: format!("{line}\n").into_bytes(),
|
||||||
|
timestamp: Utc::now(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Delete the test index to start clean.
|
||||||
|
async fn cleanup_index(url: &str) {
|
||||||
|
let client = reqwest::Client::new();
|
||||||
|
let _ = client
|
||||||
|
.delete(format!("{url}/{LOG_INDEX}"))
|
||||||
|
.send()
|
||||||
|
.await;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn opensearch_ensure_index_creates_index() {
|
||||||
|
let Some(url) = opensearch_url() else {
|
||||||
|
eprintln!("SKIP: OpenSearch not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
|
||||||
|
let index = LogSearchIndex::new(&url).unwrap();
|
||||||
|
index.ensure_index().await.unwrap();
|
||||||
|
|
||||||
|
// Calling again should be idempotent.
|
||||||
|
index.ensure_index().await.unwrap();
|
||||||
|
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn opensearch_index_and_search_chunk() {
|
||||||
|
let Some(url) = opensearch_url() else {
|
||||||
|
eprintln!("SKIP: OpenSearch not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
|
||||||
|
let index = LogSearchIndex::new(&url).unwrap();
|
||||||
|
index.ensure_index().await.unwrap();
|
||||||
|
|
||||||
|
// Index some log chunks.
|
||||||
|
let chunk = make_test_chunk("wf-search-1", "build", LogStreamType::Stdout, "compiling wfe-core v1.5.0");
|
||||||
|
index.index_chunk(&chunk).await.unwrap();
|
||||||
|
|
||||||
|
let chunk = make_test_chunk("wf-search-1", "build", LogStreamType::Stderr, "warning: unused variable");
|
||||||
|
index.index_chunk(&chunk).await.unwrap();
|
||||||
|
|
||||||
|
let chunk = make_test_chunk("wf-search-1", "test", LogStreamType::Stdout, "test result: ok. 79 passed");
|
||||||
|
index.index_chunk(&chunk).await.unwrap();
|
||||||
|
|
||||||
|
// OpenSearch needs a refresh to make docs searchable.
|
||||||
|
let client = reqwest::Client::new();
|
||||||
|
client.post(format!("{url}/{LOG_INDEX}/_refresh")).send().await.unwrap();
|
||||||
|
|
||||||
|
// Search by text.
|
||||||
|
let (results, total) = index
|
||||||
|
.search("wfe-core", None, None, None, 0, 10)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert!(total >= 1, "expected at least 1 hit, got {total}");
|
||||||
|
assert!(results.iter().any(|r| r.line.contains("wfe-core")));
|
||||||
|
|
||||||
|
// Search by workflow_id filter.
|
||||||
|
let (results, _) = index
|
||||||
|
.search("", Some("wf-search-1"), None, None, 0, 10)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(results.len(), 3);
|
||||||
|
|
||||||
|
// Search by step_name filter.
|
||||||
|
let (results, _) = index
|
||||||
|
.search("", Some("wf-search-1"), Some("test"), None, 0, 10)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(results.len(), 1);
|
||||||
|
assert!(results[0].line.contains("79 passed"));
|
||||||
|
|
||||||
|
// Search by stream filter.
|
||||||
|
let (results, _) = index
|
||||||
|
.search("", Some("wf-search-1"), None, Some("stderr"), 0, 10)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(results.len(), 1);
|
||||||
|
assert!(results[0].line.contains("unused variable"));
|
||||||
|
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn opensearch_search_empty_index() {
|
||||||
|
let Some(url) = opensearch_url() else {
|
||||||
|
eprintln!("SKIP: OpenSearch not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
|
||||||
|
let index = LogSearchIndex::new(&url).unwrap();
|
||||||
|
index.ensure_index().await.unwrap();
|
||||||
|
|
||||||
|
let (results, total) = index
|
||||||
|
.search("nonexistent", None, None, None, 0, 10)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(total, 0);
|
||||||
|
assert!(results.is_empty());
|
||||||
|
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn opensearch_search_pagination() {
|
||||||
|
let Some(url) = opensearch_url() else {
|
||||||
|
eprintln!("SKIP: OpenSearch not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
|
||||||
|
let index = LogSearchIndex::new(&url).unwrap();
|
||||||
|
index.ensure_index().await.unwrap();
|
||||||
|
|
||||||
|
// Index 5 chunks.
|
||||||
|
for i in 0..5 {
|
||||||
|
let chunk = make_test_chunk("wf-page", "build", LogStreamType::Stdout, &format!("line {i}"));
|
||||||
|
index.index_chunk(&chunk).await.unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
let client = reqwest::Client::new();
|
||||||
|
client.post(format!("{url}/{LOG_INDEX}/_refresh")).send().await.unwrap();
|
||||||
|
|
||||||
|
// Get first 2.
|
||||||
|
let (results, total) = index
|
||||||
|
.search("", Some("wf-page"), None, None, 0, 2)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(total, 5);
|
||||||
|
assert_eq!(results.len(), 2);
|
||||||
|
|
||||||
|
// Get next 2.
|
||||||
|
let (results, _) = index
|
||||||
|
.search("", Some("wf-page"), None, None, 2, 2)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(results.len(), 2);
|
||||||
|
|
||||||
|
// Get last 1.
|
||||||
|
let (results, _) = index
|
||||||
|
.search("", Some("wf-page"), None, None, 4, 2)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(results.len(), 1);
|
||||||
|
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn log_search_index_new_constructs_ok() {
|
||||||
|
// Construction should succeed even for unreachable URLs (fails on first use).
|
||||||
|
let result = LogSearchIndex::new("http://localhost:19876");
|
||||||
|
assert!(result.is_ok());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn opensearch_index_chunk_result_fields() {
|
||||||
|
let Some(url) = opensearch_url() else {
|
||||||
|
eprintln!("SKIP: OpenSearch not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
|
||||||
|
let index = LogSearchIndex::new(&url).unwrap();
|
||||||
|
index.ensure_index().await.unwrap();
|
||||||
|
|
||||||
|
let chunk = make_test_chunk("wf-fields", "clippy", LogStreamType::Stderr, "error: type mismatch");
|
||||||
|
index.index_chunk(&chunk).await.unwrap();
|
||||||
|
|
||||||
|
let client = reqwest::Client::new();
|
||||||
|
client.post(format!("{url}/{LOG_INDEX}/_refresh")).send().await.unwrap();
|
||||||
|
|
||||||
|
let (results, _) = index
|
||||||
|
.search("type mismatch", None, None, None, 0, 10)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
assert!(!results.is_empty());
|
||||||
|
let hit = &results[0];
|
||||||
|
assert_eq!(hit.workflow_id, "wf-fields");
|
||||||
|
assert_eq!(hit.definition_id, "test-def");
|
||||||
|
assert_eq!(hit.step_name, "clippy");
|
||||||
|
assert_eq!(hit.stream, "stderr");
|
||||||
|
assert!(hit.line.contains("type mismatch"));
|
||||||
|
|
||||||
|
cleanup_index(&url).await;
|
||||||
|
}
|
||||||
|
}
|
||||||
203
wfe-server/src/log_store.rs
Normal file
203
wfe-server/src/log_store.rs
Normal file
@@ -0,0 +1,203 @@
|
|||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use async_trait::async_trait;
|
||||||
|
use dashmap::DashMap;
|
||||||
|
use tokio::sync::broadcast;
|
||||||
|
use wfe_core::traits::log_sink::{LogChunk, LogSink};
|
||||||
|
|
||||||
|
/// Stores and broadcasts log chunks for workflow step executions.
|
||||||
|
///
|
||||||
|
/// Three tiers:
|
||||||
|
/// 1. **Live broadcast** — per-workflow broadcast channel for StreamLogs subscribers
|
||||||
|
/// 2. **In-memory history** — append-only buffer per (workflow_id, step_id) for replay
|
||||||
|
/// 3. **Search index** — OpenSearch log indexing via LogSearchIndex (optional)
|
||||||
|
pub struct LogStore {
|
||||||
|
/// Per-workflow broadcast channels for live streaming.
|
||||||
|
live: DashMap<String, broadcast::Sender<LogChunk>>,
|
||||||
|
/// In-memory history per (workflow_id, step_id).
|
||||||
|
history: DashMap<(String, usize), Vec<LogChunk>>,
|
||||||
|
/// Optional search index for log lines.
|
||||||
|
search: Option<Arc<crate::log_search::LogSearchIndex>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl LogStore {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self {
|
||||||
|
live: DashMap::new(),
|
||||||
|
history: DashMap::new(),
|
||||||
|
search: None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_search(mut self, index: Arc<crate::log_search::LogSearchIndex>) -> Self {
|
||||||
|
self.search = Some(index);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Subscribe to live log chunks for a workflow.
|
||||||
|
pub fn subscribe(&self, workflow_id: &str) -> broadcast::Receiver<LogChunk> {
|
||||||
|
self.live
|
||||||
|
.entry(workflow_id.to_string())
|
||||||
|
.or_insert_with(|| broadcast::channel(4096).0)
|
||||||
|
.subscribe()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get historical logs for a workflow, optionally filtered by step.
|
||||||
|
pub fn get_history(&self, workflow_id: &str, step_id: Option<usize>) -> Vec<LogChunk> {
|
||||||
|
let mut result = Vec::new();
|
||||||
|
for entry in self.history.iter() {
|
||||||
|
let (wf_id, s_id) = entry.key();
|
||||||
|
if wf_id != workflow_id {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if let Some(filter_step) = step_id {
|
||||||
|
if *s_id != filter_step {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result.extend(entry.value().iter().cloned());
|
||||||
|
}
|
||||||
|
// Sort by timestamp.
|
||||||
|
result.sort_by_key(|c| c.timestamp);
|
||||||
|
result
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
impl LogSink for LogStore {
|
||||||
|
async fn write_chunk(&self, chunk: LogChunk) {
|
||||||
|
// Store in history.
|
||||||
|
self.history
|
||||||
|
.entry((chunk.workflow_id.clone(), chunk.step_id))
|
||||||
|
.or_default()
|
||||||
|
.push(chunk.clone());
|
||||||
|
|
||||||
|
// Broadcast to live subscribers.
|
||||||
|
let sender = self
|
||||||
|
.live
|
||||||
|
.entry(chunk.workflow_id.clone())
|
||||||
|
.or_insert_with(|| broadcast::channel(4096).0);
|
||||||
|
let _ = sender.send(chunk.clone());
|
||||||
|
|
||||||
|
// Index to OpenSearch (best-effort, don't block on failure).
|
||||||
|
if let Some(ref search) = self.search {
|
||||||
|
if let Err(e) = search.index_chunk(&chunk).await {
|
||||||
|
tracing::warn!(error = %e, "failed to index log chunk to OpenSearch");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use chrono::Utc;
|
||||||
|
use wfe_core::traits::LogStreamType;
|
||||||
|
|
||||||
|
fn make_chunk(workflow_id: &str, step_id: usize, step_name: &str, data: &str) -> LogChunk {
|
||||||
|
LogChunk {
|
||||||
|
workflow_id: workflow_id.to_string(),
|
||||||
|
definition_id: "def-1".to_string(),
|
||||||
|
step_id,
|
||||||
|
step_name: step_name.to_string(),
|
||||||
|
stream: LogStreamType::Stdout,
|
||||||
|
data: data.as_bytes().to_vec(),
|
||||||
|
timestamp: Utc::now(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn write_and_read_history() {
|
||||||
|
let store = LogStore::new();
|
||||||
|
store.write_chunk(make_chunk("wf-1", 0, "build", "line 1\n")).await;
|
||||||
|
store.write_chunk(make_chunk("wf-1", 0, "build", "line 2\n")).await;
|
||||||
|
|
||||||
|
let history = store.get_history("wf-1", None);
|
||||||
|
assert_eq!(history.len(), 2);
|
||||||
|
assert_eq!(history[0].data, b"line 1\n");
|
||||||
|
assert_eq!(history[1].data, b"line 2\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn history_filtered_by_step() {
|
||||||
|
let store = LogStore::new();
|
||||||
|
store.write_chunk(make_chunk("wf-1", 0, "build", "build log\n")).await;
|
||||||
|
store.write_chunk(make_chunk("wf-1", 1, "test", "test log\n")).await;
|
||||||
|
|
||||||
|
let build_only = store.get_history("wf-1", Some(0));
|
||||||
|
assert_eq!(build_only.len(), 1);
|
||||||
|
assert_eq!(build_only[0].step_name, "build");
|
||||||
|
|
||||||
|
let test_only = store.get_history("wf-1", Some(1));
|
||||||
|
assert_eq!(test_only.len(), 1);
|
||||||
|
assert_eq!(test_only[0].step_name, "test");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn empty_history_for_unknown_workflow() {
|
||||||
|
let store = LogStore::new();
|
||||||
|
assert!(store.get_history("nonexistent", None).is_empty());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn live_broadcast() {
|
||||||
|
let store = LogStore::new();
|
||||||
|
let mut rx = store.subscribe("wf-1");
|
||||||
|
|
||||||
|
store.write_chunk(make_chunk("wf-1", 0, "build", "hello\n")).await;
|
||||||
|
|
||||||
|
let received = rx.recv().await.unwrap();
|
||||||
|
assert_eq!(received.data, b"hello\n");
|
||||||
|
assert_eq!(received.workflow_id, "wf-1");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn broadcast_different_workflows_isolated() {
|
||||||
|
let store = LogStore::new();
|
||||||
|
let mut rx1 = store.subscribe("wf-1");
|
||||||
|
let mut rx2 = store.subscribe("wf-2");
|
||||||
|
|
||||||
|
store.write_chunk(make_chunk("wf-1", 0, "build", "wf1 log\n")).await;
|
||||||
|
store.write_chunk(make_chunk("wf-2", 0, "test", "wf2 log\n")).await;
|
||||||
|
|
||||||
|
let e1 = rx1.recv().await.unwrap();
|
||||||
|
assert_eq!(e1.workflow_id, "wf-1");
|
||||||
|
|
||||||
|
let e2 = rx2.recv().await.unwrap();
|
||||||
|
assert_eq!(e2.workflow_id, "wf-2");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn no_subscribers_does_not_error() {
|
||||||
|
let store = LogStore::new();
|
||||||
|
// No subscribers — should not panic.
|
||||||
|
store.write_chunk(make_chunk("wf-1", 0, "build", "orphan log\n")).await;
|
||||||
|
// History should still be stored.
|
||||||
|
assert_eq!(store.get_history("wf-1", None).len(), 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn multiple_subscribers_same_workflow() {
|
||||||
|
let store = LogStore::new();
|
||||||
|
let mut rx1 = store.subscribe("wf-1");
|
||||||
|
let mut rx2 = store.subscribe("wf-1");
|
||||||
|
|
||||||
|
store.write_chunk(make_chunk("wf-1", 0, "build", "shared\n")).await;
|
||||||
|
|
||||||
|
let e1 = rx1.recv().await.unwrap();
|
||||||
|
let e2 = rx2.recv().await.unwrap();
|
||||||
|
assert_eq!(e1.data, b"shared\n");
|
||||||
|
assert_eq!(e2.data, b"shared\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn history_preserves_stream_type() {
|
||||||
|
let store = LogStore::new();
|
||||||
|
let mut chunk = make_chunk("wf-1", 0, "build", "error output\n");
|
||||||
|
chunk.stream = LogStreamType::Stderr;
|
||||||
|
store.write_chunk(chunk).await;
|
||||||
|
|
||||||
|
let history = store.get_history("wf-1", None);
|
||||||
|
assert_eq!(history[0].stream, LogStreamType::Stderr);
|
||||||
|
}
|
||||||
|
}
|
||||||
250
wfe-server/src/main.rs
Normal file
250
wfe-server/src/main.rs
Normal file
@@ -0,0 +1,250 @@
|
|||||||
|
mod auth;
|
||||||
|
mod config;
|
||||||
|
mod grpc;
|
||||||
|
mod lifecycle_bus;
|
||||||
|
mod log_search;
|
||||||
|
mod log_store;
|
||||||
|
mod webhook;
|
||||||
|
|
||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use clap::Parser;
|
||||||
|
use tonic::transport::Server;
|
||||||
|
use tracing_subscriber::EnvFilter;
|
||||||
|
use wfe::WorkflowHostBuilder;
|
||||||
|
use wfe_core::test_support::{
|
||||||
|
InMemoryLockProvider, InMemoryPersistenceProvider, InMemoryQueueProvider,
|
||||||
|
};
|
||||||
|
use wfe_server_protos::wfe::v1::wfe_server::WfeServer;
|
||||||
|
|
||||||
|
use crate::config::{Cli, PersistenceConfig, QueueConfig};
|
||||||
|
use crate::grpc::WfeService;
|
||||||
|
|
||||||
|
#[tokio::main]
|
||||||
|
async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
||||||
|
// 1. Parse CLI + load config.
|
||||||
|
let cli = Cli::parse();
|
||||||
|
let config = config::load(&cli);
|
||||||
|
|
||||||
|
// 2. Init tracing.
|
||||||
|
tracing_subscriber::fmt()
|
||||||
|
.with_env_filter(
|
||||||
|
EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new("info")),
|
||||||
|
)
|
||||||
|
.init();
|
||||||
|
|
||||||
|
tracing::info!(
|
||||||
|
grpc_addr = %config.grpc_addr,
|
||||||
|
http_addr = %config.http_addr,
|
||||||
|
"starting wfe-server"
|
||||||
|
);
|
||||||
|
|
||||||
|
// 3. Build providers based on config.
|
||||||
|
let (persistence, lock, queue): (
|
||||||
|
Arc<dyn wfe_core::traits::PersistenceProvider>,
|
||||||
|
Arc<dyn wfe_core::traits::DistributedLockProvider>,
|
||||||
|
Arc<dyn wfe_core::traits::QueueProvider>,
|
||||||
|
) = match (&config.persistence, &config.queue) {
|
||||||
|
(PersistenceConfig::Sqlite { path }, QueueConfig::InMemory) => {
|
||||||
|
tracing::info!(path = %path, "using SQLite + in-memory queue");
|
||||||
|
let persistence = Arc::new(
|
||||||
|
wfe_sqlite::SqlitePersistenceProvider::new(path)
|
||||||
|
.await
|
||||||
|
.expect("failed to init SQLite"),
|
||||||
|
);
|
||||||
|
let lock = Arc::new(InMemoryLockProvider::new());
|
||||||
|
let queue = Arc::new(InMemoryQueueProvider::new());
|
||||||
|
(persistence, lock, queue)
|
||||||
|
}
|
||||||
|
(PersistenceConfig::Postgres { url }, QueueConfig::Valkey { url: valkey_url }) => {
|
||||||
|
tracing::info!("using Postgres + Valkey");
|
||||||
|
let persistence = Arc::new(
|
||||||
|
wfe_postgres::PostgresPersistenceProvider::new(url)
|
||||||
|
.await
|
||||||
|
.expect("failed to init Postgres"),
|
||||||
|
);
|
||||||
|
let lock = Arc::new(
|
||||||
|
wfe_valkey::ValkeyLockProvider::new(valkey_url, "wfe")
|
||||||
|
.await
|
||||||
|
.expect("failed to init Valkey lock"),
|
||||||
|
);
|
||||||
|
let queue = Arc::new(
|
||||||
|
wfe_valkey::ValkeyQueueProvider::new(valkey_url, "wfe")
|
||||||
|
.await
|
||||||
|
.expect("failed to init Valkey queue"),
|
||||||
|
);
|
||||||
|
(
|
||||||
|
persistence as Arc<dyn wfe_core::traits::PersistenceProvider>,
|
||||||
|
lock as Arc<dyn wfe_core::traits::DistributedLockProvider>,
|
||||||
|
queue as Arc<dyn wfe_core::traits::QueueProvider>,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
_ => {
|
||||||
|
tracing::info!("using in-memory providers (dev mode)");
|
||||||
|
let persistence = Arc::new(InMemoryPersistenceProvider::new());
|
||||||
|
let lock = Arc::new(InMemoryLockProvider::new());
|
||||||
|
let queue = Arc::new(InMemoryQueueProvider::new());
|
||||||
|
(
|
||||||
|
persistence as Arc<dyn wfe_core::traits::PersistenceProvider>,
|
||||||
|
lock as Arc<dyn wfe_core::traits::DistributedLockProvider>,
|
||||||
|
queue as Arc<dyn wfe_core::traits::QueueProvider>,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// 4. Build lifecycle broadcaster.
|
||||||
|
let lifecycle_bus = Arc::new(lifecycle_bus::BroadcastLifecyclePublisher::new(4096));
|
||||||
|
|
||||||
|
// 5. Build log search index (optional, needs to exist before log store).
|
||||||
|
let log_search_index = if let Some(ref search_config) = config.search {
|
||||||
|
match log_search::LogSearchIndex::new(&search_config.url) {
|
||||||
|
Ok(index) => {
|
||||||
|
let index = Arc::new(index);
|
||||||
|
if let Err(e) = index.ensure_index().await {
|
||||||
|
tracing::warn!(error = %e, "failed to create log search index");
|
||||||
|
}
|
||||||
|
tracing::info!(url = %search_config.url, "log search enabled");
|
||||||
|
Some(index)
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(error = %e, "failed to connect to OpenSearch");
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
|
|
||||||
|
// 6. Build log store (with optional search indexing).
|
||||||
|
let log_store = {
|
||||||
|
let store = log_store::LogStore::new();
|
||||||
|
if let Some(ref index) = log_search_index {
|
||||||
|
Arc::new(store.with_search(index.clone()))
|
||||||
|
} else {
|
||||||
|
Arc::new(store)
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// 7. Build WorkflowHost with lifecycle + log_sink.
|
||||||
|
let host = WorkflowHostBuilder::new()
|
||||||
|
.use_persistence(persistence)
|
||||||
|
.use_lock_provider(lock)
|
||||||
|
.use_queue_provider(queue)
|
||||||
|
.use_lifecycle(lifecycle_bus.clone() as Arc<dyn wfe_core::traits::LifecyclePublisher>)
|
||||||
|
.use_log_sink(log_store.clone() as Arc<dyn wfe_core::traits::LogSink>)
|
||||||
|
.build()
|
||||||
|
.expect("failed to build workflow host");
|
||||||
|
|
||||||
|
// 8. Auto-load YAML definitions.
|
||||||
|
if let Some(ref dir) = config.workflows_dir {
|
||||||
|
load_yaml_definitions(&host, dir).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
// 9. Start the workflow engine.
|
||||||
|
host.start().await.expect("failed to start workflow host");
|
||||||
|
tracing::info!("workflow engine started");
|
||||||
|
|
||||||
|
let host = Arc::new(host);
|
||||||
|
|
||||||
|
// 10. Build gRPC service.
|
||||||
|
let mut wfe_service = WfeService::new(host.clone(), lifecycle_bus, log_store);
|
||||||
|
if let Some(index) = log_search_index {
|
||||||
|
wfe_service = wfe_service.with_log_search(index);
|
||||||
|
}
|
||||||
|
let (health_reporter, health_service) = tonic_health::server::health_reporter();
|
||||||
|
health_reporter
|
||||||
|
.set_serving::<WfeServer<WfeService>>()
|
||||||
|
.await;
|
||||||
|
|
||||||
|
// 11. Build auth state.
|
||||||
|
let auth_state = Arc::new(auth::AuthState::new(config.auth.clone()).await);
|
||||||
|
let auth_interceptor = auth::make_interceptor(auth_state);
|
||||||
|
|
||||||
|
// 12. Build axum HTTP server for webhooks.
|
||||||
|
let webhook_state = webhook::WebhookState {
|
||||||
|
host: host.clone(),
|
||||||
|
config: config.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
// HIGH-08: Limit webhook payload size to 2 MB to prevent OOM DoS.
|
||||||
|
let http_router = axum::Router::new()
|
||||||
|
.route("/webhooks/events", axum::routing::post(webhook::handle_generic_event))
|
||||||
|
.route("/webhooks/github", axum::routing::post(webhook::handle_github_webhook))
|
||||||
|
.route("/webhooks/gitea", axum::routing::post(webhook::handle_gitea_webhook))
|
||||||
|
.route("/healthz", axum::routing::get(webhook::health_check))
|
||||||
|
.layer(axum::extract::DefaultBodyLimit::max(2 * 1024 * 1024))
|
||||||
|
.with_state(webhook_state);
|
||||||
|
|
||||||
|
// 12. Run gRPC + HTTP servers with graceful shutdown.
|
||||||
|
let grpc_addr = config.grpc_addr;
|
||||||
|
let http_addr = config.http_addr;
|
||||||
|
tracing::info!(%grpc_addr, %http_addr, "servers listening");
|
||||||
|
|
||||||
|
let grpc_server = Server::builder()
|
||||||
|
.add_service(health_service)
|
||||||
|
.add_service(WfeServer::with_interceptor(wfe_service, auth_interceptor))
|
||||||
|
.serve(grpc_addr);
|
||||||
|
|
||||||
|
let http_listener = tokio::net::TcpListener::bind(http_addr)
|
||||||
|
.await
|
||||||
|
.expect("failed to bind HTTP address");
|
||||||
|
let http_server = axum::serve(http_listener, http_router);
|
||||||
|
|
||||||
|
tokio::select! {
|
||||||
|
result = grpc_server => {
|
||||||
|
if let Err(e) = result {
|
||||||
|
tracing::error!(error = %e, "gRPC server error");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result = http_server => {
|
||||||
|
if let Err(e) = result {
|
||||||
|
tracing::error!(error = %e, "HTTP server error");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_ = tokio::signal::ctrl_c() => {
|
||||||
|
tracing::info!("shutdown signal received");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 9. Graceful shutdown.
|
||||||
|
host.stop().await;
|
||||||
|
tracing::info!("wfe-server stopped");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn load_yaml_definitions(host: &wfe::WorkflowHost, dir: &std::path::Path) {
|
||||||
|
let entries = match std::fs::read_dir(dir) {
|
||||||
|
Ok(e) => e,
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(dir = %dir.display(), error = %e, "failed to read workflows directory");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let config = std::collections::HashMap::new();
|
||||||
|
|
||||||
|
for entry in entries.flatten() {
|
||||||
|
let path = entry.path();
|
||||||
|
if path.extension().is_some_and(|ext| ext == "yaml" || ext == "yml") {
|
||||||
|
match wfe_yaml::load_workflow_from_str(
|
||||||
|
&std::fs::read_to_string(&path).unwrap_or_default(),
|
||||||
|
&config,
|
||||||
|
) {
|
||||||
|
Ok(workflows) => {
|
||||||
|
for compiled in workflows {
|
||||||
|
for (key, factory) in compiled.step_factories {
|
||||||
|
host.register_step_factory(&key, factory).await;
|
||||||
|
}
|
||||||
|
let id = compiled.definition.id.clone();
|
||||||
|
let version = compiled.definition.version;
|
||||||
|
host.register_workflow_definition(compiled.definition).await;
|
||||||
|
tracing::info!(id = %id, version, path = %path.display(), "loaded workflow definition");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(path = %path.display(), error = %e, "failed to compile workflow");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
556
wfe-server/src/webhook.rs
Normal file
556
wfe-server/src/webhook.rs
Normal file
@@ -0,0 +1,556 @@
|
|||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use axum::body::Bytes;
|
||||||
|
use axum::extract::State;
|
||||||
|
use axum::http::{HeaderMap, StatusCode};
|
||||||
|
use axum::response::IntoResponse;
|
||||||
|
use axum::Json;
|
||||||
|
use hmac::{Hmac, Mac};
|
||||||
|
use sha2::Sha256;
|
||||||
|
|
||||||
|
use crate::config::{ServerConfig, WebhookTrigger};
|
||||||
|
|
||||||
|
type HmacSha256 = Hmac<Sha256>;
|
||||||
|
|
||||||
|
/// Shared state for webhook handlers.
|
||||||
|
#[derive(Clone)]
|
||||||
|
pub struct WebhookState {
|
||||||
|
pub host: Arc<wfe::WorkflowHost>,
|
||||||
|
pub config: ServerConfig,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Generic event webhook.
|
||||||
|
///
|
||||||
|
/// POST /webhooks/events
|
||||||
|
/// Body: { "event_name": "...", "event_key": "...", "data": { ... } }
|
||||||
|
/// Requires bearer token authentication (same tokens as gRPC auth).
|
||||||
|
pub async fn handle_generic_event(
|
||||||
|
State(state): State<WebhookState>,
|
||||||
|
headers: HeaderMap,
|
||||||
|
Json(payload): Json<GenericEventPayload>,
|
||||||
|
) -> impl IntoResponse {
|
||||||
|
// HIGH-07: Authenticate generic event endpoint.
|
||||||
|
if !state.config.auth.tokens.is_empty() {
|
||||||
|
let auth_header = headers
|
||||||
|
.get("authorization")
|
||||||
|
.and_then(|v| v.to_str().ok())
|
||||||
|
.unwrap_or("");
|
||||||
|
let token = auth_header
|
||||||
|
.strip_prefix("Bearer ")
|
||||||
|
.or_else(|| auth_header.strip_prefix("bearer "))
|
||||||
|
.unwrap_or("");
|
||||||
|
if !crate::auth::check_static_tokens_pub(&state.config.auth.tokens, token) {
|
||||||
|
return (StatusCode::UNAUTHORIZED, "invalid token");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let data = payload.data.unwrap_or_else(|| serde_json::json!({}));
|
||||||
|
|
||||||
|
match state
|
||||||
|
.host
|
||||||
|
.publish_event(&payload.event_name, &payload.event_key, data)
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
Ok(()) => (StatusCode::OK, "event published"),
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(error = %e, "failed to publish generic event");
|
||||||
|
(StatusCode::INTERNAL_SERVER_ERROR, "failed to publish event")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// GitHub webhook handler.
|
||||||
|
///
|
||||||
|
/// POST /webhooks/github
|
||||||
|
/// Verifies X-Hub-Signature-256, parses X-GitHub-Event header.
|
||||||
|
pub async fn handle_github_webhook(
|
||||||
|
State(state): State<WebhookState>,
|
||||||
|
headers: HeaderMap,
|
||||||
|
body: Bytes,
|
||||||
|
) -> impl IntoResponse {
|
||||||
|
// 1. Verify HMAC signature if secret is configured.
|
||||||
|
if let Some(secret) = state.config.auth.webhook_secrets.get("github") {
|
||||||
|
let sig_header = headers
|
||||||
|
.get("x-hub-signature-256")
|
||||||
|
.and_then(|v| v.to_str().ok())
|
||||||
|
.unwrap_or("");
|
||||||
|
|
||||||
|
if !verify_hmac_sha256(secret.as_bytes(), &body, sig_header) {
|
||||||
|
return (StatusCode::UNAUTHORIZED, "invalid signature");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 2. Parse event type.
|
||||||
|
let event_type = headers
|
||||||
|
.get("x-github-event")
|
||||||
|
.and_then(|v| v.to_str().ok())
|
||||||
|
.unwrap_or("");
|
||||||
|
|
||||||
|
// 3. Parse payload.
|
||||||
|
let payload: serde_json::Value = match serde_json::from_slice(&body) {
|
||||||
|
Ok(v) => v,
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(error = %e, "invalid GitHub webhook JSON");
|
||||||
|
return (StatusCode::BAD_REQUEST, "invalid JSON");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
tracing::info!(
|
||||||
|
event = event_type,
|
||||||
|
repo = payload["repository"]["full_name"].as_str().unwrap_or(""),
|
||||||
|
"received GitHub webhook"
|
||||||
|
);
|
||||||
|
|
||||||
|
// 4. Map to WFE event + check triggers.
|
||||||
|
let forge_event = map_forge_event(event_type, &payload);
|
||||||
|
|
||||||
|
// Publish as event (for workflows waiting on events).
|
||||||
|
if let Err(e) = state
|
||||||
|
.host
|
||||||
|
.publish_event(&forge_event.event_name, &forge_event.event_key, forge_event.data.clone())
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
tracing::error!(error = %e, "failed to publish forge event");
|
||||||
|
return (StatusCode::INTERNAL_SERVER_ERROR, "failed to publish event");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check triggers and auto-start workflows.
|
||||||
|
for trigger in &state.config.webhook.triggers {
|
||||||
|
if trigger.source != "github" {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if trigger.event != event_type {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if let Some(ref match_ref) = trigger.match_ref {
|
||||||
|
let payload_ref = payload["ref"].as_str().unwrap_or("");
|
||||||
|
if payload_ref != match_ref {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let data = map_trigger_data(trigger, &payload);
|
||||||
|
match state
|
||||||
|
.host
|
||||||
|
.start_workflow(&trigger.workflow_id, trigger.version, data)
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
Ok(id) => {
|
||||||
|
tracing::info!(
|
||||||
|
workflow_id = %id,
|
||||||
|
trigger = %trigger.workflow_id,
|
||||||
|
"webhook triggered workflow"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(
|
||||||
|
error = %e,
|
||||||
|
trigger = %trigger.workflow_id,
|
||||||
|
"failed to start triggered workflow"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
(StatusCode::OK, "ok")
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Gitea webhook handler.
|
||||||
|
///
|
||||||
|
/// POST /webhooks/gitea
|
||||||
|
/// Verifies X-Gitea-Signature, parses X-Gitea-Event (or X-GitHub-Event) header.
|
||||||
|
/// Gitea payloads are intentionally compatible with GitHub's format.
|
||||||
|
pub async fn handle_gitea_webhook(
|
||||||
|
State(state): State<WebhookState>,
|
||||||
|
headers: HeaderMap,
|
||||||
|
body: Bytes,
|
||||||
|
) -> impl IntoResponse {
|
||||||
|
// 1. Verify HMAC signature if secret is configured.
|
||||||
|
if let Some(secret) = state.config.auth.webhook_secrets.get("gitea") {
|
||||||
|
// Gitea uses X-Gitea-Signature (raw hex, no sha256= prefix in older versions).
|
||||||
|
let sig_header = headers
|
||||||
|
.get("x-gitea-signature")
|
||||||
|
.and_then(|v| v.to_str().ok())
|
||||||
|
.unwrap_or("");
|
||||||
|
|
||||||
|
// Handle both raw hex and sha256= prefixed formats.
|
||||||
|
if !verify_hmac_sha256(secret.as_bytes(), &body, sig_header)
|
||||||
|
&& !verify_hmac_sha256_raw(secret.as_bytes(), &body, sig_header)
|
||||||
|
{
|
||||||
|
return (StatusCode::UNAUTHORIZED, "invalid signature");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 2. Parse event type (try Gitea header first, fall back to GitHub compat header).
|
||||||
|
let event_type = headers
|
||||||
|
.get("x-gitea-event")
|
||||||
|
.or_else(|| headers.get("x-github-event"))
|
||||||
|
.and_then(|v| v.to_str().ok())
|
||||||
|
.unwrap_or("");
|
||||||
|
|
||||||
|
// 3. Parse payload.
|
||||||
|
let payload: serde_json::Value = match serde_json::from_slice(&body) {
|
||||||
|
Ok(v) => v,
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(error = %e, "invalid Gitea webhook JSON");
|
||||||
|
return (StatusCode::BAD_REQUEST, "invalid JSON");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
tracing::info!(
|
||||||
|
event = event_type,
|
||||||
|
repo = payload["repository"]["full_name"].as_str().unwrap_or(""),
|
||||||
|
"received Gitea webhook"
|
||||||
|
);
|
||||||
|
|
||||||
|
// 4. Map to WFE event + check triggers (same logic as GitHub).
|
||||||
|
let forge_event = map_forge_event(event_type, &payload);
|
||||||
|
|
||||||
|
if let Err(e) = state
|
||||||
|
.host
|
||||||
|
.publish_event(&forge_event.event_name, &forge_event.event_key, forge_event.data.clone())
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
tracing::error!(error = %e, "failed to publish forge event");
|
||||||
|
return (StatusCode::INTERNAL_SERVER_ERROR, "failed to publish event");
|
||||||
|
}
|
||||||
|
|
||||||
|
for trigger in &state.config.webhook.triggers {
|
||||||
|
if trigger.source != "gitea" {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if trigger.event != event_type {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if let Some(ref match_ref) = trigger.match_ref {
|
||||||
|
let payload_ref = payload["ref"].as_str().unwrap_or("");
|
||||||
|
if payload_ref != match_ref {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let data = map_trigger_data(trigger, &payload);
|
||||||
|
match state
|
||||||
|
.host
|
||||||
|
.start_workflow(&trigger.workflow_id, trigger.version, data)
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
Ok(id) => {
|
||||||
|
tracing::info!(workflow_id = %id, trigger = %trigger.workflow_id, "webhook triggered workflow");
|
||||||
|
}
|
||||||
|
Err(e) => {
|
||||||
|
tracing::warn!(error = %e, trigger = %trigger.workflow_id, "failed to start triggered workflow");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
(StatusCode::OK, "ok")
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Health check endpoint.
|
||||||
|
pub async fn health_check() -> impl IntoResponse {
|
||||||
|
(StatusCode::OK, "ok")
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Types ───────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
#[derive(serde::Deserialize)]
|
||||||
|
pub struct GenericEventPayload {
|
||||||
|
pub event_name: String,
|
||||||
|
pub event_key: String,
|
||||||
|
pub data: Option<serde_json::Value>,
|
||||||
|
}
|
||||||
|
|
||||||
|
struct ForgeEvent {
|
||||||
|
event_name: String,
|
||||||
|
event_key: String,
|
||||||
|
data: serde_json::Value,
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Helpers ─────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
/// Verify HMAC-SHA256 signature with `sha256=<hex>` prefix (GitHub format).
|
||||||
|
fn verify_hmac_sha256(secret: &[u8], body: &[u8], signature: &str) -> bool {
|
||||||
|
let hex_sig = signature.strip_prefix("sha256=").unwrap_or("");
|
||||||
|
if hex_sig.is_empty() {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
let expected = match hex::decode(hex_sig) {
|
||||||
|
Ok(v) => v,
|
||||||
|
Err(_) => return false,
|
||||||
|
};
|
||||||
|
let mut mac = HmacSha256::new_from_slice(secret).expect("HMAC accepts any key size");
|
||||||
|
mac.update(body);
|
||||||
|
mac.verify_slice(&expected).is_ok()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Verify HMAC-SHA256 signature as raw hex (no prefix, Gitea legacy format).
|
||||||
|
fn verify_hmac_sha256_raw(secret: &[u8], body: &[u8], signature: &str) -> bool {
|
||||||
|
let expected = match hex::decode(signature) {
|
||||||
|
Ok(v) => v,
|
||||||
|
Err(_) => return false,
|
||||||
|
};
|
||||||
|
let mut mac = HmacSha256::new_from_slice(secret).expect("HMAC accepts any key size");
|
||||||
|
mac.update(body);
|
||||||
|
mac.verify_slice(&expected).is_ok()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Map a git forge event type + payload to a WFE event.
|
||||||
|
fn map_forge_event(event_type: &str, payload: &serde_json::Value) -> ForgeEvent {
|
||||||
|
let repo = payload["repository"]["full_name"]
|
||||||
|
.as_str()
|
||||||
|
.unwrap_or("unknown")
|
||||||
|
.to_string();
|
||||||
|
|
||||||
|
match event_type {
|
||||||
|
"push" => {
|
||||||
|
let git_ref = payload["ref"].as_str().unwrap_or("").to_string();
|
||||||
|
ForgeEvent {
|
||||||
|
event_name: "git.push".to_string(),
|
||||||
|
event_key: format!("{repo}/{git_ref}"),
|
||||||
|
data: serde_json::json!({
|
||||||
|
"repo": repo,
|
||||||
|
"ref": git_ref,
|
||||||
|
"before": payload["before"].as_str().unwrap_or(""),
|
||||||
|
"after": payload["after"].as_str().unwrap_or(""),
|
||||||
|
"commit": payload["head_commit"]["id"].as_str().unwrap_or(""),
|
||||||
|
"message": payload["head_commit"]["message"].as_str().unwrap_or(""),
|
||||||
|
"sender": payload["sender"]["login"].as_str().unwrap_or(""),
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
"pull_request" => {
|
||||||
|
let number = payload["number"].as_u64().unwrap_or(0);
|
||||||
|
ForgeEvent {
|
||||||
|
event_name: "git.pr".to_string(),
|
||||||
|
event_key: format!("{repo}/{number}"),
|
||||||
|
data: serde_json::json!({
|
||||||
|
"repo": repo,
|
||||||
|
"action": payload["action"].as_str().unwrap_or(""),
|
||||||
|
"number": number,
|
||||||
|
"title": payload["pull_request"]["title"].as_str().unwrap_or(""),
|
||||||
|
"head_ref": payload["pull_request"]["head"]["ref"].as_str().unwrap_or(""),
|
||||||
|
"base_ref": payload["pull_request"]["base"]["ref"].as_str().unwrap_or(""),
|
||||||
|
"sender": payload["sender"]["login"].as_str().unwrap_or(""),
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
"create" => {
|
||||||
|
let ref_name = payload["ref"].as_str().unwrap_or("").to_string();
|
||||||
|
let ref_type = payload["ref_type"].as_str().unwrap_or("").to_string();
|
||||||
|
ForgeEvent {
|
||||||
|
event_name: format!("git.{ref_type}"),
|
||||||
|
event_key: format!("{repo}/{ref_name}"),
|
||||||
|
data: serde_json::json!({
|
||||||
|
"repo": repo,
|
||||||
|
"ref": ref_name,
|
||||||
|
"ref_type": ref_type,
|
||||||
|
"sender": payload["sender"]["login"].as_str().unwrap_or(""),
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_ => ForgeEvent {
|
||||||
|
event_name: format!("git.{event_type}"),
|
||||||
|
event_key: repo.clone(),
|
||||||
|
data: serde_json::json!({
|
||||||
|
"repo": repo,
|
||||||
|
"event_type": event_type,
|
||||||
|
}),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Extract data fields from payload using simple JSONPath-like mapping.
|
||||||
|
/// Supports `$.field.nested` syntax.
|
||||||
|
fn map_trigger_data(
|
||||||
|
trigger: &WebhookTrigger,
|
||||||
|
payload: &serde_json::Value,
|
||||||
|
) -> serde_json::Value {
|
||||||
|
let mut data = serde_json::Map::new();
|
||||||
|
for (key, path) in &trigger.data_mapping {
|
||||||
|
if let Some(value) = resolve_json_path(payload, path) {
|
||||||
|
data.insert(key.clone(), value.clone());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
serde_json::Value::Object(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Resolve a simple JSONPath expression like `$.repository.full_name`.
|
||||||
|
fn resolve_json_path<'a>(value: &'a serde_json::Value, path: &str) -> Option<&'a serde_json::Value> {
|
||||||
|
let path = path.strip_prefix("$.").unwrap_or(path);
|
||||||
|
let mut current = value;
|
||||||
|
for segment in path.split('.') {
|
||||||
|
current = current.get(segment)?;
|
||||||
|
}
|
||||||
|
Some(current)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn verify_github_hmac_valid() {
|
||||||
|
let secret = b"mysecret";
|
||||||
|
let body = b"hello world";
|
||||||
|
let mut mac = HmacSha256::new_from_slice(secret).unwrap();
|
||||||
|
mac.update(body);
|
||||||
|
let sig = format!("sha256={}", hex::encode(mac.finalize().into_bytes()));
|
||||||
|
assert!(verify_hmac_sha256(secret, body, &sig));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn verify_github_hmac_invalid() {
|
||||||
|
assert!(!verify_hmac_sha256(b"secret", b"body", "sha256=deadbeef"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn verify_github_hmac_missing_prefix() {
|
||||||
|
assert!(!verify_hmac_sha256(b"secret", b"body", "not-a-signature"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn verify_gitea_hmac_raw_valid() {
|
||||||
|
let secret = b"giteasecret";
|
||||||
|
let body = b"payload";
|
||||||
|
let mut mac = HmacSha256::new_from_slice(secret).unwrap();
|
||||||
|
mac.update(body);
|
||||||
|
let sig = hex::encode(mac.finalize().into_bytes());
|
||||||
|
assert!(verify_hmac_sha256_raw(secret, body, &sig));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn verify_gitea_hmac_raw_invalid() {
|
||||||
|
assert!(!verify_hmac_sha256_raw(b"secret", b"body", "badhex"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn map_push_event() {
|
||||||
|
let payload = serde_json::json!({
|
||||||
|
"ref": "refs/heads/main",
|
||||||
|
"before": "aaa",
|
||||||
|
"after": "bbb",
|
||||||
|
"head_commit": { "id": "bbb", "message": "fix: stuff" },
|
||||||
|
"repository": { "full_name": "studio/wfe" },
|
||||||
|
"sender": { "login": "sienna" }
|
||||||
|
});
|
||||||
|
let event = map_forge_event("push", &payload);
|
||||||
|
assert_eq!(event.event_name, "git.push");
|
||||||
|
assert_eq!(event.event_key, "studio/wfe/refs/heads/main");
|
||||||
|
assert_eq!(event.data["commit"], "bbb");
|
||||||
|
assert_eq!(event.data["sender"], "sienna");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn map_pull_request_event() {
|
||||||
|
let payload = serde_json::json!({
|
||||||
|
"action": "opened",
|
||||||
|
"number": 42,
|
||||||
|
"pull_request": {
|
||||||
|
"title": "Add feature",
|
||||||
|
"head": { "ref": "feature-branch" },
|
||||||
|
"base": { "ref": "main" }
|
||||||
|
},
|
||||||
|
"repository": { "full_name": "studio/wfe" },
|
||||||
|
"sender": { "login": "sienna" }
|
||||||
|
});
|
||||||
|
let event = map_forge_event("pull_request", &payload);
|
||||||
|
assert_eq!(event.event_name, "git.pr");
|
||||||
|
assert_eq!(event.event_key, "studio/wfe/42");
|
||||||
|
assert_eq!(event.data["action"], "opened");
|
||||||
|
assert_eq!(event.data["title"], "Add feature");
|
||||||
|
assert_eq!(event.data["head_ref"], "feature-branch");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn map_create_tag_event() {
|
||||||
|
let payload = serde_json::json!({
|
||||||
|
"ref": "v1.5.0",
|
||||||
|
"ref_type": "tag",
|
||||||
|
"repository": { "full_name": "studio/wfe" },
|
||||||
|
"sender": { "login": "sienna" }
|
||||||
|
});
|
||||||
|
let event = map_forge_event("create", &payload);
|
||||||
|
assert_eq!(event.event_name, "git.tag");
|
||||||
|
assert_eq!(event.event_key, "studio/wfe/v1.5.0");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn map_create_branch_event() {
|
||||||
|
let payload = serde_json::json!({
|
||||||
|
"ref": "feature-x",
|
||||||
|
"ref_type": "branch",
|
||||||
|
"repository": { "full_name": "studio/wfe" },
|
||||||
|
"sender": { "login": "sienna" }
|
||||||
|
});
|
||||||
|
let event = map_forge_event("create", &payload);
|
||||||
|
assert_eq!(event.event_name, "git.branch");
|
||||||
|
assert_eq!(event.event_key, "studio/wfe/feature-x");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn map_unknown_event() {
|
||||||
|
let payload = serde_json::json!({
|
||||||
|
"repository": { "full_name": "studio/wfe" }
|
||||||
|
});
|
||||||
|
let event = map_forge_event("release", &payload);
|
||||||
|
assert_eq!(event.event_name, "git.release");
|
||||||
|
assert_eq!(event.event_key, "studio/wfe");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolve_json_path_simple() {
|
||||||
|
let v = serde_json::json!({"a": {"b": {"c": "value"}}});
|
||||||
|
assert_eq!(resolve_json_path(&v, "$.a.b.c").unwrap(), "value");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolve_json_path_no_prefix() {
|
||||||
|
let v = serde_json::json!({"repo": "test"});
|
||||||
|
assert_eq!(resolve_json_path(&v, "repo").unwrap(), "test");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn resolve_json_path_missing() {
|
||||||
|
let v = serde_json::json!({"a": 1});
|
||||||
|
assert!(resolve_json_path(&v, "$.b.c").is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn map_trigger_data_extracts_fields() {
|
||||||
|
let trigger = WebhookTrigger {
|
||||||
|
source: "github".to_string(),
|
||||||
|
event: "push".to_string(),
|
||||||
|
match_ref: None,
|
||||||
|
workflow_id: "ci".to_string(),
|
||||||
|
version: 1,
|
||||||
|
data_mapping: [
|
||||||
|
("repo".to_string(), "$.repository.full_name".to_string()),
|
||||||
|
("commit".to_string(), "$.head_commit.id".to_string()),
|
||||||
|
]
|
||||||
|
.into(),
|
||||||
|
};
|
||||||
|
let payload = serde_json::json!({
|
||||||
|
"repository": { "full_name": "studio/wfe" },
|
||||||
|
"head_commit": { "id": "abc123" }
|
||||||
|
});
|
||||||
|
let data = map_trigger_data(&trigger, &payload);
|
||||||
|
assert_eq!(data["repo"], "studio/wfe");
|
||||||
|
assert_eq!(data["commit"], "abc123");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn map_trigger_data_missing_field_skipped() {
|
||||||
|
let trigger = WebhookTrigger {
|
||||||
|
source: "github".to_string(),
|
||||||
|
event: "push".to_string(),
|
||||||
|
match_ref: None,
|
||||||
|
workflow_id: "ci".to_string(),
|
||||||
|
version: 1,
|
||||||
|
data_mapping: [("missing".to_string(), "$.nonexistent.field".to_string())].into(),
|
||||||
|
};
|
||||||
|
let payload = serde_json::json!({"repo": "test"});
|
||||||
|
let data = map_trigger_data(&trigger, &payload);
|
||||||
|
assert!(data.get("missing").is_none());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -9,6 +9,7 @@ default = []
|
|||||||
deno = ["deno_core", "deno_error", "url", "reqwest"]
|
deno = ["deno_core", "deno_error", "url", "reqwest"]
|
||||||
buildkit = ["wfe-buildkit"]
|
buildkit = ["wfe-buildkit"]
|
||||||
containerd = ["wfe-containerd"]
|
containerd = ["wfe-containerd"]
|
||||||
|
rustlang = ["wfe-rustlang"]
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
wfe-core = { workspace = true }
|
wfe-core = { workspace = true }
|
||||||
@@ -20,6 +21,7 @@ async-trait = { workspace = true }
|
|||||||
tokio = { workspace = true }
|
tokio = { workspace = true }
|
||||||
thiserror = { workspace = true }
|
thiserror = { workspace = true }
|
||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
|
chrono = { workspace = true }
|
||||||
regex = { workspace = true }
|
regex = { workspace = true }
|
||||||
deno_core = { workspace = true, optional = true }
|
deno_core = { workspace = true, optional = true }
|
||||||
deno_error = { workspace = true, optional = true }
|
deno_error = { workspace = true, optional = true }
|
||||||
@@ -27,6 +29,7 @@ url = { workspace = true, optional = true }
|
|||||||
reqwest = { workspace = true, optional = true }
|
reqwest = { workspace = true, optional = true }
|
||||||
wfe-buildkit = { workspace = true, optional = true }
|
wfe-buildkit = { workspace = true, optional = true }
|
||||||
wfe-containerd = { workspace = true, optional = true }
|
wfe-containerd = { workspace = true, optional = true }
|
||||||
|
wfe-rustlang = { workspace = true, optional = true }
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
pretty_assertions = { workspace = true }
|
pretty_assertions = { workspace = true }
|
||||||
@@ -36,3 +39,4 @@ wfe-core = { workspace = true, features = ["test-support"] }
|
|||||||
wfe = { path = "../wfe" }
|
wfe = { path = "../wfe" }
|
||||||
wiremock = { workspace = true }
|
wiremock = { workspace = true }
|
||||||
tempfile = { workspace = true }
|
tempfile = { workspace = true }
|
||||||
|
tracing-subscriber = { workspace = true }
|
||||||
|
|||||||
@@ -13,6 +13,8 @@ use crate::executors::deno::{DenoConfig, DenoPermissions, DenoStep};
|
|||||||
use wfe_buildkit::{BuildkitConfig, BuildkitStep};
|
use wfe_buildkit::{BuildkitConfig, BuildkitStep};
|
||||||
#[cfg(feature = "containerd")]
|
#[cfg(feature = "containerd")]
|
||||||
use wfe_containerd::{ContainerdConfig, ContainerdStep};
|
use wfe_containerd::{ContainerdConfig, ContainerdStep};
|
||||||
|
#[cfg(feature = "rustlang")]
|
||||||
|
use wfe_rustlang::{CargoCommand, CargoConfig, CargoStep, RustupCommand, RustupConfig, RustupStep};
|
||||||
use wfe_core::primitives::sub_workflow::SubWorkflowStep;
|
use wfe_core::primitives::sub_workflow::SubWorkflowStep;
|
||||||
use wfe_core::models::condition::{ComparisonOp, FieldComparison, StepCondition};
|
use wfe_core::models::condition::{ComparisonOp, FieldComparison, StepCondition};
|
||||||
|
|
||||||
@@ -454,6 +456,38 @@ fn build_step_config_and_factory(
|
|||||||
});
|
});
|
||||||
Ok((key, value, factory))
|
Ok((key, value, factory))
|
||||||
}
|
}
|
||||||
|
#[cfg(feature = "rustlang")]
|
||||||
|
"cargo-build" | "cargo-test" | "cargo-check" | "cargo-clippy" | "cargo-fmt"
|
||||||
|
| "cargo-doc" | "cargo-publish" | "cargo-audit" | "cargo-deny" | "cargo-nextest"
|
||||||
|
| "cargo-llvm-cov" | "cargo-doc-mdx" => {
|
||||||
|
let config = build_cargo_config(step, step_type)?;
|
||||||
|
let key = format!("wfe_yaml::cargo::{}", step.name);
|
||||||
|
let value = serde_json::to_value(&config).map_err(|e| {
|
||||||
|
YamlWorkflowError::Compilation(format!(
|
||||||
|
"Failed to serialize cargo config: {e}"
|
||||||
|
))
|
||||||
|
})?;
|
||||||
|
let config_clone = config.clone();
|
||||||
|
let factory: StepFactory = Box::new(move || {
|
||||||
|
Box::new(CargoStep::new(config_clone.clone())) as Box<dyn StepBody>
|
||||||
|
});
|
||||||
|
Ok((key, value, factory))
|
||||||
|
}
|
||||||
|
#[cfg(feature = "rustlang")]
|
||||||
|
"rust-install" | "rustup-toolchain" | "rustup-component" | "rustup-target" => {
|
||||||
|
let config = build_rustup_config(step, step_type)?;
|
||||||
|
let key = format!("wfe_yaml::rustup::{}", step.name);
|
||||||
|
let value = serde_json::to_value(&config).map_err(|e| {
|
||||||
|
YamlWorkflowError::Compilation(format!(
|
||||||
|
"Failed to serialize rustup config: {e}"
|
||||||
|
))
|
||||||
|
})?;
|
||||||
|
let config_clone = config.clone();
|
||||||
|
let factory: StepFactory = Box::new(move || {
|
||||||
|
Box::new(RustupStep::new(config_clone.clone())) as Box<dyn StepBody>
|
||||||
|
});
|
||||||
|
Ok((key, value, factory))
|
||||||
|
}
|
||||||
"workflow" => {
|
"workflow" => {
|
||||||
let config = step.config.as_ref().ok_or_else(|| {
|
let config = step.config.as_ref().ok_or_else(|| {
|
||||||
YamlWorkflowError::Compilation(format!(
|
YamlWorkflowError::Compilation(format!(
|
||||||
@@ -576,6 +610,88 @@ fn build_shell_config(step: &YamlStep) -> Result<ShellConfig, YamlWorkflowError>
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "rustlang")]
|
||||||
|
fn build_cargo_config(
|
||||||
|
step: &YamlStep,
|
||||||
|
step_type: &str,
|
||||||
|
) -> Result<CargoConfig, YamlWorkflowError> {
|
||||||
|
let command = match step_type {
|
||||||
|
"cargo-build" => CargoCommand::Build,
|
||||||
|
"cargo-test" => CargoCommand::Test,
|
||||||
|
"cargo-check" => CargoCommand::Check,
|
||||||
|
"cargo-clippy" => CargoCommand::Clippy,
|
||||||
|
"cargo-fmt" => CargoCommand::Fmt,
|
||||||
|
"cargo-doc" => CargoCommand::Doc,
|
||||||
|
"cargo-publish" => CargoCommand::Publish,
|
||||||
|
"cargo-audit" => CargoCommand::Audit,
|
||||||
|
"cargo-deny" => CargoCommand::Deny,
|
||||||
|
"cargo-nextest" => CargoCommand::Nextest,
|
||||||
|
"cargo-llvm-cov" => CargoCommand::LlvmCov,
|
||||||
|
"cargo-doc-mdx" => CargoCommand::DocMdx,
|
||||||
|
_ => {
|
||||||
|
return Err(YamlWorkflowError::Compilation(format!(
|
||||||
|
"Unknown cargo step type: '{step_type}'"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let config = step.config.as_ref();
|
||||||
|
let timeout_ms = config
|
||||||
|
.and_then(|c| c.timeout.as_ref())
|
||||||
|
.and_then(|t| parse_duration_ms(t));
|
||||||
|
|
||||||
|
Ok(CargoConfig {
|
||||||
|
command,
|
||||||
|
toolchain: config.and_then(|c| c.toolchain.clone()),
|
||||||
|
package: config.and_then(|c| c.package.clone()),
|
||||||
|
features: config.map(|c| c.features.clone()).unwrap_or_default(),
|
||||||
|
all_features: config.and_then(|c| c.all_features).unwrap_or(false),
|
||||||
|
no_default_features: config.and_then(|c| c.no_default_features).unwrap_or(false),
|
||||||
|
release: config.and_then(|c| c.release).unwrap_or(false),
|
||||||
|
target: config.and_then(|c| c.target.clone()),
|
||||||
|
profile: config.and_then(|c| c.profile.clone()),
|
||||||
|
extra_args: config.map(|c| c.extra_args.clone()).unwrap_or_default(),
|
||||||
|
env: config.map(|c| c.env.clone()).unwrap_or_default(),
|
||||||
|
working_dir: config.and_then(|c| c.working_dir.clone()),
|
||||||
|
timeout_ms,
|
||||||
|
output_dir: config.and_then(|c| c.output_dir.clone()),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "rustlang")]
|
||||||
|
fn build_rustup_config(
|
||||||
|
step: &YamlStep,
|
||||||
|
step_type: &str,
|
||||||
|
) -> Result<RustupConfig, YamlWorkflowError> {
|
||||||
|
let command = match step_type {
|
||||||
|
"rust-install" => RustupCommand::Install,
|
||||||
|
"rustup-toolchain" => RustupCommand::ToolchainInstall,
|
||||||
|
"rustup-component" => RustupCommand::ComponentAdd,
|
||||||
|
"rustup-target" => RustupCommand::TargetAdd,
|
||||||
|
_ => {
|
||||||
|
return Err(YamlWorkflowError::Compilation(format!(
|
||||||
|
"Unknown rustup step type: '{step_type}'"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let config = step.config.as_ref();
|
||||||
|
let timeout_ms = config
|
||||||
|
.and_then(|c| c.timeout.as_ref())
|
||||||
|
.and_then(|t| parse_duration_ms(t));
|
||||||
|
|
||||||
|
Ok(RustupConfig {
|
||||||
|
command,
|
||||||
|
toolchain: config.and_then(|c| c.toolchain.clone()),
|
||||||
|
components: config.map(|c| c.components.clone()).unwrap_or_default(),
|
||||||
|
targets: config.map(|c| c.targets.clone()).unwrap_or_default(),
|
||||||
|
profile: config.and_then(|c| c.profile.clone()),
|
||||||
|
default_toolchain: config.and_then(|c| c.default_toolchain.clone()),
|
||||||
|
extra_args: config.map(|c| c.extra_args.clone()).unwrap_or_default(),
|
||||||
|
timeout_ms,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
fn parse_duration_ms(s: &str) -> Option<u64> {
|
fn parse_duration_ms(s: &str) -> Option<u64> {
|
||||||
let s = s.trim();
|
let s = s.trim();
|
||||||
// Check "ms" before "s" since strip_suffix('s') would also match "500ms"
|
// Check "ms" before "s" since strip_suffix('s') would also match "500ms"
|
||||||
|
|||||||
@@ -23,18 +23,23 @@ impl ShellStep {
|
|||||||
pub fn new(config: ShellConfig) -> Self {
|
pub fn new(config: ShellConfig) -> Self {
|
||||||
Self { config }
|
Self { config }
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
#[async_trait]
|
fn build_command(&self, context: &StepExecutionContext<'_>) -> tokio::process::Command {
|
||||||
impl StepBody for ShellStep {
|
|
||||||
async fn run(&mut self, context: &StepExecutionContext<'_>) -> wfe_core::Result<ExecutionResult> {
|
|
||||||
let mut cmd = tokio::process::Command::new(&self.config.shell);
|
let mut cmd = tokio::process::Command::new(&self.config.shell);
|
||||||
cmd.arg("-c").arg(&self.config.run);
|
cmd.arg("-c").arg(&self.config.run);
|
||||||
|
|
||||||
// Inject workflow data as UPPER_CASE env vars (top-level keys only).
|
// Inject workflow data as UPPER_CASE env vars (top-level keys only).
|
||||||
|
// Skip keys that would override security-sensitive environment variables.
|
||||||
|
const BLOCKED_KEYS: &[&str] = &[
|
||||||
|
"PATH", "LD_PRELOAD", "LD_LIBRARY_PATH", "DYLD_LIBRARY_PATH",
|
||||||
|
"HOME", "SHELL", "USER", "LOGNAME", "TERM",
|
||||||
|
];
|
||||||
if let Some(data_obj) = context.workflow.data.as_object() {
|
if let Some(data_obj) = context.workflow.data.as_object() {
|
||||||
for (key, value) in data_obj {
|
for (key, value) in data_obj {
|
||||||
let env_key = key.to_uppercase();
|
let env_key = key.to_uppercase();
|
||||||
|
if BLOCKED_KEYS.contains(&env_key.as_str()) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
let env_val = match value {
|
let env_val = match value {
|
||||||
serde_json::Value::String(s) => s.clone(),
|
serde_json::Value::String(s) => s.clone(),
|
||||||
other => other.to_string(),
|
other => other.to_string(),
|
||||||
@@ -43,12 +48,10 @@ impl StepBody for ShellStep {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add extra env from config.
|
|
||||||
for (key, value) in &self.config.env {
|
for (key, value) in &self.config.env {
|
||||||
cmd.env(key, value);
|
cmd.env(key, value);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set working directory if specified.
|
|
||||||
if let Some(ref dir) = self.config.working_dir {
|
if let Some(ref dir) = self.config.working_dir {
|
||||||
cmd.current_dir(dir);
|
cmd.current_dir(dir);
|
||||||
}
|
}
|
||||||
@@ -56,15 +59,137 @@ impl StepBody for ShellStep {
|
|||||||
cmd.stdout(std::process::Stdio::piped());
|
cmd.stdout(std::process::Stdio::piped());
|
||||||
cmd.stderr(std::process::Stdio::piped());
|
cmd.stderr(std::process::Stdio::piped());
|
||||||
|
|
||||||
// Execute with optional timeout.
|
cmd
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Run with streaming output via LogSink.
|
||||||
|
///
|
||||||
|
/// Reads stdout and stderr line-by-line, streaming each line to the
|
||||||
|
/// LogSink as it's produced. Uses `tokio::select!` to interleave both
|
||||||
|
/// streams without spawning tasks (avoids lifetime issues with &dyn LogSink).
|
||||||
|
async fn run_streaming(
|
||||||
|
&self,
|
||||||
|
context: &StepExecutionContext<'_>,
|
||||||
|
) -> wfe_core::Result<(String, String, i32)> {
|
||||||
|
use tokio::io::{AsyncBufReadExt, BufReader};
|
||||||
|
use wfe_core::traits::{LogChunk, LogStreamType};
|
||||||
|
|
||||||
|
let log_sink = context.log_sink.unwrap();
|
||||||
|
let workflow_id = context.workflow.id.clone();
|
||||||
|
let definition_id = context.workflow.workflow_definition_id.clone();
|
||||||
|
let step_id = context.step.id;
|
||||||
|
let step_name = context.step.name.clone().unwrap_or_else(|| "unknown".to_string());
|
||||||
|
|
||||||
|
let mut cmd = self.build_command(context);
|
||||||
|
let mut child = cmd.spawn().map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("Failed to spawn shell command: {e}"))
|
||||||
|
})?;
|
||||||
|
|
||||||
|
let stdout_pipe = child.stdout.take().ok_or_else(|| {
|
||||||
|
WfeError::StepExecution("failed to capture stdout pipe".to_string())
|
||||||
|
})?;
|
||||||
|
let stderr_pipe = child.stderr.take().ok_or_else(|| {
|
||||||
|
WfeError::StepExecution("failed to capture stderr pipe".to_string())
|
||||||
|
})?;
|
||||||
|
let mut stdout_lines = BufReader::new(stdout_pipe).lines();
|
||||||
|
let mut stderr_lines = BufReader::new(stderr_pipe).lines();
|
||||||
|
|
||||||
|
let mut stdout_buf = Vec::new();
|
||||||
|
let mut stderr_buf = Vec::new();
|
||||||
|
let mut stdout_done = false;
|
||||||
|
let mut stderr_done = false;
|
||||||
|
|
||||||
|
// Interleave stdout/stderr reads with optional timeout.
|
||||||
|
let read_future = async {
|
||||||
|
while !stdout_done || !stderr_done {
|
||||||
|
tokio::select! {
|
||||||
|
line = stdout_lines.next_line(), if !stdout_done => {
|
||||||
|
match line {
|
||||||
|
Ok(Some(line)) => {
|
||||||
|
log_sink.write_chunk(LogChunk {
|
||||||
|
workflow_id: workflow_id.clone(),
|
||||||
|
definition_id: definition_id.clone(),
|
||||||
|
step_id,
|
||||||
|
step_name: step_name.clone(),
|
||||||
|
stream: LogStreamType::Stdout,
|
||||||
|
data: format!("{line}\n").into_bytes(),
|
||||||
|
timestamp: chrono::Utc::now(),
|
||||||
|
}).await;
|
||||||
|
stdout_buf.push(line);
|
||||||
|
}
|
||||||
|
_ => stdout_done = true,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
line = stderr_lines.next_line(), if !stderr_done => {
|
||||||
|
match line {
|
||||||
|
Ok(Some(line)) => {
|
||||||
|
log_sink.write_chunk(LogChunk {
|
||||||
|
workflow_id: workflow_id.clone(),
|
||||||
|
definition_id: definition_id.clone(),
|
||||||
|
step_id,
|
||||||
|
step_name: step_name.clone(),
|
||||||
|
stream: LogStreamType::Stderr,
|
||||||
|
data: format!("{line}\n").into_bytes(),
|
||||||
|
timestamp: chrono::Utc::now(),
|
||||||
|
}).await;
|
||||||
|
stderr_buf.push(line);
|
||||||
|
}
|
||||||
|
_ => stderr_done = true,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
child.wait().await
|
||||||
|
};
|
||||||
|
|
||||||
|
let status = if let Some(timeout_ms) = self.config.timeout_ms {
|
||||||
|
let duration = std::time::Duration::from_millis(timeout_ms);
|
||||||
|
match tokio::time::timeout(duration, read_future).await {
|
||||||
|
Ok(result) => result.map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("Failed to wait for shell command: {e}"))
|
||||||
|
})?,
|
||||||
|
Err(_) => {
|
||||||
|
// Kill the child on timeout.
|
||||||
|
let _ = child.kill().await;
|
||||||
|
return Err(WfeError::StepExecution(format!(
|
||||||
|
"Shell command timed out after {timeout_ms}ms"
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
read_future.await.map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("Failed to wait for shell command: {e}"))
|
||||||
|
})?
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut stdout = stdout_buf.join("\n");
|
||||||
|
let mut stderr = stderr_buf.join("\n");
|
||||||
|
if !stdout.is_empty() {
|
||||||
|
stdout.push('\n');
|
||||||
|
}
|
||||||
|
if !stderr.is_empty() {
|
||||||
|
stderr.push('\n');
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok((stdout, stderr, status.code().unwrap_or(-1)))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Run with buffered output (original path, no LogSink).
|
||||||
|
async fn run_buffered(
|
||||||
|
&self,
|
||||||
|
context: &StepExecutionContext<'_>,
|
||||||
|
) -> wfe_core::Result<(String, String, i32)> {
|
||||||
|
let mut cmd = self.build_command(context);
|
||||||
|
|
||||||
let output = if let Some(timeout_ms) = self.config.timeout_ms {
|
let output = if let Some(timeout_ms) = self.config.timeout_ms {
|
||||||
let duration = std::time::Duration::from_millis(timeout_ms);
|
let duration = std::time::Duration::from_millis(timeout_ms);
|
||||||
match tokio::time::timeout(duration, cmd.output()).await {
|
match tokio::time::timeout(duration, cmd.output()).await {
|
||||||
Ok(result) => result.map_err(|e| WfeError::StepExecution(format!("Failed to spawn shell command: {e}")))?,
|
Ok(result) => result.map_err(|e| {
|
||||||
|
WfeError::StepExecution(format!("Failed to spawn shell command: {e}"))
|
||||||
|
})?,
|
||||||
Err(_) => {
|
Err(_) => {
|
||||||
return Err(WfeError::StepExecution(format!(
|
return Err(WfeError::StepExecution(format!(
|
||||||
"Shell command timed out after {}ms",
|
"Shell command timed out after {timeout_ms}ms"
|
||||||
timeout_ms
|
|
||||||
)));
|
)));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -76,11 +201,24 @@ impl StepBody for ShellStep {
|
|||||||
|
|
||||||
let stdout = String::from_utf8_lossy(&output.stdout).to_string();
|
let stdout = String::from_utf8_lossy(&output.stdout).to_string();
|
||||||
let stderr = String::from_utf8_lossy(&output.stderr).to_string();
|
let stderr = String::from_utf8_lossy(&output.stderr).to_string();
|
||||||
|
|
||||||
if !output.status.success() {
|
|
||||||
let code = output.status.code().unwrap_or(-1);
|
let code = output.status.code().unwrap_or(-1);
|
||||||
|
|
||||||
|
Ok((stdout, stderr, code))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
impl StepBody for ShellStep {
|
||||||
|
async fn run(&mut self, context: &StepExecutionContext<'_>) -> wfe_core::Result<ExecutionResult> {
|
||||||
|
let (stdout, stderr, exit_code) = if context.log_sink.is_some() {
|
||||||
|
self.run_streaming(context).await?
|
||||||
|
} else {
|
||||||
|
self.run_buffered(context).await?
|
||||||
|
};
|
||||||
|
|
||||||
|
if exit_code != 0 {
|
||||||
return Err(WfeError::StepExecution(format!(
|
return Err(WfeError::StepExecution(format!(
|
||||||
"Shell command exited with code {code}\nstdout: {stdout}\nstderr: {stderr}"
|
"Shell command exited with code {exit_code}\nstdout: {stdout}\nstderr: {stderr}"
|
||||||
)));
|
)));
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -93,7 +231,6 @@ impl StepBody for ShellStep {
|
|||||||
{
|
{
|
||||||
let name = rest[..eq_pos].trim().to_string();
|
let name = rest[..eq_pos].trim().to_string();
|
||||||
let raw_value = rest[eq_pos + 1..].to_string();
|
let raw_value = rest[eq_pos + 1..].to_string();
|
||||||
// Auto-convert typed values from string annotations
|
|
||||||
let value = match raw_value.as_str() {
|
let value = match raw_value.as_str() {
|
||||||
"true" => serde_json::Value::Bool(true),
|
"true" => serde_json::Value::Bool(true),
|
||||||
"false" => serde_json::Value::Bool(false),
|
"false" => serde_json::Value::Bool(false),
|
||||||
@@ -110,15 +247,10 @@ impl StepBody for ShellStep {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add raw stdout under the step name.
|
let step_name = context.step.name.as_deref().unwrap_or("unknown");
|
||||||
let step_name = context
|
|
||||||
.step
|
|
||||||
.name
|
|
||||||
.as_deref()
|
|
||||||
.unwrap_or("unknown");
|
|
||||||
outputs.insert(
|
outputs.insert(
|
||||||
format!("{step_name}.stdout"),
|
format!("{step_name}.stdout"),
|
||||||
serde_json::Value::String(stdout.clone()),
|
serde_json::Value::String(stdout),
|
||||||
);
|
);
|
||||||
outputs.insert(
|
outputs.insert(
|
||||||
format!("{step_name}.stderr"),
|
format!("{step_name}.stderr"),
|
||||||
|
|||||||
@@ -164,6 +164,39 @@ pub struct StepConfig {
|
|||||||
pub containerd_addr: Option<String>,
|
pub containerd_addr: Option<String>,
|
||||||
/// CLI binary name for containerd steps: "nerdctl" (default) or "docker".
|
/// CLI binary name for containerd steps: "nerdctl" (default) or "docker".
|
||||||
pub cli: Option<String>,
|
pub cli: Option<String>,
|
||||||
|
// Cargo fields
|
||||||
|
/// Target package for cargo steps (`-p`).
|
||||||
|
pub package: Option<String>,
|
||||||
|
/// Features to enable for cargo steps.
|
||||||
|
#[serde(default)]
|
||||||
|
pub features: Vec<String>,
|
||||||
|
/// Enable all features for cargo steps.
|
||||||
|
#[serde(default)]
|
||||||
|
pub all_features: Option<bool>,
|
||||||
|
/// Disable default features for cargo steps.
|
||||||
|
#[serde(default)]
|
||||||
|
pub no_default_features: Option<bool>,
|
||||||
|
/// Build in release mode for cargo steps.
|
||||||
|
#[serde(default)]
|
||||||
|
pub release: Option<bool>,
|
||||||
|
/// Build profile for cargo steps (`--profile`).
|
||||||
|
pub profile: Option<String>,
|
||||||
|
/// Rust toolchain override for cargo steps (e.g. "nightly").
|
||||||
|
pub toolchain: Option<String>,
|
||||||
|
/// Additional arguments for cargo/rustup steps.
|
||||||
|
#[serde(default)]
|
||||||
|
pub extra_args: Vec<String>,
|
||||||
|
/// Output directory for generated files (e.g., MDX docs).
|
||||||
|
pub output_dir: Option<String>,
|
||||||
|
// Rustup fields
|
||||||
|
/// Components to add for rustup steps (e.g. ["clippy", "rustfmt"]).
|
||||||
|
#[serde(default)]
|
||||||
|
pub components: Vec<String>,
|
||||||
|
/// Compilation targets to add for rustup steps (e.g. ["wasm32-unknown-unknown"]).
|
||||||
|
#[serde(default)]
|
||||||
|
pub targets: Vec<String>,
|
||||||
|
/// Default toolchain for rust-install steps.
|
||||||
|
pub default_toolchain: Option<String>,
|
||||||
// Workflow (sub-workflow) fields
|
// Workflow (sub-workflow) fields
|
||||||
/// Child workflow ID (for `type: workflow` steps).
|
/// Child workflow ID (for `type: workflow` steps).
|
||||||
#[serde(rename = "workflow")]
|
#[serde(rename = "workflow")]
|
||||||
|
|||||||
@@ -1082,6 +1082,7 @@ workflows:
|
|||||||
workflow: &workflow,
|
workflow: &workflow,
|
||||||
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
||||||
host_context: Some(&host),
|
host_context: Some(&host),
|
||||||
|
log_sink: None,
|
||||||
};
|
};
|
||||||
|
|
||||||
let result = step.run(&ctx).await.unwrap();
|
let result = step.run(&ctx).await.unwrap();
|
||||||
|
|||||||
@@ -42,6 +42,7 @@ fn make_context<'a>(
|
|||||||
workflow,
|
workflow,
|
||||||
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
cancellation_token: tokio_util::sync::CancellationToken::new(),
|
||||||
host_context: None,
|
host_context: None,
|
||||||
|
log_sink: None,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
777
wfe-yaml/tests/rustlang.rs
Normal file
777
wfe-yaml/tests/rustlang.rs
Normal file
@@ -0,0 +1,777 @@
|
|||||||
|
#![cfg(feature = "rustlang")]
|
||||||
|
|
||||||
|
use std::collections::HashMap;
|
||||||
|
use std::sync::Arc;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use wfe::models::WorkflowStatus;
|
||||||
|
use wfe::{WorkflowHostBuilder, run_workflow_sync};
|
||||||
|
use wfe_core::test_support::{
|
||||||
|
InMemoryLockProvider, InMemoryPersistenceProvider, InMemoryQueueProvider,
|
||||||
|
};
|
||||||
|
use wfe_yaml::load_single_workflow_from_str;
|
||||||
|
|
||||||
|
fn has_factory(compiled: &wfe_yaml::compiler::CompiledWorkflow, key: &str) -> bool {
|
||||||
|
compiled.step_factories.iter().any(|(k, _)| k == key)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn run_yaml_workflow(yaml: &str) -> wfe::models::WorkflowInstance {
|
||||||
|
let config = HashMap::new();
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &config).unwrap();
|
||||||
|
|
||||||
|
let persistence = Arc::new(InMemoryPersistenceProvider::new());
|
||||||
|
let lock = Arc::new(InMemoryLockProvider::new());
|
||||||
|
let queue = Arc::new(InMemoryQueueProvider::new());
|
||||||
|
|
||||||
|
let host = WorkflowHostBuilder::new()
|
||||||
|
.use_persistence(persistence as Arc<dyn wfe_core::traits::PersistenceProvider>)
|
||||||
|
.use_lock_provider(lock as Arc<dyn wfe_core::traits::DistributedLockProvider>)
|
||||||
|
.use_queue_provider(queue as Arc<dyn wfe_core::traits::QueueProvider>)
|
||||||
|
.build()
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
for (key, factory) in compiled.step_factories {
|
||||||
|
host.register_step_factory(&key, factory).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
host.register_workflow_definition(compiled.definition.clone())
|
||||||
|
.await;
|
||||||
|
host.start().await.unwrap();
|
||||||
|
|
||||||
|
let instance = run_workflow_sync(
|
||||||
|
&host,
|
||||||
|
&compiled.definition.id,
|
||||||
|
compiled.definition.version,
|
||||||
|
serde_json::json!({}),
|
||||||
|
Duration::from_secs(30),
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
host.stop().await;
|
||||||
|
instance
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Compiler tests — verify YAML compiles to correct step types and configs
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_build_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: cargo-build-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: build
|
||||||
|
type: cargo-build
|
||||||
|
config:
|
||||||
|
release: true
|
||||||
|
package: my-crate
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
let step = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("build"))
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(step.step_type, "wfe_yaml::cargo::build");
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::build"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_test_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: cargo-test-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: test
|
||||||
|
type: cargo-test
|
||||||
|
config:
|
||||||
|
features:
|
||||||
|
- feat1
|
||||||
|
- feat2
|
||||||
|
extra_args:
|
||||||
|
- "--"
|
||||||
|
- "--nocapture"
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
let step = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("test"))
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(step.step_type, "wfe_yaml::cargo::test");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_check_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: cargo-check-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: check
|
||||||
|
type: cargo-check
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::check"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_clippy_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: cargo-clippy-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: lint
|
||||||
|
type: cargo-clippy
|
||||||
|
config:
|
||||||
|
all_features: true
|
||||||
|
extra_args:
|
||||||
|
- "--"
|
||||||
|
- "-D"
|
||||||
|
- "warnings"
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::lint"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_fmt_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: cargo-fmt-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: format
|
||||||
|
type: cargo-fmt
|
||||||
|
config:
|
||||||
|
extra_args:
|
||||||
|
- "--check"
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::format"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_doc_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: cargo-doc-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: docs
|
||||||
|
type: cargo-doc
|
||||||
|
config:
|
||||||
|
extra_args:
|
||||||
|
- "--no-deps"
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::docs"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_publish_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: cargo-publish-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: publish
|
||||||
|
type: cargo-publish
|
||||||
|
config:
|
||||||
|
extra_args:
|
||||||
|
- "--dry-run"
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::publish"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_step_with_toolchain() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: nightly-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: nightly-check
|
||||||
|
type: cargo-check
|
||||||
|
config:
|
||||||
|
toolchain: nightly
|
||||||
|
no_default_features: true
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::nightly-check"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_step_with_timeout() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: timeout-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: slow-build
|
||||||
|
type: cargo-build
|
||||||
|
config:
|
||||||
|
timeout: 5m
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::slow-build"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_step_without_config() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: bare-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: bare-check
|
||||||
|
type: cargo-check
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::bare-check"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_multi_step_pipeline() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: ci-pipeline
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: fmt
|
||||||
|
type: cargo-fmt
|
||||||
|
config:
|
||||||
|
extra_args: ["--check"]
|
||||||
|
- name: check
|
||||||
|
type: cargo-check
|
||||||
|
- name: clippy
|
||||||
|
type: cargo-clippy
|
||||||
|
config:
|
||||||
|
extra_args: ["--", "-D", "warnings"]
|
||||||
|
- name: test
|
||||||
|
type: cargo-test
|
||||||
|
- name: build
|
||||||
|
type: cargo-build
|
||||||
|
config:
|
||||||
|
release: true
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::fmt"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::check"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::clippy"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::test"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::build"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_step_with_all_shared_flags() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: full-flags-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: full
|
||||||
|
type: cargo-build
|
||||||
|
config:
|
||||||
|
package: my-crate
|
||||||
|
features: [foo, bar]
|
||||||
|
all_features: false
|
||||||
|
no_default_features: true
|
||||||
|
release: true
|
||||||
|
toolchain: stable
|
||||||
|
profile: release
|
||||||
|
extra_args: ["--jobs", "4"]
|
||||||
|
working_dir: /tmp/project
|
||||||
|
timeout: 30s
|
||||||
|
env:
|
||||||
|
RUSTFLAGS: "-C target-cpu=native"
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::full"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_step_preserves_step_config_json() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: config-json-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: build
|
||||||
|
type: cargo-build
|
||||||
|
config:
|
||||||
|
release: true
|
||||||
|
package: wfe-core
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
let step = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("build"))
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let step_config = step.step_config.as_ref().unwrap();
|
||||||
|
assert_eq!(step_config["command"], "build");
|
||||||
|
assert_eq!(step_config["release"], true);
|
||||||
|
assert_eq!(step_config["package"], "wfe-core");
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Integration tests — run actual cargo commands through the workflow engine
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn cargo_check_on_self_succeeds() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: self-check
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: check
|
||||||
|
type: cargo-check
|
||||||
|
config:
|
||||||
|
working_dir: .
|
||||||
|
timeout: 120s
|
||||||
|
"#;
|
||||||
|
let instance = run_yaml_workflow(yaml).await;
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Complete);
|
||||||
|
|
||||||
|
let data = instance.data.as_object().unwrap();
|
||||||
|
assert!(data.contains_key("check.stdout") || data.contains_key("check.stderr"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn cargo_fmt_check_compiles() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: fmt-check
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: fmt
|
||||||
|
type: cargo-fmt
|
||||||
|
config:
|
||||||
|
working_dir: .
|
||||||
|
extra_args: ["--check"]
|
||||||
|
timeout: 60s
|
||||||
|
"#;
|
||||||
|
let config = HashMap::new();
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &config).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::fmt"));
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Rustup compiler tests
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_rust_install_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: rust-install-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: install-rust
|
||||||
|
type: rust-install
|
||||||
|
config:
|
||||||
|
profile: minimal
|
||||||
|
default_toolchain: stable
|
||||||
|
timeout: 5m
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
let step = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("install-rust"))
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(step.step_type, "wfe_yaml::rustup::install-rust");
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::install-rust"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_rustup_toolchain_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: tc-install-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: add-nightly
|
||||||
|
type: rustup-toolchain
|
||||||
|
config:
|
||||||
|
toolchain: nightly-2024-06-01
|
||||||
|
profile: minimal
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::add-nightly"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_rustup_component_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: comp-add-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: add-tools
|
||||||
|
type: rustup-component
|
||||||
|
config:
|
||||||
|
components: [clippy, rustfmt, rust-src]
|
||||||
|
toolchain: nightly
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::add-tools"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_rustup_target_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: target-add-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: add-wasm
|
||||||
|
type: rustup-target
|
||||||
|
config:
|
||||||
|
targets: [wasm32-unknown-unknown]
|
||||||
|
toolchain: stable
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::add-wasm"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_rustup_step_without_config() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: bare-install-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: install
|
||||||
|
type: rust-install
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::install"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_rustup_step_preserves_config_json() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: config-json-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: tc
|
||||||
|
type: rustup-toolchain
|
||||||
|
config:
|
||||||
|
toolchain: nightly
|
||||||
|
profile: minimal
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
let step = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("tc"))
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let step_config = step.step_config.as_ref().unwrap();
|
||||||
|
assert_eq!(step_config["command"], "toolchain-install");
|
||||||
|
assert_eq!(step_config["toolchain"], "nightly");
|
||||||
|
assert_eq!(step_config["profile"], "minimal");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_full_rust_ci_pipeline() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: full-rust-ci
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: install
|
||||||
|
type: rust-install
|
||||||
|
config:
|
||||||
|
profile: minimal
|
||||||
|
default_toolchain: stable
|
||||||
|
- name: add-nightly
|
||||||
|
type: rustup-toolchain
|
||||||
|
config:
|
||||||
|
toolchain: nightly
|
||||||
|
- name: add-components
|
||||||
|
type: rustup-component
|
||||||
|
config:
|
||||||
|
components: [clippy, rustfmt]
|
||||||
|
- name: add-wasm
|
||||||
|
type: rustup-target
|
||||||
|
config:
|
||||||
|
targets: [wasm32-unknown-unknown]
|
||||||
|
- name: fmt
|
||||||
|
type: cargo-fmt
|
||||||
|
config:
|
||||||
|
extra_args: ["--check"]
|
||||||
|
- name: check
|
||||||
|
type: cargo-check
|
||||||
|
- name: clippy
|
||||||
|
type: cargo-clippy
|
||||||
|
config:
|
||||||
|
extra_args: ["--", "-D", "warnings"]
|
||||||
|
- name: test
|
||||||
|
type: cargo-test
|
||||||
|
- name: build
|
||||||
|
type: cargo-build
|
||||||
|
config:
|
||||||
|
release: true
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::install"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::add-nightly"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::add-components"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::add-wasm"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::fmt"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::check"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::clippy"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::test"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::build"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_rustup_component_with_extra_args() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: comp-extra-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: add-llvm
|
||||||
|
type: rustup-component
|
||||||
|
config:
|
||||||
|
components: [llvm-tools-preview]
|
||||||
|
extra_args: ["--force"]
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::add-llvm"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_rustup_target_multiple() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: multi-target-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: cross-targets
|
||||||
|
type: rustup-target
|
||||||
|
config:
|
||||||
|
targets:
|
||||||
|
- wasm32-unknown-unknown
|
||||||
|
- aarch64-linux-android
|
||||||
|
- x86_64-unknown-linux-musl
|
||||||
|
toolchain: nightly
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::rustup::cross-targets"));
|
||||||
|
|
||||||
|
let step_config = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("cross-targets"))
|
||||||
|
.unwrap()
|
||||||
|
.step_config
|
||||||
|
.as_ref()
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(step_config["command"], "target-add");
|
||||||
|
let targets = step_config["targets"].as_array().unwrap();
|
||||||
|
assert_eq!(targets.len(), 3);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// External cargo tool step compiler tests
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_audit_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: audit-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: audit
|
||||||
|
type: cargo-audit
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::audit"));
|
||||||
|
|
||||||
|
let step_config = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("audit"))
|
||||||
|
.unwrap()
|
||||||
|
.step_config
|
||||||
|
.as_ref()
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(step_config["command"], "audit");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_deny_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: deny-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: license-check
|
||||||
|
type: cargo-deny
|
||||||
|
config:
|
||||||
|
extra_args: ["check"]
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::license-check"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_nextest_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: nextest-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: fast-test
|
||||||
|
type: cargo-nextest
|
||||||
|
config:
|
||||||
|
features: [foo]
|
||||||
|
extra_args: ["--no-fail-fast"]
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::fast-test"));
|
||||||
|
|
||||||
|
let step_config = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("fast-test"))
|
||||||
|
.unwrap()
|
||||||
|
.step_config
|
||||||
|
.as_ref()
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(step_config["command"], "nextest");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_llvm_cov_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: cov-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: coverage
|
||||||
|
type: cargo-llvm-cov
|
||||||
|
config:
|
||||||
|
extra_args: ["--html", "--output-dir", "coverage"]
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::coverage"));
|
||||||
|
|
||||||
|
let step_config = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("coverage"))
|
||||||
|
.unwrap()
|
||||||
|
.step_config
|
||||||
|
.as_ref()
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(step_config["command"], "llvm-cov");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_full_ci_with_external_tools() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: full-ci-external
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: audit
|
||||||
|
type: cargo-audit
|
||||||
|
- name: deny
|
||||||
|
type: cargo-deny
|
||||||
|
config:
|
||||||
|
extra_args: ["check", "licenses"]
|
||||||
|
- name: test
|
||||||
|
type: cargo-nextest
|
||||||
|
- name: coverage
|
||||||
|
type: cargo-llvm-cov
|
||||||
|
config:
|
||||||
|
extra_args: ["--summary-only"]
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::audit"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::deny"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::test"));
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::coverage"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_doc_mdx_step() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: doc-mdx-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: docs
|
||||||
|
type: cargo-doc-mdx
|
||||||
|
config:
|
||||||
|
package: my-crate
|
||||||
|
output_dir: docs/api
|
||||||
|
extra_args: ["--no-deps"]
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::docs"));
|
||||||
|
|
||||||
|
let step_config = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("docs"))
|
||||||
|
.unwrap()
|
||||||
|
.step_config
|
||||||
|
.as_ref()
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(step_config["command"], "doc-mdx");
|
||||||
|
assert_eq!(step_config["package"], "my-crate");
|
||||||
|
assert_eq!(step_config["output_dir"], "docs/api");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn compile_cargo_doc_mdx_minimal() {
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: doc-mdx-minimal-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: generate-docs
|
||||||
|
type: cargo-doc-mdx
|
||||||
|
"#;
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &HashMap::new()).unwrap();
|
||||||
|
assert!(has_factory(&compiled, "wfe_yaml::cargo::generate-docs"));
|
||||||
|
|
||||||
|
let step_config = compiled
|
||||||
|
.definition
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.find(|s| s.name.as_deref() == Some("generate-docs"))
|
||||||
|
.unwrap()
|
||||||
|
.step_config
|
||||||
|
.as_ref()
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(step_config["command"], "doc-mdx");
|
||||||
|
assert!(step_config["output_dir"].is_null());
|
||||||
|
}
|
||||||
474
wfe-yaml/tests/rustlang_containerd.rs
Normal file
474
wfe-yaml/tests/rustlang_containerd.rs
Normal file
@@ -0,0 +1,474 @@
|
|||||||
|
//! End-to-end integration tests for the Rust toolchain steps running inside
|
||||||
|
//! containerd containers.
|
||||||
|
//!
|
||||||
|
//! These tests start from a bare Debian image (no Rust installed) and exercise
|
||||||
|
//! the full Rust CI pipeline: install Rust, install external tools, create a
|
||||||
|
//! test project, and run every cargo operation.
|
||||||
|
//!
|
||||||
|
//! Requirements:
|
||||||
|
//! - A running containerd daemon (Lima/colima or native)
|
||||||
|
//! - Set `WFE_CONTAINERD_ADDR` to point to the socket
|
||||||
|
//!
|
||||||
|
//! These tests are gated behind `rustlang` + `containerd` features and are
|
||||||
|
//! marked `#[ignore]` so they don't run in normal CI. Run them explicitly:
|
||||||
|
//! cargo test -p wfe-yaml --features rustlang,containerd --test rustlang_containerd -- --ignored
|
||||||
|
|
||||||
|
#![cfg(all(feature = "rustlang", feature = "containerd"))]
|
||||||
|
|
||||||
|
use std::collections::HashMap;
|
||||||
|
use std::path::Path;
|
||||||
|
use std::sync::Arc;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use wfe::models::WorkflowStatus;
|
||||||
|
use wfe::{WorkflowHostBuilder, run_workflow_sync};
|
||||||
|
use wfe_core::test_support::{
|
||||||
|
InMemoryLockProvider, InMemoryPersistenceProvider, InMemoryQueueProvider,
|
||||||
|
};
|
||||||
|
use wfe_yaml::load_single_workflow_from_str;
|
||||||
|
|
||||||
|
/// Returns the containerd address if available, or None.
|
||||||
|
/// Supports both Unix sockets (`unix:///path`) and TCP (`http://host:port`).
|
||||||
|
fn containerd_addr() -> Option<String> {
|
||||||
|
let addr = std::env::var("WFE_CONTAINERD_ADDR").unwrap_or_else(|_| {
|
||||||
|
// Default: TCP proxy on the Lima VM (socat forwarding containerd socket)
|
||||||
|
"http://127.0.0.1:2500".to_string()
|
||||||
|
});
|
||||||
|
|
||||||
|
// For TCP addresses, assume reachable (the test will fail fast if not).
|
||||||
|
if addr.starts_with("http://") || addr.starts_with("tcp://") {
|
||||||
|
return Some(addr);
|
||||||
|
}
|
||||||
|
|
||||||
|
// For Unix sockets, check the file exists.
|
||||||
|
let socket_path = addr.strip_prefix("unix://").unwrap_or(addr.as_str());
|
||||||
|
if Path::new(socket_path).exists() {
|
||||||
|
Some(addr)
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn run_yaml_workflow_with_config(
|
||||||
|
yaml: &str,
|
||||||
|
config: &HashMap<String, serde_json::Value>,
|
||||||
|
) -> wfe::models::WorkflowInstance {
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, config).unwrap();
|
||||||
|
for step in &compiled.definition.steps {
|
||||||
|
eprintln!(" step: {:?} type={} config={:?}", step.name, step.step_type, step.step_config);
|
||||||
|
}
|
||||||
|
eprintln!(" factories: {:?}", compiled.step_factories.iter().map(|(k, _)| k.clone()).collect::<Vec<_>>());
|
||||||
|
|
||||||
|
let persistence = Arc::new(InMemoryPersistenceProvider::new());
|
||||||
|
let lock = Arc::new(InMemoryLockProvider::new());
|
||||||
|
let queue = Arc::new(InMemoryQueueProvider::new());
|
||||||
|
|
||||||
|
let host = WorkflowHostBuilder::new()
|
||||||
|
.use_persistence(persistence as Arc<dyn wfe_core::traits::PersistenceProvider>)
|
||||||
|
.use_lock_provider(lock as Arc<dyn wfe_core::traits::DistributedLockProvider>)
|
||||||
|
.use_queue_provider(queue as Arc<dyn wfe_core::traits::QueueProvider>)
|
||||||
|
.build()
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
for (key, factory) in compiled.step_factories {
|
||||||
|
host.register_step_factory(&key, factory).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
host.register_workflow_definition(compiled.definition.clone())
|
||||||
|
.await;
|
||||||
|
host.start().await.unwrap();
|
||||||
|
|
||||||
|
let instance = run_workflow_sync(
|
||||||
|
&host,
|
||||||
|
&compiled.definition.id,
|
||||||
|
compiled.definition.version,
|
||||||
|
serde_json::json!({}),
|
||||||
|
Duration::from_secs(1800),
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
host.stop().await;
|
||||||
|
instance
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Shared env block and volume template for containerd steps.
|
||||||
|
/// Uses format! to avoid Rust 2024 reserved `##` token in raw strings.
|
||||||
|
fn containerd_step_yaml(
|
||||||
|
name: &str,
|
||||||
|
network: &str,
|
||||||
|
pull: &str,
|
||||||
|
timeout: &str,
|
||||||
|
working_dir: Option<&str>,
|
||||||
|
mount_workspace: bool,
|
||||||
|
run_script: &str,
|
||||||
|
) -> String {
|
||||||
|
let wfe = "##wfe";
|
||||||
|
let wd = working_dir
|
||||||
|
.map(|d| format!(" working_dir: {d}"))
|
||||||
|
.unwrap_or_default();
|
||||||
|
let ws_volume = if mount_workspace {
|
||||||
|
" - source: ((workspace))\n target: /workspace"
|
||||||
|
} else {
|
||||||
|
""
|
||||||
|
};
|
||||||
|
|
||||||
|
format!(
|
||||||
|
r#" - name: {name}
|
||||||
|
type: containerd
|
||||||
|
config:
|
||||||
|
image: docker.io/library/debian:bookworm-slim
|
||||||
|
containerd_addr: ((containerd_addr))
|
||||||
|
user: "0:0"
|
||||||
|
network: {network}
|
||||||
|
pull: {pull}
|
||||||
|
timeout: {timeout}
|
||||||
|
{wd}
|
||||||
|
env:
|
||||||
|
CARGO_HOME: /cargo
|
||||||
|
RUSTUP_HOME: /rustup
|
||||||
|
PATH: /cargo/bin:/rustup/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
|
||||||
|
volumes:
|
||||||
|
- source: ((cargo_home))
|
||||||
|
target: /cargo
|
||||||
|
- source: ((rustup_home))
|
||||||
|
target: /rustup
|
||||||
|
{ws_volume}
|
||||||
|
run: |
|
||||||
|
{run_script}
|
||||||
|
echo "{wfe}[output {name}.status=ok]"
|
||||||
|
"#
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Base directory for shared state between host and containerd VM.
|
||||||
|
/// Must be inside the virtiofs mount defined in test/lima/wfe-test.yaml.
|
||||||
|
fn shared_dir() -> std::path::PathBuf {
|
||||||
|
let base = std::env::var("WFE_IO_DIR")
|
||||||
|
.map(std::path::PathBuf::from)
|
||||||
|
.unwrap_or_else(|_| std::path::PathBuf::from("/tmp/wfe-io"));
|
||||||
|
std::fs::create_dir_all(&base).unwrap();
|
||||||
|
base
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a temporary directory inside the shared mount so containerd can see it.
|
||||||
|
fn shared_tempdir(name: &str) -> std::path::PathBuf {
|
||||||
|
let id = std::time::SystemTime::now()
|
||||||
|
.duration_since(std::time::UNIX_EPOCH)
|
||||||
|
.unwrap()
|
||||||
|
.as_nanos();
|
||||||
|
let dir = shared_dir().join(format!("{name}-{id}"));
|
||||||
|
std::fs::create_dir_all(&dir).unwrap();
|
||||||
|
dir
|
||||||
|
}
|
||||||
|
|
||||||
|
fn make_config(
|
||||||
|
addr: &str,
|
||||||
|
cargo_home: &Path,
|
||||||
|
rustup_home: &Path,
|
||||||
|
workspace: Option<&Path>,
|
||||||
|
) -> HashMap<String, serde_json::Value> {
|
||||||
|
let mut config = HashMap::new();
|
||||||
|
config.insert(
|
||||||
|
"containerd_addr".to_string(),
|
||||||
|
serde_json::Value::String(addr.to_string()),
|
||||||
|
);
|
||||||
|
config.insert(
|
||||||
|
"cargo_home".to_string(),
|
||||||
|
serde_json::Value::String(cargo_home.to_str().unwrap().to_string()),
|
||||||
|
);
|
||||||
|
config.insert(
|
||||||
|
"rustup_home".to_string(),
|
||||||
|
serde_json::Value::String(rustup_home.to_str().unwrap().to_string()),
|
||||||
|
);
|
||||||
|
if let Some(ws) = workspace {
|
||||||
|
config.insert(
|
||||||
|
"workspace".to_string(),
|
||||||
|
serde_json::Value::String(ws.to_str().unwrap().to_string()),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
config
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Minimal: just echo hello in a containerd step through the workflow engine
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
#[ignore = "requires containerd daemon"]
|
||||||
|
async fn minimal_echo_in_containerd_via_workflow() {
|
||||||
|
let _ = tracing_subscriber::fmt().with_env_filter("wfe_containerd=debug,wfe_core::executor=debug").try_init();
|
||||||
|
let Some(addr) = containerd_addr() else {
|
||||||
|
eprintln!("SKIP: containerd not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut config = HashMap::new();
|
||||||
|
config.insert(
|
||||||
|
"containerd_addr".to_string(),
|
||||||
|
serde_json::Value::String(addr),
|
||||||
|
);
|
||||||
|
|
||||||
|
let wfe = "##wfe";
|
||||||
|
let yaml = format!(
|
||||||
|
r#"workflow:
|
||||||
|
id: minimal-containerd
|
||||||
|
version: 1
|
||||||
|
error_behavior:
|
||||||
|
type: terminate
|
||||||
|
steps:
|
||||||
|
- name: echo
|
||||||
|
type: containerd
|
||||||
|
config:
|
||||||
|
image: docker.io/library/alpine:3.18
|
||||||
|
containerd_addr: ((containerd_addr))
|
||||||
|
user: "0:0"
|
||||||
|
network: none
|
||||||
|
pull: if-not-present
|
||||||
|
timeout: 30s
|
||||||
|
run: |
|
||||||
|
echo hello-from-workflow
|
||||||
|
echo "{wfe}[output echo.status=ok]"
|
||||||
|
"#
|
||||||
|
);
|
||||||
|
|
||||||
|
let instance = run_yaml_workflow_with_config(&yaml, &config).await;
|
||||||
|
|
||||||
|
eprintln!("Status: {:?}, Data: {:?}", instance.status, instance.data);
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Complete);
|
||||||
|
let data = instance.data.as_object().unwrap();
|
||||||
|
assert_eq!(
|
||||||
|
data.get("echo.status").and_then(|v| v.as_str()),
|
||||||
|
Some("ok"),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Full Rust CI pipeline in a container: install → build → test → lint → cover
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
#[ignore = "requires containerd daemon"]
|
||||||
|
async fn full_rust_pipeline_in_container() {
|
||||||
|
let Some(addr) = containerd_addr() else {
|
||||||
|
eprintln!("SKIP: containerd socket not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
let cargo_home = shared_tempdir("cargo");
|
||||||
|
let rustup_home = shared_tempdir("rustup");
|
||||||
|
let workspace = shared_tempdir("workspace");
|
||||||
|
|
||||||
|
let config = make_config(
|
||||||
|
&addr,
|
||||||
|
&cargo_home,
|
||||||
|
&rustup_home,
|
||||||
|
Some(&workspace),
|
||||||
|
);
|
||||||
|
|
||||||
|
let steps = [
|
||||||
|
containerd_step_yaml(
|
||||||
|
"install-rust", "host", "if-not-present", "10m", None, false,
|
||||||
|
" apt-get update && apt-get install -y curl gcc pkg-config libssl-dev\n\
|
||||||
|
\x20 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile minimal --default-toolchain stable",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"install-tools", "host", "never", "10m", None, false,
|
||||||
|
" rustup component add clippy rustfmt llvm-tools-preview\n\
|
||||||
|
\x20 cargo install cargo-audit cargo-deny cargo-nextest cargo-llvm-cov",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"create-project", "host", "never", "2m", None, true,
|
||||||
|
" cargo init /workspace/test-crate --name test-crate\n\
|
||||||
|
\x20 cd /workspace/test-crate\n\
|
||||||
|
\x20 echo '#[cfg(test)] mod tests { #[test] fn it_works() { assert_eq!(2+2,4); } }' >> src/main.rs",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-fmt", "none", "never", "2m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo fmt -- --check || cargo fmt",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-check", "none", "never", "5m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo check",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-clippy", "none", "never", "5m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo clippy -- -D warnings",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-test", "none", "never", "5m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo test",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-build", "none", "never", "5m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo build --release",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-nextest", "none", "never", "5m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo nextest run",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-llvm-cov", "none", "never", "5m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo llvm-cov --summary-only",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-audit", "host", "never", "5m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo audit || true",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-deny", "none", "never", "5m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo deny init\n\
|
||||||
|
\x20 cargo deny check || true",
|
||||||
|
),
|
||||||
|
containerd_step_yaml(
|
||||||
|
"cargo-doc", "none", "never", "5m",
|
||||||
|
Some("/workspace/test-crate"), true,
|
||||||
|
" cargo doc --no-deps",
|
||||||
|
),
|
||||||
|
];
|
||||||
|
|
||||||
|
let yaml = format!(
|
||||||
|
"workflow:\n id: rust-container-pipeline\n version: 1\n error_behavior:\n type: terminate\n steps:\n{}",
|
||||||
|
steps.join("\n")
|
||||||
|
);
|
||||||
|
|
||||||
|
let instance = run_yaml_workflow_with_config(&yaml, &config).await;
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
instance.status,
|
||||||
|
WorkflowStatus::Complete,
|
||||||
|
"workflow should complete successfully, data: {:?}",
|
||||||
|
instance.data
|
||||||
|
);
|
||||||
|
|
||||||
|
let data = instance.data.as_object().unwrap();
|
||||||
|
|
||||||
|
for key in [
|
||||||
|
"install-rust.status",
|
||||||
|
"install-tools.status",
|
||||||
|
"create-project.status",
|
||||||
|
"cargo-fmt.status",
|
||||||
|
"cargo-check.status",
|
||||||
|
"cargo-clippy.status",
|
||||||
|
"cargo-test.status",
|
||||||
|
"cargo-build.status",
|
||||||
|
"cargo-nextest.status",
|
||||||
|
"cargo-llvm-cov.status",
|
||||||
|
"cargo-audit.status",
|
||||||
|
"cargo-deny.status",
|
||||||
|
"cargo-doc.status",
|
||||||
|
] {
|
||||||
|
assert_eq!(
|
||||||
|
data.get(key).and_then(|v| v.as_str()),
|
||||||
|
Some("ok"),
|
||||||
|
"step output '{key}' should be 'ok', got: {:?}",
|
||||||
|
data.get(key)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// Focused test: just rust-install in a bare container
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
#[ignore = "requires containerd daemon"]
|
||||||
|
async fn rust_install_in_bare_container() {
|
||||||
|
let Some(addr) = containerd_addr() else {
|
||||||
|
eprintln!("SKIP: containerd socket not available");
|
||||||
|
return;
|
||||||
|
};
|
||||||
|
|
||||||
|
let cargo_home = shared_tempdir("cargo");
|
||||||
|
let rustup_home = shared_tempdir("rustup");
|
||||||
|
|
||||||
|
let config = make_config(&addr, &cargo_home, &rustup_home, None);
|
||||||
|
|
||||||
|
let wfe = "##wfe";
|
||||||
|
let yaml = format!(
|
||||||
|
r#"workflow:
|
||||||
|
id: rust-install-container
|
||||||
|
version: 1
|
||||||
|
error_behavior:
|
||||||
|
type: terminate
|
||||||
|
steps:
|
||||||
|
- name: install
|
||||||
|
type: containerd
|
||||||
|
config:
|
||||||
|
image: docker.io/library/debian:bookworm-slim
|
||||||
|
containerd_addr: ((containerd_addr))
|
||||||
|
user: "0:0"
|
||||||
|
network: host
|
||||||
|
pull: if-not-present
|
||||||
|
timeout: 10m
|
||||||
|
env:
|
||||||
|
CARGO_HOME: /cargo
|
||||||
|
RUSTUP_HOME: /rustup
|
||||||
|
PATH: /cargo/bin:/rustup/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
|
||||||
|
volumes:
|
||||||
|
- source: ((cargo_home))
|
||||||
|
target: /cargo
|
||||||
|
- source: ((rustup_home))
|
||||||
|
target: /rustup
|
||||||
|
run: |
|
||||||
|
apt-get update && apt-get install -y curl
|
||||||
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --profile minimal --default-toolchain stable
|
||||||
|
rustc --version
|
||||||
|
cargo --version
|
||||||
|
echo "{wfe}[output rustc_installed=true]"
|
||||||
|
|
||||||
|
- name: verify
|
||||||
|
type: containerd
|
||||||
|
config:
|
||||||
|
image: docker.io/library/debian:bookworm-slim
|
||||||
|
containerd_addr: ((containerd_addr))
|
||||||
|
user: "0:0"
|
||||||
|
network: none
|
||||||
|
pull: if-not-present
|
||||||
|
timeout: 2m
|
||||||
|
env:
|
||||||
|
CARGO_HOME: /cargo
|
||||||
|
RUSTUP_HOME: /rustup
|
||||||
|
PATH: /cargo/bin:/rustup/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
|
||||||
|
volumes:
|
||||||
|
- source: ((cargo_home))
|
||||||
|
target: /cargo
|
||||||
|
- source: ((rustup_home))
|
||||||
|
target: /rustup
|
||||||
|
run: |
|
||||||
|
rustc --version
|
||||||
|
cargo --version
|
||||||
|
echo "{wfe}[output verify.status=ok]"
|
||||||
|
"#
|
||||||
|
);
|
||||||
|
|
||||||
|
let instance = run_yaml_workflow_with_config(&yaml, &config).await;
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
instance.status,
|
||||||
|
WorkflowStatus::Complete,
|
||||||
|
"install workflow should complete, data: {:?}",
|
||||||
|
instance.data
|
||||||
|
);
|
||||||
|
|
||||||
|
let data = instance.data.as_object().unwrap();
|
||||||
|
eprintln!("Workflow data: {:?}", instance.data);
|
||||||
|
assert!(
|
||||||
|
data.get("rustc_installed").is_some(),
|
||||||
|
"rustc_installed should be set, got data: {:?}",
|
||||||
|
data
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
data.get("verify.status").and_then(|v| v.as_str()),
|
||||||
|
Some("ok"),
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -53,6 +53,70 @@ async fn run_yaml_workflow(yaml: &str) -> wfe::models::WorkflowInstance {
|
|||||||
run_yaml_workflow_with_data(yaml, serde_json::json!({})).await
|
run_yaml_workflow_with_data(yaml, serde_json::json!({})).await
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A test LogSink that collects all chunks.
|
||||||
|
struct CollectingLogSink {
|
||||||
|
chunks: tokio::sync::Mutex<Vec<wfe_core::traits::LogChunk>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CollectingLogSink {
|
||||||
|
fn new() -> Self {
|
||||||
|
Self { chunks: tokio::sync::Mutex::new(Vec::new()) }
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn chunks(&self) -> Vec<wfe_core::traits::LogChunk> {
|
||||||
|
self.chunks.lock().await.clone()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[async_trait::async_trait]
|
||||||
|
impl wfe_core::traits::LogSink for CollectingLogSink {
|
||||||
|
async fn write_chunk(&self, chunk: wfe_core::traits::LogChunk) {
|
||||||
|
self.chunks.lock().await.push(chunk);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Run a workflow with a LogSink to verify log streaming works end-to-end.
|
||||||
|
async fn run_yaml_workflow_with_log_sink(
|
||||||
|
yaml: &str,
|
||||||
|
log_sink: Arc<CollectingLogSink>,
|
||||||
|
) -> wfe::models::WorkflowInstance {
|
||||||
|
let config = HashMap::new();
|
||||||
|
let compiled = load_single_workflow_from_str(yaml, &config).unwrap();
|
||||||
|
|
||||||
|
let persistence = Arc::new(InMemoryPersistenceProvider::new());
|
||||||
|
let lock = Arc::new(InMemoryLockProvider::new());
|
||||||
|
let queue = Arc::new(InMemoryQueueProvider::new());
|
||||||
|
|
||||||
|
let host = WorkflowHostBuilder::new()
|
||||||
|
.use_persistence(persistence as Arc<dyn wfe_core::traits::PersistenceProvider>)
|
||||||
|
.use_lock_provider(lock as Arc<dyn wfe_core::traits::DistributedLockProvider>)
|
||||||
|
.use_queue_provider(queue as Arc<dyn wfe_core::traits::QueueProvider>)
|
||||||
|
.use_log_sink(log_sink as Arc<dyn wfe_core::traits::LogSink>)
|
||||||
|
.build()
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
for (key, factory) in compiled.step_factories {
|
||||||
|
host.register_step_factory(&key, factory).await;
|
||||||
|
}
|
||||||
|
|
||||||
|
host.register_workflow_definition(compiled.definition.clone())
|
||||||
|
.await;
|
||||||
|
host.start().await.unwrap();
|
||||||
|
|
||||||
|
let instance = run_workflow_sync(
|
||||||
|
&host,
|
||||||
|
&compiled.definition.id,
|
||||||
|
compiled.definition.version,
|
||||||
|
serde_json::json!({}),
|
||||||
|
Duration::from_secs(10),
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
host.stop().await;
|
||||||
|
instance
|
||||||
|
}
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn simple_echo_captures_stdout() {
|
async fn simple_echo_captures_stdout() {
|
||||||
let yaml = r#"
|
let yaml = r#"
|
||||||
@@ -236,3 +300,176 @@ workflow:
|
|||||||
let instance = run_yaml_workflow(yaml).await;
|
let instance = run_yaml_workflow(yaml).await;
|
||||||
assert_eq!(instance.status, WorkflowStatus::Complete);
|
assert_eq!(instance.status, WorkflowStatus::Complete);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// ── LogSink regression tests ─────────────────────────────────────────
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn log_sink_receives_stdout_chunks() {
|
||||||
|
let log_sink = Arc::new(CollectingLogSink::new());
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: logsink-stdout-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: echo-step
|
||||||
|
type: shell
|
||||||
|
config:
|
||||||
|
run: echo "line one" && echo "line two"
|
||||||
|
"#;
|
||||||
|
let instance = run_yaml_workflow_with_log_sink(yaml, log_sink.clone()).await;
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Complete);
|
||||||
|
|
||||||
|
let chunks = log_sink.chunks().await;
|
||||||
|
assert!(chunks.len() >= 2, "expected at least 2 stdout chunks, got {}", chunks.len());
|
||||||
|
|
||||||
|
let stdout_chunks: Vec<_> = chunks
|
||||||
|
.iter()
|
||||||
|
.filter(|c| c.stream == wfe_core::traits::LogStreamType::Stdout)
|
||||||
|
.collect();
|
||||||
|
assert!(stdout_chunks.len() >= 2, "expected at least 2 stdout chunks");
|
||||||
|
|
||||||
|
let all_data: String = stdout_chunks.iter()
|
||||||
|
.map(|c| String::from_utf8_lossy(&c.data).to_string())
|
||||||
|
.collect();
|
||||||
|
assert!(all_data.contains("line one"), "stdout should contain 'line one', got: {all_data}");
|
||||||
|
assert!(all_data.contains("line two"), "stdout should contain 'line two', got: {all_data}");
|
||||||
|
|
||||||
|
// Verify chunk metadata.
|
||||||
|
for chunk in &stdout_chunks {
|
||||||
|
assert!(!chunk.workflow_id.is_empty());
|
||||||
|
assert_eq!(chunk.step_name, "echo-step");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn log_sink_receives_stderr_chunks() {
|
||||||
|
let log_sink = Arc::new(CollectingLogSink::new());
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: logsink-stderr-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: err-step
|
||||||
|
type: shell
|
||||||
|
config:
|
||||||
|
run: echo "stderr output" >&2
|
||||||
|
"#;
|
||||||
|
let instance = run_yaml_workflow_with_log_sink(yaml, log_sink.clone()).await;
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Complete);
|
||||||
|
|
||||||
|
let chunks = log_sink.chunks().await;
|
||||||
|
let stderr_chunks: Vec<_> = chunks
|
||||||
|
.iter()
|
||||||
|
.filter(|c| c.stream == wfe_core::traits::LogStreamType::Stderr)
|
||||||
|
.collect();
|
||||||
|
assert!(!stderr_chunks.is_empty(), "expected stderr chunks");
|
||||||
|
|
||||||
|
let stderr_data: String = stderr_chunks.iter()
|
||||||
|
.map(|c| String::from_utf8_lossy(&c.data).to_string())
|
||||||
|
.collect();
|
||||||
|
assert!(stderr_data.contains("stderr output"), "stderr should contain 'stderr output', got: {stderr_data}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn log_sink_captures_multi_step_workflow() {
|
||||||
|
let log_sink = Arc::new(CollectingLogSink::new());
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: logsink-multi-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: step-a
|
||||||
|
type: shell
|
||||||
|
config:
|
||||||
|
run: echo "from step a"
|
||||||
|
- name: step-b
|
||||||
|
type: shell
|
||||||
|
config:
|
||||||
|
run: echo "from step b"
|
||||||
|
"#;
|
||||||
|
let instance = run_yaml_workflow_with_log_sink(yaml, log_sink.clone()).await;
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Complete);
|
||||||
|
|
||||||
|
let chunks = log_sink.chunks().await;
|
||||||
|
let step_names: Vec<_> = chunks.iter().map(|c| c.step_name.as_str()).collect();
|
||||||
|
assert!(step_names.contains(&"step-a"), "should have chunks from step-a");
|
||||||
|
assert!(step_names.contains(&"step-b"), "should have chunks from step-b");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn log_sink_not_configured_still_works() {
|
||||||
|
// Without a log_sink, the buffered path should still work.
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: no-logsink-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: echo-step
|
||||||
|
type: shell
|
||||||
|
config:
|
||||||
|
run: echo "no sink"
|
||||||
|
"#;
|
||||||
|
let instance = run_yaml_workflow(yaml).await;
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Complete);
|
||||||
|
let data = instance.data.as_object().unwrap();
|
||||||
|
assert!(data.get("echo-step.stdout").unwrap().as_str().unwrap().contains("no sink"));
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Security regression tests ────────────────────────────────────────
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn security_blocked_env_vars_not_injected() {
|
||||||
|
// MEDIUM-22: Workflow data keys like "path" must NOT override PATH.
|
||||||
|
let yaml = r#"
|
||||||
|
workflow:
|
||||||
|
id: sec-env-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: check-path
|
||||||
|
type: shell
|
||||||
|
config:
|
||||||
|
run: echo "$PATH"
|
||||||
|
"#;
|
||||||
|
// Set a workflow data key "path" that would override PATH if not blocked.
|
||||||
|
let instance = run_yaml_workflow_with_data(
|
||||||
|
yaml,
|
||||||
|
serde_json::json!({"path": "/attacker/bin"}),
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Complete);
|
||||||
|
|
||||||
|
let data = instance.data.as_object().unwrap();
|
||||||
|
let stdout = data.get("check-path.stdout").unwrap().as_str().unwrap();
|
||||||
|
// PATH should NOT contain /attacker/bin.
|
||||||
|
assert!(
|
||||||
|
!stdout.contains("/attacker/bin"),
|
||||||
|
"PATH should not be overridden by workflow data, got: {stdout}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn security_safe_env_vars_still_injected() {
|
||||||
|
// Verify non-blocked keys still work after the security fix.
|
||||||
|
let wfe_prefix = "##wfe";
|
||||||
|
let yaml = format!(
|
||||||
|
r#"
|
||||||
|
workflow:
|
||||||
|
id: sec-safe-env-wf
|
||||||
|
version: 1
|
||||||
|
steps:
|
||||||
|
- name: check-var
|
||||||
|
type: shell
|
||||||
|
config:
|
||||||
|
run: echo "{wfe_prefix}[output val=$MY_CUSTOM_VAR]"
|
||||||
|
"#
|
||||||
|
);
|
||||||
|
let instance = run_yaml_workflow_with_data(
|
||||||
|
&yaml,
|
||||||
|
serde_json::json!({"my_custom_var": "works"}),
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
assert_eq!(instance.status, WorkflowStatus::Complete);
|
||||||
|
|
||||||
|
let data = instance.data.as_object().unwrap();
|
||||||
|
assert_eq!(data.get("val").and_then(|v| v.as_str()), Some("works"));
|
||||||
|
}
|
||||||
|
|||||||
@@ -8,8 +8,8 @@ use tracing::{debug, error, info, warn};
|
|||||||
|
|
||||||
use wfe_core::executor::{StepRegistry, WorkflowExecutor};
|
use wfe_core::executor::{StepRegistry, WorkflowExecutor};
|
||||||
use wfe_core::models::{
|
use wfe_core::models::{
|
||||||
Event, ExecutionPointer, PointerStatus, QueueType, WorkflowDefinition, WorkflowInstance,
|
Event, ExecutionPointer, LifecycleEvent, LifecycleEventType, PointerStatus, QueueType,
|
||||||
WorkflowStatus,
|
WorkflowDefinition, WorkflowInstance, WorkflowStatus,
|
||||||
};
|
};
|
||||||
use wfe_core::traits::{
|
use wfe_core::traits::{
|
||||||
DistributedLockProvider, HostContext, LifecyclePublisher, PersistenceProvider, QueueProvider,
|
DistributedLockProvider, HostContext, LifecyclePublisher, PersistenceProvider, QueueProvider,
|
||||||
@@ -308,6 +308,18 @@ impl WorkflowHost {
|
|||||||
.queue_work(&id, QueueType::Workflow)
|
.queue_work(&id, QueueType::Workflow)
|
||||||
.await?;
|
.await?;
|
||||||
|
|
||||||
|
// Publish lifecycle event.
|
||||||
|
if let Some(ref publisher) = self.lifecycle {
|
||||||
|
let _ = publisher
|
||||||
|
.publish(LifecycleEvent::new(
|
||||||
|
&id,
|
||||||
|
definition_id,
|
||||||
|
version,
|
||||||
|
LifecycleEventType::Started,
|
||||||
|
))
|
||||||
|
.await;
|
||||||
|
}
|
||||||
|
|
||||||
Ok(id)
|
Ok(id)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -345,6 +357,16 @@ impl WorkflowHost {
|
|||||||
}
|
}
|
||||||
instance.status = WorkflowStatus::Suspended;
|
instance.status = WorkflowStatus::Suspended;
|
||||||
self.persistence.persist_workflow(&instance).await?;
|
self.persistence.persist_workflow(&instance).await?;
|
||||||
|
if let Some(ref publisher) = self.lifecycle {
|
||||||
|
let _ = publisher
|
||||||
|
.publish(LifecycleEvent::new(
|
||||||
|
id,
|
||||||
|
&instance.workflow_definition_id,
|
||||||
|
instance.version,
|
||||||
|
LifecycleEventType::Suspended,
|
||||||
|
))
|
||||||
|
.await;
|
||||||
|
}
|
||||||
Ok(true)
|
Ok(true)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -362,6 +384,16 @@ impl WorkflowHost {
|
|||||||
.queue_work(id, QueueType::Workflow)
|
.queue_work(id, QueueType::Workflow)
|
||||||
.await?;
|
.await?;
|
||||||
|
|
||||||
|
if let Some(ref publisher) = self.lifecycle {
|
||||||
|
let _ = publisher
|
||||||
|
.publish(LifecycleEvent::new(
|
||||||
|
id,
|
||||||
|
&instance.workflow_definition_id,
|
||||||
|
instance.version,
|
||||||
|
LifecycleEventType::Resumed,
|
||||||
|
))
|
||||||
|
.await;
|
||||||
|
}
|
||||||
Ok(true)
|
Ok(true)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -376,6 +408,16 @@ impl WorkflowHost {
|
|||||||
instance.status = WorkflowStatus::Terminated;
|
instance.status = WorkflowStatus::Terminated;
|
||||||
instance.complete_time = Some(chrono::Utc::now());
|
instance.complete_time = Some(chrono::Utc::now());
|
||||||
self.persistence.persist_workflow(&instance).await?;
|
self.persistence.persist_workflow(&instance).await?;
|
||||||
|
if let Some(ref publisher) = self.lifecycle {
|
||||||
|
let _ = publisher
|
||||||
|
.publish(LifecycleEvent::new(
|
||||||
|
id,
|
||||||
|
&instance.workflow_definition_id,
|
||||||
|
instance.version,
|
||||||
|
LifecycleEventType::Terminated,
|
||||||
|
))
|
||||||
|
.await;
|
||||||
|
}
|
||||||
Ok(true)
|
Ok(true)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ pub struct WorkflowHostBuilder {
|
|||||||
queue_provider: Option<Arc<dyn QueueProvider>>,
|
queue_provider: Option<Arc<dyn QueueProvider>>,
|
||||||
lifecycle: Option<Arc<dyn LifecyclePublisher>>,
|
lifecycle: Option<Arc<dyn LifecyclePublisher>>,
|
||||||
search: Option<Arc<dyn SearchIndex>>,
|
search: Option<Arc<dyn SearchIndex>>,
|
||||||
|
log_sink: Option<Arc<dyn wfe_core::traits::LogSink>>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WorkflowHostBuilder {
|
impl WorkflowHostBuilder {
|
||||||
@@ -31,6 +32,7 @@ impl WorkflowHostBuilder {
|
|||||||
queue_provider: None,
|
queue_provider: None,
|
||||||
lifecycle: None,
|
lifecycle: None,
|
||||||
search: None,
|
search: None,
|
||||||
|
log_sink: None,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -64,6 +66,12 @@ impl WorkflowHostBuilder {
|
|||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set an optional log sink for real-time step output streaming.
|
||||||
|
pub fn use_log_sink(mut self, sink: Arc<dyn wfe_core::traits::LogSink>) -> Self {
|
||||||
|
self.log_sink = Some(sink);
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
/// Build the `WorkflowHost`.
|
/// Build the `WorkflowHost`.
|
||||||
///
|
///
|
||||||
/// Returns an error if persistence, lock_provider, or queue_provider have not been set.
|
/// Returns an error if persistence, lock_provider, or queue_provider have not been set.
|
||||||
@@ -90,6 +98,9 @@ impl WorkflowHostBuilder {
|
|||||||
if let Some(ref search) = self.search {
|
if let Some(ref search) = self.search {
|
||||||
executor = executor.with_search(Arc::clone(search));
|
executor = executor.with_search(Arc::clone(search));
|
||||||
}
|
}
|
||||||
|
if let Some(ref log_sink) = self.log_sink {
|
||||||
|
executor = executor.with_log_sink(Arc::clone(log_sink));
|
||||||
|
}
|
||||||
|
|
||||||
Ok(WorkflowHost {
|
Ok(WorkflowHost {
|
||||||
persistence,
|
persistence,
|
||||||
|
|||||||
@@ -158,7 +158,8 @@ workflows:
|
|||||||
config:
|
config:
|
||||||
run: |
|
run: |
|
||||||
cd "$WORKSPACE_DIR"
|
cd "$WORKSPACE_DIR"
|
||||||
cargo nextest run -p wfe-yaml --features buildkit,containerd -P ci
|
cargo nextest run -p wfe-yaml --features buildkit,containerd,rustlang -P ci
|
||||||
|
cargo nextest run -p wfe-rustlang -P ci
|
||||||
|
|
||||||
# ─── Workflow: test-integration ──────────────────────────────────
|
# ─── Workflow: test-integration ──────────────────────────────────
|
||||||
|
|
||||||
@@ -299,12 +300,12 @@ workflows:
|
|||||||
}
|
}
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Wait for sockets to be available
|
# Wait for TCP proxy ports (socat bridges to containerd/buildkit sockets)
|
||||||
for i in $(seq 1 30); do
|
for i in $(seq 1 30); do
|
||||||
if [ -S "$HOME/.lima/wfe-test/sock/buildkitd.sock" ]; then
|
if curl -sf http://127.0.0.1:2500 >/dev/null 2>&1 || [ $? -eq 56 ]; then
|
||||||
break
|
break
|
||||||
fi
|
fi
|
||||||
echo "Waiting for buildkitd socket... ($i/30)"
|
echo "Waiting for containerd TCP proxy... ($i/30)"
|
||||||
sleep 2
|
sleep 2
|
||||||
done
|
done
|
||||||
|
|
||||||
@@ -320,7 +321,7 @@ workflows:
|
|||||||
config:
|
config:
|
||||||
run: |
|
run: |
|
||||||
cd "$WORKSPACE_DIR"
|
cd "$WORKSPACE_DIR"
|
||||||
export WFE_BUILDKIT_ADDR="unix://$HOME/.lima/wfe-test/sock/buildkitd.sock"
|
export WFE_BUILDKIT_ADDR="http://127.0.0.1:2501"
|
||||||
cargo nextest run -p wfe-buildkit -P ci
|
cargo nextest run -p wfe-buildkit -P ci
|
||||||
echo "##wfe[output buildkit_ok=true]"
|
echo "##wfe[output buildkit_ok=true]"
|
||||||
|
|
||||||
@@ -334,8 +335,11 @@ workflows:
|
|||||||
config:
|
config:
|
||||||
run: |
|
run: |
|
||||||
cd "$WORKSPACE_DIR"
|
cd "$WORKSPACE_DIR"
|
||||||
export WFE_CONTAINERD_ADDR="unix://$HOME/.lima/wfe-test/sock/containerd.sock"
|
export WFE_CONTAINERD_ADDR="http://127.0.0.1:2500"
|
||||||
|
export WFE_IO_DIR="/tmp/wfe-io"
|
||||||
|
mkdir -p "$WFE_IO_DIR"
|
||||||
cargo nextest run -p wfe-containerd -P ci
|
cargo nextest run -p wfe-containerd -P ci
|
||||||
|
cargo nextest run -p wfe-yaml --features rustlang,containerd --test rustlang_containerd -P ci -- --ignored
|
||||||
echo "##wfe[output containerd_ok=true]"
|
echo "##wfe[output containerd_ok=true]"
|
||||||
|
|
||||||
ensure:
|
ensure:
|
||||||
@@ -475,7 +479,7 @@ workflows:
|
|||||||
cd "$WORKSPACE_DIR"
|
cd "$WORKSPACE_DIR"
|
||||||
for crate in wfe-core wfe-sqlite wfe-postgres wfe-opensearch wfe-valkey \
|
for crate in wfe-core wfe-sqlite wfe-postgres wfe-opensearch wfe-valkey \
|
||||||
wfe-buildkit-protos wfe-containerd-protos wfe-buildkit wfe-containerd \
|
wfe-buildkit-protos wfe-containerd-protos wfe-buildkit wfe-containerd \
|
||||||
wfe wfe-yaml; do
|
wfe-rustlang wfe wfe-yaml; do
|
||||||
echo "Packaging $crate..."
|
echo "Packaging $crate..."
|
||||||
cargo package -p "$crate" --no-verify --allow-dirty 2>&1 || exit 1
|
cargo package -p "$crate" --no-verify --allow-dirty 2>&1 || exit 1
|
||||||
done
|
done
|
||||||
@@ -619,7 +623,7 @@ workflows:
|
|||||||
exit 0
|
exit 0
|
||||||
cd "$WORKSPACE_DIR"
|
cd "$WORKSPACE_DIR"
|
||||||
REGISTRY="${REGISTRY:-sunbeam}"
|
REGISTRY="${REGISTRY:-sunbeam}"
|
||||||
for crate in wfe-buildkit wfe-containerd; do
|
for crate in wfe-buildkit wfe-containerd wfe-rustlang; do
|
||||||
echo "Publishing $crate..."
|
echo "Publishing $crate..."
|
||||||
cargo publish -p "$crate" --registry "$REGISTRY" 2>&1 || echo "Already published: $crate"
|
cargo publish -p "$crate" --registry "$REGISTRY" 2>&1 || echo "Already published: $crate"
|
||||||
done
|
done
|
||||||
|
|||||||
Reference in New Issue
Block a user