mirror of
https://github.com/ModernRelay/omnigraph.git
synced 2026-06-09 01:35:18 +02:00
1a4d2cee97
* feat(MR-656): inline query strings in CLI and HTTP server
CLI:
- Add -e / --query-string <STRING> to omnigraph read and omnigraph change
- Exactly one of --query, --query-string, --alias is required (3-way XOR)
- Empty --query-string is rejected with a clear error
HTTP:
- New POST /query (read-only, clean field names: query/name/params/branch/snapshot)
- Mutations on /query are rejected with 400 -- use POST /change instead
- ChangeRequest fields polished: query (alias query_source), name (alias query_name)
- POST /read and POST /change remain byte-compatible for existing clients
Tests:
- cli.rs: -e happy-path on read/change, mutex error vs --query, empty -e rejected
- system_local.rs: inline -e read and -e change exercise the local flow
- system_remote.rs: inline -e read/change over HTTP plus direct /query 200/400
- server.rs: /query 200, /query 400 on mutation, /change legacy field alias
- openapi.rs: new /query path, QueryRequest schema, ChangeRequest field-name polish
Docs: cli.md (-e examples), cli-reference.md (read/change rows), server.md (/query)
Co-Authored-By: Ragnor Comerford <ragnor.comerford@gmail.com>
* feat(MR-656): rename read/change to query/mutate with deprecation signals
HTTP server:
- Add POST /mutate as canonical write endpoint (pairs with POST /query).
- Mark POST /read and POST /change as deprecated. Three-channel signal:
* OpenAPI: `deprecated: true` on the operation (every codegen flags
the generated SDK method).
* RFC 9745: response `Deprecation: true` header on every response.
* RFC 8288: response `Link: </successor>; rel="successor-version"`
pointing at /query and /mutate respectively.
- Share business logic across /mutate and /change via run_mutate(); the
/change wrapper is the only place that adds the deprecation headers.
- ChangeRequest field aliases (query_source/query_name) preserved.
- AliasCommand serde now accepts `query`/`mutate` alongside `read`/`change`.
CLI:
- Promote `omnigraph query` / `omnigraph mutate` to top-level canonical
subcommands (clap visible_alias keeps `omnigraph read` / `omnigraph
change` working forever).
- Promote `omnigraph lint` / `omnigraph check` to top-level (was nested
under `omnigraph query lint`, which is now a deprecated argv shim that
rewrites to the canonical form).
- Argv-level preprocessing prints a one-line deprecation warning to
stderr when any legacy spelling is used. Canonical names are silent.
Tests:
- Server: /mutate works, /change emits Deprecation+Link headers, /read
emits Deprecation+Link headers, /query carries no deprecation signal.
- OpenAPI: /read and /change flagged deprecated; /query and /mutate not.
- CLI: canonical `lint` matches deprecated `query lint` / `query check`
output; `read` / `change` print deprecation warnings.
Docs:
- cli.md: new canonical examples; "Deprecated names" migration table.
- cli-reference.md: top-level table updated; aliases.<name>.command
accepts both legacy and canonical spellings.
- server.md: endpoint inventory shows /query and /mutate as canonical
and /read and /change as deprecated; dedicated section explains the
three-channel deprecation signal.
- og-cheet-sheet.md: use new `omnigraph lint` / `omnigraph check`.
- openapi.json regenerated.
Migration is purely cosmetic — every deprecated form continues to work
indefinitely; only the spelling changes.
Co-Authored-By: Ragnor Comerford <ragnor.comerford@gmail.com>
* fix(MR-656): address Devin Review findings on /query and /change
Two issues raised by Devin Review on PR #110:
1. `POST /query` mutation-rejection error pointed at the deprecated
`/change` endpoint instead of the canonical `/mutate`. Fixed in
three places: the runtime error message in `server_query`, the
utoipa 400-response description, and the handler doc comment. The
`QueryRequest` schema docstrings in `api.rs` got the same update so
the openapi.json bodies match. Server and openapi tests updated.
2. `execute_change_remote` serialized `ChangeRequest` directly, which
emits the new canonical field names `query` / `name` on the wire.
`#[serde(alias = "query_source")]` only affects deserialization, so
a newer CLI talking to an older server would have its `/change`
POST body fail with "missing field: query_source". Fixed by
extracting a `legacy_change_request_body` helper that hand-rolls
the JSON with the legacy keys (`query_source` / `query_name`), the
same byte-stable contract `execute_read_remote` already uses
against `/read`. Added two unit tests on the helper to lock the
wire shape in.
Co-Authored-By: Ragnor Comerford <ragnor.comerford@gmail.com>
* docs(dev): RFC 001 — inline + stored queries, envelope, MCP
Tracked artifact consolidating the design across MR-656 (this branch),
MR-976 (Phase 1 envelope hardening parent, with MR-977/978/979/980
sub-issues), and MR-969 (stored queries + MCP).
Sections:
* Two paths, one engine — inline `/query` + `/mutate` (this PR) coexist
with stored `/queries/{name}` (MR-969). Same `run_query` / `run_mutate`
backend (the fold-in landed in the previous commit).
* Request envelope ("before") — Idempotency-Key, If-Match, X-Deadline,
X-Trace-Id, expect, dry_run, fields. Phase 1 ships the load-bearing
subset on `/mutate`.
* Response envelope ("after") — audit_id, snapshot_id, commit_id, stats,
warnings. Closes the provenance loop today's `ChangeOutput` leaves
open.
* `.gq` pragmas — `@description`, `@returns`, `@mcp`. Source-of-truth
for the stored-query agent contract; no separate YAML registry.
* Multi-graph MCP — per-graph `/graphs/{id}/mcp/tools` + `/mcp/invoke`.
Token binds to one graph by default; cross-graph agents loop.
* Cedar split — `read`/`change` for inline, `invoke_query` for stored.
Operators deny ad-hoc for agent groups while keeping curated tool
list open.
* Rejected alternatives — per-env override files, compiled bundles,
tool-name prefixing across graphs, body-field graph dispatch.
Index entry added under "Active Implementation Plans" so future agents
land on the RFC before touching queries / mutations / envelope code.
`scripts/check-agents-md.sh` clean (35 links, 34 docs).
* docs(server): clarify why run_query lacks AppState parameter
run_mutate takes state for workload admission; run_query doesn't because
reads aren't admission-gated today. Mark the asymmetry as intentional and
flag the two future events that would grow the signature: Phase 1's
`expect: { max_rows_scanned: N }` budget (MR-976) or per-actor admission
extending to stored-read invocations (MR-969). Prevents the natural
"make these symmetrical" follow-up.
* refactor(server): run_query / run_mutate take &ResolvedActor
Replace `Option<Extension<ResolvedActor>>` in the helpers with
`Option<&ResolvedActor>`. Saves MR-969's stored-query handler from
wrapping a bare actor in axum's `Extension(...)` before calling.
Handler signatures (`server_query`, `server_read`, `server_mutate`,
`server_change`) keep `Option<Extension<ResolvedActor>>` because that
is what axum injects, and unwrap at the call site with
`actor.as_ref().map(|Extension(actor)| actor)`.
Net: -13/+10 LOC, 89/0 server tests pass.
* docs(releases): v0.6.0 — describe inline + canonical-named queries (MR-656)
Extend the v0.6.0 release notes to cover the third piece of work landing
alongside the graph terminology rename and multi-graph server mode:
canonical-named `POST /query` and `POST /mutate` endpoints, the CLI's
new `-e/--query-string` flag, the top-level promotion of `lint` /
`check`, and the three-channel deprecation signal on `/read` and
`/change` (OpenAPI `deprecated: true` + RFC 9745 + RFC 8288).
Additions:
* Top blurb: "Two pieces" -> "Three pieces" with a bullet describing
the rename + inline flow.
* Breaking Changes: new "Query / mutation rename" subsection covering
the `ChangeRequest` field rename (with the back-compat serde aliases
and the CLI's `legacy_change_request_body` byte-stable wire helper)
and the `omnigraph query lint` -> `omnigraph lint` move.
* New: 5 bullets — the two endpoints, the CLI subcommands, the `-e`
flag, the deprecation signal channels, the widened `aliases.<name>.command`
vocabulary.
* User Impact: one bullet making explicit that the rename is cosmetic
on the client side and migration is voluntary.
* Documentation: pointers to the updated `server.md` / `cli.md` /
`cli-reference.md` and the new `docs/dev/rfc-001-queries-envelope-mcp.md`.
+15/-1 lines. `./scripts/check-agents-md.sh` clean.
* refactor(cli): demote `check` from visible_alias to deprecation shim
`omnigraph check` was a clap `visible_alias` on `lint`, advertised in
`--help` as an equivalent canonical name. Per MR-981 §6 (long-form
flags as canonical, short forms as visible aliases), visible aliases
on subcommand names hurt agent CX: agents emit either spelling
depending on training-data drift, and there's no length signal
pointing at the canonical name.
Changes:
* Remove `#[command(visible_alias = "check")]` from the `Lint` variant.
`omnigraph --help` now shows only `lint`.
* Add bare `check` to `rewrite_deprecated_argv` so `omnigraph check
<args>` still works — it rewrites to `omnigraph lint <args>` and
emits a one-line stderr deprecation warning, matching the existing
pattern for `read` / `change` / `query lint` / `query check`.
* Fix the nested `query check` shim to substitute `check` -> `lint` in
the rewritten argv (previously it relied on `check` being a
visible_alias to reach the `Lint` variant).
* New test `deprecated_check_top_level_rewrites_to_lint` covers: bare
`check` produces identical stdout to `lint`, emits the deprecation
warning, and `check` does NOT appear as an alias in `omnigraph
--help`.
* Release notes updated to reflect the deprecation-shim treatment and
cross-reference MR-981 §6 reasoning.
Cargo / Go users typing `check` still work indefinitely; one stderr
nudge per invocation teaches the canonical name. Agents see only
`lint` in `--help --json` so they emit one canonical form.
67/0 omnigraph-cli tests pass; 39 workspace test suites green.
---------
Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-authored-by: Ragnor Comerford <ragnor.comerford@gmail.com>
Co-authored-by: Ragnor Comerford <hello@ragnor.co>
1359 lines
44 KiB
Rust
1359 lines
44 KiB
Rust
use std::collections::HashSet;
|
|
use std::env;
|
|
use std::fs;
|
|
use std::path::{Path, PathBuf};
|
|
|
|
use axum::Router;
|
|
use axum::body::{Body, to_bytes};
|
|
use axum::http::{Method, Request, StatusCode};
|
|
use omnigraph::db::Omnigraph;
|
|
use omnigraph::loader::{LoadMode, load_jsonl};
|
|
use omnigraph_server::{ApiDoc, AppState, build_app};
|
|
use serde_json::Value;
|
|
use tower::ServiceExt;
|
|
use utoipa::OpenApi;
|
|
|
|
fn fixture(name: &str) -> PathBuf {
|
|
PathBuf::from(env!("CARGO_MANIFEST_DIR"))
|
|
.join("../omnigraph/tests/fixtures")
|
|
.join(name)
|
|
}
|
|
|
|
fn graph_path(root: &Path) -> PathBuf {
|
|
root.join("openapi_test.omni")
|
|
}
|
|
|
|
async fn init_loaded_graph() -> tempfile::TempDir {
|
|
let temp = tempfile::tempdir().unwrap();
|
|
let graph = graph_path(temp.path());
|
|
fs::create_dir_all(&graph).unwrap();
|
|
let schema = fs::read_to_string(fixture("test.pg")).unwrap();
|
|
let data = fs::read_to_string(fixture("test.jsonl")).unwrap();
|
|
Omnigraph::init(graph.to_str().unwrap(), &schema)
|
|
.await
|
|
.unwrap();
|
|
let mut db = Omnigraph::open(graph.to_str().unwrap()).await.unwrap();
|
|
load_jsonl(&mut db, &data, LoadMode::Overwrite)
|
|
.await
|
|
.unwrap();
|
|
temp
|
|
}
|
|
|
|
async fn app_for_loaded_graph() -> (tempfile::TempDir, Router) {
|
|
let temp = init_loaded_graph().await;
|
|
let graph = graph_path(temp.path());
|
|
let state = AppState::open(graph.to_string_lossy().to_string())
|
|
.await
|
|
.unwrap();
|
|
let app = build_app(state);
|
|
(temp, app)
|
|
}
|
|
|
|
async fn app_for_loaded_graph_with_auth(token: &str) -> (tempfile::TempDir, Router) {
|
|
let temp = init_loaded_graph().await;
|
|
let graph = graph_path(temp.path());
|
|
let db = Omnigraph::open(graph.to_str().unwrap()).await.unwrap();
|
|
let state = AppState::new_with_bearer_token(
|
|
graph.to_string_lossy().to_string(),
|
|
db,
|
|
Some(token.to_string()),
|
|
);
|
|
let app = build_app(state);
|
|
(temp, app)
|
|
}
|
|
|
|
async fn json_response(app: &Router, request: Request<Body>) -> (StatusCode, Value) {
|
|
let response = app.clone().oneshot(request).await.unwrap();
|
|
let status = response.status();
|
|
let body = to_bytes(response.into_body(), usize::MAX).await.unwrap();
|
|
let json: Value = serde_json::from_slice(&body).unwrap();
|
|
(status, json)
|
|
}
|
|
|
|
fn openapi_doc() -> utoipa::openapi::OpenApi {
|
|
ApiDoc::openapi()
|
|
}
|
|
|
|
fn openapi_json() -> Value {
|
|
serde_json::to_value(openapi_doc()).unwrap()
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Endpoint integration tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[tokio::test]
|
|
async fn openapi_endpoint_returns_200_with_valid_json() {
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (status, json) = json_response(&app, request).await;
|
|
assert_eq!(status, StatusCode::OK);
|
|
assert!(json.is_object(), "response must be a JSON object");
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn openapi_endpoint_returns_openapi_31_version() {
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let version = json["openapi"].as_str().unwrap();
|
|
assert!(
|
|
version.starts_with("3.1"),
|
|
"expected OpenAPI 3.1.x, got {version}"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn openapi_endpoint_does_not_require_auth() {
|
|
let temp = init_loaded_graph().await;
|
|
let graph = graph_path(temp.path());
|
|
let db = Omnigraph::open(graph.to_str().unwrap()).await.unwrap();
|
|
let state = AppState::new_with_bearer_token(
|
|
graph.to_string_lossy().to_string(),
|
|
db,
|
|
Some("secret-token".to_string()),
|
|
);
|
|
let app = build_app(state);
|
|
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (status, _) = json_response(&app, request).await;
|
|
assert_eq!(
|
|
status,
|
|
StatusCode::OK,
|
|
"/openapi.json should not require auth"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Info and metadata tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_info_contains_title_and_description() {
|
|
let doc = openapi_json();
|
|
let info = &doc["info"];
|
|
assert_eq!(info["title"].as_str().unwrap(), "Omnigraph API");
|
|
assert!(info["description"].as_str().unwrap().contains("Omnigraph"));
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_info_contains_version() {
|
|
let doc = openapi_json();
|
|
let version = doc["info"]["version"].as_str().unwrap();
|
|
assert!(!version.is_empty(), "version must not be empty");
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Path coverage tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
const EXPECTED_PATHS: &[&str] = &[
|
|
"/healthz",
|
|
"/graphs",
|
|
"/snapshot",
|
|
"/read",
|
|
"/query",
|
|
"/export",
|
|
"/change",
|
|
"/mutate",
|
|
"/schema",
|
|
"/schema/apply",
|
|
"/ingest",
|
|
"/branches",
|
|
"/branches/{branch}",
|
|
"/branches/merge",
|
|
"/commits",
|
|
"/commits/{commit_id}",
|
|
];
|
|
|
|
#[test]
|
|
fn openapi_contains_all_expected_paths() {
|
|
let doc = openapi_json();
|
|
let paths = doc["paths"].as_object().expect("paths must be an object");
|
|
let path_keys: HashSet<&str> = paths.keys().map(|k| k.as_str()).collect();
|
|
|
|
for expected in EXPECTED_PATHS {
|
|
assert!(
|
|
path_keys.contains(expected),
|
|
"missing path: {expected}. Found: {path_keys:?}"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_has_no_unexpected_paths() {
|
|
let doc = openapi_json();
|
|
let paths = doc["paths"].as_object().expect("paths must be an object");
|
|
let expected: HashSet<&str> = EXPECTED_PATHS.iter().copied().collect();
|
|
|
|
for path in paths.keys() {
|
|
assert!(
|
|
expected.contains(path.as_str()),
|
|
"unexpected path in OpenAPI spec: {path}"
|
|
);
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// HTTP method tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_healthz_is_get() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/healthz"]["get"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_read_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/read"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_export_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/export"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_change_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/change"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_mutate_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/mutate"]["post"].is_object());
|
|
}
|
|
|
|
// Deprecation flagging — `/read` and `/change` are kept indefinitely for
|
|
// back-compat but are flagged so OpenAPI codegens (typescript-fetch,
|
|
// openapi-generator, oapi-codegen, etc.) emit @deprecated on the generated
|
|
// SDK methods. The canonical successors `/query` and `/mutate` are not
|
|
// flagged. See `deprecation_headers` in `omnigraph-server/src/lib.rs` for
|
|
// the matching runtime signal (RFC 9745 + RFC 8288 headers).
|
|
#[test]
|
|
fn openapi_read_is_deprecated() {
|
|
let doc = openapi_json();
|
|
assert_eq!(
|
|
doc["paths"]["/read"]["post"]["deprecated"],
|
|
serde_json::Value::Bool(true),
|
|
"/read must be flagged deprecated in OpenAPI; use /query instead"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_change_is_deprecated() {
|
|
let doc = openapi_json();
|
|
assert_eq!(
|
|
doc["paths"]["/change"]["post"]["deprecated"],
|
|
serde_json::Value::Bool(true),
|
|
"/change must be flagged deprecated in OpenAPI; use /mutate instead"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_query_is_not_deprecated() {
|
|
let doc = openapi_json();
|
|
let deprecated = doc["paths"]["/query"]["post"]
|
|
.get("deprecated")
|
|
.and_then(serde_json::Value::as_bool)
|
|
.unwrap_or(false);
|
|
assert!(
|
|
!deprecated,
|
|
"/query is the canonical read endpoint and must not be deprecated"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_mutate_is_not_deprecated() {
|
|
let doc = openapi_json();
|
|
let deprecated = doc["paths"]["/mutate"]["post"]
|
|
.get("deprecated")
|
|
.and_then(serde_json::Value::as_bool)
|
|
.unwrap_or(false);
|
|
assert!(
|
|
!deprecated,
|
|
"/mutate is the canonical mutation endpoint and must not be deprecated"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_ingest_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/ingest"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_branches_supports_get_and_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/branches"]["get"].is_object());
|
|
assert!(doc["paths"]["/branches"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_branch_delete_is_delete() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/branches/{branch}"]["delete"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_branch_merge_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/branches/merge"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_commits_is_get() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/commits"]["get"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_commit_show_is_get() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/commits/{commit_id}"]["get"].is_object());
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Schema coverage tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
const EXPECTED_SCHEMAS: &[&str] = &[
|
|
"BranchCreateOutput",
|
|
"BranchCreateRequest",
|
|
"BranchDeleteOutput",
|
|
"BranchListOutput",
|
|
"BranchMergeOutcome",
|
|
"BranchMergeOutput",
|
|
"BranchMergeRequest",
|
|
"ChangeOutput",
|
|
"ChangeRequest",
|
|
"QueryRequest",
|
|
"CommitListOutput",
|
|
"CommitOutput",
|
|
"ErrorCode",
|
|
"ErrorOutput",
|
|
"ExportRequest",
|
|
"HealthOutput",
|
|
"IngestOutput",
|
|
"IngestRequest",
|
|
"IngestTableOutput",
|
|
"LoadMode",
|
|
"MergeConflictKindOutput",
|
|
"MergeConflictOutput",
|
|
"ReadOutput",
|
|
"ReadRequest",
|
|
"ReadTargetOutput",
|
|
"ManifestConflictOutput",
|
|
"SchemaApplyOutput",
|
|
"SchemaApplyRequest",
|
|
"SnapshotOutput",
|
|
"SnapshotTableOutput",
|
|
];
|
|
|
|
#[test]
|
|
fn openapi_contains_all_expected_schemas() {
|
|
let doc = openapi_json();
|
|
let schemas = doc["components"]["schemas"]
|
|
.as_object()
|
|
.expect("schemas must be an object");
|
|
let schema_keys: HashSet<&str> = schemas.keys().map(|k| k.as_str()).collect();
|
|
|
|
for expected in EXPECTED_SCHEMAS {
|
|
assert!(
|
|
schema_keys.contains(expected),
|
|
"missing schema: {expected}. Found: {schema_keys:?}"
|
|
);
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Schema field validation tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn health_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["HealthOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("status"));
|
|
assert!(props.contains_key("version"));
|
|
assert!(props.contains_key("source_version"));
|
|
}
|
|
|
|
#[test]
|
|
fn read_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ReadRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("query_source"));
|
|
assert!(props.contains_key("query_name"));
|
|
assert!(props.contains_key("params"));
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("snapshot"));
|
|
}
|
|
|
|
#[test]
|
|
fn read_request_query_source_is_required() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ReadRequest"];
|
|
let required: Vec<&str> = schema["required"]
|
|
.as_array()
|
|
.unwrap()
|
|
.iter()
|
|
.map(|v| v.as_str().unwrap())
|
|
.collect();
|
|
assert!(required.contains(&"query_source"));
|
|
}
|
|
|
|
#[test]
|
|
fn read_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ReadOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("query_name"));
|
|
assert!(props.contains_key("target"));
|
|
assert!(props.contains_key("row_count"));
|
|
assert!(props.contains_key("rows"));
|
|
}
|
|
|
|
#[test]
|
|
fn change_request_schema_has_expected_fields() {
|
|
// Canonical field names on the wire are now `query` and `name`. The
|
|
// schema descriptions document `query_source` and `query_name` as
|
|
// legacy deserialization aliases for backward compatibility.
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ChangeRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("query"));
|
|
assert!(props.contains_key("name"));
|
|
assert!(props.contains_key("params"));
|
|
assert!(props.contains_key("branch"));
|
|
let query_desc = schema["properties"]["query"]["description"]
|
|
.as_str()
|
|
.unwrap_or_default();
|
|
assert!(
|
|
query_desc.contains("query_source"),
|
|
"expected `query` description to mention the legacy `query_source` alias, got: {query_desc}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn query_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["QueryRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("query"));
|
|
assert!(props.contains_key("name"));
|
|
assert!(props.contains_key("params"));
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("snapshot"));
|
|
}
|
|
|
|
#[test]
|
|
fn query_request_query_is_required() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["QueryRequest"];
|
|
let required: Vec<&str> = schema["required"]
|
|
.as_array()
|
|
.unwrap()
|
|
.iter()
|
|
.map(|v| v.as_str().unwrap())
|
|
.collect();
|
|
assert!(required.contains(&"query"));
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_query_is_post() {
|
|
let doc = openapi_json();
|
|
assert!(doc["paths"]["/query"]["post"].is_object());
|
|
}
|
|
|
|
#[test]
|
|
fn query_endpoint_documents_mutation_400() {
|
|
let doc = openapi_json();
|
|
let four_hundred = &doc["paths"]["/query"]["post"]["responses"]["400"];
|
|
let description = four_hundred["description"].as_str().unwrap_or_default();
|
|
assert!(
|
|
description.contains("mutations") || description.contains("POST /mutate"),
|
|
"expected /query 400 response to mention mutation rejection, got: {description}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn change_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ChangeOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("query_name"));
|
|
assert!(props.contains_key("affected_nodes"));
|
|
assert!(props.contains_key("affected_edges"));
|
|
}
|
|
|
|
#[test]
|
|
fn ingest_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["IngestRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("from"));
|
|
assert!(props.contains_key("mode"));
|
|
assert!(props.contains_key("data"));
|
|
}
|
|
|
|
#[test]
|
|
fn ingest_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["IngestOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("uri"));
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("base_branch"));
|
|
assert!(props.contains_key("branch_created"));
|
|
assert!(props.contains_key("mode"));
|
|
assert!(props.contains_key("tables"));
|
|
}
|
|
|
|
#[test]
|
|
fn export_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ExportRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("type_names"));
|
|
assert!(props.contains_key("table_keys"));
|
|
}
|
|
|
|
#[test]
|
|
fn branch_create_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["BranchCreateRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("from"));
|
|
assert!(props.contains_key("name"));
|
|
}
|
|
|
|
#[test]
|
|
fn branch_create_request_name_is_required() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["BranchCreateRequest"];
|
|
let required: Vec<&str> = schema["required"]
|
|
.as_array()
|
|
.unwrap()
|
|
.iter()
|
|
.map(|v| v.as_str().unwrap())
|
|
.collect();
|
|
assert!(required.contains(&"name"));
|
|
}
|
|
|
|
#[test]
|
|
fn branch_merge_request_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["BranchMergeRequest"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("source"));
|
|
assert!(props.contains_key("target"));
|
|
}
|
|
|
|
#[test]
|
|
fn error_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ErrorOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("error"));
|
|
assert!(props.contains_key("code"));
|
|
assert!(props.contains_key("merge_conflicts"));
|
|
assert!(props.contains_key("manifest_conflict"));
|
|
}
|
|
|
|
#[test]
|
|
fn manifest_conflict_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ManifestConflictOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("table_key"));
|
|
assert!(props.contains_key("expected"));
|
|
assert!(props.contains_key("actual"));
|
|
}
|
|
|
|
#[test]
|
|
fn commit_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["CommitOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("graph_commit_id"));
|
|
assert!(props.contains_key("manifest_version"));
|
|
assert!(props.contains_key("parent_commit_id"));
|
|
assert!(props.contains_key("actor_id"));
|
|
assert!(props.contains_key("created_at"));
|
|
}
|
|
|
|
#[test]
|
|
fn snapshot_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["SnapshotOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("branch"));
|
|
assert!(props.contains_key("manifest_version"));
|
|
assert!(props.contains_key("tables"));
|
|
}
|
|
|
|
#[test]
|
|
fn snapshot_table_output_schema_has_expected_fields() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["SnapshotTableOutput"];
|
|
let props = schema["properties"].as_object().unwrap();
|
|
assert!(props.contains_key("table_key"));
|
|
assert!(props.contains_key("table_path"));
|
|
assert!(props.contains_key("table_version"));
|
|
assert!(props.contains_key("row_count"));
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Enum schema tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn load_mode_schema_has_three_variants() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["LoadMode"];
|
|
let variants = schema["enum"].as_array().unwrap();
|
|
assert_eq!(variants.len(), 3);
|
|
let values: HashSet<&str> = variants.iter().map(|v| v.as_str().unwrap()).collect();
|
|
assert!(values.contains("overwrite"));
|
|
assert!(values.contains("append"));
|
|
assert!(values.contains("merge"));
|
|
}
|
|
|
|
#[test]
|
|
fn branch_merge_outcome_schema_has_three_variants() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["BranchMergeOutcome"];
|
|
let variants = schema["enum"].as_array().unwrap();
|
|
assert_eq!(variants.len(), 3);
|
|
let values: HashSet<&str> = variants.iter().map(|v| v.as_str().unwrap()).collect();
|
|
assert!(values.contains("already_up_to_date"));
|
|
assert!(values.contains("fast_forward"));
|
|
assert!(values.contains("merged"));
|
|
}
|
|
|
|
#[test]
|
|
fn error_code_schema_has_expected_variants() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["ErrorCode"];
|
|
let variants = schema["enum"].as_array().unwrap();
|
|
let values: HashSet<&str> = variants.iter().map(|v| v.as_str().unwrap()).collect();
|
|
assert!(values.contains("unauthorized"));
|
|
assert!(values.contains("forbidden"));
|
|
assert!(values.contains("bad_request"));
|
|
assert!(values.contains("not_found"));
|
|
assert!(values.contains("conflict"));
|
|
assert!(values.contains("internal"));
|
|
}
|
|
|
|
#[test]
|
|
fn merge_conflict_kind_output_schema_has_expected_variants() {
|
|
let doc = openapi_json();
|
|
let schema = &doc["components"]["schemas"]["MergeConflictKindOutput"];
|
|
let variants = schema["enum"].as_array().unwrap();
|
|
let values: HashSet<&str> = variants.iter().map(|v| v.as_str().unwrap()).collect();
|
|
assert!(values.contains("divergent_insert"));
|
|
assert!(values.contains("divergent_update"));
|
|
assert!(values.contains("delete_vs_update"));
|
|
assert!(values.contains("orphan_edge"));
|
|
assert!(values.contains("unique_violation"));
|
|
assert!(values.contains("cardinality_violation"));
|
|
assert!(values.contains("value_constraint_violation"));
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Security scheme tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_defines_bearer_token_security_scheme() {
|
|
let doc = openapi_json();
|
|
let scheme = &doc["components"]["securitySchemes"]["bearer_token"];
|
|
assert_eq!(scheme["type"].as_str().unwrap(), "http");
|
|
assert_eq!(scheme["scheme"].as_str().unwrap(), "bearer");
|
|
}
|
|
|
|
#[test]
|
|
fn protected_endpoints_reference_bearer_token_security() {
|
|
let doc = openapi_json();
|
|
let protected_paths = [
|
|
("/read", "post"),
|
|
("/change", "post"),
|
|
("/schema/apply", "post"),
|
|
("/ingest", "post"),
|
|
("/export", "post"),
|
|
("/snapshot", "get"),
|
|
("/branches", "get"),
|
|
("/branches", "post"),
|
|
("/branches/{branch}", "delete"),
|
|
("/branches/merge", "post"),
|
|
("/commits", "get"),
|
|
("/commits/{commit_id}", "get"),
|
|
];
|
|
|
|
for (path, method) in protected_paths {
|
|
let operation = &doc["paths"][path][method];
|
|
let security = operation["security"]
|
|
.as_array()
|
|
.unwrap_or_else(|| panic!("no security on {method} {path}"));
|
|
let has_bearer = security
|
|
.iter()
|
|
.any(|s| s.as_object().unwrap().contains_key("bearer_token"));
|
|
assert!(has_bearer, "{method} {path} missing bearer_token security");
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn healthz_does_not_require_security() {
|
|
let doc = openapi_json();
|
|
let healthz = &doc["paths"]["/healthz"]["get"];
|
|
assert!(
|
|
healthz.get("security").is_none() || healthz["security"].is_null(),
|
|
"/healthz should not have security requirements"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Path parameter tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn branch_delete_has_branch_path_parameter() {
|
|
let doc = openapi_json();
|
|
let params = doc["paths"]["/branches/{branch}"]["delete"]["parameters"]
|
|
.as_array()
|
|
.unwrap();
|
|
let has_branch = params
|
|
.iter()
|
|
.any(|p| p["name"].as_str() == Some("branch") && p["in"].as_str() == Some("path"));
|
|
assert!(
|
|
has_branch,
|
|
"DELETE /branches/{{branch}} must have 'branch' path parameter"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn commit_show_has_commit_id_path_parameter() {
|
|
let doc = openapi_json();
|
|
let params = doc["paths"]["/commits/{commit_id}"]["get"]["parameters"]
|
|
.as_array()
|
|
.unwrap();
|
|
let has_commit_id = params
|
|
.iter()
|
|
.any(|p| p["name"].as_str() == Some("commit_id") && p["in"].as_str() == Some("path"));
|
|
assert!(
|
|
has_commit_id,
|
|
"GET /commits/{{commit_id}} must have 'commit_id' path parameter"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn snapshot_has_branch_query_parameter() {
|
|
let doc = openapi_json();
|
|
let params = doc["paths"]["/snapshot"]["get"]["parameters"]
|
|
.as_array()
|
|
.unwrap();
|
|
let has_branch = params
|
|
.iter()
|
|
.any(|p| p["name"].as_str() == Some("branch") && p["in"].as_str() == Some("query"));
|
|
assert!(
|
|
has_branch,
|
|
"GET /snapshot must have 'branch' query parameter"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn commits_has_branch_query_parameter() {
|
|
let doc = openapi_json();
|
|
let params = doc["paths"]["/commits"]["get"]["parameters"]
|
|
.as_array()
|
|
.unwrap();
|
|
let has_branch = params
|
|
.iter()
|
|
.any(|p| p["name"].as_str() == Some("branch") && p["in"].as_str() == Some("query"));
|
|
assert!(
|
|
has_branch,
|
|
"GET /commits must have 'branch' query parameter"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Tag tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_operations_have_tags() {
|
|
let doc = openapi_json();
|
|
let paths = doc["paths"].as_object().unwrap();
|
|
|
|
for (path, methods) in paths {
|
|
let methods = methods.as_object().unwrap();
|
|
for (method, operation) in methods {
|
|
let tags = operation["tags"].as_array();
|
|
assert!(
|
|
tags.is_some_and(|t| !t.is_empty()),
|
|
"{method} {path} should have at least one tag"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Response schema reference tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn read_endpoint_200_references_read_output_schema() {
|
|
let doc = openapi_json();
|
|
let content = &doc["paths"]["/read"]["post"]["responses"]["200"]["content"];
|
|
let schema = &content["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains("ReadOutput"),
|
|
"POST /read 200 should reference ReadOutput, got {ref_path}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn change_endpoint_200_references_change_output_schema() {
|
|
let doc = openapi_json();
|
|
let content = &doc["paths"]["/change"]["post"]["responses"]["200"]["content"];
|
|
let schema = &content["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains("ChangeOutput"),
|
|
"POST /change 200 should reference ChangeOutput, got {ref_path}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn healthz_200_references_health_output_schema() {
|
|
let doc = openapi_json();
|
|
let content = &doc["paths"]["/healthz"]["get"]["responses"]["200"]["content"];
|
|
let schema = &content["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains("HealthOutput"),
|
|
"GET /healthz 200 should reference HealthOutput, got {ref_path}"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn error_responses_reference_error_output_schema() {
|
|
let doc = openapi_json();
|
|
let paths_with_errors = [
|
|
("/read", "post", "400"),
|
|
("/read", "post", "401"),
|
|
("/change", "post", "400"),
|
|
("/change", "post", "409"),
|
|
("/branches", "post", "409"),
|
|
];
|
|
|
|
for (path, method, status) in paths_with_errors {
|
|
let content = &doc["paths"][path][method]["responses"][status]["content"];
|
|
let schema = &content["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains("ErrorOutput"),
|
|
"{method} {path} {status} should reference ErrorOutput, got {ref_path}"
|
|
);
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Request body reference tests
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn post_endpoints_have_request_body() {
|
|
let doc = openapi_json();
|
|
let post_paths = [
|
|
("/read", "ReadRequest"),
|
|
("/change", "ChangeRequest"),
|
|
("/schema/apply", "SchemaApplyRequest"),
|
|
("/ingest", "IngestRequest"),
|
|
("/export", "ExportRequest"),
|
|
("/branches", "BranchCreateRequest"),
|
|
("/branches/merge", "BranchMergeRequest"),
|
|
];
|
|
|
|
for (path, expected_schema) in post_paths {
|
|
let request_body = &doc["paths"][path]["post"]["requestBody"];
|
|
assert!(
|
|
request_body.is_object(),
|
|
"POST {path} should have a requestBody"
|
|
);
|
|
let schema = &request_body["content"]["application/json"]["schema"];
|
|
let ref_path = schema["$ref"].as_str().unwrap();
|
|
assert!(
|
|
ref_path.contains(expected_schema),
|
|
"POST {path} requestBody should reference {expected_schema}, got {ref_path}"
|
|
);
|
|
}
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Serialization round-trip test
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[test]
|
|
fn openapi_spec_round_trips_through_json() {
|
|
let doc = openapi_doc();
|
|
let json_string = serde_json::to_string_pretty(&doc).unwrap();
|
|
let parsed: Value = serde_json::from_str(&json_string).unwrap();
|
|
assert!(parsed["openapi"].is_string());
|
|
assert!(parsed["paths"].is_object());
|
|
assert!(parsed["components"]["schemas"].is_object());
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Open-mode vs auth-mode: served spec reflects runtime config
|
|
// ---------------------------------------------------------------------------
|
|
|
|
#[tokio::test]
|
|
async fn open_mode_spec_has_no_security_schemes() {
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let schemes = &json["components"]["securitySchemes"];
|
|
assert!(
|
|
schemes.is_null() || schemes.as_object().is_some_and(|m| m.is_empty()),
|
|
"open-mode spec should have no security schemes"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn open_mode_spec_has_no_operation_security() {
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
for (path, methods) in paths {
|
|
for (method, operation) in methods.as_object().unwrap() {
|
|
let security = &operation["security"];
|
|
assert!(
|
|
security.is_null(),
|
|
"open-mode: {method} {path} should have no security requirement"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn auth_mode_spec_includes_bearer_token_security_scheme() {
|
|
let (_temp, app) = app_for_loaded_graph_with_auth("secret").await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let scheme = &json["components"]["securitySchemes"]["bearer_token"];
|
|
assert_eq!(scheme["type"].as_str().unwrap(), "http");
|
|
assert_eq!(scheme["scheme"].as_str().unwrap(), "bearer");
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn auth_mode_spec_has_security_on_protected_operations() {
|
|
let (_temp, app) = app_for_loaded_graph_with_auth("secret").await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let protected_paths = [
|
|
("/read", "post"),
|
|
("/change", "post"),
|
|
("/snapshot", "get"),
|
|
("/branches", "get"),
|
|
("/commits", "get"),
|
|
];
|
|
for (path, method) in protected_paths {
|
|
let security = &json["paths"][path][method]["security"];
|
|
let arr = security
|
|
.as_array()
|
|
.unwrap_or_else(|| panic!("auth-mode: {method} {path} missing security"));
|
|
let has_bearer = arr
|
|
.iter()
|
|
.any(|s| s.as_object().unwrap().contains_key("bearer_token"));
|
|
assert!(
|
|
has_bearer,
|
|
"auth-mode: {method} {path} should require bearer_token"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn auth_mode_spec_matches_static_generation() {
|
|
let (_temp, app) = app_for_loaded_graph_with_auth("secret").await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, served) = json_response(&app, request).await;
|
|
let static_doc = openapi_json();
|
|
assert_eq!(
|
|
served, static_doc,
|
|
"auth-mode served spec must match static generation"
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn auth_mode_healthz_still_has_no_security() {
|
|
let (_temp, app) = app_for_loaded_graph_with_auth("secret").await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let healthz = &json["paths"]["/healthz"]["get"];
|
|
assert!(
|
|
healthz.get("security").is_none() || healthz["security"].is_null(),
|
|
"auth-mode: /healthz should still have no security"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn openapi_spec_is_up_to_date() {
|
|
let spec_path = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("../../openapi.json");
|
|
|
|
let generated = serde_json::to_string_pretty(&openapi_doc()).unwrap() + "\n";
|
|
|
|
if !env::var("OMNIGRAPH_UPDATE_OPENAPI")
|
|
.unwrap_or_default()
|
|
.is_empty()
|
|
{
|
|
fs::write(&spec_path, &generated).unwrap();
|
|
return;
|
|
}
|
|
|
|
let committed = fs::read_to_string(&spec_path).unwrap_or_else(|_| {
|
|
panic!(
|
|
"openapi.json not found at {}. Run: OMNIGRAPH_UPDATE_OPENAPI=1 cargo test -p omnigraph-server --test openapi openapi_spec_is_up_to_date",
|
|
spec_path.display()
|
|
)
|
|
});
|
|
|
|
assert_eq!(
|
|
committed, generated,
|
|
"openapi.json is out of date. Run: OMNIGRAPH_UPDATE_OPENAPI=1 cargo test -p omnigraph-server --test openapi openapi_spec_is_up_to_date"
|
|
);
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// MR-668 — multi-mode OpenAPI cluster filter
|
|
// ---------------------------------------------------------------------------
|
|
//
|
|
// In multi-graph mode, `/openapi.json` reports cluster routes
|
|
// (`/graphs/{graph_id}/...`) instead of the legacy flat routes. The
|
|
// only flat path that survives is `/healthz`. Operation IDs gain a
|
|
// `cluster_` prefix so SDK generators have stable, unique ids.
|
|
//
|
|
// These tests exercise the request-time `server_openapi` handler via
|
|
// `oneshot`, not the static `ApiDoc::openapi()` — the rewrite happens
|
|
// only on the served document.
|
|
|
|
const EXPECTED_CLUSTER_PATHS: &[&str] = &[
|
|
"/graphs/{graph_id}/snapshot",
|
|
"/graphs/{graph_id}/read",
|
|
"/graphs/{graph_id}/export",
|
|
"/graphs/{graph_id}/change",
|
|
"/graphs/{graph_id}/schema",
|
|
"/graphs/{graph_id}/schema/apply",
|
|
"/graphs/{graph_id}/ingest",
|
|
"/graphs/{graph_id}/branches",
|
|
"/graphs/{graph_id}/branches/{branch}",
|
|
"/graphs/{graph_id}/branches/merge",
|
|
"/graphs/{graph_id}/commits",
|
|
"/graphs/{graph_id}/commits/{commit_id}",
|
|
];
|
|
|
|
async fn app_for_multi_mode(graph_ids: &[&str]) -> (Vec<tempfile::TempDir>, Router) {
|
|
use std::sync::Arc;
|
|
|
|
use omnigraph_server::{GraphHandle, GraphId, GraphKey};
|
|
|
|
let mut dirs = Vec::with_capacity(graph_ids.len());
|
|
let mut handles = Vec::with_capacity(graph_ids.len());
|
|
for id in graph_ids {
|
|
let dir = tempfile::tempdir().unwrap();
|
|
let graph_uri = dir.path().join(id).to_str().unwrap().to_string();
|
|
let schema = fs::read_to_string(fixture("test.pg")).unwrap();
|
|
let engine = Omnigraph::init(&graph_uri, &schema).await.unwrap();
|
|
handles.push(Arc::new(GraphHandle {
|
|
key: GraphKey::cluster(GraphId::try_from(*id).unwrap()),
|
|
uri: graph_uri,
|
|
engine: Arc::new(engine),
|
|
policy: None,
|
|
}));
|
|
dirs.push(dir);
|
|
}
|
|
let workload = omnigraph_server::workload::WorkloadController::from_env();
|
|
let state = AppState::new_multi(handles, Vec::new(), None, workload, None).unwrap();
|
|
let app = build_app(state);
|
|
(dirs, app)
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_lists_cluster_paths() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (status, json) = json_response(&app, request).await;
|
|
assert_eq!(status, StatusCode::OK);
|
|
let paths = json["paths"].as_object().expect("paths must be an object");
|
|
let path_keys: HashSet<&str> = paths.keys().map(|k| k.as_str()).collect();
|
|
for expected in EXPECTED_CLUSTER_PATHS {
|
|
assert!(
|
|
path_keys.contains(expected),
|
|
"missing cluster path in multi-mode spec: {expected}. \
|
|
Found: {path_keys:?}"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_drops_flat_protected_paths() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
// None of the legacy flat protected paths should appear in multi mode.
|
|
let flat_protected = [
|
|
"/snapshot",
|
|
"/read",
|
|
"/export",
|
|
"/change",
|
|
"/schema",
|
|
"/schema/apply",
|
|
"/ingest",
|
|
"/branches",
|
|
"/branches/{branch}",
|
|
"/branches/merge",
|
|
"/commits",
|
|
"/commits/{commit_id}",
|
|
];
|
|
for flat in flat_protected {
|
|
assert!(
|
|
!paths.contains_key(flat),
|
|
"flat path {flat} must not appear in multi-mode spec; \
|
|
cluster routes are the only protected surface"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_keeps_management_paths_flat() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
for flat in ["/healthz", "/graphs"] {
|
|
assert!(
|
|
paths.contains_key(flat),
|
|
"{flat} must remain flat in multi mode"
|
|
);
|
|
let nested = format!("/graphs/{{graph_id}}{flat}");
|
|
assert!(
|
|
!paths.contains_key(&nested),
|
|
"{flat} must NOT be cluster-prefixed to {nested}"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_prefixes_operation_ids_with_cluster() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
// Every cluster path operation must have a `cluster_` operation_id.
|
|
// Flat-mounted paths (healthz, management /graphs) keep their
|
|
// original operation_ids — they're not per-graph.
|
|
let paths = json["paths"].as_object().unwrap();
|
|
let mut checked = 0;
|
|
for (path, item) in paths {
|
|
if path == "/healthz" || path == "/graphs" {
|
|
continue;
|
|
}
|
|
for method in ["get", "post", "put", "delete", "patch"] {
|
|
if let Some(op) = item.get(method).filter(|v| v.is_object()) {
|
|
if let Some(id) = op["operationId"].as_str() {
|
|
assert!(
|
|
id.starts_with("cluster_"),
|
|
"operation_id at {path}.{method} must start with `cluster_`, got `{id}`"
|
|
);
|
|
checked += 1;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
assert!(
|
|
checked >= EXPECTED_CLUSTER_PATHS.len(),
|
|
"expected at least {} cluster operation_ids; checked {checked}",
|
|
EXPECTED_CLUSTER_PATHS.len()
|
|
);
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_openapi_declares_graph_id_path_parameter() {
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
|
|
for expected_path in EXPECTED_CLUSTER_PATHS {
|
|
let item = paths
|
|
.get(*expected_path)
|
|
.unwrap_or_else(|| panic!("missing cluster path {expected_path}"));
|
|
for method in ["get", "post", "put", "delete", "patch"] {
|
|
let Some(operation) = item.get(method).filter(|value| value.is_object()) else {
|
|
continue;
|
|
};
|
|
let parameters = operation["parameters"]
|
|
.as_array()
|
|
.unwrap_or_else(|| panic!("{expected_path}.{method} missing parameters"));
|
|
let graph_id = parameters
|
|
.iter()
|
|
.find(|param| param["name"] == "graph_id" && param["in"] == "path")
|
|
.unwrap_or_else(|| {
|
|
panic!("{expected_path}.{method} missing graph_id path parameter")
|
|
});
|
|
assert_eq!(
|
|
graph_id["required"].as_bool(),
|
|
Some(true),
|
|
"{expected_path}.{method} graph_id parameter must be required"
|
|
);
|
|
assert_eq!(
|
|
graph_id["schema"]["type"].as_str(),
|
|
Some("string"),
|
|
"{expected_path}.{method} graph_id parameter must be string typed"
|
|
);
|
|
}
|
|
}
|
|
|
|
for flat in ["/healthz", "/graphs"] {
|
|
let item = paths.get(flat).unwrap();
|
|
for method in ["get", "post", "put", "delete", "patch"] {
|
|
if let Some(operation) = item.get(method).filter(|value| value.is_object()) {
|
|
let has_graph_id = operation["parameters"]
|
|
.as_array()
|
|
.map(|params| {
|
|
params
|
|
.iter()
|
|
.any(|param| param["name"] == "graph_id" && param["in"] == "path")
|
|
})
|
|
.unwrap_or(false);
|
|
assert!(
|
|
!has_graph_id,
|
|
"{flat}.{method} must not declare graph_id; it remains flat"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn multi_mode_operation_ids_are_unique() {
|
|
// Sanity check: the cluster_ prefix prevents collision with flat ids
|
|
// (which don't appear in multi mode, but the contract is "unique
|
|
// across the spec"). Verify every operation_id in the multi-mode
|
|
// spec is unique.
|
|
let (_dirs, app) = app_for_multi_mode(&["alpha"]).await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
let mut seen_ids: HashSet<String> = HashSet::new();
|
|
for (_, item) in paths {
|
|
for method in ["get", "post", "put", "delete", "patch"] {
|
|
if let Some(op) = item.get(method).filter(|v| v.is_object()) {
|
|
if let Some(id) = op["operationId"].as_str() {
|
|
assert!(
|
|
seen_ids.insert(id.to_string()),
|
|
"duplicate operation_id `{id}` in multi-mode spec"
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn single_mode_openapi_unchanged_by_cluster_filter() {
|
|
// Regression: single mode still emits the legacy flat surface.
|
|
let (_temp, app) = app_for_loaded_graph().await;
|
|
let request = Request::builder()
|
|
.method(Method::GET)
|
|
.uri("/openapi.json")
|
|
.body(Body::empty())
|
|
.unwrap();
|
|
let (_, json) = json_response(&app, request).await;
|
|
let paths = json["paths"].as_object().unwrap();
|
|
let path_keys: HashSet<&str> = paths.keys().map(|k| k.as_str()).collect();
|
|
for expected in EXPECTED_PATHS {
|
|
assert!(
|
|
path_keys.contains(expected),
|
|
"single mode must still emit flat path: {expected}"
|
|
);
|
|
}
|
|
for cluster in EXPECTED_CLUSTER_PATHS {
|
|
assert!(
|
|
!path_keys.contains(cluster),
|
|
"single mode must NOT emit cluster path: {cluster}"
|
|
);
|
|
}
|
|
}
|