mirror of
https://github.com/fabro-sh/fabro.git
synced 2026-09-27 01:21:25 +00:00
## Summary Adds run-level controls for clone behavior, managed run branch setup/pushes, and metadata branch writes/pushes so workflows can opt out of Fabro-managed Git behavior without relying on provider-specific `skip_clone` settings. This closes fabro-sh/fabro#240. ## What Changed - Introduced `[run.clone]`, `[run.run_branch]`, and `[run.meta_branch]` settings with defaults that preserve current behavior. - Removed user-facing `skip_clone` from Docker/Daytona config while mapping the new run-level clone setting into the internal sandbox runtime options. - Gated run branch setup/push, metadata branch writer creation/push, and PR branch output on the new settings. - Enforced invalid combinations: pull requests require an enabled pushed run branch, and disabling the run branch also disables metadata branch behavior. - Updated OpenAPI, the generated TypeScript API client, frontend fixture data, and docs for the new configuration shape. ## Testing - `cargo nextest run -p fabro-config -p fabro-types -p fabro-workflow -p fabro-server` - `cargo build -p fabro-api` - `cd lib/packages/fabro-api-client && bun run generate` - `cd lib/packages/fabro-api-client && bun run typecheck` - `cd apps/fabro-web && bun run typecheck` - `cd apps/fabro-web && bun test` - `cargo build --workspace` - `cargo +nightly-2026-04-14 fmt --check --all` - `cargo +nightly-2026-04-14 clippy --workspace --all-targets -- -D warnings` - `cargo insta pending-snapshots` - `git diff --check` ## Post-Deploy Monitoring & Validation - Validation window: first 24 hours after release; owner: release owner/on-call engineer. - Log queries/search terms: `run_branch`, `meta_branch`, `clone.enabled`, `skip_clone`, `pull request requires an enabled pushed run branch`, `metadata branch`. - Healthy signals: runs without custom branch config continue creating and pushing run/meta branches; runs with `[run.clone] enabled = false` start provider sandboxes without cloning; runs with branch pushes disabled complete without Git push errors. - Failure signals: increased run startup failures for Docker/Daytona, unexpected PR creation conflicts, missing metadata for default-config runs, or validation errors for configurations that previously used default settings. - Mitigation trigger: if default-config runs stop producing expected branch/metadata artifacts or sandbox startup failures increase, roll back the release or temporarily restore previous defaults while investigating the run-level setting resolution path. --- [](https://github.com/EveryInc/compound-engineering-plugin) 🤖 Generated with GPT-5 via [Codex](https://openai.com/codex) Co-authored-by: Haroldo Olivieri <6575718+haroldolivieri@users.noreply.github.com>
448 lines
12 KiB
Rust
448 lines
12 KiB
Rust
use fabro_test::{fabro_snapshot, test_context};
|
|
use httpmock::MockServer;
|
|
use insta::assert_snapshot;
|
|
use serde_json::json;
|
|
|
|
use super::support::{
|
|
compact_git_inspect, compact_inspect, remote_run_summary_json, run_success,
|
|
setup_seeded_completed_dry_run, setup_seeded_created_dry_run,
|
|
setup_seeded_git_backed_changed_run,
|
|
};
|
|
use crate::support::{run_projection_json, unique_run_id};
|
|
|
|
fn remote_run_summary(run_id: &str, status: &serde_json::Value) -> serde_json::Value {
|
|
remote_run_summary_json(
|
|
run_id,
|
|
"Nightly Build",
|
|
"nightly-build",
|
|
"Inspect remote state",
|
|
status,
|
|
"2026-04-19T12:00:00Z",
|
|
)
|
|
}
|
|
|
|
#[test]
|
|
fn help() {
|
|
let context = test_context!();
|
|
let mut cmd = context.command();
|
|
cmd.args(["inspect", "--help"]);
|
|
fabro_snapshot!(context.filters(), cmd, @"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
Show detailed information about a workflow run
|
|
|
|
Usage: fabro inspect [OPTIONS] <RUN>
|
|
|
|
Arguments:
|
|
<RUN> Run ID prefix or workflow name (most recent run)
|
|
|
|
Options:
|
|
--json Output as JSON [env: FABRO_JSON=]
|
|
--server <SERVER> Fabro server target: http(s) URL or absolute Unix socket path [env: FABRO_SERVER=]
|
|
--debug Enable DEBUG-level logging (default is INFO) [env: FABRO_DEBUG=]
|
|
--no-upgrade-check Disable automatic upgrade check [env: FABRO_NO_UPGRADE_CHECK=true]
|
|
--quiet Suppress non-essential output [env: FABRO_QUIET=]
|
|
--verbose Enable verbose output [env: FABRO_VERBOSE=]
|
|
-h, --help Print help
|
|
----- stderr -----
|
|
");
|
|
}
|
|
|
|
#[test]
|
|
fn inspect_resolves_selector_via_server_endpoint() {
|
|
let context = test_context!();
|
|
let server = MockServer::start();
|
|
let run_id = unique_run_id();
|
|
let summary = remote_run_summary(
|
|
run_id.as_str(),
|
|
&json!({
|
|
"kind": "succeeded",
|
|
"reason": "completed"
|
|
}),
|
|
);
|
|
|
|
let resolve_run = server.mock(|when, then| {
|
|
when.method("GET")
|
|
.path("/api/v1/runs/resolve")
|
|
.query_param("selector", "nightly-build");
|
|
then.status(200)
|
|
.header("content-type", "application/json")
|
|
.body(summary.to_string());
|
|
});
|
|
let run_state = server.mock(|when, then| {
|
|
when.method("GET")
|
|
.path(format!("/api/v1/runs/{}/state", run_id.as_str()));
|
|
then.status(200)
|
|
.header("content-type", "application/json")
|
|
.body(
|
|
run_projection_json(
|
|
run_id.as_str(),
|
|
&json!({
|
|
"kind": "succeeded",
|
|
"reason": "completed"
|
|
}),
|
|
)
|
|
.to_string(),
|
|
);
|
|
});
|
|
|
|
let mut cmd = context.command();
|
|
cmd.args([
|
|
"inspect",
|
|
"--server",
|
|
&format!("{}/api/v1", server.base_url()),
|
|
"nightly-build",
|
|
]);
|
|
|
|
fabro_snapshot!(context.filters(), cmd, @r#"
|
|
success: true
|
|
exit_code: 0
|
|
----- stdout -----
|
|
[
|
|
{
|
|
"run_id": "[ULID]",
|
|
"status": {
|
|
"kind": "succeeded",
|
|
"reason": "completed"
|
|
},
|
|
"run_spec": {
|
|
"run_id": "[ULID]",
|
|
"settings": {
|
|
"project": {
|
|
"name": null,
|
|
"description": null,
|
|
"metadata": {}
|
|
},
|
|
"workflow": {
|
|
"name": null,
|
|
"description": null,
|
|
"graph": "",
|
|
"metadata": {}
|
|
},
|
|
"run": {
|
|
"goal": null,
|
|
"working_dir": null,
|
|
"metadata": {},
|
|
"inputs": {},
|
|
"model": {
|
|
"provider": null,
|
|
"name": null,
|
|
"fallbacks": [],
|
|
"controls": {
|
|
"reasoning_effort": null,
|
|
"speed": null
|
|
}
|
|
},
|
|
"git": {
|
|
"author": null
|
|
},
|
|
"prepare": {
|
|
"commands": [],
|
|
"timeout_ms": 300000
|
|
},
|
|
"execution": {
|
|
"mode": "normal",
|
|
"approval": "prompt"
|
|
},
|
|
"checkpoint": {
|
|
"exclude_globs": []
|
|
},
|
|
"clone": {
|
|
"enabled": true
|
|
},
|
|
"run_branch": {
|
|
"enabled": true,
|
|
"push": true
|
|
},
|
|
"meta_branch": {
|
|
"enabled": true,
|
|
"push": true
|
|
},
|
|
"sandbox": {
|
|
"provider": "local",
|
|
"preserve": false,
|
|
"stop_on_terminal": true,
|
|
"devcontainer": false,
|
|
"env": {},
|
|
"docker": null,
|
|
"daytona": null
|
|
},
|
|
"notifications": {},
|
|
"interviews": {
|
|
"provider": null,
|
|
"slack": null
|
|
},
|
|
"agent": {
|
|
"permissions": null,
|
|
"mcps": {}
|
|
},
|
|
"hooks": [],
|
|
"scm": {
|
|
"provider": null,
|
|
"owner": null,
|
|
"repository": null,
|
|
"github": null
|
|
},
|
|
"pull_request": null,
|
|
"artifacts": {
|
|
"include": []
|
|
},
|
|
"integrations": {
|
|
"github": {
|
|
"permissions": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"graph": {
|
|
"name": "Remote Workflow",
|
|
"nodes": {},
|
|
"edges": [],
|
|
"attrs": {}
|
|
},
|
|
"workflow_slug": "remote-workflow",
|
|
"source_directory": "/srv/repo"
|
|
},
|
|
"start_record": null,
|
|
"conclusion": null,
|
|
"checkpoint": null,
|
|
"sandbox": null
|
|
}
|
|
]
|
|
----- stderr -----
|
|
"#);
|
|
|
|
resolve_run.assert();
|
|
run_state.assert();
|
|
}
|
|
|
|
#[test]
|
|
fn inspect_created_run_shows_run_spec_without_start_or_conclusion() {
|
|
let context = test_context!();
|
|
let run = setup_seeded_created_dry_run(&context);
|
|
let output = run_success(&context, &["inspect", &run.run_id]);
|
|
|
|
assert_snapshot!(serde_json::to_string_pretty(&compact_inspect(&output)).unwrap(), @r#"
|
|
[
|
|
{
|
|
"run_id": "[ULID]",
|
|
"status": {
|
|
"kind": "submitted"
|
|
},
|
|
"run_spec": {
|
|
"goal": {
|
|
"type": "inline",
|
|
"value": "Run tests and report results"
|
|
},
|
|
"workflow_name": "Simple",
|
|
"workflow_slug": "simple",
|
|
"sandbox_provider": "local",
|
|
"dry_run": true,
|
|
"provenance": {
|
|
"server_version": "[VERSION]",
|
|
"client_name": "fabro-cli",
|
|
"client_version": "[VERSION]",
|
|
"subject_auth_method": "dev_token"
|
|
}
|
|
},
|
|
"start_record": null,
|
|
"conclusion": null,
|
|
"checkpoint": null,
|
|
"sandbox": {
|
|
"provider": "local"
|
|
}
|
|
}
|
|
]
|
|
"#);
|
|
}
|
|
|
|
#[test]
|
|
fn inspect_completed_run_shows_run_start_conclusion_checkpoint() {
|
|
let context = test_context!();
|
|
let run = setup_seeded_completed_dry_run(&context);
|
|
let output = run_success(&context, &["inspect", &run.run_id]);
|
|
|
|
assert_snapshot!(serde_json::to_string_pretty(&compact_inspect(&output)).unwrap(), @r#"
|
|
[
|
|
{
|
|
"run_id": "[ULID]",
|
|
"status": {
|
|
"kind": "succeeded",
|
|
"reason": "completed"
|
|
},
|
|
"run_spec": {
|
|
"goal": {
|
|
"type": "inline",
|
|
"value": "Run tests and report results"
|
|
},
|
|
"workflow_name": "Simple",
|
|
"workflow_slug": "simple",
|
|
"sandbox_provider": "local",
|
|
"dry_run": true,
|
|
"provenance": {
|
|
"server_version": "[VERSION]",
|
|
"client_name": "fabro-cli",
|
|
"client_version": "[VERSION]",
|
|
"subject_auth_method": "dev_token"
|
|
}
|
|
},
|
|
"start_record": {
|
|
"has_start_time": true
|
|
},
|
|
"conclusion": {
|
|
"status": "succeeded",
|
|
"duration_ms": "[DURATION_MS]",
|
|
"stage_count": null
|
|
},
|
|
"checkpoint": {
|
|
"current_node": "report",
|
|
"completed_nodes": [
|
|
"start",
|
|
"run_tests",
|
|
"report"
|
|
],
|
|
"next_node_id": "exit"
|
|
},
|
|
"sandbox": {
|
|
"provider": "local"
|
|
}
|
|
}
|
|
]
|
|
"#);
|
|
}
|
|
|
|
#[test]
|
|
fn inspect_json_omits_run_dir() {
|
|
let context = test_context!();
|
|
let run = setup_seeded_completed_dry_run(&context);
|
|
let output = run_success(&context, &["inspect", &run.run_id]);
|
|
let items: serde_json::Value =
|
|
serde_json::from_slice(&output.stdout).expect("inspect output should parse");
|
|
let first = items
|
|
.as_array()
|
|
.and_then(|items| items.first())
|
|
.expect("inspect output should contain one item");
|
|
assert!(
|
|
first.get("run_dir").is_none(),
|
|
"inspect JSON should not expose run_dir"
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn inspect_completed_run_reads_store_without_disk_metadata_files() {
|
|
let context = test_context!();
|
|
let run = setup_seeded_completed_dry_run(&context);
|
|
let output = run_success(&context, &["inspect", &run.run_id]);
|
|
|
|
assert_snapshot!(serde_json::to_string_pretty(&compact_inspect(&output)).unwrap(), @r#"
|
|
[
|
|
{
|
|
"run_id": "[ULID]",
|
|
"status": {
|
|
"kind": "succeeded",
|
|
"reason": "completed"
|
|
},
|
|
"run_spec": {
|
|
"goal": {
|
|
"type": "inline",
|
|
"value": "Run tests and report results"
|
|
},
|
|
"workflow_name": "Simple",
|
|
"workflow_slug": "simple",
|
|
"sandbox_provider": "local",
|
|
"dry_run": true,
|
|
"provenance": {
|
|
"server_version": "[VERSION]",
|
|
"client_name": "fabro-cli",
|
|
"client_version": "[VERSION]",
|
|
"subject_auth_method": "dev_token"
|
|
}
|
|
},
|
|
"start_record": {
|
|
"has_start_time": true
|
|
},
|
|
"conclusion": {
|
|
"status": "succeeded",
|
|
"duration_ms": "[DURATION_MS]",
|
|
"stage_count": null
|
|
},
|
|
"checkpoint": {
|
|
"current_node": "report",
|
|
"completed_nodes": [
|
|
"start",
|
|
"run_tests",
|
|
"report"
|
|
],
|
|
"next_node_id": "exit"
|
|
},
|
|
"sandbox": {
|
|
"provider": "local"
|
|
}
|
|
}
|
|
]
|
|
"#);
|
|
}
|
|
|
|
#[test]
|
|
fn inspect_git_backed_run_exposes_checkpoint_and_sandbox_state() {
|
|
let context = test_context!();
|
|
let setup = setup_seeded_git_backed_changed_run(&context);
|
|
let output = run_success(&context, &["inspect", &setup.run.run_id]);
|
|
|
|
assert_snapshot!(
|
|
serde_json::to_string_pretty(&compact_git_inspect(&output)).unwrap(),
|
|
@r#"
|
|
[
|
|
{
|
|
"run_id": "[ULID]",
|
|
"status": {
|
|
"kind": "succeeded",
|
|
"reason": "completed"
|
|
},
|
|
"run_spec": {
|
|
"goal": {
|
|
"type": "inline",
|
|
"value": "Edit a tracked file"
|
|
},
|
|
"workflow_name": "Flow",
|
|
"workflow_slug": "flow",
|
|
"llm_provider": "openai",
|
|
"sandbox_provider": "local",
|
|
"provenance": {
|
|
"server_version": "[VERSION]",
|
|
"client_name": "fabro-cli",
|
|
"client_version": "[VERSION]",
|
|
"subject_auth_method": "dev_token"
|
|
}
|
|
},
|
|
"start_record": {
|
|
"has_start_time": true,
|
|
"run_branch": "fabro/run/[ULID]",
|
|
"base_sha": "[SHA]"
|
|
},
|
|
"conclusion": {
|
|
"status": "succeeded",
|
|
"duration_ms": "[DURATION_MS]",
|
|
"final_git_commit_sha": "[SHA]",
|
|
"stage_count": null
|
|
},
|
|
"checkpoint": {
|
|
"current_node": "step_two",
|
|
"completed_nodes": [
|
|
"start",
|
|
"step_one",
|
|
"step_two"
|
|
],
|
|
"next_node_id": "exit",
|
|
"git_commit_sha": "[SHA]"
|
|
},
|
|
"sandbox": {
|
|
"provider": "local",
|
|
"working_directory": "[WORKTREE]"
|
|
}
|
|
}
|
|
]
|
|
"#
|
|
);
|
|
}
|