Merge pull request #209 from esnible/dependency-check-target

esnible · web-flow · commit c61ab3786fcf · 2026-04-01T09:33:33.000-04:00
Feat: Introduce targets to verify A2A and MCP servers start.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -37,3 +37,19 @@ jobs:
         run: pip install pytest pydantic pydantic-settings httpx python-dotenv
       - name: Run tests
         run: python -m pytest -v
+
+  # Make sure all of the examples start up successfully by running their `test_startup.exp` scripts, which use `expect` to verify the agent starts and responds to a simple input.
+  test-startup:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6
+        with:
+          python-version: "3.12"
+      - name: Install uv
+        uses: astral-sh/setup-uv@c7f87aa956e4c323abf06d5dec078e358f6b4d04  # v6
+      - name: Install expect
+        run: sudo apt-get update && sudo apt-get install -y expect
+      - name: Verify agents start
+        run: make test-startup-all
diff --git a/Makefile b/Makefile
@@ -1,4 +1,6 @@
-.PHONY: lint fmt test-docker test-a2a test-mcp sync-all-uv sync-a2a sync-mcp
+SHELL := /bin/bash
+
+.PHONY: lint fmt test-docker test-a2a test-mcp sync-all-uv sync-a2a sync-mcp test-startup-all test-startup-a2a test-startup-mcp
 
 lint:
 	pre-commit run --all-files
@@ -48,3 +50,26 @@ sync-mcp:
 		uv sync --no-dev || exit; \
 		popd; \
 	done
+
+test-startup-all: test-startup-a2a test-startup-mcp
+
+# Run the test_startup.exp script for each A2A example that has one to verify it starts successfully.
+test-startup-a2a:
+	@for f in $(shell find a2a -mindepth 1 -maxdepth 1 -type d); do \
+		pushd $${f} || exit; \
+		if [ -f test_startup.exp ]; then \
+			echo "Testing startup for $${f}..."; \
+			expect -f test_startup.exp || exit; \
+		fi; \
+		popd; \
+	done
+
+test-startup-mcp:
+	@for f in $(shell find mcp -mindepth 1 -maxdepth 1 -type d); do \
+		pushd $${f} || exit; \
+		if [ -f test_startup.exp ]; then \
+			echo "Testing startup for $${f}..."; \
+			expect -f test_startup.exp || exit; \
+		fi; \
+		popd; \
+	done
diff --git a/a2a/a2a_contact_extractor/.dockerignore b/a2a/a2a_contact_extractor/.dockerignore
@@ -1 +1,4 @@
-.venv
+.venv
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/a2a_contact_extractor/test_startup.exp b/a2a/a2a_contact_extractor/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked . --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/a2a_currency_converter/.dockerignore b/a2a/a2a_currency_converter/.dockerignore
@@ -1,2 +1,5 @@
 .venv
 deployment
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/a2a_currency_converter/test_startup.exp b/a2a/a2a_currency_converter/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked app --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/cheerup_agent/.dockerignore b/a2a/cheerup_agent/.dockerignore
@@ -2,3 +2,6 @@ __pycache__
 *.pyc
 .venv
 .git
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/cheerup_agent/test_startup.exp b/a2a/cheerup_agent/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked server --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/file_organizer/.dockerignore b/a2a/file_organizer/.dockerignore
@@ -1 +1,4 @@
-.venv
+.venv
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/file_organizer/test_startup.exp b/a2a/file_organizer/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked server --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/generic_agent/.dockerignore b/a2a/generic_agent/.dockerignore
@@ -1 +1,4 @@
-.venv
+.venv
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/generic_agent/test_startup.exp b/a2a/generic_agent/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked server --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/git_issue_agent/.dockerignore b/a2a/git_issue_agent/.dockerignore
@@ -0,0 +1,4 @@
+.venv
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/git_issue_agent/test_startup.exp b/a2a/git_issue_agent/test_startup.exp
@@ -0,0 +1,23 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+set child_pid [spawn env HOST=localhost PORT=8001 uv run --locked server]
+
+expect {
+    "Uvicorn running on" {
+        # Unlike the other servers, this one opens a child process.
+        # Without the explicit `pkill -P` it would leave a `uv` process running.
+        puts "Spawned pid was $child_pid"
+        exec pkill -P $child_pid
+        puts "Success"; exit 0
+    }
+    timeout {
+        exec pkill -P $child_pid
+        puts "Timed out waiting for startup"; exit 1
+    }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/image_service/.dockerignore b/a2a/image_service/.dockerignore
@@ -1 +1,4 @@
-.venv
+.venv
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/image_service/test_startup.exp b/a2a/image_service/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked server --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/recipe_agent/.dockerignore b/a2a/recipe_agent/.dockerignore
@@ -2,3 +2,6 @@ __pycache__
 *.pyc
 .venv
 .git
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/recipe_agent/test_startup.exp b/a2a/recipe_agent/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked server --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/reservation_service/.dockerignore b/a2a/reservation_service/.dockerignore
@@ -13,3 +13,6 @@ build
 .git
 .gitignore
 .DS_Store
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/reservation_service/test_startup.exp b/a2a/reservation_service/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked python -c "from src.reservation_service.agent import run; run()" --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/simple_generalist/.dockerignore b/a2a/simple_generalist/.dockerignore
@@ -18,4 +18,7 @@ README.md
 tests
 .pytest_cache
 .coverage
-htmlcov
+htmlcov
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/simple_generalist/test_startup.exp b/a2a/simple_generalist/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked python -c "from src.simple_generalist.main import run; run()" --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/slack_researcher/.dockerignore b/a2a/slack_researcher/.dockerignore
@@ -1 +1,4 @@
-.venv
+.venv
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/slack_researcher/test_startup.exp b/a2a/slack_researcher/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked server --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/trivia_agent/.dockerignore b/a2a/trivia_agent/.dockerignore
@@ -2,3 +2,6 @@ __pycache__
 *.pyc
 .venv
 .git
+
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/trivia_agent/test_startup.exp b/a2a/trivia_agent/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked python -c "from src.trivia_agent.agent import run; run()" --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/a2a/weather_service/.dockerignore b/a2a/weather_service/.dockerignore
@@ -2,3 +2,5 @@
 
 deployment
 
+# `expect` scripts
+test_startup.exp
diff --git a/a2a/weather_service/test_startup.exp b/a2a/weather_service/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked server --host localhost --port 8001
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/mcp/cloud_storage_tool/.dockerignore b/mcp/cloud_storage_tool/.dockerignore
@@ -1 +1,4 @@
-.venv
+.venv
+
+# `expect` scripts
+test_startup.exp
diff --git a/mcp/cloud_storage_tool/test_startup.exp b/mcp/cloud_storage_tool/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked cloud_storage_tool.py
+
+expect {
+    "Uvicorn running on" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/mcp/flight_tool/.dockerignore b/mcp/flight_tool/.dockerignore
@@ -0,0 +1,4 @@
+.venv
+
+# `expect` scripts
+test_startup.exp
diff --git a/mcp/flight_tool/test_startup.exp b/mcp/flight_tool/test_startup.exp
@@ -0,0 +1,14 @@
+# This script tests if the server has dependencies and reaches the point of starting its server.
+
+# Run with `expect -f test_startup.exp`
+
+set timeout 120
+
+# This is similar the Dockerfile CMD
+spawn env HOST=localhost PORT=8001 uv run --locked flight_tool.py
+
+expect {
+    "http://localhost:8001/mcp" { puts "Success"; exit 0 }
+    timeout { puts "Timed out waiting for startup"; exit 1 }
+    eof { puts "Process exited early"; exit 2 }
+}
diff --git a/mcp/image_tool/.dockerignore b/mcp/image_tool/.dockerignore
@@ -1 +1,4 @@
-.venv
+.venv
+
+# `expect` scripts
+test_startup.exp
diff --git a/mcp/image_tool/test_startup.exp b/mcp/image_tool/test_startup.exp
diff --git a/mcp/movie_tool/.dockerignore b/mcp/movie_tool/.dockerignore
diff --git a/mcp/movie_tool/test_startup.exp b/mcp/movie_tool/test_startup.exp
diff --git a/mcp/reservation_tool/.dockerignore b/mcp/reservation_tool/.dockerignore
diff --git a/mcp/reservation_tool/test_startup.exp b/mcp/reservation_tool/test_startup.exp
diff --git a/mcp/shopping_tool/.dockerignore b/mcp/shopping_tool/.dockerignore
diff --git a/mcp/shopping_tool/test_startup.exp b/mcp/shopping_tool/test_startup.exp
diff --git a/mcp/slack_tool/.dockerignore b/mcp/slack_tool/.dockerignore
diff --git a/mcp/slack_tool/test_startup.exp b/mcp/slack_tool/test_startup.exp
diff --git a/mcp/weather_tool/.dockerignore b/mcp/weather_tool/.dockerignore
diff --git a/mcp/weather_tool/test_startup.exp b/mcp/weather_tool/test_startup.exp

-Original file line number
+Diff line change
@@ @@ -1 +1,4 @@ @@
 -.venv
 +.venv
++
 +# `expect` scripts
 +test_startup.exp