CircleCI

Tento průvodce vysvětluje, jak integrovat klienta LoadFocus JMeter API s CircleCI pro automatizované výkonnostní testování.

Kroky nastavení

1. Přidání proměnných prostředí

Uložte vaše LoadFocus API přihlašovací údaje jako proměnné prostředí v CircleCI:

Přejděte k vašemu projektu v CircleCI
Přejděte na Project Settings > Environment Variables
Přidejte následující proměnné:
- LOADFOCUS_API_KEY: Váš LoadFocus API klíč
- LOADFOCUS_TEAM_ID: Vaše LoadFocus team ID

2. Konfigurace CircleCI workflow

Vytvořte nebo aktualizujte váš soubor .circleci/config.yml pro zahrnutí výkonnostního testování:

version: 2.1
jobs:
  performance_test:
    docker:
      - image: cimg/node:16.13
    steps:
      - checkout
      - run:
          name: Install LoadFocus JMeter API Client
          command: npm install -g @loadfocus/loadfocus-api-client
      - run:
          name: Configure LoadFocus API Client
          command: |
            loadfocus-api config set apikey $LOADFOCUS_API_KEY
            loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
      - run:
          name: Run Performance Tests
          command: |
            loadfocus-api jmeter run-test \
              --name "CircleCI_${CIRCLE_PROJECT_REPONAME}_${CIRCLE_BRANCH}" \
              --thresholds "avgresponse<=200,errors==0,p95<=250" \
              --format json > performance_results.json
      - store_artifacts:
          path: performance_results.json
          destination: performance-test-results

workflows:
  version: 2
  build_test_deploy:
    jobs:
      - build_and_test
      - performance_test:
          requires:
            - build_and_test
      - deploy:
          requires:
            - performance_test
          filters:
            branches:
              only: main

3. Selhání buildu při výkonnostních problémech

Aby vaše pipeline selhala, když nejsou splněny výkonnostní prahové hodnoty, upravte krok "Run Performance Tests":

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

      # Check exit code - the command will exit with code 1 if thresholds are not met
      if [ $? -ne 0 ]; then
        echo "Performance test failed to meet thresholds"
        exit 1
      fi

Pokročilá konfigurace

Paralelní testování

Pro spouštění více výkonnostních testů paralelně:

performance_tests:
  docker:
    - image: cimg/node:16.13
  parallelism: 3
  steps:
    - checkout
    - run:
        name: Install LoadFocus JMeter API Client
        command: npm install -g @loadfocus/loadfocus-api-client
    - run:
        name: Configure LoadFocus API Client
        command: |
          loadfocus-api config set apikey $LOADFOCUS_API_KEY
          loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
    - run:
        name: Run Performance Tests
        command: |
          # Get test name based on index
          TESTS=("API_Test" "Frontend_Test" "Database_Test")
          INDEX=$(( $CIRCLE_NODE_INDEX % 3 ))
          TEST_NAME=${TESTS[$INDEX]}

          echo "Running test: $TEST_NAME"

          loadfocus-api jmeter run-test \
            --name "$TEST_NAME" \
            --thresholds "avgresponse<=200,errors==0,p95<=250" \
            --format json > "performance_results_${TEST_NAME}.json"
    - store_artifacts:
        path: performance_results_*.json
        destination: performance-test-results

Tipy pro integraci s CircleCI

Alokace zdrojů: Ujistěte se, že váš CircleCI plán má dostatečné zdroje pro spouštění výkonnostních testů, zejména pokud jsou dlouho běžící.

Nastavení timeoutu: Pro delší testy upravte timeout úlohy v CircleCI:

- run:
    name: Run Performance Tests
    command: loadfocus-api jmeter run-test --name "Test_Name" --waitTimeout 3600
    no_output_timeout: 60m

Podmíněné testování: Spouštějte výkonnostní testy pouze na konkrétních větvích nebo pro konkrétní commity:

performance_test:
  # Only run if commit message contains [PERF-TEST]
  when:
    condition:
      or:
        - equal: [ main, << pipeline.git.branch >> ]
        - matches:
            pattern: ".*\\[PERF-TEST\\].*"
            value: << pipeline.git.commit.message >>

Oznámení: Nastavte oznámení při selhání výkonnostních testů:

- run:
    name: Notify on Performance Test Failure
    command: |
      if [ $? -ne 0 ]; then
        curl -X POST -H "Content-Type: application/json" \
          -d '{"text":"Performance test failed for $CIRCLE_PROJECT_REPONAME"}' \
          $SLACK_WEBHOOK_URL
      fi
    when: on_fail

Pro více informací se obraťte na dokumentaci CircleCI a dokumentaci LoadFocus API klienta.