testrail-backup.yml

name: TestRail Backup

on:
  workflow_dispatch:

env:
  BUCKET: backups-testrail-test-suites
  DEFAULT_DIR: ./backup-tools
  PROJECT_IDS: 59 14 27 13 48
  # Fenix Browser: 59
  # Firefox for iOS: 14 
  # Focus for iOS: 27 
  # Firefox for Android: 13 
  # Focus for Android:48
  STORAGE_URL_PREFIX: https://storage.googleapis.com

jobs:
  test:
    name: Backup test suites
    runs-on: ubuntu-24.04
    defaults:
      run:
        working-directory: ${{ env.DEFAULT_DIR }}

    env:
      TESTRAIL_HOST: ${{ secrets.TESTRAIL_HOST }}
      TESTRAIL_USERNAME: ${{ secrets.TESTRAIL_USERNAME }}
      TESTRAIL_PASSWORD: ${{ secrets.TESTRAIL_PASSWORD }}
      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL_TEST_ALERTS_SANDBOX }}

    steps:
      - name: Checkout code
        uses: actions/checkout@v4.1.4

      - name: Set up Python
        uses: actions/setup-python@v5.1.0
        with:
          python-version: 3.11

      - name: Install dependencies
        run: |
          pip install -r requirements.txt

      - name: Fetch test cases
        run: |
          python backup_testrail.py ${{ env.PROJECT_IDS }}

      - name: Create file listing
        run: |
          touch Listing.md
          echo "# Projects & Test Suites" >> Listing.md
          echo "" >> Listing.md
          echo "| Project | Test Suite | File |" >> Listing.md
          echo "|---------|------------|------|" >> Listing.md
          ls *.csv > files.txt
          awk -F '_' '{print "| " $2 " | " $3 " | `" $0 "` |"}' < files.txt >> Listing.md

      - name: Create gzip file containing csv and listing
        run: |
          today=`date "+%Y-%m-%d"`
          subdir=`date "+%Y-%m"`
          filename=$today-TestRail-backup

          mkdir $filename
          mv *.csv $filename
          mv Listing.md $filename
          tar -cvzf $filename.tgz $filename/*

          echo "filename=$filename" >> $GITHUB_ENV
          echo "subdir=$subdir" >> $GITHUB_ENV

      - name: Establish Google Cloud connection
        uses: google-github-actions/auth@v2
        with:
          credentials_json: ${{ secrets.GCLOUD_AUTH }}
    
      - name: Upload CSV files to GCP bucket
        id: upload-file
        uses: google-github-actions/upload-cloud-storage@v2
        with:
          path: ${{ env.DEFAULT_DIR }}/${{ env.filename }}.tgz
          destination: ${{ env.BUCKET }}/${{ env.subdir }}

      - name: Output URL to Github Actions summary
        run: |
          echo "[Download CSV files](${{ env.STORAGE_URL_PREFIX }}/${{ env.BUCKET }}/${{ steps.upload-file.outputs.uploaded }})" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "Projects Included in the Backup" >> $GITHUB_STEP_SUMMARY
          cd $filename
          ls *.csv > files.txt
          awk -F '_' '{print "* " $2 }' < files.txt | uniq >> $GITHUB_STEP_SUMMARY

      - name: Notify Slack for failures
        uses: slackapi/slack-github-action@v1.26.0
        if: ${{ failure() }}
        with:
          channel-id: ${{ secrets.SLACK_MOBILE_ALERTS_SANDBOX_CHANNEL }}
          payload: | 
            {
              "type": "mrkdwn",
              "text": "TestRail backup failed :sad:"
            }

      - name: Notify Slack for successful job
        uses: slackapi/slack-github-action@v1.26.0
        if: ${{ success() }}
        with:
          channel-id: ${{ secrets.SLACK_MOBILE_ALERTS_SANDBOX_CHANNEL }}
          payload: |
            {
              "blocks": [
                {
                  "type": "header",
                  "text": {
                    "type": "mrkdwn",
                    "text": ":tada: TestRail Backup"
                  }
                },
                {
                  "type": "section",
                  "text": {
                    "type": "mrkdwn",
                    "text": "<${{ env.STORAGE_URL_PREFIX }}/${{ env.BUCKET }}/${{ steps.upload-file.outputs.uploaded }}|Download Backup>"
                  }
                },
                                {
                  "type": "section",
                  "text": {
                    "type": "mrkdwn",
                    "text": "<${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}|Link>"
                  }
                }
              ]
            }