chore(aio): add simple testinfra test for postgrest

Author: soedirgo

.github/workflows/testinfra.yml

@@ -0,0 +1,29 @@
+name: Testinfra Integration Tests
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        include:
+          - runner: [self-hosted, X64]
+            arch: amd64
+          - runner: arm-runner
+            arch: arm64
+    runs-on: ${{ matrix.runner }}
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v3
+
+      - run: docker context create builders
+      - uses: docker/setup-buildx-action@v3
+        with:
+          endpoint: builders
+
+      - name: Run aio integration tests
+        run: |
+          pip3 install docker pytest pytest-testinfra
+          pytest -vv testinfra/test_all_in_one.py

.gitignore

@@ -5,3 +5,8 @@ venv/
 docker/cache/
 
 ansible/image-manifest*.json
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class

docker/all-in-one/README.md

@@ -5,21 +5,24 @@ All Supabase backend services bundled in a single Docker image for quick local t
 ## Build
 
 ```bash
-docker build . -t supabase/all-in-one
+# cwd: repo root
+docker build -f docker/all-in-one/Dockerfile -t supabase/all-in-one .
 ```
 
 ## Run
 
 ```bash
-docker run --rm \
+docker run --rm -it \
     -e POSTGRES_PASSWORD=postgres \
     -e JWT_SECRET=super-secret-jwt-token-with-at-least-32-characters-long \
     -e ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJhbm9uIiwKICAgICJpc3MiOiAic3VwYWJhc2UtZGVtbyIsCiAgICAiaWF0IjogMTY0MTc2OTIwMCwKICAgICJleHAiOiAxNzk5NTM1NjAwCn0.dc_X5iR_VP_qT0zsiyj_I_OZ2T9FtRU2BBNWN8Bu4GE \
     -e SERVICE_ROLE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJzZXJ2aWNlX3JvbGUiLAogICAgImlzcyI6ICJzdXBhYmFzZS1kZW1vIiwKICAgICJpYXQiOiAxNjQxNzY5MjAwLAogICAgImV4cCI6IDE3OTk1MzU2MDAKfQ.DaYlNEoUrrEn2Ig7tqibS-PHK5vgusbcbo7X36XVt4Q \
     -e ADMIN_API_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoic3VwYWJhc2VfYWRtaW4iLCJpc3MiOiJzdXBhYmFzZS1kZW1vIiwiaWF0IjoxNjQxNzY5MjAwLCJleHAiOjE3OTk1MzU2MDB9.Y9mSNVuTw2TdfryoaqM5wySvwQemGGWfSe9ixcklVfM \
+    -e DATA_VOLUME_MOUNTPOINT=/data \
+    -e MACHINE_TYPE=shared_cpu_1x_512m \
     -p 5432:5432 \
     -p 8000:8000 \
-    -it supabase/all-in-one
+    supabase/all-in-one
 ```
 
 Use bind mount to start from an existing physical backup: `-v $(pwd)/data:/var/lib/postgresql/data`

docker/all-in-one/etc/gotrue.env

@@ -1,3 +1,4 @@
+API_EXTERNAL_URL=api_external_url
 GOTRUE_API_HOST=gotrue_api_host
 GOTRUE_SITE_URL=gotrue_site_url
 GOTRUE_DB_DRIVER=postgres

docker/all-in-one/healthcheck.sh

@@ -37,5 +37,7 @@ fail2ban-client status
 # prometheus exporter up
 curl -sSfI "http://localhost:$PGEXPORTER_PORT/metrics"
 
-# vector is up
-curl -sSfI "http://localhost:$VECTOR_API_PORT/health"
+# vector is up (if starting logflare)
+if [ -n "${LOGFLARE_API_KEY:-}" ]; then
+  curl -sSfI "http://localhost:$VECTOR_API_PORT/health"
+fi

docker/all-in-one/init/configure-gotrue.sh

@@ -5,6 +5,7 @@ touch /var/log/services/gotrue.log
 
 /usr/local/bin/configure-shim.sh /dist/gotrue /opt/gotrue/gotrue
 
+sed -i "s|api_external_url|${API_EXTERNAL_URL:-http://localhost}|g" /etc/gotrue.env
 sed -i "s|gotrue_api_host|${GOTRUE_API_HOST:-0.0.0.0}|g" /etc/gotrue.env
 sed -i "s|gotrue_site_url|$GOTRUE_SITE_URL|g" /etc/gotrue.env
 sed -i "s|gotrue_jwt_secret|$JWT_SECRET|g" /etc/gotrue.env

testinfra/README.md

@@ -0,0 +1,15 @@
+# Testinfra Integration Tests
+
+## Prerequisites
+
+```sh
+pip3 install docker pytest pytest-testinfra
+```
+
+## Running locally
+
+```sh
+# cwd: repo root
+# docker must be running
+pytest -vv testinfra/*.py
+```

testinfra/test_all_in_one.py

@@ -0,0 +1,79 @@
+from docker.models.containers import Container
+from time import sleep
+from typing import cast
+import docker
+import pytest
+import subprocess
+import testinfra
+
+all_in_one_image_tag = "supabase/all-in-one:testinfra"
+all_in_one_envs = {
+    "POSTGRES_PASSWORD": "postgres",
+    "JWT_SECRET": "super-secret-jwt-token-with-at-least-32-characters-long",
+    "ANON_KEY": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJhbm9uIiwKICAgICJpc3MiOiAic3VwYWJhc2UtZGVtbyIsCiAgICAiaWF0IjogMTY0MTc2OTIwMCwKICAgICJleHAiOiAxNzk5NTM1NjAwCn0.dc_X5iR_VP_qT0zsiyj_I_OZ2T9FtRU2BBNWN8Bu4GE",
+    "SERVICE_ROLE_KEY": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyAgCiAgICAicm9sZSI6ICJzZXJ2aWNlX3JvbGUiLAogICAgImlzcyI6ICJzdXBhYmFzZS1kZW1vIiwKICAgICJpYXQiOiAxNjQxNzY5MjAwLAogICAgImV4cCI6IDE3OTk1MzU2MDAKfQ.DaYlNEoUrrEn2Ig7tqibS-PHK5vgusbcbo7X36XVt4Q",
+    "ADMIN_API_KEY": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoic3VwYWJhc2VfYWRtaW4iLCJpc3MiOiJzdXBhYmFzZS1kZW1vIiwiaWF0IjoxNjQxNzY5MjAwLCJleHAiOjE3OTk1MzU2MDB9.Y9mSNVuTw2TdfryoaqM5wySvwQemGGWfSe9ixcklVfM",
+    "DATA_VOLUME_MOUNTPOINT": "/data",
+    "MACHINE_TYPE": "shared_cpu_1x_512m",
+}
+
+# TODO: spin up local Logflare for Vector tests.
+
+
+# scope='session' uses the same container for all the tests;
+# scope='function' uses a new container per test function.
+@pytest.fixture(scope="session")
+def host(request):
+    # We build the image with the Docker CLI in path instead of using docker-py
+    # (official Docker SDK for Python) because the latter doesn't use BuildKit,
+    # so things like `ARG TARGETARCH` don't work:
+    # - https://github.com/docker/docker-py/issues/2230
+    # - https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope
+    subprocess.check_call(
+        [
+            "docker",
+            "buildx",
+            "build",
+            "--file",
+            "docker/all-in-one/Dockerfile",
+            "--load",
+            "--tag",
+            all_in_one_image_tag,
+            ".",
+        ]
+    )
+
+    docker_client = docker.from_env()
+    container = cast(
+        Container,
+        docker_client.containers.run(
+            all_in_one_image_tag,
+            detach=True,
+            environment=all_in_one_envs,
+            ports={
+                "5432/tcp": 5432,
+                "8000/tcp": 8000,
+            },
+        ),
+    )
+
+    def get_health(container: Container) -> str:
+        inspect_results = docker_client.api.inspect_container(container.name)
+        return inspect_results["State"]["Health"]["Status"]
+
+    while True:
+        health = get_health(container)
+        if health == "healthy":
+            break
+        sleep(1)
+
+    # return a testinfra connection to the container
+    yield testinfra.get_host("docker://" + cast(str, container.name))
+
+    # at the end of the test suite, destroy the container
+    container.remove(v=True, force=True)
+
+
+def test_postgrest_service(host):
+    postgrest = host.supervisor("services:postgrest")
+    assert postgrest.is_running