-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add MTE-3753 TestRail backup daily (#47)
* Let's do gzip file * again * Create file listing in README * Fix upload filename * Fix filename * Fix GITHUB_ENV * I meant to create a separate file for the file listing * Ignore underscore in filename in Listing.md * Fix headers * Update cfg file for a few more fields * Output result to Github Actions job page * Use year-month as sub directories * Fix subdir * Fix download path on summary page * More doc * Add Slack notification * Just output a simple message * Send just one emoji! * Fix json * Can we report backup status? * Fix json * Just a header * Try this payload * Can we have blocks? * Include all info in one mrkdwn * Put mrkdwn in one single line * Use separate json file * Fix slack.json * Use slack.json * Oh no! updated the wrong file! * Add default directory in file path * Does slackapi work? * Try again * Test slack.json * Use payload file (for real!!) * Test connection again * Fix env for URLs * Trying out mrkdwn? * Fix json * Prettify slack notif * Fix slack message * Eliminate the directory name * Add limitation * Update webhook * Try this webhook * No channel-id? * Don't worry about Slack notification until the webhooks are sorted out * Add passphrase * comment out unused step * Use apt-get (it's Ubuntu after all!) * Add passphrase to env * document how to decrypt the file * Disable gpg for now * Use sandbox channel for now * Put back Slack notifications for failed jobs * Let's trigger a failure scenario * Put password back * Put job on schedule 🎉 * Nit: Add divider back to notification * Remove instructions for gpg
- Loading branch information
Showing
7 changed files
with
149 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,20 +2,32 @@ name: TestRail Backup | |
|
|
||
| on: | ||
| workflow_dispatch: | ||
| schedule: | ||
| - cron: "0 15 * * *" # Run every day at 3pm | ||
|
|
||
| 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-latest | ||
| runs-on: ubuntu-24.04 | ||
| defaults: | ||
| run: | ||
| working-directory: ./backup-tools | ||
| 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 | ||
|
|
@@ -29,24 +41,78 @@ jobs: | |
| - name: Install dependencies | ||
| run: | | ||
| pip install -r requirements.txt | ||
| sudo apt-get install gnupg | ||
| - 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: Fetch test cases | ||
| - name: Output URL to Github Actions summary | ||
| run: | | ||
| python backup_testrail.py | ||
| today=`date "+%Y-%m-%d"` | ||
| mkdir $today | ||
| cp *.csv $today | ||
| pwd | ||
| ls $today | ||
| echo "today=$today" >> $GITHUB_ENV | ||
| - name: Upload CSV to GCP bucket | ||
| uses: google-github-actions/upload-cloud-storage@v2 | ||
| 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 (Fail) | ||
| uses: slackapi/[email protected] | ||
| if: ${{ failure() }} | ||
| with: | ||
| payload-file-path: ${{ env.DEFAULT_DIR }}/slack-fail.json | ||
| env: | ||
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL_TEST_ALERTS_SANDBOX }} | ||
| SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK | ||
| server_url: ${{ github.server_url }} | ||
| repository: ${{ github.repository }} | ||
| run_id: ${{ github.run_id }} | ||
|
|
||
| - name: Notify Slack (Success) | ||
| uses: slackapi/[email protected] | ||
| if: ${{ success() }} | ||
| with: | ||
| path: backup-tools/${{ env.today }} | ||
| destination: backups-testrail-test-suites | ||
| payload-file-path: ${{ env.DEFAULT_DIR }}/slack-success.json | ||
| env: | ||
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL_TEST_ALERTS_SANDBOX }} | ||
| SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK | ||
| uploaded: ${{ steps.upload-file.outputs.uploaded }} | ||
| server_url: ${{ github.server_url }} | ||
| repository: ${{ github.repository }} | ||
| run_id: ${{ github.run_id }} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "blocks": [ | ||
| { | ||
| "type": "header", | ||
| "text": { | ||
| "type": "plain_text", | ||
| "text": ":x: TestRail Backup Failed", | ||
| "emoji": true | ||
| } | ||
| }, | ||
| { | ||
| "type": "divider" | ||
| }, | ||
| { | ||
| "type": "section", | ||
| "text": { | ||
| "type": "mrkdwn", | ||
| "text": "<${{ env.server_url }}/${{ env.repository }}/actions/runs/${{ env.run_id }}|Github Actions Job>" | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "blocks": [ | ||
| { | ||
| "type": "header", | ||
| "text": { | ||
| "type": "plain_text", | ||
| "text": ":tada: TestRail Backup Successful", | ||
| "emoji": true | ||
| } | ||
| }, | ||
| { | ||
| "type": "divider" | ||
| }, | ||
| { | ||
| "type": "section", | ||
| "text": { | ||
| "type": "mrkdwn", | ||
| "text": "<${{ env.STORAGE_URL_PREFIX }}/${{ env.BUCKET }}/${{ env.uploaded }}|Download Backup (${{ env.uploaded }})> \n <${{ env.server_url }}/${{ env.repository }}/actions/runs/${{ env.run_id }}|Github Actions Job>" | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"import":{"format":"csv","version":1},"file":{"encoding":"UTF-8","delimiter":",","start_row":1,"has_header":true,"skip_empty":true},"layout":{"format":"multi","break":1,"template":2},"columns":["","cases:title","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","cases:custom_steps_separated.content","cases:custom_steps_separated.expected"],"values":{"1":{"remove_html":false},"34":{"remove_html":false},"35":{"remove_html":false}}} | ||
| {"import":{"format":"csv","version":1},"file":{"encoding":"UTF-8","delimiter":",","start_row":1,"has_header":true,"skip_empty":true},"layout":{"format":"multi","break":1,"template":2},"columns":["","cases:title","cases:section_id","","cases:type_id","cases:priority_id","","cases:refs","","","","","cases:estimate","","","","","cases:assigned_to_id","cases:custom_test_case_owner","","","","cases:custom_rotation","","","cases:custom_preconds","","","","","","","","","cases:custom_steps_separated.content","cases:custom_steps_separated.expected"],"values":{"1":{"remove_html":false},"4":{"mapping":{"6":"6","7":"7","11":"11"}},"5":{"mapping":{"2":"2","3":"3"}},"7":{"remove_html":false},"17":{"mapping":[]},"18":{"mapping":{"37":"","68":"68","82":"82"}},"22":{"remove_html":false},"25":{"remove_html":false},"34":{"remove_html":false},"35":{"remove_html":false}}} |