Skip to content

Expand demo walkthrough lifecycle coverage #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codeforester merged 1 commit into from
Jun 20, 2026
Merged

Expand demo walkthrough lifecycle coverage #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 62 additions & 11 deletions demo/demo.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ BASE_DEMO_ROOT="$(demo_project_root)" || {
exit 1
}

if [[ -n "${MISE_TRUSTED_CONFIG_PATHS:-}" ]]; then
export MISE_TRUSTED_CONFIG_PATHS="$BASE_DEMO_ROOT:$MISE_TRUSTED_CONFIG_PATHS"
else
export MISE_TRUSTED_CONFIG_PATHS="$BASE_DEMO_ROOT"
fi

demo_workspace_root() {
cd -- "$BASE_DEMO_ROOT/.." && pwd -P
}
Expand Down Expand Up @@ -103,7 +109,7 @@ capture_command() {

printf ' $'
printf ' %q' "$@"
printf '\n'
printf '\n\n'

if ! output="$("$@" 2>&1)"; then
printf '%s\n' "$output" >&2
Expand Down Expand Up @@ -133,6 +139,8 @@ intro() {
}

project_shape_step() {
local repo_output

step 1 "Project Shape"
run_command test -f "$BASE_DEMO_ROOT/base_manifest.yaml"
run_command test -f "$BASE_DEMO_ROOT/Brewfile"
Expand All @@ -149,6 +157,11 @@ project_shape_step() {
run_command test -x "$BASE_DEMO_ROOT/src/manifest.sh"
run_command test -x "$BASE_DEMO_ROOT/src/build-info.sh"
run_command test -x "$BASE_DEMO_ROOT/tests/validate.sh"

printf '\nChecking the repository baseline files separately from project health.\n'
repo_output="$(capture_command "$BASE_DEMO_BASECTL" repo check .)"
printf '%s\n' "$repo_output"
require_contains "repo check" "$repo_output" "Repository baseline"
pause
}

Expand Down Expand Up @@ -179,8 +192,20 @@ discovery_step() {
pause
}

setup_step() {
local output

step 4 "Setup Contract"
printf 'Showing the setup reconciliation plan for manifest artifacts, Brewfile dependencies, mise tools, and the project virtualenv.\n'
printf 'The walkthrough uses --dry-run so it is stable on machines where setup is already complete or local tool trust is pending.\n'
printf 'For this process only, the project root is trusted for mise checks without changing persistent mise trust.\n'
output="$(capture_command "$BASE_DEMO_BASECTL" setup "$BASE_DEMO_PROJECT" --manifest "$BASE_DEMO_ROOT/base_manifest.yaml" --dry-run --no-notify)"
printf '%s\n' "$output"
pause
}

diagnostics_step() {
step 4 "Project Diagnostics"
step 5 "Project Diagnostics"
printf 'The manifest declares BASE_DEMO_ENV as a required_env health check.\n'
printf 'The green path has BASE_DEMO_ENV=baseline from activation or CI.\n'
printf 'Before activation, check and doctor can report a useful diagnostic instead.\n'
Expand All @@ -191,7 +216,9 @@ diagnostics_step() {
}

activation_step() {
step 5 "Project Activation Source"
local check_output doctor_output

step 6 "Project Activation Source"
# shellcheck source=/dev/null
source "$BASE_DEMO_ROOT/.base/activate.sh" || return 1
printf 'BASE_DEMO_ENV=%s\n' "${BASE_DEMO_ENV:-unset}"
Expand All @@ -200,13 +227,20 @@ activation_step() {
require_contains "activation" "${BASE_DEMO_ENV:-}" "baseline"
require_contains "activation" "${BASE_DEMO_ACTIVATED:-}" "true"
require_contains "activation" "${BASE_DEMO_PROJECT_KIND:-}" "reference-demo"

printf '\nRunning the post-activation green path through check and doctor.\n'
check_output="$(capture_command "$BASE_DEMO_BASECTL" check "$BASE_DEMO_PROJECT" --manifest "$BASE_DEMO_ROOT/base_manifest.yaml")"
printf '%s\n' "$check_output"

doctor_output="$(capture_command "$BASE_DEMO_BASECTL" doctor "$BASE_DEMO_PROJECT" --manifest "$BASE_DEMO_ROOT/base_manifest.yaml")"
printf '%s\n' "$doctor_output"
pause
}

command_discovery_step() {
local output

step 6 "Declared Commands"
step 7 "Declared Commands"
output="$(capture_command "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" --list)"
printf '%s\n' "$output"
require_contains "run command list" "$output" "hello"
Expand All @@ -221,7 +255,7 @@ command_discovery_step() {
run_step() {
local output

step 7 "Declared Command Execution"
step 8 "Declared Command Execution"
output="$(capture_command "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" hello)"
printf '%s\n' "$output"
require_contains "run command" "$output" "hello from base-demo"
Expand All @@ -231,27 +265,32 @@ run_step() {
inspection_step() {
local env_output manifest_output python_output services_output environments_output

step 8 "Inspection Commands"
step 9 "Inspection Commands"
printf 'Inspecting activation and manifest environment values.\n'
env_output="$(capture_command "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" env)"
printf '%s\n' "$env_output"
require_contains "env command" "$env_output" "BASE_PROJECT=base-demo"
require_contains "env command" "$env_output" "BASE_DEMO_PROJECT_KIND=reference-demo"

printf '\nReading the manifest summary command.\n'
manifest_output="$(capture_command "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" manifest)"
printf '%s\n' "$manifest_output"
require_contains "manifest command" "$manifest_output" "base-demo manifest"
require_contains "manifest command" "$manifest_output" "commands:"

printf '\nConfirming the Base-managed Python command runs inside the project environment.\n'
python_output="$(capture_command "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" python-info)"
printf '%s\n' "$python_output"
require_contains "python command" "$python_output" "base-demo python cli"
require_contains "python command" "$python_output" "BASE_PROJECT=base-demo"

printf '\nViewing the representative service catalog and health states.\n'
services_output="$(capture_command "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" services -- status)"
printf '%s\n' "$services_output"
require_contains "services command" "$services_output" "project-baseline"
require_contains "services command" "$services_output" "healthy"

printf '\nListing modeled environments and deployment boundaries.\n'
environments_output="$(capture_command "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" environments -- list)"
printf '%s\n' "$environments_output"
require_contains "environments command" "$environments_output" "dev"
Expand All @@ -264,20 +303,23 @@ inspection_step() {
representative_environment_step() {
local check_output start_output validate_output

step 9 "Representative Environment"
step 10 "Representative Environment"
printf 'Checking representative service health.\n'
check_output="$(capture_command "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" services -- check)"
printf '%s\n' "$check_output"
require_contains "services check" "$check_output" "project-baseline ok"
require_contains "services check" "$check_output" "c-service"
require_contains "services check" "$check_output" "cpp-service"
require_contains "services check" "$check_output" "demo-console"

printf '\nDry-running service startup without launching dependencies.\n'
start_output="$(capture_command env BASE_DEMO_SERVICES_DRY_RUN=1 "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" services -- start)"
printf '%s\n' "$start_output"
require_contains "services dry-run start" "$start_output" "DRY-RUN docker compose"
require_contains "services dry-run start" "$start_output" "go-api"
require_contains "services dry-run start" "$start_output" "demo-console"

printf '\nValidating every modeled environment file.\n'
validate_output="$(capture_command "$BASE_DEMO_BASECTL" run "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" environments -- validate --all)"
printf '%s\n' "$validate_output"
require_contains "environment validation" "$validate_output" "dev"
Expand All @@ -289,7 +331,7 @@ representative_environment_step() {
test_step() {
local output

step 10 "Test Contract"
step 11 "Test Contract"
output="$(capture_command "$BASE_DEMO_BASECTL" test "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE")"
printf '%s\n' "$output"
require_contains "test command" "$output" "Repository baseline is present."
Expand All @@ -299,7 +341,7 @@ test_step() {
build_step() {
local output

step 11 "Build Targets"
step 12 "Build Targets"
output="$(capture_command "$BASE_DEMO_BASECTL" build "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" --list)"
printf '%s\n' "$output"
require_contains "build list" "$output" "info"
Expand All @@ -324,13 +366,21 @@ build_step() {
demo_step() {
local output

step 12 "Demo Contract"
step 13 "Demo Contract"
output="$(capture_command "$BASE_DEMO_BASECTL" demo "$BASE_DEMO_PROJECT" --workspace "$BASE_DEMO_WORKSPACE" --dry-run -- --non-interactive)"
printf '%s\n' "$output"
require_contains "demo command" "$output" "Would run demo"
pause
}

closing_summary() {
printf '\nWalkthrough Summary\n\n'
printf 'Manifest fields exercised: activate, health.required_env, commands, test, build, demo, brewfile, and mise.\n'
printf 'Next steps: read docs/representative-environment.md for the environment model.\n'
printf 'For a deeper application shape, compare this reference repo with banyanlabs.\n'
printf '\nbase-demo walkthrough complete.\n'
}

main() {
parse_args "$@" || {
local status=$?
Expand All @@ -343,6 +393,7 @@ main() {
project_shape_step
manifest_step
discovery_step
setup_step
diagnostics_step
activation_step
command_discovery_step
Expand All @@ -352,7 +403,7 @@ main() {
test_step
build_step
demo_step
printf '\nbase-demo walkthrough complete.\n'
closing_summary
}

main "$@"
22 changes: 22 additions & 0 deletions tests/demo_test.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ teardown() {
cat > "$fake_bin/basectl" <<'EOF'
#!/usr/bin/env bash
case "$*" in
repo\ check\ .)
printf 'Repository baseline: all 12 required files present.\n'
;;
projects\ list\ --workspace\ *)
printf 'PROJECT PATH\n'
printf 'other-demo /tmp/other-demo\n'
Expand Down Expand Up @@ -60,10 +63,16 @@ EOF
#!/usr/bin/env bash
printf 'basectl %s\n' "$*" >> "${BASE_DEMO_TEST_STATE:?}"
case "$*" in
repo\ check\ .)
printf 'Repository baseline: all 12 required files present.\n'
;;
projects\ list\ --workspace\ *)
printf 'PROJECT PATH\n'
printf 'base-demo %s\n' "${BASE_PROJECT_ROOT:?}"
;;
setup\ base-demo\ --manifest\ *\ --dry-run\ --no-notify)
printf '[DRY-RUN] Would reconcile base_manifest.yaml, Brewfile, mise, and project virtualenv.\n'
;;
check\ base-demo\ --manifest\ *)
printf 'Base CLI environment check passed.\n'
;;
Expand Down Expand Up @@ -187,12 +196,18 @@ EOF
[ "$status" -eq 0 ]
[[ "$output" == *"base-demo Walkthrough"* ]]
[[ "$output" == *"Workspace Discovery"* ]]
[[ "$output" == *"Setup Contract"* ]]
[[ "$output" == *"Project Diagnostics"* ]]
[[ "$output" == *"post-activation green path"* ]]
[[ "$output" == *"Declared Commands"* ]]
[[ "$output" == *"services ./bin/base-demo-services"* ]]
[[ "$output" == *"environments ./bin/base-demo-environments"* ]]
[[ "$output" == *"Inspection Commands"* ]]
[[ "$output" == *"Inspecting activation and manifest environment values."* ]]
[[ "$output" == *"Reading the manifest summary command."* ]]
[[ "$output" == *"Checking representative service health."* ]]
[[ "$output" == *"Representative Environment"* ]]
[[ "$output" == *"Dry-running service startup without launching dependencies."* ]]
[[ "$output" == *"DRY-RUN docker compose"* ]]
[[ "$output" == *"c-service ok"* ]]
[[ "$output" == *"cpp-service ok"* ]]
Expand Down Expand Up @@ -229,10 +244,17 @@ EOF
[[ "$output" == *"Build Targets"* ]]
[[ "$output" == *"project=base-demo"* ]]
[[ "$output" == *"python-api build target validated"* ]]
[[ "$output" == *"Manifest fields exercised:"* ]]
[[ "$output" == *"docs/representative-environment.md"* ]]
[[ "$output" == *"banyanlabs"* ]]
[[ "$output" == *"base-demo walkthrough complete."* ]]
grep -Eq "^basectl repo check \\.$" "$state_file"
grep -Fq "basectl projects list --workspace " "$state_file"
grep -Eq "^basectl setup base-demo --manifest .+/base_manifest.yaml --dry-run --no-notify$" "$state_file"
grep -Eq "^basectl check base-demo --manifest .+/base_manifest.yaml$" "$state_file"
grep -Eq "^basectl doctor base-demo --manifest .+/base_manifest.yaml$" "$state_file"
[ "$(grep -Ec "^basectl check base-demo --manifest .+/base_manifest.yaml$" "$state_file")" -eq 2 ]
[ "$(grep -Ec "^basectl doctor base-demo --manifest .+/base_manifest.yaml$" "$state_file")" -eq 2 ]
grep -Eq "^basectl run base-demo --workspace .+ --list$" "$state_file"
grep -Eq "^basectl run base-demo --workspace .+ hello$" "$state_file"
grep -Eq "^basectl run base-demo --workspace .+ env$" "$state_file"
Expand Down
Loading