ci: test postgres

Author: ValuedMammal

.github/workflows/rust.yml

@@ -1,18 +1,100 @@
-name: Rust
+name: CI
 
 on:
   push:
     branches: [ "master" ]
+  
   pull_request:
-    branches: [ "master" ]
+      types: [ opened, synchronize, reopened ]
+      branches:
+        - master
 
 env:
   CARGO_TERM_COLOR: auto
+  SQLX_VERSION: 0.8.2
+  SQLX_FEATURES: "rustls,postgres"
 
 jobs:
-  build:
+  build-test:
+    name: Build + Test
     runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: postgres
+        ports:
+          - 5432:5432
+    #   redis:
+    #     image: redis:7
+    #     ports:
+    #       - 6379:6379
     steps:
-    - uses: actions/checkout@v4
-    - name: Check
-      run: cargo check
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: sqlx-${{ env.SQLX_VERSION }}
+      - name: Install sqlx-cli
+        run:
+            cargo install sqlx-cli
+            --version=${{ env.SQLX_VERSION }}
+            --no-default-features
+            --features ${{ env.SQLX_FEATURES }}
+            --locked
+      - name: Migrate database
+        run: |
+          sudo apt-get install libpq-dev -y
+          ./ci/init_db.sh
+    #   - name: Check sqlx-data.json is up-to-date
+    #     run: |
+    #       cargo sqlx prepare --workspace --check
+      - name: Test
+        run: cargo test
+
+#   fmt:
+#     name: Rustfmt
+#     runs-on: ubuntu-latest
+#     steps:
+#       - uses: actions/checkout@v3
+#       - uses: dtolnay/rust-toolchain@stable
+#         with:
+#           components: rustfmt
+#       - name: Check fmt
+#         run: cargo fmt --check
+
+#   clippy:
+#     name: Clippy
+#     runs-on: ubuntu-latest
+#     services:
+#       postgres:
+#         image: postgres:14
+#         env:
+#           POSTGRES_USER: postgres
+#           POSTGRES_PASSWORD: password
+#           POSTGRES_DB: postgres
+#         ports:
+#           - 5432:5432
+#     steps:
+#       - uses: actions/checkout@v3
+#       - uses: dtolnay/rust-toolchain@stable
+#         with:
+#           components: clippy
+#       - uses: Swatinem/rust-cache@v2
+#         with:
+#           key: sqlx-${{ env.SQLX_VERSION }}
+#       - name: Install sqlx-cli
+#         run:
+#           cargo install sqlx-cli
+#             --version=${{ env.SQLX_VERSION }}
+#             --features ${{ env.SQLX_FEATURES }}
+#             --no-default-features
+#             --locked
+#       - name: Migrate database
+#         run: |
+#           sudo apt-get install libpq-dev -y
+#           SKIP_DOCKER=true ./scripts/init_db.sh
+#       - name: Linting
+#         run: cargo clippy -- -D warnings

ci/init_db.sh

@@ -0,0 +1,64 @@
+#!/usr/bin/env bash
+set -x
+set -eo pipefail
+
+if ! [ -x "$(command -v psql)" ]; then
+  echo >&2 "Error: psql is not installed."
+  exit 1
+fi
+
+if ! [ -x "$(command -v sqlx)" ]; then
+  echo >&2 "Error: sqlx is not installed."
+  echo >&2 "Use:"
+  echo >&2 "    cargo install --version='~0.8' sqlx-cli --no-default-features --features rustls,postgres"
+  echo >&2 "to install it."
+  exit 1
+fi
+
+# Check if a custom user has been set, otherwise default to 'postgres'
+DB_USER="${POSTGRES_USER:=postgres}"
+# Check if a custom password has been set, otherwise default to 'password'
+DB_PASSWORD="${POSTGRES_PASSWORD:=password}"
+# Check if a custom database name has been set, otherwise default to 'bdk_wallet'
+DB_NAME="${POSTGRES_DB:=bdk_wallet}"
+# Check if a custom port has been set, otherwise default to '5432'
+DB_PORT="${POSTGRES_PORT:=5432}"
+# Check if a custom host has been set, otherwise default to 'localhost'
+DB_HOST="${POSTGRES_HOST:=localhost}"
+
+# Allow to skip Docker if a dockerized Postgres database is already running
+# if [[ -z "${SKIP_DOCKER}" ]]
+# then
+#   # if a postgres container is running, print instructions to kill it and exit
+#   RUNNING_POSTGRES_CONTAINER=$(docker ps --filter 'name=postgres' --format '{{.ID}}')
+#   if [[ -n $RUNNING_POSTGRES_CONTAINER ]]; then
+#     echo >&2 "there is a postgres container already running, kill it with"
+#     echo >&2 "    docker kill ${RUNNING_POSTGRES_CONTAINER}"
+#     exit 1
+#   fi
+#   # Launch postgres using Docker
+#   docker run \
+#       -e POSTGRES_USER=${DB_USER} \
+#       -e POSTGRES_PASSWORD=${DB_PASSWORD} \
+#       -e POSTGRES_DB=${DB_NAME} \
+#       -p "${DB_PORT}":5432 \
+#       -d \
+#       --name "postgres_$(date '+%s')" \
+#       postgres -N 1000
+#       # ^ Increased maximum number of connections for testing purposes
+# fi
+
+# Keep pinging Postgres until it's ready to accept commands
+until PGPASSWORD="${DB_PASSWORD}" psql -h "${DB_HOST}" -U "${DB_USER}" -p "${DB_PORT}" -d "postgres" -c '\q'; do
+  >&2 echo "Postgres is still unavailable - sleeping"
+  sleep 1
+done
+
+>&2 echo "Postgres is up and running on port ${DB_PORT} - running migrations."
+
+export DATABASE_URL=postgres://${DB_USER}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}
+export DATABASE_TEST_URL=$DATABASE_URL
+sqlx database create
+sqlx migrate run --source ./db/migrations
+
+>&2 echo "Completed migration."