mirror of
https://github.com/NVIDIA/OpenShell.git
synced 2026-10-17 05:31:16 +08:00
* feat(workspace): implement workspace model (Phase 1 of RFC 0011) Implements workspace and membership model providing hard isolation boundaries for multi-player OpenShell deployments. Workspace CRUD with Kubernetes-style Terminating phase for graceful deletion. All resources scoped by workspace via ObjectMeta. Membership RPCs for workspace access control. Persistence migration shifts name uniqueness to (object_type, workspace, name). Provider profiles support platform and workspace scoping. Service routing uses workspace-prefixed DNS labels. Inference routes renamed and workspace-scoped with DeleteInferenceRoute RPC. Python SDK with WorkspaceClient, two-method list pattern (workspace-scoped and for_all_workspaces), and workspace parameter on all methods. CLI workspace flags, TUI workspace cycling. K8s driver filters unmanaged CRs and uses delete preconditions. Podman driver uses immutable container IDs. Label serialization fixed across all put_if call sites. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(cli): delegate sandbox upload command to existing upload function The standalone `sandbox upload` command reimplemented upload logic inline with two bugs: it used `Path::exists()` which follows symlinks (rejecting dangling symlinks), and it ran git-aware filtering on symlink sources. The `run::sandbox_upload()` function already handles both cases correctly via `sandbox_upload_plan()`. Replace the inline logic with a call to the existing function. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(e2e): shorten sandbox names and fix test compatibility Shorten the sandbox name in initial_sparse_policy_is_acknowledged_as_loaded from 'e2e-2159-sparse-enrich' (22 chars) to 'e2e-sparse-enrich' (17 chars) to comply with MAX_ROUTABLE_NAME_LEN (19 chars). Also capture stderr in create_keep_with_args so future sandbox creation failures include the actual CLI error instead of reporting empty output. Signed-off-by: Derek Carr <decarr@redhat.com> * test(workspace): add test coverage for workspace CRUD and persistence isolation Add unit tests for workspace create happy path, get round-trip, get not-found, get empty-name rejection, already-exists error, and resolve_workspace not-found. Add persistence test proving cross-workspace name uniqueness (same name in different workspaces produces separate records). Add workspace name max-length boundary tests. Fix e2e harness to include stderr in name-parse-failure error path. Align Python e2e test_workspace_crud with try/finally pattern. Document provider profile catalog workspace scoping gap in RFC 0011. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(examples): update examples for workspace model compatibility Shorten sandbox names in demo scripts to fit the 19-character MAX_ROUTABLE_NAME_LEN limit: policy-demo prefix to pd-, multi-agent notepad derives a short SANDBOX_TAG from the run ID, governance interceptor uses gs-PID-RANDOM. Update vscode-remote-sandbox.md SSH host aliases from openshell-{name} to openshell-{name}.{workspace} format. Signed-off-by: Derek Carr <decarr@redhat.com> * feat(sdk): add workspace-scoped client and workspace CRUD Add WorkspaceScopedClient modeled after kube::Api::namespaced — captures workspace once and injects it into every sandbox request. Add workspace CRUD methods (create, get, list, delete) and list_sandboxes_all_workspaces on OpenShellClient. Extend SandboxRef with workspace field and add WorkspaceRef type. Include mock tests for all new operations. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(lint): resolve clippy warnings in workspace test assertions Signed-off-by: Derek Carr <decarr@redhat.com> * fix(docs): convert indented code blocks to fenced in RFC 0011 Signed-off-by: Derek Carr <decarr@redhat.com> * fix(lint): resolve clippy warnings and apply cargo fmt across workspace Auto-format with cargo fmt and fix clippy warnings exposed by the reformat: unnecessary qualifications, map_unwrap_or, identical match arms, unused variable prefix, dead code annotations, and let-unit-value in e2e harness. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(workspace): address workspace scoping issues from review - Add workspace field to settings JSON output (CLI) - Skip Podman containers missing workspace label instead of defaulting to empty string, matching K8s driver behavior - Add resource_version to list_by_scope SELECT in both SQLite and Postgres backends, with regression test - Gate PolicyLocalContext proposal/lookup routes on workspace readiness, returning 503 when workspace is not yet discovered - Block sandbox and provider creation in TUI all-workspaces mode - Clear workspace vectors in TUI reset_sandbox_state Signed-off-by: Derek Carr <decarr@redhat.com> * fix(workspace): make provider profile catalog workspace-aware Thread workspace through snapshot_catalog so the EffectiveProviderProfileCatalog enforces workspace boundaries on both read and write paths. UserProviderProfileSource now loads platform-scoped profiles (workspace "") plus the target workspace's profiles, preventing cross-workspace duplicate profile ID collisions that previously caused global catalog failures. Update RFC 0011 to reflect catalog scoping is implemented in Phase 1 rather than deferred to future work. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(persistence): include workspace column in atomic policy revision INSERT put_policy_revision_atomic omitted the workspace column from the INSERT into the objects table in both SQLite and Postgres backends, causing atomically-written policy revisions to lose their workspace association. Add workspace field to AtomicPolicyRevisionWrite and thread it through both backend INSERT statements, matching the non-atomic put_policy_revision path which already included it. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(proxy): skip ancestor walk when socket owner is the entrypoint collect_ancestor_identities walked the entire process tree above the entrypoint when the connecting process was the entrypoint itself, SHA256-hashing every ancestor binary (IDE, shell, container runtime). On dev machines with large binaries in the ancestor chain this exceeded the 30-second test timeout. When start_pid == stop_pid there are no intermediate ancestors to verify, so return an empty list immediately. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(workspace): make provider profile catalog scope-aware Allow the same profile ID at platform and workspace scopes by introducing layered catalog entries where workspace profiles shadow platform profiles. Add source and scope fields to the ProviderProfile proto and CLI output. Migrate List/Get handlers to the catalog, fixing divergence with runtime profile resolution. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(e2e): align podman e2e labels with centralized driver constants The podman driver moved its container labels to the centralized openshell.ai/ prefix, but the e2e test harness and cleanup script still referenced the old openshell.sandbox-* keys, causing the local_driver_token_restart test to fail on container lookup. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(e2e): align python profile isolation test with scope-aware catalog Platform profiles are now visible in workspace listings as fallbacks per the layered catalog design. Update the assertion to match. Signed-off-by: Derek Carr <decarr@redhat.com> * fix(workspace): honor profile_workspace in runtime profile resolution Runtime profile lookups now consult provider.profile_workspace via get_type_profile_for_scope. Providers created with --global-profile (profile_workspace="") resolve to the platform profile even when a workspace profile shadows the same ID. All 6 runtime call sites updated; type-only call sites remain scope-agnostic. Signed-off-by: Derek Carr <decarr@redhat.com> --------- Signed-off-by: Derek Carr <decarr@redhat.com>
249 lines
9.3 KiB
Bash
Executable File
249 lines
9.3 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
set -euo pipefail
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
POLICY_TEMPLATE="${SCRIPT_DIR}/policy.template.yaml"
|
|
PROMPTS_DIR="${SCRIPT_DIR}/prompts"
|
|
|
|
OPENSHELL_BIN="${OPENSHELL_BIN:-openshell}"
|
|
DEMO_TOPIC="${DEMO_TOPIC:-How should teams evaluate sandboxed coding agents?}"
|
|
DEMO_AGENT_COUNT="${DEMO_AGENT_COUNT:-5}"
|
|
DEMO_BRANCH="${DEMO_BRANCH:-main}"
|
|
DEMO_RUN_ID="${DEMO_RUN_ID:-$(date +%Y%m%d-%H%M%S)}"
|
|
# Sandbox names are capped at 19 characters. Derive a short tag from the
|
|
# run ID for sandbox naming while keeping the full ID for providers and
|
|
# GitHub paths.
|
|
SANDBOX_TAG="${DEMO_RUN_ID:2:12}" # e.g. "260718-12345" (12 chars)
|
|
DEMO_KEEP_SANDBOXES="${DEMO_KEEP_SANDBOXES:-0}"
|
|
DEMO_CODEX_PROVIDER_NAME="${DEMO_CODEX_PROVIDER_NAME:-codex-oauth-${DEMO_RUN_ID}}"
|
|
DEMO_GITHUB_PROVIDER_NAME="${DEMO_GITHUB_PROVIDER_NAME:-github-memory-${DEMO_RUN_ID}}"
|
|
|
|
TMP_DIR="$(mktemp -d "${TMPDIR:-/tmp}/openshell-codex-github.XXXXXX")"
|
|
POLICY_FILE="${TMP_DIR}/policy.yaml"
|
|
PAYLOAD_DIR="${TMP_DIR}/payload"
|
|
RUNNER_FILE="${PAYLOAD_DIR}/demo-runner.sh"
|
|
PROMPTS_UPLOAD_DIR="${PAYLOAD_DIR}/prompts"
|
|
LOG_DIR="${TMP_DIR}/logs"
|
|
mkdir -p "$LOG_DIR" "$PROMPTS_UPLOAD_DIR"
|
|
|
|
BOLD='\033[1m'
|
|
DIM='\033[2m'
|
|
CYAN='\033[36m'
|
|
GREEN='\033[32m'
|
|
RED='\033[31m'
|
|
YELLOW='\033[33m'
|
|
RESET='\033[0m'
|
|
|
|
WORKER_SLICES=(
|
|
"Adoption criteria: what makes a sandboxed coding-agent workflow trustworthy enough to try?"
|
|
"Operational risks: what can go wrong when many autonomous agents run at once?"
|
|
"Security controls: which controls make the biggest difference for credential and network safety?"
|
|
"Developer experience: where does the workflow need to feel simple for users to adopt it?"
|
|
"Measurement: what signals show whether the agents produced useful work?"
|
|
"Scaling: what changes when the team runs dozens of agents instead of five?"
|
|
"Governance: what review and approval steps should remain human-controlled?"
|
|
"Repository hygiene: what makes the shared markdown notepad easy to review and clean up?"
|
|
)
|
|
|
|
step() {
|
|
printf "\n${BOLD}${CYAN}==> %s${RESET}\n\n" "$1"
|
|
}
|
|
|
|
info() {
|
|
printf " %b\n" "$*"
|
|
}
|
|
|
|
fail() {
|
|
printf "\n${RED}error:${RESET} %s\n" "$*" >&2
|
|
exit 1
|
|
}
|
|
|
|
cleanup() {
|
|
local status=$?
|
|
|
|
if [[ "$DEMO_KEEP_SANDBOXES" != "1" ]]; then
|
|
for i in $(seq 1 "$DEMO_AGENT_COUNT"); do
|
|
"$OPENSHELL_BIN" sandbox delete "mn-${SANDBOX_TAG}-a${i}" >/dev/null 2>&1 || true
|
|
done
|
|
"$OPENSHELL_BIN" sandbox delete "mn-${SANDBOX_TAG}-sum" >/dev/null 2>&1 || true
|
|
else
|
|
printf "\n${YELLOW}Keeping sandboxes because DEMO_KEEP_SANDBOXES=1.${RESET}\n"
|
|
fi
|
|
|
|
"$OPENSHELL_BIN" provider delete "$DEMO_CODEX_PROVIDER_NAME" >/dev/null 2>&1 || true
|
|
"$OPENSHELL_BIN" provider delete "$DEMO_GITHUB_PROVIDER_NAME" >/dev/null 2>&1 || true
|
|
|
|
if [[ $status -ne 0 ]]; then
|
|
printf "\n${YELLOW}Logs kept at: %s${RESET}\n" "$LOG_DIR"
|
|
else
|
|
rm -rf "$TMP_DIR"
|
|
fi
|
|
}
|
|
trap cleanup EXIT
|
|
|
|
require_command() {
|
|
command -v "$1" >/dev/null 2>&1 || fail "missing required command: $1"
|
|
}
|
|
|
|
validate_env() {
|
|
require_command "$OPENSHELL_BIN"
|
|
require_command jq
|
|
require_command sed
|
|
|
|
[[ -n "${DEMO_GITHUB_OWNER:-}" ]] || fail "set DEMO_GITHUB_OWNER"
|
|
[[ -n "${DEMO_GITHUB_REPO:-}" ]] || fail "set DEMO_GITHUB_REPO"
|
|
[[ -n "${DEMO_GITHUB_TOKEN:-}" ]] || fail "set DEMO_GITHUB_TOKEN"
|
|
[[ -f "${HOME}/.codex/auth.json" ]] || fail "missing local Codex sign-in; run: codex login"
|
|
[[ "$DEMO_AGENT_COUNT" =~ ^[0-9]+$ ]] || fail "DEMO_AGENT_COUNT must be a number"
|
|
(( DEMO_AGENT_COUNT >= 1 && DEMO_AGENT_COUNT <= 8 )) || fail "DEMO_AGENT_COUNT must be between 1 and 8 for this demo"
|
|
[[ "$DEMO_RUN_ID" =~ ^[a-z0-9-]+$ ]] || fail "DEMO_RUN_ID may contain only lowercase letters, numbers, and '-'"
|
|
[[ "$DEMO_GITHUB_OWNER" =~ ^[A-Za-z0-9_.-]+$ ]] || fail "DEMO_GITHUB_OWNER contains unsupported characters"
|
|
[[ "$DEMO_GITHUB_REPO" =~ ^[A-Za-z0-9_.-]+$ ]] || fail "DEMO_GITHUB_REPO contains unsupported characters"
|
|
[[ "$DEMO_BRANCH" =~ ^[A-Za-z0-9._-]+$ ]] || fail "DEMO_BRANCH may contain only letters, numbers, '.', '_', and '-'"
|
|
info "GitHub repo ${DEMO_GITHUB_OWNER}/${DEMO_GITHUB_REPO}@${DEMO_BRANCH} and token present"
|
|
|
|
info "checking OpenShell gateway is reachable..."
|
|
"$OPENSHELL_BIN" status >/dev/null 2>&1 || fail "OpenShell gateway is not reachable; run: mise run gateway:docker"
|
|
|
|
export CODEX_AUTH_ACCESS_TOKEN
|
|
export CODEX_AUTH_REFRESH_TOKEN
|
|
export CODEX_AUTH_ACCOUNT_ID
|
|
CODEX_AUTH_ACCESS_TOKEN="$(jq -r '.tokens.access_token // empty' "${HOME}/.codex/auth.json")"
|
|
CODEX_AUTH_REFRESH_TOKEN="$(jq -r '.tokens.refresh_token // empty' "${HOME}/.codex/auth.json")"
|
|
CODEX_AUTH_ACCOUNT_ID="$(jq -r '.tokens.account_id // empty' "${HOME}/.codex/auth.json")"
|
|
|
|
[[ -n "$CODEX_AUTH_ACCESS_TOKEN" ]] || fail "local Codex sign-in is missing an access token; run: codex login"
|
|
[[ -n "$CODEX_AUTH_REFRESH_TOKEN" ]] || fail "local Codex sign-in is missing a refresh token; run: codex login"
|
|
[[ -n "$CODEX_AUTH_ACCOUNT_ID" ]] || fail "local Codex sign-in is missing an account id; run: codex login"
|
|
info "local Codex OAuth tokens loaded from ~/.codex/auth.json"
|
|
}
|
|
|
|
render_policy() {
|
|
sed \
|
|
-e "s/__OWNER__/${DEMO_GITHUB_OWNER}/g" \
|
|
-e "s/__REPO__/${DEMO_GITHUB_REPO}/g" \
|
|
-e "s/__RUN_ID__/${DEMO_RUN_ID}/g" \
|
|
"$POLICY_TEMPLATE" > "$POLICY_FILE"
|
|
}
|
|
|
|
write_runner() {
|
|
cp "${PROMPTS_DIR}/worker.md" "${PROMPTS_UPLOAD_DIR}/worker.md"
|
|
cp "${PROMPTS_DIR}/synthesis.md" "${PROMPTS_UPLOAD_DIR}/synthesis.md"
|
|
cp "${SCRIPT_DIR}/runner.sh" "$RUNNER_FILE"
|
|
chmod +x "$RUNNER_FILE"
|
|
}
|
|
|
|
create_providers() {
|
|
"$OPENSHELL_BIN" provider delete "$DEMO_CODEX_PROVIDER_NAME" >/dev/null 2>&1 || true
|
|
"$OPENSHELL_BIN" provider delete "$DEMO_GITHUB_PROVIDER_NAME" >/dev/null 2>&1 || true
|
|
|
|
"$OPENSHELL_BIN" provider create \
|
|
--name "$DEMO_CODEX_PROVIDER_NAME" \
|
|
--type generic \
|
|
--credential CODEX_AUTH_ACCESS_TOKEN \
|
|
--credential CODEX_AUTH_REFRESH_TOKEN \
|
|
--credential CODEX_AUTH_ACCOUNT_ID >/dev/null
|
|
|
|
"$OPENSHELL_BIN" provider create \
|
|
--name "$DEMO_GITHUB_PROVIDER_NAME" \
|
|
--type generic \
|
|
--credential DEMO_GITHUB_TOKEN >/dev/null
|
|
}
|
|
|
|
run_sandbox() {
|
|
local name="$1"
|
|
shift
|
|
"$OPENSHELL_BIN" sandbox create \
|
|
--name "$name" \
|
|
--from base \
|
|
--provider "$DEMO_CODEX_PROVIDER_NAME" \
|
|
--provider "$DEMO_GITHUB_PROVIDER_NAME" \
|
|
--policy "$POLICY_FILE" \
|
|
--upload "${PAYLOAD_DIR}:/sandbox" \
|
|
--no-tty \
|
|
-- bash /sandbox/payload/demo-runner.sh "$@"
|
|
}
|
|
|
|
run_worker() {
|
|
local index="$1"
|
|
local slice_index=$(( (index - 1) % ${#WORKER_SLICES[@]} ))
|
|
local name="mn-${SANDBOX_TAG}-a${index}"
|
|
run_sandbox "$name" worker "$DEMO_GITHUB_OWNER" "$DEMO_GITHUB_REPO" "$DEMO_BRANCH" "$DEMO_RUN_ID" "$index" "$DEMO_AGENT_COUNT" "$DEMO_TOPIC" "${WORKER_SLICES[$slice_index]}"
|
|
}
|
|
|
|
run_workers() {
|
|
local pids=()
|
|
local failed=0
|
|
|
|
for i in $(seq 1 "$DEMO_AGENT_COUNT"); do
|
|
(
|
|
run_worker "$i"
|
|
) >"${LOG_DIR}/agent-${i}.log" 2>&1 &
|
|
pids+=("$!")
|
|
info "${DIM}started worker ${i} (log: ${LOG_DIR}/agent-${i}.log)${RESET}"
|
|
done
|
|
|
|
for i in $(seq 1 "$DEMO_AGENT_COUNT"); do
|
|
if ! wait "${pids[$((i - 1))]}"; then
|
|
failed=1
|
|
printf "\n${RED}worker ${i} failed; log follows:${RESET}\n"
|
|
sed 's/^/ /' "${LOG_DIR}/agent-${i}.log" | tail -80
|
|
else
|
|
printf " ${GREEN}worker ${i} complete${RESET}\n"
|
|
fi
|
|
done
|
|
|
|
[[ "$failed" == "0" ]] || fail "one or more workers failed"
|
|
}
|
|
|
|
run_synthesis() {
|
|
local name="mn-${SANDBOX_TAG}-sum"
|
|
run_sandbox "$name" synthesis "$DEMO_GITHUB_OWNER" "$DEMO_GITHUB_REPO" "$DEMO_BRANCH" "$DEMO_RUN_ID" "0" "$DEMO_AGENT_COUNT" "$DEMO_TOPIC" \
|
|
>"${LOG_DIR}/summary.log" 2>&1 || {
|
|
printf "\n${RED}synthesis failed; log follows:${RESET}\n"
|
|
sed 's/^/ /' "${LOG_DIR}/summary.log" | tail -120
|
|
return 1
|
|
}
|
|
printf " ${GREEN}synthesis complete${RESET}\n"
|
|
}
|
|
|
|
print_results() {
|
|
local base_url="https://github.com/${DEMO_GITHUB_OWNER}/${DEMO_GITHUB_REPO}/tree/${DEMO_BRANCH}/runs/${DEMO_RUN_ID}"
|
|
printf "\n${BOLD}${GREEN}Demo complete.${RESET}\n\n"
|
|
printf " Shared agent notepad:\n"
|
|
printf " %s\n\n" "$base_url"
|
|
printf " What happened:\n"
|
|
printf " - %s isolated worker sandboxes wrote notes to a GitHub-backed markdown notepad.\n" "$DEMO_AGENT_COUNT"
|
|
printf " - One synthesis sandbox read those notes and wrote the final summary.\n"
|
|
printf " - No worker shared a filesystem or container with another worker.\n\n"
|
|
printf " Generated files:\n"
|
|
for i in $(seq 1 "$DEMO_AGENT_COUNT"); do
|
|
printf " - %s/notes/agent-%s.md\n" "$base_url" "$i"
|
|
done
|
|
printf " - %s/summary.md\n" "$base_url"
|
|
}
|
|
|
|
main() {
|
|
step "Validating Codex and GitHub credentials"
|
|
validate_env
|
|
render_policy
|
|
write_runner
|
|
|
|
step "Creating provider-backed Codex OAuth and GitHub token records"
|
|
create_providers
|
|
|
|
step "Launching ${DEMO_AGENT_COUNT} Codex worker sandboxes"
|
|
run_workers
|
|
|
|
step "Launching synthesis Codex sandbox"
|
|
run_synthesis
|
|
|
|
print_results
|
|
}
|
|
|
|
main "$@"
|