Uruchamianie testów JMeter w OpenShift za pomocą Jenkins Pipeline

Cześć wszystkim!

W tym artykule chciałbym podzielić się jednym ze sposobów uruchamiania testów wydajności JMeter w OpenShift przy użyciu Jenkins jako automatyzacji. Najpierw wykonamy wszystkie niezbędne działania (tworzenie ImageStreams, BuildConfig, Zadanie i inne) w trybie ręcznym. Po tym napiszemy Jenkins Pipeline.

Jako punkt wyjścia powinniśmy mieć:

  1. działający klaster OpenShift (v3.11)
  2. serwer Jenkins z skonfigurowanymi danymi logowania do pracy w OpenShift
  3. pliku apache-jmeter-5.2.tgz

Jako testy wykorzystamy prosty HTTP Request na ya.ru w jednym wątku.

Tworzenie projektu w OpenShift

Zaczniemy od stworzenia nowego środowiska. Utworzymy perftest środowisko poleceniem:

$ oc new-project perftest --display-name="Testy Wydajności" --description="Tests Performance - JMeter"

Zostaniemy automatycznie przeniesieni do właśnie stworzonego środowiska perftest, sprawdźmy, że tak jest:

$ oc project
Using project "perftest" on server "https://127.0.0.1:8443".

Tworzenie Storage’a

Raporty testów będą przechowywane w wspólnym miejscu dla serwera www i jmeter-meter'a miejscu — /jmeter/reports.

Storage warto stworzyć teraz, ponieważ będą od nich zależne POD’y jmeter-web i jmeter-master.

Szczegółowe informacje dotyczące storage’y znajdziesz w oficjalnej dokumentacji Persistent Storage.

Stwórzmy pliki yaml dla PV i PVC.

pv.yaml

$ tee pv.yaml<<EOF
apiVersion: v1
kind: PersistentVolume
metadata:
  name: jmeter-reports
spec:
  capacity:
    storage: 10Gi
  accessModes:
    - ReadWriteMany
  glusterfs:
    endpoints: glusterfs-cluster
    path: /jmeter/reports
    readOnly: false
  persistentVolumeReclaimPolicy: Retain
EOF

pvc.yaml

$ tee pvc.yaml<<EOF
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: jmeter-reports
spec:
  accessModes:
    - ReadWriteMany
  resources:
    requests:
      storage: 10Gi
EOF

Utworzymy PV i PVC w środowisku OpenShift:

$ oc create -f pv.yaml -n perftest
$ oc create -f pvc.yaml -n perftest

Sprawdzamy status dla PVC:

$ oc get pvc -n perftest
NAME             STATUS    VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS        AGE
jmeter-reports   Bound     pvc-b0e5f152-db4b-11ea-a497-566f75280024   10Gi       RWX            glusterfs-storage   8m

Oto, jak będzie wyglądać w GUI:

Uruchamianie testów JMeter w OpenShift za pomocą Jenkins Pipeline

Tworzenie podstawowego obrazu JMeter

Przejdźmy do tworzenia ImageStream i BuildConfig.

Wszystkie potrzebne informacje znajdziesz w dokumentacji — Builds and Image Streams.

Jako strategię budowy obrazów zastosowano Docker z lokalnego źródła.

Stwórzmy podstawowy obraz jmeter-base, który będzie podstawą dla jmeter-master.

Dockerfile

FROM openjdk:8u212-jdk

ARG JMETER_VER="5.2"
ENV JMETER_HOME /jmeter/apache-jmeter-$JMETER_VER
ENV PATH $JMETER_HOME/bin:$PATH

RUN mkdir -p /jmeter/results 
    && mkdir /jmeter/tests

WORKDIR /jmeter

COPY apache-jmeter-$JMETER_VER.tgz .

RUN tar -xzf $JMETER_HOME.tgz 
    && rm $JMETER_HOME.tgz 
    && ls -la

RUN sed -i s/#server.rmi.ssl.disable=false/server.rmi.ssl.disable=true/ $JMETER_HOME/bin/jmeter.properties

EXPOSE 60000

is.yaml

$ tee is.yaml<<EOF
apiVersion: v1
kind: ImageStream
metadata:
  labels:
    build: jmeter-base
  name: jmeter-base
EOF

bc.yaml

$ tee bc.yaml<<EOF
apiVersion: v1
kind: BuildConfig
metadata:
  name: jmeter-base
spec:
  failedBuildsHistoryLimit: 5
  nodeSelector: null
  output:
    to:
      kind: ImageStreamTag
      name: 'jmeter-base:latest'
  postCommit: {}
  resources: {}
  runPolicy: Serial
  source:
    binary: {}
    type: Binary
  strategy:
    dockerStrategy:
      from:
        kind: ImageStreamTag
        name: 'openjdk:8u212-jdk'
    type: Docker
  successfulBuildsHistoryLimit: 5
EOF

Utworzymy obiekty IS i BC:

$ oc create -f is.yaml -n perftest
$ oc create -f bc.yaml -n perftest

Teraz zbudujemy podstawowy obraz jmeter-base:

$ oc start-build jmeter-base -n perftest --from-dir=. --follow

JMeter WEB

jmeter-web to serwer WWW Apache. Jego zadaniem jest udostępnienie katalogu z wynikami testów do przeglądania.

Przygotowano Dockerfile i plik konfiguracyjny httpd.conf. Dla dyrektywy DocumentRoot ustawiono wartość /jmeter/reports, t.j. katalog, w którym przechowywane są wyniki testów.

Dockerfile

$ tee Dockerfile<<EOF
FROM httpd:2.4

COPY httpd.conf /usr/local/apache2/conf/httpd.conf
RUN chmod -R 777 /usr/local/apache2/logs

EXPOSE 8080

CMD ["httpd", "-D", "FOREGROUND"]
EOF

is.yaml

$ tee is.yaml<<EOF
apiVersion: v1
kind: ImageStream
metadata:
  generation: 1
  labels:
    build: jmeter-web
  name: jmeter-web
EOF

bc.yaml

$ tee bc.yaml<<EOF
apiVersion: v1
kind: BuildConfig
metadata:
  name: jmeter-web
spec:
  failedBuildsHistoryLimit: 5
  nodeSelector: null
  output:
    to:
      kind: ImageStreamTag
      name: 'jmeter-web:latest'
  runPolicy: Serial
  source:
    binary: {}
    type: Binary
  strategy:
    dockerStrategy:
      from:
        kind: ImageStreamTag
        name: 'httpd:2.4'
    type: Docker
  successfulBuildsHistoryLimit: 5
EOF

Utworzymy ImageStream i BuildConfig obiekty:

$ oc create -f is.yaml -n perftest
$ oc create -f bc.yaml -n perftest

Budujemy obraz z Dockerfile:

$ oc start-build jmeter-web -n perftest --from-dir=. --follow

dc.yaml

$ tee dc.yaml<<EOF
apiVersion: apps.openshift.io/v1
kind: DeploymentConfig
metadata:
  name: jmeter-web
spec:
  replicas: 1
  template:
    metadata:
      labels:
        name: jmeter-web
    spec:
      containers:
        - image: 172.30.1.1:5000/perftest/jmeter-web
          name: jmeter-web
          volumeMounts:
            - mountPath: /jmeter/reports
              name: jmeter-reports
          ports:
            - containerPort: 80
              protocol: TCP
            - containerPort: 8080
              protocol: TCP
      volumes:
        - name: jmeter-reports
          persistentVolumeClaim:
            claimName: jmeter-reports
EOF

sc.yaml

$ tee sc.yaml<<EOF
apiVersion: v1
kind: Service
metadata:
  labels:
    app: jmeter-web
  name: jmeter-web
spec:
  ports:
    - name: 8080-tcp
      port: 8080
      protocol: TCP
      targetPort: 8080
  selector:
    deploymentconfig: jmeter-web
  sessionAffinity: None
  type: ClusterIP
EOF

Utworzymy obiekty Service i DeploymentConfig:

$ oc create -f sc.yaml -n perftest
$ oc create -f dc.yaml -n perftest

Jmeter-master

Zajmijmy się wdrażaniem serwera WWW Apache.

To jest Dockerfile jmeter-master‘a, oparty na jmeter-base, który będzie uruchamiał testy i zapisywał wyniki w magazynie.

Dockerfile

Dockerfile do jmeter-master, oparty na jmeter-base.

FROM jmeter-base

ARG JMETER_VER="5.2"
ENV JMETER_HOME /jmeter/apache-jmeter-$JMETER_VER
ENV PATH $JMETER_HOME/bin:$PATH

WORKDIR /jmeter
COPY run.sh /jmeter/
COPY tests/*.jmx /jmeter/tests/
RUN chmod +x /jmeter/run.sh

ENTRYPOINT ["/bin/bash"]
CMD ["/jmeter/run.sh"]

run.sh

run.sh to skrypt, który uruchamia JMeter'a i zapisuje wyniki w katalogu files.

Przy każdym uruchomieniu skryptu usuwane są wcześniejsze testy, więc można pracować tylko z danymi najnowszymi. Ale to nie jest problem, ponieważ można go dostosować do swoich potrzeb.

#!/bin/bash

set -e

if [ -d "/jmeter/reports/files" ]
then
    echo "Directory /jmeter/reports/files exist - OK"
else
    echo "Creating /jmeter/reports/files directory"
    mkdir /jmeter/reports/files
fi

if [ -d "/jmeter/reports/dashboards" ]
then
    echo "Directory /jmeter/reports/dashboards exist"
else
    echo "Creating /jmeter/reports/dashboards directory"
    mkdir /jmeter/reports/dashboards
fi

echo "*** JMeter START Tests ***"

for item in $(ls -1 /jmeter/tests | grep jmx)
do
    echo "*** Removing dashboard directory for $item"
    rm -rdf /jmeter/reports/dashboards/${item}*

    echo "*** Removing tests directory for $item"
    rm -rdf /jmeter/reports/files/${item}*

    echo "*** Testing a $item file ***"
    jmeter -n -t /jmeter/tests/${item} -l /jmeter/reports/files/${item}-report.jtl -e -o /jmeter/reports/dashboards/${item}-dash
done

is.yaml

$ tee is.yaml<<EOF
apiVersion: image.openshift.io/v1
kind: ImageStream
metadata:
  generation: 1
  labels:
    build: jmeter-master
  name: jmeter-master
EOF

bc.yaml

$ tee bc.yaml<<EOF
apiVersion: build.openshift.io/v1
kind: BuildConfig
metadata:
  name: jmeter-master
spec:
  failedBuildsHistoryLimit: 5
  nodeSelector: null
  output:
    to:
      kind: ImageStreamTag
      name: 'jmeter-master:latest'
  runPolicy: Serial
  source:
    binary: {}
    type: Binary
  strategy:
    dockerStrategy:
      from:
        kind: ImageStreamTag
        name: 'jmeter-base:latest'
    type: Docker
  successfulBuildsHistoryLimit: 5
EOF

Utworzymy IS i BC obiekty:

$ oc create -f is.yaml -n perftest
$ oc create -f bc.yaml -n perftest

Budujemy jmeter-master obraz:

$ oc start-build jmeter-master -n perftest --from-dir=. --follow

Zadanie

Zadanie‘s są używane do OpenShift‘e do uruchomienia jednego lub więcej POD‘ów i zapewnienia ich pomyślnego zakończenia po wykonaniu polecenia/skryptu.

$ tee job.yaml<<EOF
apiVersion: batch/v1
kind: Job
metadata:
  name: jmeter-master
  labels:
    jobName: jmeter-master
spec:
  completions: 1
  parallelism: 1
  template:
    metadata:
      name: jmeter-master
      labels:
        jobName: jmeter-master
    spec:
      containers:
        - name: jmeter-master
          image: 172.30.1.1:5000/perftest/jmeter-master:latest
          volumeMounts:
            - mountPath: /jmeter/reports
              name: jmeter-reports
          imagePullPolicy: Always
      volumes:
        - name: jmeter-reports
          persistentVolumeClaim:
            claimName: jmeter-reports
      restartPolicy: Never
      terminationGracePeriodSeconds: 30
EOF

Tworzymy obiekt Zadanie:

$ oc create -f job.yaml -n perftest

Sprawdźmy status zadania:

$ oc get jobs -n perftest
NAME            DESIRED   SUCCESSFUL   AGE
jmeter-master   1         1            5m

Aby usunąć Zadanie użyjemy polecenia:

$ oc delete jobs/jmeter-master -n perftest --ignore-not-found=true

Jenkins Pipeline

Teraz automatyzacja. Powtórzmy kroki:

  1. git clone
  2. oc whoami -t
  3. oc start-build ...
  4. oc delete jobs/jmeter-master
  5. oc create -f job.yaml -n perftest

Poniżej znajduje się pipeline, w którym wykonywane są klonowanie repozytoriów, usuwanie i tworzenie OpenShift Zadanie‘ów.

#!groovy

pipeline {

    agent any

    stages {

        stage('Start Notifications') {
            steps {
                echo "Sending Email Notification"
            }
            post {
                always {
                    echo "STARTED - Performance Tests"
                    mail(to: 'username@srv.net', from: "jenkins@srv.net", subject: "START - Performance Tests",mimeType: "text/html", body: "<strong>START - Testy wydajnościowe</strong><br /><br />Projekt: Nazwa projektu<br />Środowisko: PerfTest<br />Numer kompilacji: ${env.BUILD_NUMBER}<br />URL kompilacji:   ${env.BUILD_URL}"
                }
            }
        }

        etap('Git checkout') {
            kroki {
                ...
            }
        }

        etap('Testy wydajnościowe') {
            kroki {
                skrypt {
                    sh '''
                        OC_CMD1="oc login -u=użytkownik -p=HASŁO -n=perftest 
                        --server=https://...:8443"

                        $OC_CMD1

                        OC_TOKEN=`oc whoami -t`

                        OC_CMD2="oc --token=$OC_TOKEN --server=https://...:8443 
                        start-build jmeter-master -n=perftest --from-dir=./master 
                        --follow=true"

                        OC_CMD3="oc --token=$OC_TOKEN --server=https://...:8443 
                        delete jobs/jmeter-master -n=perftest --ignore-not-found=true"

                        OC_CMD4="oc --token=$OC_TOKEN --server=https://...:8443 
                        create -f ./master/job.yaml -n=perftest"

                        $OC_CMD2
                        $OC_CMD3
                        $OC_CMD4
                    '''
                }
            }
        }

        po {
            niepowodzenie {
                echo "NIEUDANE - Testy wydajnościowe"
                mail(to: 'username@srv.net', from: "jenkins@srv.net", subject: "NIEUDANE - Testy wydajnościowe", mimeType: "text/html", body: "<strong>NIEUDANE - Testy wydajnościowe</strong><br /><br />Projekt: Nazwa projektu<br />Środowisko: PerfTest<br />Numer kompilacji: ${env.BUILD_NUMBER}<br />URL kompilacji: ${env.BUILD_URL}"
                }

            sukces {
                echo "UDANE - Testy wydajnościowe"
                mail(to: 'username@srv.net', from: "jenkins@srv.net", subject: "UDANE - Testy wydajnościowe", mimeType: "text/html", body: "<strong>UDANE - Testy wydajnościowe</strong><br /><br />Projekt: Nazwa projektu<br />Środowisko: PerfTest<br />Numer kompilacji: ${env.BUILD_NUMBER}<br />URL kompilacji:   ${env.BUILD_URL}"
            }
        }

    }
}

Po uruchomieniu Pipeline otrzymamy powiadomienie na e-mail 'username@srv.net od jenkins@srv.net.

Przechodząc pod ten link http://jmeter-web.127.0.0.1.nip.io/ zobaczymy katalog files, w którym przechowywane są raporty testów:

Uruchamianie testów JMeter w OpenShift za pomocą Jenkins Pipeline

Zawartość pliku ya.HTTP.Request.jmx-report.jtk:

timeStamp,elapsed,label,responseCode,responseMessage,threadName,dataType,success,failureMessage,bytes,sentBytes,grpThreads,allThreads,URL,Latency,IdleTime,Connect
1597311456443,569,Yandex - HTTP Request,200,Ok,Thread Group 1-1,text,true,,59449,220,1,1,https://ya.ru/,145,0,57
1597311456443,147,Yandex - HTTP Request-0,302,Found,Thread Group 1-1,,true,,478,110,1,1,http://ya.ru/,145,0,57
1597311456592,420,Yandex - HTTP Request-1,200,Ok,Thread Group 1-1,text,true,,58971,110,1,1,https://ya.ru/,370,0,259

Podsumowanie

W tym artykule zaprezentowano jeden ze sposobów uruchamiania testów JMeter w środowisku OpenShift. Wykonano wszystkie kroki ręcznie, a następnie stworzono Jenkins Pipeline do automatyzacji procesu uruchamiania testów.

Źródła i dokumentacja

Źródło: habr.com

Kup solidny hosting stron z ochroną przed DDoS, serwery VPS VDS 🔥 Kup solidny hosting stron z ochroną przed DDoS, serwery VPS VDS | ProHoster