b086f8c3ff
PowerShell switched to requiring certificate credentials so the existing cleanup jobs have been failing since the switch --- #### Does this PR need a docs update or release note? - [ ] ✅ Yes, it's included - [ ] 🕐 Yes, but in a later PR - [x] ⛔ No #### Type of change - [ ] 🌻 Feature - [x] 🐛 Bugfix - [ ] 🗺️ Documentation - [ ] 🤖 Supportability/Tests - [x] 💻 CI/Deployment - [ ] 🧹 Tech Debt/Cleanup #### Test Plan - [ ] 💪 Manual - [ ] ⚡ Unit test - [ ] 💚 E2E
269 lines
11 KiB
YAML
269 lines
11 KiB
YAML
name: Backup Restore Test
|
|
description: Run various backup/restore/export tests for a service.
|
|
|
|
inputs:
|
|
service:
|
|
description: Service to test
|
|
required: true
|
|
kind:
|
|
description: Kind of test
|
|
required: true
|
|
backup-id:
|
|
description: Backup to retrieve data out of
|
|
required: false
|
|
backup-args:
|
|
description: Arguments to pass for backup
|
|
required: false
|
|
default: ""
|
|
restore-args:
|
|
description: Arguments to pass for restore; restore is skipped when missing.
|
|
required: false
|
|
default: ""
|
|
export-args:
|
|
description: Arguments to pass for export.
|
|
required: false
|
|
default: ""
|
|
restore-container:
|
|
description: Folder to use for testing
|
|
required: true
|
|
log-dir:
|
|
description: Folder to store test log files
|
|
required: true
|
|
on-collision:
|
|
description: Value for the --collisions flag
|
|
required: false
|
|
default: "replace"
|
|
with-export:
|
|
description: Runs export tests when true
|
|
required: false
|
|
default: false
|
|
category:
|
|
description: category of data for given service
|
|
required: false
|
|
|
|
outputs:
|
|
backup-id:
|
|
value: ${{ steps.backup.outputs.result }}
|
|
|
|
runs:
|
|
using: composite
|
|
steps:
|
|
- name: Backup ${{ inputs.service }} ${{ inputs.kind }}
|
|
id: backup
|
|
shell: bash
|
|
working-directory: src
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Backup ${{ inputs.service }} ${{ inputs.kind }}
|
|
echo "---------------------------"
|
|
set -euo pipefail
|
|
CATEGORY_SUFFIX=""
|
|
[[ -n "${{ inputs.category }}" ]] && CATEGORY_SUFFIX="-${{ inputs.category }}"
|
|
CORSO_LOG_FILE=${{ inputs.log-dir }}/gotest-${{ inputs.service }}${CATEGORY_SUFFIX}-backup-${{inputs.kind }}.log
|
|
./corso backup create '${{ inputs.service }}' \
|
|
--no-stats --hide-progress --json \
|
|
${{ inputs.backup-args }} |
|
|
tee /dev/stderr | # for printing logs
|
|
jq -r '.[0] | .id' |
|
|
sed 's/^/result=/' |
|
|
tee $GITHUB_OUTPUT
|
|
|
|
- name: Restore ${{ inputs.service }} ${{ inputs.kind }}
|
|
if: inputs.restore-args
|
|
id: restore
|
|
shell: bash
|
|
working-directory: src
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Restore ${{ inputs.service }} ${{ inputs.kind }}
|
|
echo "---------------------------"
|
|
set -euo pipefail
|
|
CATEGORY_SUFFIX=""
|
|
[[ -n "${{ inputs.category }}" ]] && CATEGORY_SUFFIX="-${{ inputs.category }}"
|
|
CORSO_LOG_FILE=${{ inputs.log-dir }}/gotest-${{ inputs.service }}${CATEGORY_SUFFIX}-restore-${{inputs.kind }}.log
|
|
./corso restore '${{ inputs.service }}' \
|
|
--no-stats \
|
|
--hide-progress \
|
|
--collisions ${{ inputs.on-collision }} \
|
|
${{ inputs.restore-args }} \
|
|
--backup '${{ steps.backup.outputs.result }}' \
|
|
2>&1 |
|
|
tee /tmp/corsologs |
|
|
grep -i -e 'Restoring to folder ' |
|
|
sed "s/Restoring to folder /result=/" |
|
|
tee $GITHUB_OUTPUT
|
|
|
|
cat /tmp/corsologs
|
|
|
|
- name: Check restore ${{ inputs.service }} ${{ inputs.kind }}
|
|
if: inputs.restore-args
|
|
shell: bash
|
|
working-directory: src
|
|
env:
|
|
SANITY_TEST_RESTORE_CONTAINER: ${{ steps.restore.outputs.result }}
|
|
SANITY_TEST_SOURCE_CONTAINER: ${{ inputs.restore-container }}
|
|
SANITY_BACKUP_ID: ${{ inputs.backup-id }}
|
|
# lists are not restored to a different folder. they get created adjacent to their originals
|
|
# hence SANITY_TEST_RESTORE_CONTAINER_PREFIX is necessary to differentiate restored from original
|
|
SANITY_TEST_RESTORE_CONTAINER_PREFIX: ${{ steps.restore.outputs.result }}
|
|
SANITY_TEST_CATEGORY: ${{ inputs.category }}
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Sanity Test Restore ${{ inputs.service }} ${{ inputs.kind }}
|
|
echo "---------------------------"
|
|
CATEGORY_SUFFIX=""
|
|
[[ -n "${{ inputs.category }}" ]] && CATEGORY_SUFFIX="-${{ inputs.category }}"
|
|
CORSO_LOG_FILE=${{ inputs.log-dir }}/gotest-${{ inputs.service }}${CATEGORY_SUFFIX}-validate-${{inputs.kind }}.log
|
|
./sanity-test restore ${{ inputs.service }}
|
|
|
|
- name: Export ${{ inputs.service }} ${{ inputs.kind }}
|
|
if: ${{ inputs.with-export == 'true' }}
|
|
id: export
|
|
shell: bash
|
|
working-directory: src
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Export ${{ inputs.service }} ${{ inputs.kind }}
|
|
echo "---------------------------"
|
|
set -euo pipefail
|
|
CATEGORY_SUFFIX=""
|
|
[[ -n "${{ inputs.category }}" ]] && CATEGORY_SUFFIX="-${{ inputs.category }}"
|
|
CORSO_LOG_FILE=${{ inputs.log-dir }}/gotest-${{ inputs.service }}${CATEGORY_SUFFIX}-restore-${{inputs.kind }}.log
|
|
./corso export '${{ inputs.service }}' \
|
|
/tmp/export-${{ inputs.service }}${CATEGORY_SUFFIX}-${{inputs.kind }} \
|
|
--no-stats \
|
|
--hide-progress \
|
|
${{ inputs.export-args }} \
|
|
--backup '${{ steps.backup.outputs.result }}'
|
|
|
|
cat /tmp/corsologs
|
|
|
|
- name: Check export ${{ inputs.service }} ${{ inputs.kind }}
|
|
if: ${{ inputs.with-export == 'true' }}
|
|
shell: bash
|
|
working-directory: src
|
|
env:
|
|
SANITY_TEST_RESTORE_CONTAINER: /tmp/export-${{ inputs.service }}${{ inputs.category && '-' }}${{ inputs.category }}-${{ inputs.kind }}
|
|
SANITY_TEST_SOURCE_CONTAINER: ${{ inputs.restore-container }}
|
|
SANITY_BACKUP_ID: ${{ inputs.backup-id }}
|
|
# applies only for sharepoint lists
|
|
SANITY_TEST_RESTORE_CONTAINER_PREFIX: ${{ steps.restore.outputs.result }}
|
|
SANITY_TEST_CATEGORY: ${{ inputs.category }}
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Sanity-Test Export ${{ inputs.service }} ${{ inputs.kind }}
|
|
echo "---------------------------"
|
|
CATEGORY_SUFFIX=""
|
|
[[ -n "${{ inputs.category }}" ]] && CATEGORY_SUFFIX="-${{ inputs.category }}"
|
|
CORSO_LOG_FILE=${{ inputs.log-dir }}/gotest-${{ inputs.service }}${CATEGORY_SUFFIX}-validate-${{inputs.kind }}.log
|
|
./sanity-test export ${{ inputs.service }}
|
|
|
|
- name: Export archive ${{ inputs.service }} ${{ inputs.kind }}
|
|
if: ${{ inputs.with-export == 'true' }}
|
|
id: export-archive
|
|
shell: bash
|
|
working-directory: src
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Export Archive ${{ inputs.service }} ${{ inputs.kind }}
|
|
echo "---------------------------"
|
|
set -euo pipefail
|
|
CATEGORY_SUFFIX=""
|
|
[[ -n "${{ inputs.category }}" ]] && CATEGORY_SUFFIX="-${{ inputs.category }}"
|
|
CORSO_LOG_FILE=${{ inputs.log-dir }}/gotest-${{ inputs.service }}${CATEGORY_SUFFIX}-restore-${{inputs.kind }}.log
|
|
./corso export '${{ inputs.service }}' \
|
|
/tmp/export-${{ inputs.service }}${CATEGORY_SUFFIX}-${{inputs.kind }}-archive \
|
|
--no-stats \
|
|
--hide-progress \
|
|
--archive \
|
|
${{ inputs.export-args }} \
|
|
--backup '${{ steps.backup.outputs.result }}'
|
|
|
|
unzip /tmp/export-${{ inputs.service }}${CATEGORY_SUFFIX}-${{inputs.kind }}-archive/*.zip \
|
|
-d /tmp/export-${{ inputs.service }}${CATEGORY_SUFFIX}-${{inputs.kind }}-unzipped
|
|
cat /tmp/corsologs
|
|
|
|
- name: Check archive export ${{ inputs.service }} ${{ inputs.kind }}
|
|
if: ${{ inputs.with-export == 'true' }}
|
|
shell: bash
|
|
working-directory: src
|
|
env:
|
|
SANITY_TEST_RESTORE_CONTAINER: /tmp/export-${{ inputs.service }}${{ inputs.category && '-' }}${{ inputs.category }}-${{inputs.kind }}-unzipped
|
|
SANITY_TEST_SOURCE_CONTAINER: ${{ inputs.restore-container }}
|
|
SANITY_BACKUP_ID: ${{ inputs.backup-id }}
|
|
# applies only for sharepoint lists
|
|
SANITY_TEST_RESTORE_CONTAINER_PREFIX: ${{ steps.restore.outputs.result }}
|
|
SANITY_TEST_CATEGORY: ${{ inputs.category }}
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Sanity-Test Export Archive ${{ inputs.service }} ${{ inputs.kind }}
|
|
echo "---------------------------"
|
|
CATEGORY_SUFFIX=""
|
|
[[ -n "${{ inputs.category }}" ]] && CATEGORY_SUFFIX="-${{ inputs.category }}"
|
|
CORSO_LOG_FILE=${{ inputs.log-dir }}/gotest-${{ inputs.service }}${CATEGORY_SUFFIX}-validate-${{inputs.kind }}.log
|
|
./sanity-test export ${{ inputs.service }}
|
|
|
|
- name: List ${{ inputs.service }} ${{ inputs.kind }}
|
|
shell: bash
|
|
working-directory: src
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Backup list ${{ inputs.service }} ${{ inputs.kind }}
|
|
echo "---------------------------"
|
|
set -euo pipefail
|
|
CATEGORY_SUFFIX=""
|
|
[[ -n "${{ inputs.category }}" ]] && CATEGORY_SUFFIX="-${{ inputs.category }}"
|
|
CORSO_LOG_FILE=${{ inputs.log-dir }}/gotest-backup-${{ inputs.service }}${CATEGORY_SUFFIX}-list-${{inputs.kind }}.log
|
|
./corso backup list ${{ inputs.service }} \
|
|
--no-stats \
|
|
--hide-progress \
|
|
2>&1 |
|
|
tee /tmp/corso-backup-list.log
|
|
|
|
if ! grep -q ${{ steps.backup.outputs.result }} /tmp/corso-backup-list.log
|
|
then
|
|
echo "Unable to find backup from previous run in backup list"
|
|
exit 1
|
|
fi
|
|
|
|
- name: List item ${{ inputs.service }} ${{ inputs.kind }}
|
|
shell: bash
|
|
working-directory: src
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Backup List w/ Backup ${{ inputs.service }} ${{ inputs.kind }}
|
|
echo "---------------------------"
|
|
set -euo pipefail
|
|
# Include category in the log file name if present
|
|
CATEGORY_SUFFIX=""
|
|
[[ -n "${{ inputs.category }}" ]] && CATEGORY_SUFFIX="-${{ inputs.category }}"
|
|
CORSO_LOG_FILE=${{ inputs.log-dir }}/gotest-backup-list-${{ inputs.service }}${CATEGORY_SUFFIX}-single-${{inputs.kind }}.log
|
|
./corso backup list ${{ inputs.service }} \
|
|
--no-stats \
|
|
--hide-progress \
|
|
--backup "${{ steps.backup.outputs.result }}" \
|
|
2>&1 |
|
|
tee /tmp/corso-backup-list-item.log
|
|
|
|
if ! grep -q ${{ steps.backup.outputs.result }} /tmp/corso-backup-list-item.log
|
|
then
|
|
echo "Unable to list previous backup"
|
|
exit 1
|
|
fi
|
|
|
|
- if: always()
|
|
shell: bash
|
|
run: |
|
|
echo "---------------------------"
|
|
echo Logging Results
|
|
echo "---------------------------"
|
|
|
|
- name: Upload test log
|
|
if: always()
|
|
uses: actions/upload-artifact@v3
|
|
with:
|
|
name: "${{ inputs.service }}-${{ inputs.kind }}-logs"
|
|
path: ${{ inputs.log-dir }}/*
|
|
if-no-files-found: error
|
|
retention-days: 14
|