DBのリストアテストを全自動化した話

name: restore_test
on:
  workflow_dispatch:
jobs:
  service1: # service1のリストアテストを行うjob
    runs-on: hoge
    services:
      db: # リストア先のDBを設定
        image: mysql
        ports:
          - 3307:3306
        env:
          MYSQL_ROOT_PASSWORD: hogefuga
        options: --health-cmd "mysqladmin ping -h localhost" --health-interval 20s --health-timeout 10s --health-retries 10
    steps:
      - uses: actions/checkout@v3
      - name: setup mysql-cli # リストアに必要なmysql-clientをインストール
        run: |
          apt update && apt install -y mysql-client 
      - name: set credentials # scpの際に必要となる秘密鍵をrunnerにセット
        run: |
          mkdir -p /root/.ssh/
          echo "${{secrets.[sshに使用する秘密鍵]}}" > /root/.ssh/id_rsa
          chmod 600 /root/.ssh/id_rsa
      - name: backup test # リストアテスト実施
        uses: takutakahashi/database-restore-action@main
        env:
          SSH_KEY: "/root/.ssh/id_rsa"
        with:
          config-path: .database/service1.yaml
  service2: # service2のリストアテストを行うjob
    runs-on: hoge
    services:
      db: # リストア先のDBを設定
        image: mysql
        ports:
          - 3307:3306
        env:
          MYSQL_ROOT_PASSWORD: hogefuga
        options: --health-cmd "mysqladmin ping -h localhost" --health-interval 20s --health-timeout 10s --health-retries 10
    steps:
      - uses: actions/checkout@v3
      - name: setup mysql-cli # リストアに必要なmysql-clientをインストール
        run: |
          apt update && apt install -y mysql-client 
      - name: set credentials # scpの際に必要となる秘密鍵をrunnerにセット
        run: |
          mkdir -p /root/.ssh/
          echo "${{secrets.[sshに使用する秘密鍵]}}" > /root/.ssh/id_rsa
          chmod 600 /root/.ssh/id_rsa
      - name: backup test # リストアテスト実施
        uses: takutakahashi/database-restore-action@main
        env:
          SSH_KEY: "/root/.ssh/id_rsa"
        with:
          config-path: .database/service2.yaml
  summary: # リストア結果のサマリーをissueに作成するjob
    runs-on: hoge
    needs: [service1, service2]
    if: ${{ always() }}
    steps:
      - name: Create Title # issueのタイトルを変数にセット
        id: create-title
        run: echo "title=$(date '+%Y' --date '1 month ago')年$(date '+%m' --date '1 month ago')月レポート" >> "$GITHUB_OUTPUT"
      - name: Create report # issueを作成
        uses: imjohnbo/issue-bot@v3
        with:
          labels: "report"
          title: ${{ steps.create-title.outputs.title }}
          body: |
            # report

            | service | host  | result |
            | --- | --- | --- | 
            | service1 | [service1のhost]  | ${{ needs.service1.result }} |
            | service2 | [service2のhost]  | ${{ needs.service2.result }} |

database:               # リストア先のDB情報（今回はActionで立てているDBの情報）
  type: mysql           # sqlドライバー
  name: service1        # DB名
  user: root            # DBユーザー
  password: hogefuga    # DBパスワード
  host: 127.0.0.1       # DBホスト
  port: 3307            # DBポート
check:
- query: "select * from users" # テストクエリ
  operator: exists             # operator(今回は結果がある場合はテストPASSするように指定)
backup:
  scp:                # dumpファイルがあるサーバーの情報
    host: 127.0.0.1   # ホスト
    port: 22          # scpに使用するポート
    user: user        # scpをするユーザー
    key: "path_to_backup_file/service1_{{ .Yesterday.Format \"20060102\" }}.gz" #dumpファイルがあるパス

- name: cp backup file
  uses: pepactions/ssh-action@v0.1.10
  with:
    host: [dumpファイルがあるホスト]
    username: hoge
    key: ${{secrets.[sshに使用する秘密鍵]}}
    port: 22
    envs: FILE
    script: |
      sudo cp path_to_backup_file/[dumpファイル名] /home/hoge/. 
      sudo chmod 755 /home/hoge/[dumpファイル名]

- name: set-file-name
  id: set-file-name
  run: |
    name=`ssh  hoge@[dumpファイルがあるホスト] "ls path_to_backup_file/" | grep "[dumpファイルの固定されている部分].*.gz"` # ファイル名をサーバーから取得
    echo "file=$name" >> "$GITHUB_OUTPUT" # 後続でも使えるようにoutputしておく
    echo "    key: '/home/hoge/$name'" >> .database/service1.yaml # database-restore-actionのkey設定を追記する