testing.js.yml

name: Testing
on:
  push:
    branches:
      - master
  pull_request:
  workflow_dispatch:
    inputs:
      useRealFrontend:
        description: If true, test the frontend inside the backend
        type: boolean
        default: false
        required: true
      mergeMasterToBranch:
        description: If true, the checkout-out backend is merged with the backend master
        type: boolean
        default: false
        required: true
      frontendCommitToCheckout:
        description: Tag or branch of ladybug-frontend to check out - timestamp releases are not tagged
        required: false
      backendCommitToCheckout:
        description: Tag or branch of the backend to test against
        required: false

jobs:
  testing:
    name: Unit tests
    runs-on: ubuntu-latest

    steps:
      - name: Echo inputs
        run: echo "useRealFrontend=${{ github.event.inputs.useRealFrontend}}, mergeMasterToBranch=${{ github.event.inputs.mergeMasterToBranch}}, frontendCommitToCheckout=${{ github.event.inputs.frontendCommitToCheckout}}, backendCommitToCheckout=${{ github.event.inputs.backendCommitToCheckout }}"
      - name: Checkout repository
        uses: actions/checkout@v2
        with:
          path: ladybug-frontend
      - name: Fetch all tags
        if: ${{ github.event.inputs.frontendCommitToCheckout }}
        run: git fetch --all --tags
        working-directory: "ladybug-frontend"
      - name: Checkout required version
        if: ${{ github.event.inputs.frontendCommitToCheckout }}
        run: git checkout ${{ github.event.inputs.frontendCommitToCheckout }}
        working-directory: "ladybug-frontend"

      - uses: pnpm/action-setup@v4
        name: Install pnpm
        with:
          version: 9
          run_install: false

      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: 'pnpm'
          cache-dependency-path: 'ladybug-frontend/pnpm-lock.yaml'

      - name: Get pnpm store directory
        id: store-path
        shell: bash
        run: |
          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_OUTPUT

      - uses: actions/cache@v4
        name: Setup pnpm cache
        with:
          path: ${{ steps.store-path.outputs.STORE_PATH }}
          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
          restore-keys: |
            ${{ runner.os }}-pnpm-store-

      - name: Install dependencies
        run: pnpm install --frozen-lockfile
        working-directory: ladybug-frontend

      - name: Install Cypress
        run: npx cypress install
        working-directory: ladybug-frontend

      - uses: actions/cache@v4
        name: Cache Cypress
        with:
          path: ~/.cache/Cypress
          key: ${{ runner.os }}-cypress-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-cypress-

      - name: Set Cypress environment variables
        run: cp cypress.env.json.cicd cypress.env.json
        working-directory: ladybug-frontend

      - name: Run linter
        run: pnpm run lint
        if: ${{ github.event.inputs.useRealFrontend != 'true' }}
        working-directory: ladybug-frontend

      - name: Build project
        run: pnpm run build
        if: ${{ github.event.inputs.useRealFrontend != 'true' }}
        working-directory: ladybug-frontend

      - name: Run unit tests
        run: pnpm run test-headless
        if: ${{ github.event.inputs.useRealFrontend != 'true' }}
        working-directory: ladybug-frontend
        continue-on-error: false

      - name: Checkout frank-runner
        uses: actions/checkout@v2
        with:
          repository: wearefrank/frank-runner
          path: frank-runner
      - name: Set property to skip backend unit tests
        run: echo "maven.skip.tests=true" > frank-runner/specials/ladybug/build.properties
      - name: Set properties to skip backend Javadoc
        run: echo "maven.skip.javadoc=true" >> frank-runner/specials/ladybug/build.properties
      - name: Set property to skip checking licenses
        run: echo "maven.skip.copyright=true" >> frank-runner/specials/ladybug/build.properties
      - name: Set port where ladybug-test-webapp is served
        run: echo "tomcat.connector.port=8090" > frank-runner/build.properties
      - name: Prevent Java exception about binding port 443 (for https)
        run: echo "tomcat.secure.port=8443" >> frank-runner/build.properties
      - name: Make script executable that starts backend
        run: chmod a+x frank-runner/specials/ladybug/restart.sh

      - name: Checkout ladybug
        uses: actions/checkout@v2
        with:
          repository: wearefrank/ladybug
          path: ladybug
      - name: Fetch all tags of ladybug
        if: ${{ github.event.inputs.backendCommitToCheckout }}
        run: git fetch --all --tags
        working-directory: "ladybug"
      - name: Checkout required version of ladybug
        if: ${{ github.event.inputs.backendCommitToCheckout }}
        run: git checkout ${{ github.event.inputs.backendCommitToCheckout }}
        working-directory: "ladybug"
      - name: Merge backend with its master
        if: ${{ github.event.inputs.mergeMasterToBranch == 'true' }}
        run: git merge master
        working-directory: "ladybug"
      - name: Checkout ladybug-test-webapp
        uses: actions/checkout@v2
        with:
          repository: wearefrank/ladybug-test-webapp
          path: ladybug-test-webapp

      - name: Cache Frank!Runner dependencies - build
        uses: actions/cache@v3
        with:
          path: frank-runner/build
          key: ${{ runner.os }}-frank-runner-build
          restore-keys: |
            ${{ runner.os }}-frank-runner-build
      - name: Cache Frank!Runner dependencies - download
        uses: actions/cache@v3
        with:
          path: frank-runner/download
          key: ${{ runner.os }}-frank-runner-download
          restore-keys: |
            ${{ runner.os }}-frank-runner-download
      - name: Cache Maven downloads
        uses: actions/cache@v3
        with:
          path: ~/.m2/repository/
          key: ${{ runner.os }}-maven
          restore-keys: |
            ${{ runner.os }}-maven
      - name: Remove old Tomcat version to keep it out of cache
        run: rm -rf frank-runner/download/apache-tomcat-9*; rm -rf frank-runner/build/apache-tomcat-9*;
      - name: Show current time, allows you to check that logs are not old
        run: date
      - name: Remove old catalina.out
        run: rm -rf frank-runner/build/apache-tomcat-9.0.56/logs/catalina.out

      - name: Let Frank!Runner do its downloads
        run: ./env.sh > installFrankRunnerEnv.log
        working-directory: frank-runner

      - name: Start server using Frank!Runner in background
        run: ./restart.sh -Dupdate.strategy=none > serverStartLog.log
        working-directory: frank-runner/specials/ladybug

      - name: Run cypress with chrome browser (bypass ladybug-frontend within backend)
        uses: cypress-io/github-action@v6.6.0
        if: ${{ github.event.inputs.useRealFrontend != 'true' }}
        with:
          working-directory: ladybug-frontend
          start: |
            pnpm ng serve --proxy-config src/proxy.cicd.conf.json --host 0.0.0.0
          wait-on: "http://0.0.0.0:8090, http://0.0.0.0:4200"
          wait-on-timeout: 1000
          browser: chrome
      - name: Run cypress with chrome browser (production frontend that is included in backend)
        uses: cypress-io/github-action@v6.6.0
        if: ${{ github.event.inputs.useRealFrontend == 'true' }}
        with:
          working-directory: ladybug-frontend
          wait-on: "http://0.0.0.0:8090"
          wait-on-timeout: 1000
          config: baseUrl=http://localhost:8090/ladybug
          browser: chrome
      - name: Show files
        run: tree -d -L 5 .
        if: always()

      - name: Store log of Frank!Runner downloads
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: installFrankRunnerEnv.log
          path: frank-runner/installFrankRunnerEnv.log
      - name: Store log of starting the server with the Frank!Runner
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: serverStartLog.log
          path: frank-runner/specials/ladybug/serverStartLog.log
      - name: Store build.properties
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: specials_build.properties
          path: frank-runner/specials/ladybug/build.properties
      - name: Store Apache Tomcat log
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: logs
          path: frank-runner/build/*/logs/*
      - name: Store Cypress screenshots
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: screenshots
          path: ladybug-frontend/cypress/screenshots/
      - name: Store Cypress videos
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: videos
          path: ladybug-frontend/cypress/videos/
      - name: Store Cypress screenshots for Firefox
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: Firefix screenshots
          path: ladybug-frontend/cypress/firefox/screenshots/
      - name: Store Cypress videos for Firefox
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: Firefox videos
          path: ladybug-frontend/cypress/firefox/videos/