# Copyright 2024 RustFS Team # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. name: RustFS Replication Test on: workflow_dispatch: inputs: rustfs_version: description: 'RustFS release tag to test (e.g. 1.0.0-rc.4-preview.1)' required: false default: '1.0.0-rc.4-preview.1' package_url: description: 'Direct .deb URL (nightly/R2/dev). Overrides rustfs_version.' required: false type: string suite: description: 'Suite to run (all = bucket REP-* then site SITE-*)' type: choice options: - all - bucket - site default: all repository_dispatch: # Chain handoff: dispatched when the security suite finishes. This is the # last link of the functional chain. types: [rustfs-chain-replication] permissions: contents: read # The replication suite uses the same shared VMs as the other functional # tests, so it must serialize with them instead of running in parallel. concurrency: group: rustfs-shared-functional-tests cancel-in-progress: false defaults: run: shell: bash env: RUSTFS_ACCESS_KEY: ${{ secrets.RUSTFS_ACCESS_KEY }} RUSTFS_SECRET_KEY: ${{ secrets.RUSTFS_SECRET_KEY }} RUSTFS_NODES: ${{ secrets.RUSTFS_NODES || vars.RUSTFS_NODES }} RUSTFS_SSH_USER: ${{ secrets.RUSTFS_SSH_USER || vars.RUSTFS_SSH_USER }} RUSTFS_NIGHTLY_PACKAGE_URL: ${{ vars.RUSTFS_NIGHTLY_PACKAGE_URL || 'https://dl.rustfs.com/artifacts/rustfs/packages/nightly/rustfs-nightly-latest.deb' }} PF_TESTING_GH_TOKEN: ${{ secrets.PF_TESTING_GH_TOKEN }} jobs: replication-test: runs-on: smoke-testing # A failed replication run must not break the chain or the workflow: the # failure is reported to rustfs/backlog instead (see the issue step). continue-on-error: true timeout-minutes: 360 if: ${{ github.event_name == 'workflow_dispatch' || github.event_name == 'repository_dispatch' }} steps: # auto-testing is private: clone it with the dedicated PF token (not # GITHUB_TOKEN) and retry transient GitHub/network failures. - name: Checkout auto-testing scripts (with retry) env: GH_TOKEN: ${{ secrets.PF_TESTING_GH_TOKEN }} run: | set -euo pipefail rm -rf auto-testing for attempt in 1 2 3 4 5; do if gh repo clone rustfs/auto-testing auto-testing -- --depth 1 --quiet; then echo "auto-testing cloned (attempt ${attempt})" exit 0 fi rm -rf auto-testing echo "clone attempt ${attempt} failed; retrying in $((attempt * 15))s" >&2 sleep $((attempt * 15)) done echo "ERROR: unable to clone rustfs/auto-testing after 5 attempts" >&2 exit 1 - name: Show environment run: | uname -a jq --version openssl version aws --version df -h /data | tail -1 || true - name: Cleanup environment (before) run: | set -euo pipefail read -r -a NODES <<< "${RUSTFS_NODES:-vm000 vm001 vm002}" SSH_USER="${RUSTFS_SSH_USER:-azureuser}" for node in "${NODES[@]}"; do ssh -o BatchMode=yes -o ConnectTimeout=10 -o StrictHostKeyChecking=accept-new "${SSH_USER}@${node}" ' set -euo pipefail SUDO=""; [ "$(id -u)" -ne 0 ] && SUDO="sudo -n" ${SUDO} systemctl stop rustfs rustfs-rep2 2>/dev/null || true if ${SUDO} dpkg -l rustfs 2>/dev/null | grep -q "^ii"; then ${SUDO} dpkg -P rustfs fi for i in 1 2 3 4; do ${SUDO} rm -rf /data/rustfs${i}/mnmd; done ${SUDO} rm -rf /data/rustfs-rep2 /var/log/rustfs /var/log/rustfs-rep2 /var/lib/rustfs/kms ' done - name: Run replication suite id: test continue-on-error: true env: LOG_FILE: /tmp/rustfs-replication.log run: | set -euo pipefail chmod +x auto-testing/rustfs-replication-test.sh PACKAGE_URL='${{ inputs.package_url }}' RUSTFS_VERSION='${{ inputs.rustfs_version }}' SUITE='${{ inputs.suite }}' ARGS=(-y --log-file "${LOG_FILE}") if [ "${SUITE}" = "all" ] || [ -z "${SUITE}" ] || [ "${SUITE}" = "null" ]; then ARGS+=(--suite all) else ARGS+=(--suite "${SUITE}") fi if [ -n "${PACKAGE_URL}" ]; then ARGS+=(--package-url "${PACKAGE_URL}") elif [ -n "${RUSTFS_VERSION}" ] && [ "${RUSTFS_VERSION}" != "null" ]; then ARGS+=(--version "${RUSTFS_VERSION}") else ARGS+=(--package-url "${RUSTFS_NIGHTLY_PACKAGE_URL}") fi ./auto-testing/rustfs-replication-test.sh "${ARGS[@]}" - name: Generate report if: always() env: LOG_FILE: /tmp/rustfs-replication.log REPORT_FILE: /tmp/rustfs-replication-report.md run: | set -euo pipefail PACKAGE_URL='${{ inputs.package_url }}' RUSTFS_VERSION='${{ inputs.rustfs_version }}' if [ -n "${PACKAGE_URL}" ]; then PACKAGE_SOURCE="${PACKAGE_URL}" elif [ -n "${RUSTFS_VERSION}" ] && [ "${RUSTFS_VERSION}" != "null" ]; then PACKAGE_SOURCE="version ${RUSTFS_VERSION}" else PACKAGE_SOURCE="${RUSTFS_NIGHTLY_PACKAGE_URL}" fi read -r -a NODES <<< "${RUSTFS_NODES:-vm000 vm001 vm002}" SSH_USER="${RUSTFS_SSH_USER:-azureuser}" RUSTFS_VERSION_INFO="N/A" if [ "${#NODES[@]}" -gt 0 ]; then DETECTED_VERSION="$(ssh -o BatchMode=yes -o ConnectTimeout=10 -o StrictHostKeyChecking=accept-new \ "${SSH_USER}@${NODES[0]}" 'rustfs --version' 2>/dev/null | tr -d '\r' | head -n 1 || true)" if [ -n "${DETECTED_VERSION}" ]; then RUSTFS_VERSION_INFO="${DETECTED_VERSION}" fi fi CASE_TABLE="/tmp/rustfs-replication-cases.md" python3 - "${LOG_FILE}" "${CASE_TABLE}" <<'PY' import re import sys log_file, out_file = sys.argv[1], sys.argv[2] ansi = re.compile(r'\x1b\[[0-9;]*m') start_re = re.compile(r'^---\s+([A-Z0-9]+-[0-9]+)\s+(.+?)\s+---$') done_re = re.compile(r'^\[(PASS|FAIL|UNSUPPORTED)\]\s+([A-Z0-9]+-[0-9]+)\b') rows = [] index = {} try: with open(log_file, 'r', encoding='utf-8', errors='replace') as fh: for raw in fh: line = ansi.sub('', raw).strip() m = start_re.match(line) if m: case_id, name = m.group(1), m.group(2) if case_id not in index: index[case_id] = len(rows) rows.append([case_id, name, 'RUNNING']) continue m = done_re.match(line) if m: status, case_id = m.group(1), m.group(2) if case_id in index: rows[index[case_id]][2] = status else: rows.append([case_id, case_id, status]) index[case_id] = len(rows) - 1 except FileNotFoundError: rows = [] counts = {'PASS': 0, 'FAIL': 0, 'UNSUPPORTED': 0, 'RUNNING': 0} for _, _, status in rows: counts[status] = counts.get(status, 0) + 1 with open(out_file, 'w', encoding='utf-8') as out: out.write('## Case Summary\n\n') out.write(f"- Total: {len(rows)}\\n") out.write(f"- PASS: {counts.get('PASS', 0)}\\n") out.write(f"- FAIL: {counts.get('FAIL', 0)}\\n") out.write(f"- UNSUPPORTED: {counts.get('UNSUPPORTED', 0)}\\n") out.write('\\n') out.write('| Case | Name | Status |\\n') out.write('| --- | --- | --- |\\n') for case_id, name, status in rows: out.write(f'| {case_id} | {name} | {status} |\\n') PY { echo "# RustFS replication test report" echo "" echo "- Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" echo "- Trigger: ${{ github.event_name }}" echo "- Package: ${PACKAGE_SOURCE}" echo "- RustFS Version: ${RUSTFS_VERSION_INFO}" echo "- Test Step Outcome: ${{ steps.test.outcome }}" echo "" cat "${CASE_TABLE}" || true echo "" echo "## Log tail" echo '```text' tail -n 200 "${LOG_FILE}" || true echo '```' } | tee "${REPORT_FILE}" cat "${REPORT_FILE}" >> "${GITHUB_STEP_SUMMARY}" - name: Upload functional report to dashboard if: always() continue-on-error: true env: GH_TOKEN: ${{ env.PF_TESTING_GH_TOKEN }} REPORT_FILE: /tmp/rustfs-replication-report.md SUITE: replication run: | set -euo pipefail if [ -z "${GH_TOKEN:-}" ]; then echo "PF_TESTING_GH_TOKEN is not configured; skipping dashboard upload" exit 0 fi DATE="$(date -u +%Y-%m-%d)" REPORT_PATH="functional-reports/${SUITE}/${DATE}.md" CONTENT="$(python3 -c 'import base64,sys;print(base64.b64encode(open(sys.argv[1],"rb").read()).decode())' "${REPORT_FILE}")" SHA="$(gh api "repos/rustfs/dashboard/contents/${REPORT_PATH}" -q '.sha' 2>/dev/null || true)" if [ -n "${SHA}" ]; then jq -n --arg msg "report(${SUITE}): ${DATE}" --arg content "${CONTENT}" --arg sha "${SHA}" \ '{message:$msg, content:$content, sha:$sha}' \ | gh api --method PUT "repos/rustfs/dashboard/contents/${REPORT_PATH}" --input - >/dev/null else jq -n --arg msg "report(${SUITE}): ${DATE}" --arg content "${CONTENT}" \ '{message:$msg, content:$content}' \ | gh api --method PUT "repos/rustfs/dashboard/contents/${REPORT_PATH}" --input - >/dev/null fi - name: File failure issue in rustfs/backlog if: ${{ always() && (failure() || steps.test.outcome == 'failure' || steps.test.outcome == 'cancelled') }} continue-on-error: true env: GH_TOKEN: ${{ secrets.PF_TESTING_GH_TOKEN }} SUITE: 'replication' SUITE_LABEL: 'Replication (bucket + site)' RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} REPORT_FILE: '/tmp/rustfs-replication-report.md' LOG_FILE: '/tmp/rustfs-replication.log' run: | set -euo pipefail if [ -z "${GH_TOKEN:-}" ]; then echo "PF_TESTING_GH_TOKEN is not configured; skipping backlog issue" exit 0 fi TITLE="[functional][${SUITE}] ${SUITE_LABEL} suite failed (run ${GITHUB_RUN_ID})" EXISTING="$(gh issue list -R rustfs/backlog --state all \ --search "in:title \"run ${GITHUB_RUN_ID}\"" \ --json number --jq '.[].number' || true)" if [ -n "${EXISTING}" ]; then echo "backlog issue already exists for run ${GITHUB_RUN_ID}; skipping" exit 0 fi redact() { sed -E \ -e 's/(RUSTFS_(ACCESS_KEY|SECRET_KEY)[=: ]+)[^[:space:]]+/\1[REDACTED]/Ig' \ -e 's/(Authorization:).*/\1 [REDACTED]/Ig' \ -e 's/(X-Amz-Signature=)[^&[:space:]]+/\1[REDACTED]/Ig' \ -e 's/^.*(password|secret|token)[=: ].*/[REDACTED SENSITIVE LINE]/Ig' } BODY_FILE="$(mktemp)" { echo "The **${SUITE_LABEL}** functional suite failed." echo "" echo "- Suite: \`${SUITE}\`" echo "- Run: ${RUN_URL}" echo "- Trigger: ${GITHUB_EVENT_NAME}" echo "- Date: $(date -u +%Y-%m-%d)" echo "" echo "## Report (errors and symptoms)" echo "" if [ -s "${REPORT_FILE}" ]; then redact < "${REPORT_FILE}" elif [ -s "${LOG_FILE:-}" ]; then echo "(report file missing; log tail below)" echo "" tail -n 200 "${LOG_FILE}" | redact else echo "(no report or log file was produced)" fi } | head -c 55000 > "${BODY_FILE}" gh label create functional-test -R rustfs/backlog --color d73a4a 2>/dev/null || true if ! gh issue create -R rustfs/backlog --title "${TITLE}" \ --body-file "${BODY_FILE}" --label functional-test; then gh issue create -R rustfs/backlog --title "${TITLE}" --body-file "${BODY_FILE}" fi echo "filed backlog issue for suite ${SUITE}" - name: Upload report and logs if: always() uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6 with: name: rustfs-replication-${{ github.run_id }} path: | /tmp/rustfs-replication.log /tmp/rustfs-replication-report.md if-no-files-found: warn - name: Cleanup environment (after) if: always() run: | set -euo pipefail read -r -a NODES <<< "${RUSTFS_NODES:-vm000 vm001 vm002}" SSH_USER="${RUSTFS_SSH_USER:-azureuser}" for node in "${NODES[@]}"; do ssh -o BatchMode=yes -o ConnectTimeout=10 -o StrictHostKeyChecking=accept-new "${SSH_USER}@${node}" ' set -euo pipefail SUDO=""; [ "$(id -u)" -ne 0 ] && SUDO="sudo -n" ${SUDO} systemctl stop rustfs rustfs-rep2 2>/dev/null || true if ${SUDO} dpkg -l rustfs 2>/dev/null | grep -q "^ii"; then ${SUDO} dpkg -P rustfs fi for i in 1 2 3 4; do ${SUDO} rm -rf /data/rustfs${i}/mnmd; done ${SUDO} rm -rf /data/rustfs-rep2 /var/log/rustfs /var/log/rustfs-rep2 ' done - name: Chain complete # Replication is the last link of the functional chain: nothing to # dispatch after it. This step just records that the chain finished. if: ${{ always() && github.event_name == 'repository_dispatch' }} run: | echo "Functional chain complete: replication (final suite) finished." echo "from_suite=security trigger=${{ github.event_name }} outcome=${{ steps.test.outcome }}" - name: Notify on failure if: failure() run: | echo "RustFS replication suite failed" echo "Package source: ${{ inputs.package_url || inputs.rustfs_version || 'nightly (R2 latest)' }}" echo "See the uploaded report and log artifacts for details."