slo.yml

name: SLO

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  workflow_dispatch:
    inputs:
      github_pull_request_number:
        required: true
      slo_workload_duration_seconds:
        default: '600'
        required: false
      slo_workload_read_max_rps:
        default: '1000'
        required: false
      slo_workload_write_max_rps:
        default: '100'
        required: false

jobs:
  ydb-slo-action:
    if: (!contains(github.event.pull_request.labels.*.name, 'no slo'))

    name: Run YDB SLO Tests
    runs-on: ubuntu-latest

    strategy:
      matrix:
        workload:
          - sync-table
          - sync-query

    concurrency:
      group: slo-${{ github.ref }}-${{ matrix.workload }}
      cancel-in-progress: true

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Install Python3
        uses: actions/setup-python@v5
        with:
          python-version: '3.8'
          cache: 'pip'

      - name: Install dependencies
        run: |
          python -m pip install --no-cache-dir --upgrade pip
          python -m pip install --no-cache-dir -e .
          python -m pip install --no-cache-dir -r tests/slo/requirements.txt

      - name: Initialize YDB SLO
        uses: ydb-platform/ydb-slo-action/init@main
        with:
          github_pull_request_number: ${{ github.event.inputs.github_pull_request_number }}
          github_token: ${{ secrets.GITHUB_TOKEN }}
          workload_name: ${{ matrix.workload }}
          ydb_database_node_count: 5

      - name: Prepare SLO Database
        run: |
          python ./tests/slo/src create grpc://localhost:2135 /Root/testdb

      - name: Run SLO Tests
        env:
          REF: '${{ github.head_ref || github.ref }}'
          WORKLOAD: '${{ matrix.workload }}'
        run: |
          python ./tests/slo/src run grpc://localhost:2135 /Root/testdb \
            --prom-pgw localhost:9091 \
            --report-period 250 \
            --time ${{inputs.slo_workload_duration_seconds || 600}} \
            --read-rps ${{inputs.slo_workload_read_max_rps || 1000}} \
            --write-rps ${{inputs.slo_workload_write_max_rps || 100}} \
            --read-timeout 1000 \
            --write-timeout 1000

      - if: always()
        name: Cleanup SLO Database
        run: |
          python ./tests/slo/src cleanup grpc://localhost:2135 /Root/testdb

      - if: always()
        name: Store ydb chaos testing logs
        run: |
          docker logs ydb-chaos > chaos-ydb.log

      - if: always()
        uses: actions/upload-artifact@v4
        with:
          name: ${{ matrix.workload }}-chaos-ydb.log
          path: ./chaos-ydb.log
          retention-days: 1