name: RustFS KMS 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 enforce_sse_key_policy: description: 'Enable RUSTFS_KMS_ENFORCE_SSE_KEY_POLICY (runs KMS-401/402)' type: boolean default: false frame_v2: description: 'Enable RUSTFS_ENCRYPTION_FRAME_V2 (runs KMS-318)' type: boolean default: false config_secret: description: 'Set RUSTFS_KMS_CONFIG_SECRET (runs KMS-107 config sealing)' required: false type: string repository_dispatch: # Chain handoff: dispatched when the S3 compatibility suite finishes. types: [rustfs-chain-kms] permissions: contents: read 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: kms-test: runs-on: smoke-testing continue-on-error: true timeout-minutes: 420 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 docker --version || 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 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 /var/log/rustfs /var/lib/rustfs/kms /var/lib/rustfs/kms-backup ' done - name: Ensure docker (Vault container) run: | if ! command -v docker >/dev/null 2>&1; then sudo apt-get update sudo apt-get install -y docker.io fi sudo systemctl enable --now docker docker info >/dev/null 2>&1 || sudo docker info >/dev/null 2>&1 - name: Run KMS suite id: test continue-on-error: true env: LOG_FILE: /tmp/rustfs-kms.log run: | set -euo pipefail chmod +x auto-testing/rustfs-kms-test.sh PACKAGE_URL='${{ inputs.package_url }}' RUSTFS_VERSION='${{ inputs.rustfs_version }}' ARGS=(--all-topologies --backends "local,vault-kv2" -y --log-file "${LOG_FILE}") EXTRA_ENV="" if [ "${{ inputs.enforce_sse_key_policy }}" = "true" ]; then EXTRA_ENV+="RUSTFS_KMS_ENFORCE_SSE_KEY_POLICY=true"$'\n' fi if [ "${{ inputs.frame_v2 }}" = "true" ]; then EXTRA_ENV+="RUSTFS_ENCRYPTION_FRAME_V2=true"$'\n' fi if [ -n "${{ inputs.config_secret }}" ]; then EXTRA_ENV+="RUSTFS_KMS_CONFIG_SECRET=${{ inputs.config_secret }}"$'\n' fi if [ -n "${EXTRA_ENV}" ]; then ARGS+=(--extra-env "${EXTRA_ENV}") fi if [ -n "${PACKAGE_URL}" ]; then ARGS+=(--package-url "${PACKAGE_URL}") elif [ -n "${RUSTFS_VERSION}" ]; then ARGS+=(--version "${RUSTFS_VERSION}") else ARGS+=(--package-url "${RUSTFS_NIGHTLY_PACKAGE_URL}") fi ./auto-testing/rustfs-kms-test.sh "${ARGS[@]}" - name: Generate report if: always() env: LOG_FILE: /tmp/rustfs-kms.log REPORT_FILE: /tmp/rustfs-kms-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}" ]; then PACKAGE_SOURCE="version ${RUSTFS_VERSION}" else PACKAGE_SOURCE="${RUSTFS_NIGHTLY_PACKAGE_URL}" fi CASE_TABLE="/tmp/rustfs-kms-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-Z]+-[0-9]+)\s+(.+?)\s+---$') done_re = re.compile(r'^\[(PASS|FAIL|UNSUPPORTED)\]\s+([A-Z]+-[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 KMS 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 "- 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-kms-report.md SUITE: kms 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: 'kms' SUITE_LABEL: 'KMS' RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} REPORT_FILE: '/tmp/rustfs-kms-report.md' LOG_FILE: '/tmp/rustfs-kms.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-kms-test-${{ github.run_id }} path: | /tmp/rustfs-kms.log /tmp/rustfs-kms-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 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 /var/log/rustfs /var/lib/rustfs/kms /var/lib/rustfs/kms-backup ' done - name: "Continue functional chain (next: Tier)" # Only chain-triggered runs forward to the next suite; standalone # workflow_dispatch runs stop after their own cleanup. A failed # handoff must never pass silently: it retries, then files an alert # issue in rustfs/backlog so a stalled chain is visible. if: ${{ always() && github.event_name == 'repository_dispatch' }} continue-on-error: true env: GH_TOKEN: ${{ secrets.PF_TESTING_GH_TOKEN }} run: | set -uo pipefail if [ -z "${GH_TOKEN:-}" ]; then echo "PF_TESTING_GH_TOKEN is not configured; cannot dispatch the next suite" >&2 exit 1 fi DISPATCHED=0 for attempt in 1 2 3; do if gh api --method POST repos/rustfs/rustfs/dispatches \ -f event_type='rustfs-chain-tier' \ -F 'client_payload[from_suite]=kms'; then echo "dispatched next suite Tier (attempt ${attempt})" DISPATCHED=1 break fi echo "dispatch attempt ${attempt} failed; retrying in ${attempt}0s" >&2 sleep "${attempt}0" done if [ "${DISPATCHED:-0}" -ne 1 ]; then echo "ERROR: functional chain stalled: could not dispatch Tier after 3 attempts" >&2 TITLE="[functional][chain] stalled after kms (run ${GITHUB_RUN_ID})" BODY_FILE="$(mktemp)" { echo "The functional chain could not hand off from **kms** to **Tier** after 3 attempts." echo "" echo "- Failed suite job: ${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}" echo "- Expected next event: 'rustfs-chain-tier'" echo "- Likely cause: PF_TESTING_GH_TOKEN lacks contents:write on rustfs/rustfs, or the GitHub API was unavailable." echo "- Recovery: re-dispatch manually with" FENCE="$(printf "\x60\x60\x60")"; echo " ${FENCE}" echo " gh api --method POST repos/rustfs/rustfs/dispatches -f event_type='rustfs-chain-tier'" FENCE="$(printf "\x60\x60\x60")"; echo " ${FENCE}" } > "${BODY_FILE}" gh issue create -R rustfs/backlog --title "${TITLE}" \ --body-file "${BODY_FILE}" --label functional-test \ || gh issue create -R rustfs/backlog --title "${TITLE}" --body-file "${BODY_FILE}" \ || echo "could not file the stall alert issue either; check the token" >&2 exit 1 fi - name: Notify on failure if: failure() run: | echo "RustFS KMS suite failed" echo "See the uploaded report and log artifacts for details."