Merge pull request #3628 from IntersectMBO/feat/nightly-preview-test-run

Feat: nightly preview test run

Author: kneerose

.github/scripts/register_report.sh

@@ -10,6 +10,6 @@ if grep -q "$REPORT_NAME" "$PROJECT_DIR/$PROJECT_FILE"; then
   echo "Project already exists"
   echo "project_exists=true">> $GITHUB_OUTPUT
 else
-  echo "$REPORT_NAME" >> "$PROJECT_DIR/$PROJECT_FILE"
+  echo "\n$REPORT_NAME" >> "$PROJECT_DIR/$PROJECT_FILE"
   echo "project_exists=false">> $GITHUB_OUTPUT
 fi

.github/scripts/remove_oldest_report.sh

@@ -2,14 +2,21 @@
 
 if [ -d "gh-pages/$REPORT_NAME" ]; then
     cd gh-pages/$REPORT_NAME
-    # Find the oldest numerical directory
-    oldest_dir=$(find . -maxdepth 1 -type d -regex './[0-9]+' | sort -n | head -1)
-    if [ -n "$oldest_dir" ]; then
-        echo "Removing oldest report directory: $oldest_dir"
-        rm -rf "$oldest_dir"
+    
+    # Count the number of numerical directories
+    dir_count=$(find . -maxdepth 1 -type d -regex './[0-9]+' | wc -l)
+    
+    if [ "$dir_count" -gt 10 ]; then
+        # Find the oldest numerical directory
+        oldest_dir=$(find . -maxdepth 1 -type d -regex './[0-9]+' | sort -V | head -1)
+        if [ -n "$oldest_dir" ]; then
+            echo "More than 10 report directories exist. Removing oldest: $oldest_dir"
+            rm -rf "$oldest_dir"
+        fi
     else
-        echo "No report directories found to remove"
+        echo "Only $dir_count report directories exist (threshold: 10). Nothing to remove."
     fi
+    
     cd ../../
 else
     echo "Report directory does not exist yet"

.github/workflows/test_backend.yml

@@ -16,6 +16,7 @@ on:
           - "sanchogov.tools/api"
           - "staging.govtool.byron.network/api"
           - "govtool.cardanoapi.io/api"
+          - "be.preview.gov.tools"
           - "z6b8d2f7a-zca4a4c45-gtw.z937eb260.rustrocks.fr"
           - "z78acf3c2-z5575152b-gtw.z937eb260.rustrocks.fr"
           - "be.gov.tools"
@@ -28,21 +29,25 @@ on:
           - "preview"
           - "mainnet"
           - "preprod"
+
   workflow_run:
     workflows: ["Build and deploy GovTool test stack"]
     types: [completed]
     branches: 
       - test
       - infra/test-chores
 
+  schedule:
+    - cron: "0 0 * * *" # 12AM UTC
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: false
 
 jobs:
   backend-tests:
     runs-on: ubuntu-latest
-    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' || github.event.schedule }}
     outputs:
       start_time: ${{ steps.set-pending-status.outputs.timestamp }}
       status: ${{ steps.run-tests.outcome }}
@@ -115,7 +120,7 @@ jobs:
           path: gh-pages
           repository: ${{vars.GH_PAGES}}
           ssh-key: ${{ secrets.DEPLOY_KEY }}
-        
+
       - name: Remove oldest report to save space
         if: ${{success()}}
         run: |
@@ -128,6 +133,7 @@ jobs:
         run: |
           chmod +x .github/scripts/register_report.sh
           .github/scripts/register_report.sh
+
       - if: steps.register-project.outputs.project_exists != 'true'
         uses: JamesIves/github-pages-deploy-action@v4
         with:
@@ -191,7 +197,7 @@ jobs:
           GITHUB_TOKEN: ${{ github.token }}
 
 env:
-  BASE_URL: https://${{inputs.deployment ||  'govtool.cardanoapi.io/api' }}
-  REPORT_NAME: govtool-backend
+  BASE_URL: https://${{github.event.schedule && 'be.preview.gov.tools' || inputs.deployment ||  'govtool.cardanoapi.io/api' }}
+  REPORT_NAME: ${{ github.event.schedule && 'nightly-'}}govtool-backend
   GH_PAGES: ${{vars.GH_PAGES}}
   COMMIT_SHA: ${{ github.event.workflow_run.head_sha || github.sha }}

.github/workflows/test_integration_playwright.yml

@@ -37,14 +37,17 @@ on:
       - test
       - infra/test-chores
 
+  schedule:
+    - cron: "0 0 * * *" # 12AM UTC
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: false
 
 jobs:
   integration-tests:
     runs-on: ubuntu-latest
-    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' || github.event.schedule }}
     outputs:
       start_time: ${{ steps.set-pending-status.outputs.timestamp }}
       status: ${{ steps.run-test.outcome }}
@@ -103,6 +106,11 @@ jobs:
             export BLOCKFROST_API_KEY="${{ secrets.BLOCKFROST_API_KEY_MAINNET }}"
           fi
 
+          # Set schedule workflow variable
+          if [[ "$GITHUB_EVENT_NAME" == "schedule" ]]; then
+            export SCHEDULED_WORKFLOW="true"
+          fi
+
           npm run test:headless
 
       - name: Upload report
@@ -165,7 +173,7 @@ jobs:
         run: |
           chmod +x .github/scripts/register_report.sh
           .github/scripts/register_report.sh
-          
+
       - if: steps.register-project.outputs.project_exists != 'true'
         uses: JamesIves/github-pages-deploy-action@v4
         with:
@@ -229,7 +237,7 @@ jobs:
           REPORT_NUMBER: ${{ needs.publish-report.outputs.report_number }}
           GITHUB_TOKEN: ${{ github.token }}
 env:
-  HOST_URL: https://${{inputs.deployment ||  'govtool.cardanoapi.io' }}
-  REPORT_NAME: govtool-frontend
+  HOST_URL: https://${{ github.event.schedule && 'preview.gov.tools' || (inputs.deployment || 'govtool.cardanoapi.io')  }}
+  REPORT_NAME: ${{ github.event.schedule && 'nightly-'}}govtool-frontend
   GH_PAGES: ${{vars.GH_PAGES}}
   COMMIT_SHA: ${{ github.event.workflow_run.head_sha || github.sha }}

tests/govtool-frontend/playwright/lib/constants/environments.ts

@@ -28,6 +28,10 @@ const environments = {
   metadataBucketUrl: `${CARDANO_API_METADATA_HOST_URL}/data`,
   lockInterceptorUrl: `${CARDANO_API_METADATA_HOST_URL}/lock`,
   ci: process.env.CI,
+  isScheduled:
+    (process.env.SCHEDULED_WORKFLOW &&
+      process.env.SCHEDULED_WORKFLOW == "true") ||
+    false,
 };
 
 export default environments;

tests/govtool-frontend/playwright/lib/helpers/cardano.ts

@@ -85,3 +85,10 @@ export async function getWalletBalance(address: string) {
 
   return balance;
 }
+
+export async function skipIfScheduledWorkflow() {
+  if (environments.isScheduled) {
+    await allure.description("This test is skipped in scheduled workflow.");
+    test.skip();
+  }
+}

tests/govtool-frontend/playwright/tests/7-proposal-submission/proposalSubmission.ga.spec.ts

@@ -9,6 +9,7 @@ import ProposalSubmissionPage from "@pages/proposalSubmissionPage";
 import { expect } from "@playwright/test";
 import {
   skipIfMainnet,
+  skipIfScheduledWorkflow,
   skipIfTemporyWalletIsNotAvailable,
 } from "@helpers/cardano";
 import { ProposalType } from "@types";
@@ -31,6 +32,7 @@ Object.values(ProposalType).forEach((proposalType, index) => {
     page,
     browser,
   }, testInfo) => {
+    await skipIfScheduledWorkflow();
     test.setTimeout(testInfo.timeout + environments.txTimeOut);
 
     const wallet = await walletManager.popWallet("proposalSubmission");

tests/govtool-frontend/playwright/tests/proposal.setup.ts

@@ -9,7 +9,7 @@ import walletManager from "lib/walletManager";
 import { functionWaitedAssert } from "@helpers/waitedLoop";
 import { getWalletConfigForFaucet } from "@helpers/index";
 
-const PROPOSAL_WALLETS_COUNT = 5;
+const PROPOSAL_WALLETS_COUNT = environments.isScheduled ? 1 : 5;
 
 let govActionDeposit: number;