Algolia

    GitLab CI/CD

    Denna guide förklarar hur du integrerar LoadFocus JMeter API-klienten med GitLab CI/CD för automatiserad prestandatestning.

    Installationssteg

    1. Lagra autentiseringsuppgifter som GitLab CI/CD-variabler

    Lagra först dina LoadFocus API-autentiseringsuppgifter som GitLab CI/CD-variabler:

    1. Gå till ditt GitLab-projekt
    2. Navigera till Settings > CI/CD > Variables
    3. Lägg till följande variabler:
      • LOADFOCUS_API_KEY: Din LoadFocus API-nyckel (markera som "Masked")
      • LOADFOCUS_TEAM_ID: Ditt LoadFocus team-ID

    2. Skapa en GitLab CI/CD-pipeline

    Skapa eller uppdatera din .gitlab-ci.yml-fil i ditt repository:

    stages:
      - build
      - test
      - performance
      - deploy
    

    variables:
      NODE_VERSION: "16"
    

    build:
      stage: build
      image: node:${NODE_VERSION}
      script:
        - npm install
        - npm run build
      artifacts:
        paths:
          - dist/
        expire_in: 1 week
    

    test:
      stage: test
      image: node:${NODE_VERSION}
      script:
        - npm install
        - npm test
    

    performance_test:
      stage: performance
      image: node:${NODE_VERSION}
      script:
        # Installera LoadFocus JMeter API-klienten
        - npm install -g @loadfocus/loadfocus-api-client
    

        # Konfigurera LoadFocus API-klienten
        - loadfocus-api config set apikey $LOADFOCUS_API_KEY
        - loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
    

        # Kör prestandatester
        - |
          loadfocus-api jmeter run-test \
            --name "GitLab_${CI_PROJECT_NAME}_${CI_COMMIT_REF_NAME}" \
            --thresholds "avgresponse<=200,errors==0,p95<=250" \
            --format json > performance_results.json
      artifacts:
        paths:
          - performance_results.json
        expire_in: 1 week
        when: always
      # Valfritt: Kör bara på specifika brancher
      only:
        - main
        - develop
    

    deploy:
      stage: deploy
      script:
        - echo "Deploying application..."
      only:
        - main
      # Deploya bara om alla tidigare steg lyckades
      when: on_success

    3. Visa testresultat

    Efter att pipelinen har körts:

    1. Gå till ditt GitLab-projekt
    2. Navigera till CI/CD > Pipelines
    3. Hitta din pipeline och klicka på den
    4. Gå till jobbet "performance_test"
    5. Klicka på "Browse" i höger sidofält för att visa artefakter
    6. Ladda ner och visa filen performance_results.json

    Avancerad konfiguration

    Miljöspecifik testning

    Kör olika prestandatester för olika miljöer:

    .performance_test_template: &performance_test_definition
      stage: performance
      image: node:${NODE_VERSION}
      script:
        - npm install -g @loadfocus/loadfocus-api-client
        - loadfocus-api config set apikey $LOADFOCUS_API_KEY
        - loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
        - |
          loadfocus-api jmeter run-test \
            --name "${TEST_NAME}" \
            --thresholds "${THRESHOLDS}" \
            --format json > performance_results.json
      artifacts:
        paths:
          - performance_results.json
        expire_in: 1 week
        when: always
    

    performance_test_develop:
      <<: *performance_test_definition
      variables:
        TEST_NAME: "API_Test_Develop"
        THRESHOLDS: "avgresponse<=300,errors==0,p95<=500"
      only:
        - develop
    

    performance_test_staging:
      <<: *performance_test_definition
      variables:
        TEST_NAME: "API_Test_Staging"
        THRESHOLDS: "avgresponse<=250,errors==0,p95<=350"
      only:
        - staging
    

    performance_test_production:
      <<: *performance_test_definition
      variables:
        TEST_NAME: "API_Test_Production"
        THRESHOLDS: "avgresponse<=200,errors==0,p95<=250"
      only:
        - main

    Parallell testning

    Kör flera prestandatester parallellt:

    performance_test_api:
      stage: performance
      image: node:${NODE_VERSION}
      script:
        - npm install -g @loadfocus/loadfocus-api-client
        - loadfocus-api config set apikey $LOADFOCUS_API_KEY
        - loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
        - |
          loadfocus-api jmeter run-test \
            --name "API_Performance_Test" \
            --thresholds "avgresponse<=150,errors==0" \
            --format json > api_performance_results.json
      artifacts:
        paths:
          - api_performance_results.json
        expire_in: 1 week
    

    performance_test_ui:
      stage: performance
      image: node:${NODE_VERSION}
      script:
        - npm install -g @loadfocus/loadfocus-api-client
        - loadfocus-api config set apikey $LOADFOCUS_API_KEY
        - loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
        - |
          loadfocus-api jmeter run-test \
            --name "UI_Performance_Test" \
            --thresholds "avgresponse<=300,errors==0" \
            --format json > ui_performance_results.json
      artifacts:
        paths:
          - ui_performance_results.json
        expire_in: 1 week

    Skapa sedan ett pipeline-schema i GitLab:

    1. Gå till ditt GitLab-projekt
    2. Navigera till CI/CD > Schedules
    3. Klicka på "New schedule"
    4. Konfigurera ett schema (t.ex. varje dag vid midnatt)

    Skapa prestandarapporter

    Generera HTML-rapporter från JSON-resultat:

    performance_test:
      stage: performance
      image: node:${NODE_VERSION}
      script:
        # Kör prestandatest
        - npm install -g @loadfocus/loadfocus-api-client
        - loadfocus-api config set apikey $LOADFOCUS_API_KEY
        - loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
        - |
          loadfocus-api jmeter run-test \
            --name "GitLab_${CI_PROJECT_NAME}_${CI_COMMIT_REF_NAME}" \
            --thresholds "avgresponse<=200,errors==0,p95<=250" \
            --format json > performance_results.json
    

        # Generera HTML-rapport
        - npm install -g performance-report-generator  # Ersätt med faktisk rapportgenerator
        - performance-report-generator --input performance_results.json --output performance_report.html
      artifacts:
        paths:
          - performance_results.json
          - performance_report.html
        expire_in: 1 week
        when: always
      # Valfritt: Publicera rapport som GitLab Pages
      pages:
        stage: deploy
        dependencies:
          - performance_test
        script:
          - mkdir -p public/performance-reports
          - cp performance_report.html public/performance-reports/index.html
        artifacts:
          paths:
            - public
        only:
          - main

    Integration med GitLab-funktioner

    Merge Request-widgets

    Visa prestandatestresultat i merge requests genom att använda GitLabs JUnit-rapportfunktion:

    performance_test:
      stage: performance
      image: node:${NODE_VERSION}
      script:
        # Kör prestandatest
        - npm install -g @loadfocus/loadfocus-api-client
        - loadfocus-api config set apikey $LOADFOCUS_API_KEY
        - loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
        - |
          loadfocus-api jmeter run-test \
            --name "GitLab_${CI_PROJECT_NAME}_${CI_COMMIT_REF_NAME}" \
            --thresholds "avgresponse<=200,errors==0,p95<=250" \
            --format json > performance_results.json
    

        # Konvertera till JUnit-format (med ett anpassat skript)
        - node convert-to-junit.js performance_results.json junit-report.xml
      artifacts:
        reports:
          junit: junit-report.xml
        paths:
          - performance_results.json
        expire_in: 1 week

    GitLab-mätvärden

    Använd GitLabs mätvärdsfunktion för att spåra prestanda över tid:

    performance_test:
      stage: performance
      image: node:${NODE_VERSION}
      script:
        # Kör prestandatest
        - npm install -g @loadfocus/loadfocus-api-client
        - loadfocus-api config set apikey $LOADFOCUS_API_KEY
        - loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
        - |
          loadfocus-api jmeter run-test \
            --name "GitLab_${CI_PROJECT_NAME}_${CI_COMMIT_REF_NAME}" \
            --thresholds "avgresponse<=200,errors==0,p95<=250" \
            --format json > performance_results.json
    

        # Extrahera mätvärden och rapportera dem till GitLab
        - |
          # Parsa JSON och extrahera mätvärden
          RESPONSE_TIME=$(jq '.labels[0].metrics.avgresponse' performance_results.json)
          ERROR_RATE=$(jq '.labels[0].metrics.errors' performance_results.json)
    

          # Rapportera mätvärden
          echo "performance_avg_response_time ${RESPONSE_TIME}" >> metrics.txt
          echo "performance_error_rate ${ERROR_RATE}" >> metrics.txt
      artifacts:
        reports:
          metrics: metrics.txt
        paths:
          - performance_results.json
        expire_in: 1 week

    GitLab-miljöer

    Koppla prestandatester till specifika miljöer:

    performance_test_staging:
      stage: performance
      image: node:${NODE_VERSION}
      environment:
        name: staging
      script:
        - npm install -g @loadfocus/loadfocus-api-client
        - loadfocus-api config set apikey $LOADFOCUS_API_KEY
        - loadfocus-api config set teamid $LOADFOCUS_TEAM_ID
        - |
          loadfocus-api jmeter run-test \
            --name "Staging_Performance_Test" \
            --thresholds "avgresponse<=250,errors==0" \
            --format json > performance_results.json
      artifacts:
        paths:
          - performance_results.json
        expire_in: 1 week
      only:
        - staging

    Tips för GitLab CI/CD-integration

    1. Cachning: Cacha npm-beroenden för att snabba upp pipeline-körningar:

      performance_test:
        stage: performance
        image: node:${NODE_VERSION}
        cache:
          key: ${CI_COMMIT_REF_SLUG}
          paths:
            - node_modules/
        script:
          - npm install -g @loadfocus/loadfocus-api-client
          # Resten av skriptet...

    2. Timeout-inställningar: Ange timeouts för långvariga prestandatester:

      performance_test:
        stage: performance
        image: node:${NODE_VERSION}
        timeout: 2h  # Ange en 2-timmars timeout
        script:
          # Prestandatestskript...

    3. Manuella utlösare: Tillåt att prestandatester utlöses manuellt:

      performance_test:
        stage: performance
        image: node:${NODE_VERSION}
        script:
          # Prestandatestskript...
        when: manual

    4. Dynamisk testkonfiguration: Använd GitLabs fördefinierade variabler för att dynamiskt konfigurera tester:

      performance_test:
        stage: performance
        image: node:${NODE_VERSION}
        script:
          - |
            # Ange tröskelvärden baserat på branch
            if [ "$CI_COMMIT_REF_NAME" = "main" ]; then
              THRESHOLDS="avgresponse<=200,errors==0,p95<=250"
            else
              THRESHOLDS="avgresponse<=300,errors==0,p95<=500"
            fi
      

            loadfocus-api jmeter run-test \
              --name "GitLab_${CI_PROJECT_NAME}_${CI_COMMIT_REF_NAME}" \
              --thresholds "$THRESHOLDS" \
              --format json > performance_results.json

    5. Notifieringar: Skicka notifieringar när prestandatester misslyckas:

      performance_test:
        stage: performance
        image: node:${NODE_VERSION}
        script:
          # Prestandatestskript...
        after_script:
          - |
            if [ $? -ne 0 ]; then
              # Skicka notifiering med curl, GitLab API eller annan metod
              curl -X POST -H "Content-Type: application/json" \
                -d "{\"text\":\"Performance test failed for ${CI_PROJECT_NAME}\"}" \
                $WEBHOOK_URL
            fi

    För mer information, se GitLab CI/CD-dokumentationen och LoadFocus API-klientdokumentationen.

    Föregående
    GitHub Actions
    Nästa
    Jenkins