More API spec tests (#64)

Author: metachris

README.md

@@ -39,7 +39,9 @@ go run cmd/httpserver/main.go
 
 ### Using Docker
 
-See instructions on using Docker to run the full stack at [`docs/devenv-setup.md`](./docs/devenv-setup.md)
+- See instructions on using Docker to run the full stack at [`docs/devenv-setup.md`](./docs/devenv-setup.md)
+- Also check out the [`docker-compose.yaml`](../docker/docker-compose.yaml) file, which sets up the BuilderHub, a mock proxy, and a Postgres database.
+- Finally, there's an e2e api spec test suite you can run: [`./scripts/ci/integration-test.sh`](./scripts/ci/integration-test.sh)
 
 ### Example requests
 

scripts/ci/e2e-test.hurl

@@ -37,8 +37,14 @@ POST http://localhost:8081/api/admin/v1/builders
 }
 HTTP 200
 
-# [Admin API] Create (and enable) a new builder configuration
+# [Admin API] Create an empty builder configuration
 POST http://localhost:8081/api/admin/v1/builders/configuration/test_builder
+{
+}
+HTTP 200
+
+# [Admin API] Create the actual builder configuration which is stored in secrets
+POST http://localhost:8081/api/admin/v1/builders/secrets/test_builder
 {
   "rbuilder": {
     "extra_data": "FooBar"
@@ -67,16 +73,15 @@ HTTP 200
 jsonpath "$.[0].ip" == "1.2.3.4"
 jsonpath "$.[0].name" == "test_builder"
 
-# [Builder API] Verify that the builder can get it's configuration (NOT WORKING, TODO)
-#GET http://localhost:8888/api/l1-builder/v1/configuration
-#HTTP 200
-#[Asserts]
-#jsonpath "$.[0].dns_name" == "foobar-v1.a.b.c"
-#jsonpath "$.[0].rbuilder.extra_data" == "FooBar"
-
 #
 # BUILDER APIs (via proxy)
 #
+# [Builder API] Get own configuration
+GET http://localhost:8888/api/l1-builder/v1/configuration
+HTTP 200
+[Asserts]
+jsonpath "$.rbuilder.extra_data" == "FooBar"
+
 # [Builder API] Get the list of peers
 GET http://localhost:8888/api/l1-builder/v1/builders
 HTTP 200

scripts/ci/integration-test.sh

@@ -5,19 +5,35 @@ SCRIPT_DIR=$(dirname "$0")
 cd "$SCRIPT_DIR/../.."
 
 # Build the Docker images
+echo "Building Docker images..."
 docker compose -f docker/docker-compose.yaml build
 
 # Start the Docker containers
+echo "Starting Docker containers..."
 docker compose -f docker/docker-compose.yaml up -d
 
 # Waiting for the service to be ready
 echo "Waiting for containers to be ready..."
 printf 'GET http://localhost:8888/\nHTTP 404' | hurl --retry 60 > /dev/null;
 
+# Waiting 10 more seconds to ensure everything is up
+echo "Waiting for additional 10 seconds..."
+sleep 10
+
 # Run the tests
 echo "Running integration tests..."
+
+# Enable failing for this command
+set +e
 hurl --test scripts/ci/e2e-test.hurl
-echo "Integration tests completed successfully."
+set -e
+
+# Cleanup after tests
+if [ $? -ne 0 ]; then
+    echo "Integration tests failed ❌ - see above for details."
+    docker compose -f docker/docker-compose.yaml down -v
+    exit 1
+fi
 
-# Stop and remove the Docker containers
+echo "Integration tests completed successfully ✅"
 docker compose -f docker/docker-compose.yaml down -v