chore: adds api functional testing to CI

.github/workflows/validate-n-build-api.yml

@@ -23,7 +23,6 @@ jobs:
           filters: |
             api:
               - 'apps/api/**'
-              - 'packages/database/**'
 
       - name: Setup Node.js
         if: steps.filter.outputs.api == 'true'
@@ -54,6 +53,15 @@ jobs:
         if: steps.filter.outputs.api == 'true'
         run: npm run test:unit --workspace=apps/api
 
+      - name: Run functional tests
+        if: steps.filter.outputs.api == 'true'
+        env:
+          POSTGRES_SKIP_IMPORT: true
+        run: |
+          npm run dc:up:db
+          npm run test:functional --workspace=apps/api
+          npm run dc:down
+
       - name: Build the Docker image for API
         if: steps.filter.outputs.api == 'true'
         run: packages/docker/script/dc.sh build api

apps/api/README.md

@@ -73,6 +73,10 @@ src/
       myComponent.spec.ts
 ```
 
+#### Functional Tests Wallet
+
+Functional tests rely on a sandbox akash wallet: *akash1fq8fhssjs0w8x9ysggrm4r8x26522elefm737l*. If your workflow starts failing, make sure the wallet is funded and has enough tokens to cover the costs. It can be refilled via https://faucet.sandbox-01.aksh.pw 
+
 ## Changes from **beta** to **v1** (February 2024)
 
 ### Api Versioning

apps/api/package.json

@@ -25,9 +25,9 @@
     "start": "webpack --config webpack.dev.js --watch",
     "test": "jest --selectProjects unit functional",
     "test:cov": "jest --selectProjects unit functional --coverage",
-    "test:functional": "jest --selectProjects functional",
-    "test:functional:cov": "jest --selectProjects functional --coverage",
-    "test:functional:watch": "jest --selectProjects functional --watch",
+    "test:functional": "jest --selectProjects functional --runInBand",
+    "test:functional:cov": "npm run test:functional -- --coverage",
+    "test:functional:watch": "npm run test:functional -- --watch",
     "test:unit": "jest --selectProjects unit",
     "test:unit:cov": "jest --selectProjects unit --coverage",
     "test:unit:watch": "jest --selectProjects unit --watch",

packages/docker/.env.sandbox.docker-compose-dev

@@ -23,5 +23,7 @@ ActiveChain=akashSandbox
 # DB
 POSTGRES_USER: postgres
 POSTGRES_PASSWORD: password
+POSTGRES_DBS: console-users,console-akash-sandbox
+POSTGRES_SKIP_IMPORT: ${POSTGRES_SKIP_IMPORT:-false}
 POSTGRES_DBS_FOR_IMPORT: console-akash-sandbox
 POSTGRES_USERS_DB: console-users

packages/docker/script/prepare-and-seed-postgres.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-echo "DB_SEEDER: Importing databases from cloud storage..."
+echo "DB_SEEDER: Setting up databases..."
 
 BASE_URL="https://storage.googleapis.com/console-postgresql-backups"
 
@@ -14,39 +14,48 @@ if [ -z "${POSTGRES_PASSWORD:-}" ]; then
     exit 1
 fi
 
-if [ -z "${POSTGRES_DBS_FOR_IMPORT:-}" ]; then
-    echo "DB_SEEDER: POSTGRES_DBS_FOR_IMPORT is not set. Skipping seeding."
-    exit 1
-fi
-
-if [ -z "${POSTGRES_USERS_DB:-}" ]; then
-    echo "DB_SEEDER: POSTGRES_USERS_DB is not set. Skipping seeding."
+if [ -z "${POSTGRES_DBS:-}" ]; then
+    echo "DB_SEEDER: POSTGRES_DBS is not set. Skipping seeding."
     exit 1
 fi
 
 export PGUSER=$POSTGRES_USER
 export PGPASSWORD=$POSTGRES_PASSWORD
 
-psql -c "CREATE DATABASE \"$POSTGRES_USERS_DB\""
-
+# Step 1: Create all databases from POSTGRES_DBS
 old_IFS=$IFS
 IFS=','
-
-for dbname in $POSTGRES_DBS_FOR_IMPORT; do
-    url="${BASE_URL}/${dbname}.sql.gz"
-    echo "DB_SEEDER: Importing \"$dbname\""
-
-    if ! psql -c "CREATE DATABASE \"$dbname\""; then
-        echo "DB_SEEDER: Failed to create database \"$dbname\""
-        exit 1
-    fi
-
-    if ! curl -s -S -L "$url" | gunzip | psql "$dbname"; then
-        echo "DB_SEEDER: Failed to download and import \"$url\""
-        exit 1
+for dbname in $POSTGRES_DBS; do
+    echo "DB_SEEDER: Creating database \"$dbname\""
+    if ! psql -c "CREATE DATABASE \"$dbname\"" 2>/dev/null; then
+        echo "DB_SEEDER: Database \"$dbname\" already exists or failed to create"
     fi
 done
 
+# Step 2: Import data for specified databases if POSTGRES_SKIP_IMPORT is not "true"
+if [ "${POSTGRES_SKIP_IMPORT:-false}" != "true" ] && [ -n "${POSTGRES_DBS_FOR_IMPORT:-}" ]; then
+    for dbname in $POSTGRES_DBS_FOR_IMPORT; do
+        url="${BASE_URL}/${dbname}.sql.gz"
+        echo "DB_SEEDER: Importing \"$dbname\""
+
+        # Create database if it doesn't exist
+        if ! psql -lqt | cut -d \| -f 1 | grep -qw "$dbname"; then
+            echo "DB_SEEDER: Database \"$dbname\" doesn't exist, creating..."
+            if ! psql -c "CREATE DATABASE \"$dbname\""; then
+                echo "DB_SEEDER: Failed to create database \"$dbname\""
+                exit 1
+            fi
+        fi
+
+        if ! curl -s -S -L "$url" | gunzip | psql "$dbname"; then
+            echo "DB_SEEDER: Failed to download and import \"$url\""
+            exit 1
+        fi
+    done
+else
+    echo "DB_SEEDER: Skipping import step"
+fi
+
 IFS=$old_IFS
 
 touch /var/lib/postgresql/data/init-complete