Postman uruchamianie testów na Gitlabie

Postman

Loading

Postman uruchamianie testów na Gitlabie to wpis pokazujący w jaki sposób w kilku krótkich krokach dokonać integracji i uruchamiać testy Postmana na Gitlabie. Uruchamiaj automatycznie swoje testy API na Gitlabie i monitorują aplikację. Dodatkowo twórz raporty, by móc w przystępny sposób prezentować je zespołowi.

Wstęp

Założeniem wpisu, jest wskazanie w jaki sposób, szybko i skutecznie umożliwić uruchamianie testów Postmana na Gitlabie. Przed wpisem, konieczne jest wykonanie kilka kroków:
a) stworzenie testowego repozytorium na gitlabie;
b) upewnienie się, że mamy podłączonego runnera na Gitlabie do uruchamiania testów.

Kwestie jak instalacja Postmana, weryfikacja workflow – Gitlab – lokalna maszyna, pozostawiam jako oczywistość.

Pierwszy krok

Stwórz lokalnie swój test poprzez utworzenie kolekcji. W przypadku gdy nie masz żadnego API z którego możesz skorzystać – spróbuj swoich sił z https://reqres.in/ – gdzie możemy uczyć się pracy z testami API.

Po stworzeniu pierwszego requestu, dobrze dodać jakąś asercję (zakładka Tests), co później się przyda. Przykładem najprostszej może być status odpowiedzi czy czas odpowiedzi danego requesta.

Postman uruchamianie testów na Gitlabie - snippet

Więcej przykładów różnych rodzajów testów znajdziesz w dedykowanym wpisie o snippetach. Gdy mamy pewność, że test działa przejdziemy do drugiego etapu.

Drugi krok

W drugiej kolejności mając działający test lokalnie, należy po pierwsze wyeksportować naszą kolekcję do pliku JSON i umieścić w katalogu który później umieścimy na Gitlabie.

Postman uruchamianie testów na Gitlabie - export collection

Trzeci krok

Konieczne jest stworzenie pliku .gitlab-ci.yml aby móc uruchamiać testy na Gitlabie.

stages:
    - test

postman_tests:
    stage: test
    image: 
        name: postman/newman_alpine33
        entrypoint: [""]
    tags:
      - /nazwaWaszegoRunnera/
    script:
        - newman --version
        - npm install -g newman-reporter-htmlextra
        - newman run collection.json -r htmlextra,cli
    artifacts:
        when: always
        paths:
            - ./newman/

Stworzenie takiego pliku, pozwoli Wam uruchomić test na poziomie Gitlaba. W miejscu tags pamiętaj aby wskazać nazwę Waszego runnera.
W zakresie uruchomienia na gitlabie
a) image – wskazujemy jaki obraz dockerowy chcemy wykorzystać do naszego testu;
b) script:
newman –version – sprawdzamy tylko wersję Newmana – może przydać się gdy coś będzie trzeba zdebugować;
npm install -g newman-reporter-htmlextra – instalacja newmana i reportera do tworzenia raportów;
newman run collection.json newman run collection.json -r htmlextra,cli – uruchomienie naszego testu o nazwie collection.json
-r htmlextra,cli – stworzenie raportu;
c) artifacts – dodanie naszych raportów jako artefaktów abyśmy mieli możliwość ich pobrania. 

Postman uruchamianie testów na Gitlabie - newman report

Podsumowanie

Postman uruchamianie testów na Gitlabie to kolejny wpis nawiązujący do Postmana. Postman z racji swojej popularności, będzie miał serię większej ilości artykułów, które będą sukcesywnie powstawać.. W dziale inne narzędzia opisujemy wiele innych przydatnych narzędzi, które być może pomogą Wam w bieżącej pracy.