[CI] Added API spec tests (#61)

## 📝 Summary

Adding CI API spec tests to prevent future regressions.

Basic plumbing in this PR, more tests coming in follow-up PR(s).

Tests using Hurl:
- https://github.com/Orange-OpenSource/hurl
- https://hurl.dev/

Author: metachris

.github/workflows/checks.yml

@@ -33,7 +33,7 @@ jobs:
         id: go
 
       - name: Check out code into the Go module directory
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run migrations
         run: for file in schema/*.sql; do psql "postgres://postgres:postgres@localhost:5432/postgres?sslmode=disable" -f $file; done
@@ -52,7 +52,7 @@ jobs:
         id: go
 
       - name: Check out code into the Go module directory
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Install gofumpt
         run: go install mvdan.cc/gofumpt@v0.4.0
@@ -74,3 +74,25 @@ jobs:
           go mod tidy
           git update-index -q --really-refresh
           git diff-index HEAD
+
+  integration-test:
+    name: Integration Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ^1.24
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Compose
+        uses: docker/setup-compose-action@v1
+
+      - name: Integration test
+        run: |
+          curl --location --remote-name https://github.com/Orange-OpenSource/hurl/releases/download/6.1.1/hurl_6.1.1_amd64.deb
+          sudo dpkg -i hurl_6.1.1_amd64.deb
+          ./scripts/ci/integration-test.sh

docker/docker-compose.yaml

@@ -1,6 +1,9 @@
 services:
   db:
     image: flashbots/builder-hub-db
+    build:
+      context: ../.
+      dockerfile: docker/database/Dockerfile
     ports:
       - 127.0.0.1:5432:5432
     environment:
@@ -17,6 +20,9 @@ services:
 
   web:
     image: flashbots/builder-hub
+    build:
+      context: ../.
+      dockerfile: docker/httpserver/Dockerfile
     depends_on:
       db:
         condition: service_healthy

docs/devenv-setup.md

@@ -67,14 +67,14 @@ curl -v \
   --data '{
   "name": "test_builder",
   "ip_address": "1.2.3.4",
+  "dns_name": "foobar-v1.a.b.c",
   "network": "production"
 }'
 
 # 3. Create (and enable) a new builder configuration
 curl -v \
   --url http://localhost:8081/api/admin/v1/builders/configuration/test_builder \
   --data '{
-  "dns_name": "foobar-v1.a.b.c",
   "rbuilder": {
     "extra_data": "FooBar"
   }

scripts/ci/README.md

@@ -0,0 +1 @@
+API tests using https://hurl.dev

scripts/ci/integration-test.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+set -eu
+
+SCRIPT_DIR=$(dirname "$0")
+cd "$SCRIPT_DIR/../.."
+
+# Build the Docker images
+docker compose -f docker/docker-compose.yaml build
+
+# Start the 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;
+
+# Run the tests
+echo "Running integration tests..."
+hurl --test scripts/ci/setup.hurl
+echo "Integration tests completed successfully."
+
+# Stop and remove the Docker containers
+docker compose -f docker/docker-compose.yaml down -v

scripts/ci/setup.hurl

@@ -0,0 +1,97 @@
+#
+# MEASUREMENTS SETUP
+#
+# [Admin API] Create a new measurement
+POST http://localhost:8081/api/admin/v1/measurements
+{
+  "measurement_id": "test1",
+  "attestation_type": "test",
+  "measurements": {}
+}
+HTTP 200
+
+# [Admin API] Enable the measurement
+POST http://localhost:8081/api/admin/v1/measurements/activation/test1
+{
+  "enabled": true
+}
+HTTP 200
+
+# [Internal API] Verify that the measurement is now available
+GET http://localhost:8082/api/l1-builder/v1/measurements
+HTTP 200
+[Asserts]
+jsonpath "$.[0].measurement_id" == "test1"
+jsonpath "$.[0].attestation_type" == "test"
+
+#
+# BUILDER SETUP
+#
+# [Admin API] Create a new builder instance (with IP address 1.2.3.4, which is fixed in the mock-proxy)
+POST http://localhost:8081/api/admin/v1/builders
+{
+  "name": "test_builder",
+  "ip_address": "1.2.3.4",
+  "dns_name": "foobar-v1.a.b.c",
+  "network": "production"
+}
+HTTP 200
+
+# [Admin API] Create (and enable) a new builder configuration
+POST http://localhost:8081/api/admin/v1/builders/configuration/test_builder
+{
+  "rbuilder": {
+    "extra_data": "FooBar"
+  }
+}
+HTTP 200
+
+# [Admin API] Enable the new builder instance
+POST http://localhost:8081/api/admin/v1/builders/activation/test_builder
+{
+  "enabled": true
+}
+HTTP 200
+
+# [Internal API] Get the list of peers
+GET http://localhost:8080/api/internal/l1-builder/v1/builders
+HTTP 200
+[Asserts]
+jsonpath "$.[0].ip" == "1.2.3.4"
+jsonpath "$.[0].name" == "test_builder"
+
+# [Internal API] Get the list of peers (v2)
+GET http://localhost:8080/api/internal/l1-builder/v2/network/production/builders
+HTTP 200
+[Asserts]
+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 the list of peers
+GET http://localhost:8888/api/l1-builder/v1/builders
+HTTP 200
+[Asserts]
+jsonpath "$.[0].ip" == "1.2.3.4"
+jsonpath "$.[0].name" == "test_builder"
+
+# [Builder API] Register credentials for 'rbuilder' service
+#POST http://localhost:8888/api/l1-builder/v1/register_credentials/rbuilder
+#{
+#  "ecdsa_pubkey_address": "0x321f3426eEc20DE1910af1CD595c4DD83BEA0BA5"
+#}
+
+## [Builder API] List of peers now includes the added credentials
+#GET http://localhost:8888/api/l1-builder/v1/builders
+#HTTP 200
+#[Asserts]
+#jsonpath "$.[0].rbuilder.ecdsa_pubkey_address" == "0x321f3426eec20de1910af1cd595c4dd83bea0ba5"