Postman uruchamianie testów na Githubie

Postman uruchamianie testów na Githubie to wpis pokazujący w jaki sposób w kilku krótkich krokach dokonać integracji i uruchamiać testy Postmana na Githubie. Uruchamiaj automatycznie swoje testy API na Githubie 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 Githubie. Przed wpisem, konieczne jest wykonanie kilka kroków:
a) stworzenie testowego repozytorium na Githubie;
b) upewnienie się, że mamy działającego runnera na Githubie do uruchamiania testów.

Kwestie jak instalacja Postmana, weryfikacja workflow – Githubie – 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.

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 Githubie .

Trzeci krok

Konieczne jest stworzenie pliku github-postman.yml aby móc uruchamiać testy na Githubie.

name: Postman Newman Tests

on:
  workflow_dispatch: 
  push:

jobs:
  test:
    runs-on: ubuntu-latest
    
    steps:
    - name: Checkout repository
      uses: actions/checkout@v4
      
    - name: Use Node.js
      uses: actions/setup-node@v4
      with:
        node-version: '20'

    - name: Install Newman
      run: npm install -g newman newman-reporter-htmlextra
      
    - name: Run Newman tests
      run: |
        newman --version
        newman run test.json -r htmlextra,cli --reporter-htmlextra-export ./newman-report.html
#        newman run test.json -e env.json -r htmlextra,cli --reporter-htmlextra-export ./newman-report.html   # when you have spec. env

    - name: Upload test report
      uses: actions/upload-artifact@v4
      with:
        name: newman-report
        path: ./newman-report.html

Stworzenie takiego pliku, pozwoli Wam uruchomić test na poziomie Githubie .
W zakresie uruchomienia na Githubie
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 test.json -r htmlextra,cli – uruchomienie naszego testu o nazwie test.json
– -r htmlextra,cli – stworzenie raportu;
c) artifact – dodanie naszych raportów jako artefaktów abyśmy mieli możliwość ich pobrania. 

Podsumowanie

Postman uruchamianie testów na Githubie 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.

0