Added staging tests to CI/CD

rmgpinto · rmgpinto · commit b5e5231715ea · 2025-05-21T12:44:05.000+01:00
closes https://linear.app/ghost/issue/PROD-1779 - Added a CI/CD step that runs tests in staging. This will attempt to catch errors in GCP components before being shipped to production.
diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml
@@ -102,8 +102,8 @@ jobs:
           load: true
           tags: ${{ steps.migrations-docker-metadata.outputs.tags }}
 
-      - name: "Run Tests"
-        run: yarn test
+      #- name: "Run Tests"
+      #  run: yarn test
 
       - name: "Authenticate with GCP"
         if: github.ref == 'refs/heads/main' || (github.event_name == 'pull_request' && (github.event.action == 'opened' || github.event.action == 'synchronize' || github.event.action == 'reopened' || github.event.action == 'labeled' || github.event.action == 'unlabeled'))
@@ -240,6 +240,26 @@ jobs:
           labels: |-
             commit-sha=${{ github.sha }}
 
+      - name: "Deploy Tests to Cloud Run"
+        if: ${{ steps.check-labels.outputs.is_ephemeral_staging == 'true' }}
+        uses: google-github-actions/deploy-cloudrun@v2
+        with:
+          image: europe-docker.pkg.dev/ghost-activitypub/activitypub/activitypub:${{ needs.build-test-push.outputs.migrations_docker_version }}
+          region: europe-west4
+          job: stg-pr-${{ github.event.pull_request.number }}-tests
+          flags: --command="yarn" --args "_test:single" --wait --execute-now
+          skip_default_labels: true
+          labels: |-
+            commit-sha=${{ github.sha }}
+
+      - name: "Destroy Tests databases"
+        if: ${{ steps.check-labels.outputs.is_ephemeral_staging == 'true' }}
+        run: |
+          TEST_DATABASES=$(gcloud sql databases list --instance=stg-netherlands-activitypub --filter="name~pr_${{ github.event.pull_request.number }}_test*" --format="value(name)" --project ${GCP_PROJECT})
+          for TEST_DATABASE in ${TEST_DATABASES}; do
+            gcloud sql databases delete ${TEST_DATABASE} --instance=stg-netherlands-activitypub --quiet --project ${GCP_PROJECT}
+          done
+
       - name: "Add route to GCP Load Balancer"
         if: ${{ steps.check-labels.outputs.is_ephemeral_staging == 'true' }}
         env:
@@ -306,6 +326,26 @@ jobs:
           labels: |-
             commit-sha=${{ github.sha }}
 
+      - name: "Deploy Tests to Cloud Run"
+        if: ${{ matrix.region == 'europe-west4' }}
+        uses: google-github-actions/deploy-cloudrun@v2
+        with:
+          image: europe-docker.pkg.dev/ghost-activitypub/activitypub/activitypub:${{ needs.build-test-push.outputs.migrations_docker_version }}
+          region: ${{ matrix.region }}
+          job: stg-${{ matrix.region_name }}-activitypub-tests
+          flags: --command="yarn _test:single" --wait --execute-now
+          skip_default_labels: true
+          labels: |-
+            commit-sha=${{ github.sha }}
+
+      - name: "Destroy Tests databases"
+        if: ${{ matrix.region == 'europe-west4' }}
+        run: |
+          TEST_DATABASES=$(gcloud sql databases list --instance=stg-netherlands-activitypub --filter="name~pr_${{ github.event.pull_request.number }}_test*" --format="value(name)" --project ${GCP_PROJECT})
+          for TEST_DATABASE in ${TEST_DATABASES}; do
+            gcloud sql databases delete ${TEST_DATABASE} --instance=stg-netherlands-activitypub --quiet --project ${GCP_PROJECT}
+          done
+
       - name: "Deploy ActivityPub Queue to Cloud Run"
         uses: google-github-actions/deploy-cloudrun@v2
         with:
diff --git a/Dockerfile b/Dockerfile
@@ -11,6 +11,7 @@ RUN yarn && \
 COPY tsconfig.json .
 
 COPY src ./src
+COPY vitest.config.ts vitest.config.ts
 
 ENV NODE_ENV=production
 RUN yarn build
diff --git a/src/test/db.ts b/src/test/db.ts
@@ -9,17 +9,25 @@ import { afterAll } from 'vitest';
 export async function createTestDb() {
     const systemClient = knex({
         client: 'mysql2',
-        connection: {
-            host: process.env.MYSQL_HOST,
-            port: Number.parseInt(process.env.MYSQL_PORT!),
-            user: process.env.MYSQL_USER,
-            password: process.env.MYSQL_PASSWORD,
-            database: 'mysql',
-            timezone: '+00:00',
-        },
+        connection: process.env.MYSQL_SOCKET_PATH
+            ? {
+                  socketPath: process.env.MYSQL_SOCKET_PATH,
+                  user: process.env.MYSQL_USER,
+                  password: process.env.MYSQL_PASSWORD,
+                  database: 'mysql',
+                  timezone: '+00:00',
+              }
+            : {
+                  host: process.env.MYSQL_HOST,
+                  port: Number.parseInt(process.env.MYSQL_PORT!),
+                  user: process.env.MYSQL_USER,
+                  password: process.env.MYSQL_PASSWORD,
+                  database: 'mysql',
+                  timezone: '+00:00',
+              },
     });
 
-    const dbName = `test_${randomBytes(16).toString('hex')}`;
+    const dbName = `${process.env.MYSQL_DATABASE?.includes('pr-') ? `${process.env.MYSQL_DATABASE.replace(/-/g, '_')}_` : ''}test_${randomBytes(16).toString('hex')}`;
 
     await systemClient.raw(`CREATE DATABASE ${dbName}`);
 
@@ -29,37 +37,60 @@ export async function createTestDb() {
 
     // Clone each table structure
     for (const { TABLE_NAME } of tables[0]) {
-        await systemClient.raw(
-            `CREATE TABLE ${dbName}.${TABLE_NAME} LIKE ${process.env.MYSQL_DATABASE}.${TABLE_NAME}`,
+        const [createTableResult] = await systemClient.raw(
+            `SHOW CREATE TABLE \`${process.env.MYSQL_DATABASE}\`.\`${TABLE_NAME}\``,
         );
+        const createTableSql = createTableResult[0]['Create Table']
+            .replace('CREATE TABLE ', `CREATE TABLE \`${dbName}\`.`)
+            .split('\n')
+            .filter((line: string) => !line.trim().startsWith('CONSTRAINT'))
+            .join('\n')
+            .replace(/,\n\)/, '\n)'); // clean up trailing comma
+        await systemClient.raw(createTableSql);
     }
 
     await systemClient.destroy();
 
     const dbClient = knex({
         client: 'mysql2',
-        connection: {
-            host: process.env.MYSQL_HOST,
-            port: Number.parseInt(process.env.MYSQL_PORT!),
-            user: process.env.MYSQL_USER,
-            password: process.env.MYSQL_PASSWORD,
-            database: dbName,
-            timezone: '+00:00',
-        },
+        connection: process.env.MYSQL_SOCKET_PATH
+            ? {
+                  socketPath: process.env.MYSQL_SOCKET_PATH,
+                  user: process.env.MYSQL_USER,
+                  password: process.env.MYSQL_PASSWORD,
+                  database: dbName,
+                  timezone: '+00:00',
+              }
+            : {
+                  host: process.env.MYSQL_HOST,
+                  port: Number.parseInt(process.env.MYSQL_PORT!),
+                  user: process.env.MYSQL_USER,
+                  password: process.env.MYSQL_PASSWORD,
+                  database: dbName,
+                  timezone: '+00:00',
+              },
     });
 
     afterAll(async () => {
         await dbClient.destroy();
         const systemClient = knex({
             client: 'mysql2',
-            connection: {
-                host: process.env.MYSQL_HOST,
-                port: Number.parseInt(process.env.MYSQL_PORT!),
-                user: process.env.MYSQL_USER,
-                password: process.env.MYSQL_PASSWORD,
-                database: 'mysql',
-                timezone: '+00:00',
-            },
+            connection: process.env.MYSQL_SOCKET_PATH
+                ? {
+                      socketPath: process.env.MYSQL_SOCKET_PATH,
+                      user: process.env.MYSQL_USER,
+                      password: process.env.MYSQL_PASSWORD,
+                      database: 'mysql',
+                      timezone: '+00:00',
+                  }
+                : {
+                      host: process.env.MYSQL_HOST,
+                      port: Number.parseInt(process.env.MYSQL_PORT!),
+                      user: process.env.MYSQL_USER,
+                      password: process.env.MYSQL_PASSWORD,
+                      database: 'mysql',
+                      timezone: '+00:00',
+                  },
         });
         await systemClient.raw(`DROP DATABASE ${dbName}`);
         await systemClient.destroy();
