GitHub Actions

Siame vadove paaiskiname, kaip integruoti LoadFocus JMeter API klienta su GitHub Actions automatizuotam nasumui testuoti.

Nustatymo zingsniai

1. Saugokite kredencialus kaip GitHub slaptazodzius

Pirmiausia saugokite savo LoadFocus API kredencialus kaip GitHub saugyklos slaptazodzius:

  1. Eikite i savo GitHub saugykla
  2. Eikite i Settings > Secrets and variables > Actions
  3. Pridekite siuos saugyklos slaptazodzius:
    • LOADFOCUS_API_KEY: jusu LoadFocus API raktas
    • LOADFOCUS_TEAM_ID: jusu LoadFocus komandos ID

2. Sukurkite GitHub Actions darbo eiga

Sukurkite nauja faila savo saugykloje .github/workflows/performance-test.yml:

name: Performance Tests


on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main ]
  # Optional: Run on a schedule
  schedule:
    - cron: '0 0 * * 1'  # Run at midnight every Monday


jobs:
  performance-test:
    runs-on: ubuntu-latest


    steps:
    - uses: actions/checkout@v3


    - name: Setup Node.js
      uses: actions/setup-node@v3
      with:
        node-version: '16'


    - name: Install LoadFocus JMeter API Client
      run: npm install -g @loadfocus/loadfocus-api-client


    - name: Configure LoadFocus API Client
      run: |
        loadfocus-api config set apikey ${{ secrets.LOADFOCUS_API_KEY }}
        loadfocus-api config set teamid ${{ secrets.LOADFOCUS_TEAM_ID }}


    - name: Run Performance Tests
      run: |
        loadfocus-api jmeter run-test \
          --name "GitHub_${{ github.repository_owner }}_${{ github.repository }}_${{ github.ref_name }}" \
          --thresholds "avgresponse<=200,errors==0,p95<=250" \
          --format json > performance_results.json


    - name: Upload Performance Test Results
      uses: actions/upload-artifact@v3
      with:
        name: performance-test-results
        path: performance_results.json

3. Pridekite nasumo testavima prie diegimo darbo eigos

Norint, kad diegimas priklausytu nuo nasumo testu rezultatu:

name: Build, Test, and Deploy


on:
  push:
    branches: [ main ]


jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      # Your build steps...


  performance-test:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3


      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '16'


      - name: Install LoadFocus JMeter API Client
        run: npm install -g @loadfocus/loadfocus-api-client


      - name: Configure LoadFocus API Client
        run: |
          loadfocus-api config set apikey ${{ secrets.LOADFOCUS_API_KEY }}
          loadfocus-api config set teamid ${{ secrets.LOADFOCUS_TEAM_ID }}


      - name: Run Performance Tests
        run: |
          loadfocus-api jmeter run-test \
            --name "GitHub_${{ github.repository }}_${{ github.ref_name }}" \
            --thresholds "avgresponse<=200,errors==0,p95<=250" \
            --format json > performance_results.json


      - name: Upload Performance Test Results
        uses: actions/upload-artifact@v3
        with:
          name: performance-test-results
          path: performance_results.json


  deploy:
    needs: performance-test
    runs-on: ubuntu-latest
    steps:
      # Your deployment steps...

Isplestine konfiguracija

Matricinis testavimas kelioms aplinkoms

Vykdykite testus keliose aplinkose ar konfiguracijose:

jobs:
  performance-test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        environment: [dev, staging, production]
        test-type: [api, frontend]


    steps:
      # Setup steps...


      - name: Run Performance Tests
        run: |
          TEST_NAME="${{ matrix.test-type }}_test_${{ matrix.environment }}"


          # Adjust thresholds based on environment
          if [ "${{ matrix.environment }}" == "production" ]; then
            THRESHOLDS="avgresponse<=150,errors==0,p95<=200"
          else
            THRESHOLDS="avgresponse<=300,errors==0,p95<=500"
          fi


          loadfocus-api jmeter run-test \
            --name "$TEST_NAME" \
            --thresholds "$THRESHOLDS" \
            --format json > "performance_results_${{ matrix.environment }}_${{ matrix.test-type }}.json"

Nasumo testu ataskaitu kurimas

Generuokite HTML ataskaitas is JSON rezultatu:

- name: Generate HTML Report
  run: |
    # Install report generator
    npm install -g performance-report-generator


    # Generate HTML report
    performance-report-generator \
      --input performance_results.json \
      --output performance_report.html


- name: Upload HTML Report
  uses: actions/upload-artifact@v3
  with:
    name: performance-test-report
    path: performance_report.html


# Optional: Publish to GitHub Pages
- name: Publish to GitHub Pages
  uses: peaceiris/actions-gh-pages@v3
  with:
    github_token: ${{ secrets.GITHUB_TOKEN }}
    publish_dir: ./reports
    destination_dir: performance-reports

Testu rezultatu komentavimas PR

Pridekite nasumo testu rezultatus kaip komentara prie pakeitimu uzklausu (pull request):

- name: Comment PR
  uses: actions/github-script@v6
  if: github.event_name == 'pull_request'
  with:
    github-token: ${{ secrets.GITHUB_TOKEN }}
    script: |
      const fs = require('fs');
      const results = JSON.parse(fs.readFileSync('performance_results.json', 'utf8'));


      let comment = '## Performance Test Results\n\n';
      comment += `**Overall Result:** ${results.overallResult}\n\n`;


      comment += '### Results by Label\n\n';
      for (const label of results.labels) {
        comment += `#### ${label.label}\n`;
        comment += `- **Result:** ${label.result}\n`;
        comment += `- **Samples:** ${label.metrics.samples}\n`;
        comment += `- **Avg Response:** ${label.metrics.avgresponse}ms\n`;
        comment += `- **Error Rate:** ${label.metrics.errors}\n\n`;
      }


      github.rest.issues.createComment({
        issue_number: context.issue.number,
        owner: context.repo.owner,
        repo: context.repo.repo,
        body: comment
      });

Pakartotinai naudojama darbo eiga

Sukurkite pakartotinai naudojama darbo eiga nasumo testavimui:

# .github/workflows/reusable-performance-test.yml
name: Reusable Performance Test


on:
  workflow_call:
    inputs:
      test-name:
        required: true
        type: string
      thresholds:
        required: false
        type: string
        default: "avgresponse<=200,errors==0,p95<=250"
      wait-timeout:
        required: false
        type: number
        default: 1800
    secrets:
      LOADFOCUS_API_KEY:
        required: true
      LOADFOCUS_TEAM_ID:
        required: true


jobs:
  performance-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3


      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '16'


      - name: Install LoadFocus JMeter API Client
        run: npm install -g @loadfocus/loadfocus-api-client


      - name: Configure LoadFocus API Client
        run: |
          loadfocus-api config set apikey ${{ secrets.LOADFOCUS_API_KEY }}
          loadfocus-api config set teamid ${{ secrets.LOADFOCUS_TEAM_ID }}


      - name: Run Performance Tests
        run: |
          loadfocus-api jmeter run-test \
            --name "${{ inputs.test-name }}" \
            --thresholds "${{ inputs.thresholds }}" \
            --waitTimeout ${{ inputs.wait-timeout }} \
            --format json > performance_results.json


      - name: Upload Performance Test Results
        uses: actions/upload-artifact@v3
        with:
          name: performance-test-results
          path: performance_results.json

Tada iskviekite ja is kitos darbo eigos:

# .github/workflows/main.yml
jobs:
  call-performance-test:
    uses: ./.github/workflows/reusable-performance-test.yml
    with:
      test-name: "API_Performance_Test"
      thresholds: "avgresponse<=150,errors==0"
    secrets:
      LOADFOCUS_API_KEY: ${{ secrets.LOADFOCUS_API_KEY }}
      LOADFOCUS_TEAM_ID: ${{ secrets.LOADFOCUS_TEAM_ID }}

Patarimai GitHub Actions integracijai

  1. Podeliu naudojimas: naudokite npm priklausomybiu podeli, kad pagreitintumete darbo eigos vykdyma:

    - name: Cache Node modules
      uses: actions/cache@v3
      with:
        path: ~/.npm
        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
        restore-keys: |
          ${{ runner.os }}-node-

  2. Lygiagretaus vykdymo valdymas: apribokite vienu metu vykdomu nasumo testu skaiciu:

    concurrency:
      group: performance-test-${{ github.ref }}
      cancel-in-progress: false

  3. Aplinkos specifiniai testai: naudokite GitHub aplinkas skirtingoms testu konfiguracijoms:

    jobs:
      performance-test:
        runs-on: ubuntu-latest
        environment: staging
        # Environment-specific variables are available here

  4. Salyginis testavimas: vykdykite nasumo testus tik tada, kai pasikeicia konkretius failai:

    jobs:
      performance-test:
        if: |
          contains(github.event.pull_request.labels.*.name, 'performance-test') ||
          github.event_name == 'schedule' ||
          contains(github.event.head_commit.message, '[perf-test]')

Daugiau informacijos rasite GitHub Actions dokumentacijoje ir LoadFocus API kliento dokumentacijoje.

Ankstesnis
CircleCI
Kitas
GitLab CI/CD