REST Assuranced API -testausopas

Mikä on Rest Assured?

Vakuutan mahdollistaa REST-sovellusliittymien testaamisen Java-kirjastojen avulla ja integroituu hyvin Mavenin kanssa. Siinä on erittäin tehokkaat sovitustekniikat, joten odotettujen tulosten vahvistaminen on myös melko suoraviivaista. Rest Assuredilla on menetelmiä tietojen hakemiseen lähes jokaisesta pyynnön ja vastauksen osasta riippumatta siitä, kuinka monimutkaisia ​​JSON-rakenteet ovat.

Testausyhteisölle API Automation Testing on edelleen uusi ja markkinarako. JSON-monimutkaisuus pitää API-testauksen tutkimattomana. Mutta se ei tee siitä vähemmän tärkeää testausprosessissa. Rest Assured.io -kehys on tehnyt siitä erittäin yksinkertaisen käyttämällä Java-ytimen perusteita, joten se on erittäin toivottavaa oppia.

Miksi Rest-Assured-palvelua tarvitaan?

Kuvittele, että avaat Google Kartat-näkymässä voit etsiä paikkaa, johon haluat mennä. Näet heti lähellä olevat ravintolat, johtavien matkanjärjestäjien työmatkavaihtoehdot ja paljon muita vaihtoehtoja sormiesi ulottuvilla. Me kaikki tiedämme, etteivät nämä ole... Google tuotteita, joten miten Google onnistuuko niiden näyttäminen? Se käyttää näiden palveluntarjoajien paljastettuja API-rajapintoja. Jos sinua pyydetään testaamaan tällaista kokoonpanoa, jopa ennen käyttöliittymän rakentamista tai kehitystä, API-rajapintojen testaamisesta tulee erittäin tärkeää. Niiden testaaminen toistuvasti eri datayhdistelmillä tekee siitä erittäin sopivan tapauksen automatisoinnille.

Aiemmin tiimit käyttivät dynaamisia kieliä, kuten Groovy ja Rubyä tämän saavuttamiseksi, ja se oli haastavaa. Siksi toiminnalliset testaajat eivät olleet laajalti tutkineet API-testausta.

Rest Assuredin avulla API-rajapintojen automatisoitu testaus ja yksinkertaisten HTTPS-pyyntöjen lähettäminen käyttäjäystävällisillä mukautuksilla on kuitenkin yksinkertaista, jos on perehtynyt perustietoon JavaSe on hyödyllinen API-testauksen ja integraatiotestauksen ymmärtämisessä. Rest Assured antaa vahvan luottamuksen backend-järjestelmään, kun taas front-end-testaajat voivat keskittyä käyttöliittymään ja asiakaspuolen toimintoihin. Rest Assured on avoimen lähdekoodin ohjelmisto, ja metodien ja kirjastojen jatkuva lisääminen on tehnyt siitä loistavan valinnan API-automaatioon.

REST Assured vs. Postman: Keskeiset erot

Sekä REST Assurance että Postman validoimaan REST-rajapintoja, mutta jokainen sopii testauksen elinkaaren eri vaiheeseen. Oikean työkalun valinta riippuu tiimisi taidoista, projektin laajuudesta ja integrointitarpeista.

Aspect	Lepää varmana	Postman
Tyyppi	Java koodipohjaisen automaation kirjasto	GUI-pohjainen API-asiakasohjelma skriptituella
Paras käyttökotelo	Jatkuvat integraatioputket ja regressiopaketit	Manuaalinen etsintä ja nopeat API-tarkistukset
Taitovaatimus	Ydin Java vaadittu tieto	Minimaalinen koodaus; käyttötarkoitukset JavaSkriptinpätkät
Raportointi	Integroituu TestNG, JUnitja Allure	Sisäänrakennetut ajoyhteenvedot Newman CLI:n kautta

Monet joukkueet käyttävät Postman varhaiselle prototyypilleping ja vaihda REST Assured -tilaan automaattista regressiota varten, kun API on valmistract vakautuu.

Rest Assured.io:n asetukset Eclipse

REST Assuredin määrittämiseen liittyy kolme keskeistä riippuvuutta: Java, IDE ja Maven. Noudata alla olevia ohjeita välttääksesi käännösvirheet myöhemmin.

Vaihe 1) Asenna Java. Katso tästä ohjaavat

Vaihe 2) Lataa IDE aloittaaksesi: pimennys

Vaihe 3) Asenna Maven ja aseta eclipse. Katso täältä.

Asenna, voit olla varma

1. Luo Maven-projekti IDE-ympäristössäsi. Käytämme IntelliJ:tä, mutta saat samanlaisen rakenteen mihin tahansa IDE-ympäristöön.
2. Avaa POM.xml-tiedostosi.

REST Assured Maven -työtilan projektirakenne

Voit olla varma.io: For Java versio < 9 käyttäjää:

Lisää alla oleva riippuvuus POM.xml-tiedostoosi:

<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>json-path</artifactId>
<version>4.2.0</version>
<scope>test</scope>
</dependency>


<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>xml-path</artifactId>
<version>4.2.0</version>
<scope>test</scope>
</dependency>


<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>json-schema-validator</artifactId>
<version>4.2.0</version>
<scope>test</scope>
</dependency>

Voit olla varma.io: For Java version 9+ käyttäjät:

<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>rest-assured-all</artifactId>
<version>4.2.0</version>
<scope>test</scope>
</dependency>

Vianmääritys:

Jos näet virheitä etkä ole varma, latautuivatko riippuvuudet oikein, toimi seuraavasti:

1. Suorita Maven-koonti kaikkien riippuvuuksien tuomiseksi. Löydät apua Mavenin asennukseen osoitteessa Guru99.
2. Jos virheet jatkuvat, suorita Maven-puhdistus ja sen jälkeen Maven-asennus. Käännöstyön pitäisi valmistua ilman virheitä.
3. Lisää alla olevat tuonnit omaan Java luokka ja varmista, ettei käännösvirheitä ole.

import io.restassured.RestAssured.*;
import io.restassured.matcher.RestAssuredMatchers.*;
import org.hamcrest.Matchers.*;

Ensimmäinen yksinkertainen Rest Assured -skripti

Kun riippuvuudet ovat paikoillaan, voit nyt kirjoittaa ensimmäisen skriptisi. Kehys noudattaa käyttäytymiseen perustuvaa kehitystä (BDD), joka on lähes englanninkielinen.

Syntaksi:

Rest Assured.io:n syntaksi on viitekehyksen luettavin osa, koska se on hyvin BDD-tyyppinen ja ymmärrettävä.

Given().
        param("x", "y").
        header("z", "w").
when().
Method().
Then().
        statusCode(XXX).
        body("x", "y", equalTo("z"));

Selitys:

Code	Selitys
Annettu()	Avainsana 'Given' antaa sinun asettaa taustan. Tässä välität pyynnön otsikot, kysely- ja polkuparametrit, rungon ja evästeet. Tämä on valinnaista, jos näitä kohteita ei tarvita pyynnössä.
Kun()	Avainsana 'kun' merkitsee skenaariosi lähtökohtaa. Esimerkiksi 'kun' saat/julkaiset/laitat jotain, tee jotain muuta.
Menetelmä()	Korvaa tämä millä tahansa CRUD-toiminnolla (get/post/put/delete).
Sitten()	Assert- ja matcher-ehtosi tulevat tähän.

Nyt kun sinulla on asetukset ja hieman taustatietoa syntaksista, luodaan ensimmäinen yksinkertainen testi. Ei hätää, jos rakenne vaikuttaa sinulle uudelta. Kun koodaat lisää ja tulkitset jokaista riviä, opit sen käytön.

Mitä aiot hakea?

Avaa selain ja paina - https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1. Varmista, että näet jotain alla olevan mukaisesti.

REST Assuredin kaappaama esimerkki API-vastauksesta

Jos saat selaimessa virheen yrittäessäsi saada vastausta pyyntöön:

1. Tarkista, käytitkö HTTPS:ää vai HTTP:tä. Selaimesi asetukset saattavat estää suojaamattomat verkkosivustot.
2. Tarkista, estääkö jokin välityspalvelin tai palomuuri selaintasi avaamasta verkkosivustoa.

*Huomautuksia – et käyttänyt tässä otsikoita, runkoa etkä evästettä. Se oli URL, ja saat sisältöä API:sta sen sijaan, että julkaisisit tai päivittäisit olemassa olevaa sisältöä. Tämä tekee siitä GET-kutsua. Muista tämä ymmärtääksesi ensimmäisen testimme paremmin.

Testisi tavoite:

Komentosarjan tavoitteena on tulostaa IDE-konsoliisi sama tulos kuin se, jonka sait selaimeen Rest Assured -palvelun kautta.

Koodataan tämä seuraavilla vaiheilla:

Vastauksen saaminen Body

Vaihe 1) Luo luokka nimeltä ”myFirstRestAssuredClass”.

Vaihe 2) Luo metodi nimeltä ”getResponseBody”.

Vaihe 3) Samalla tavalla kuin aiemmin opittu rakenne given, when ja then, kirjoita alla oleva koodi:

annettu(). -> Ei vaadi otsikoita, ei kyselyä tai polkuparametria.

kun(). -> Ei erityistä ehtoa.

saada('https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1'). -> vain URL on toimitettava.

then(). -> Mitään erityisiä väitteitä ei vaadita.

log().all() -> Kun kaikki vastaukset on noudettu, kirjataan lokiin vastaus, otsikot ja käytännössä kaikki, mitä pyyntö palauttaa.

public static void getResponseBody(){
   given().when().get("https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1").then().log()
  .all();

}

Huomaa nyt, että URL käytetty on pitkä ja vaikeasti luettava. Tarkemmin tarkasteltuna huomaat, että käytössä on kolme kyselyparametria:

1. Asiakas ID
2. Salasana
3. Tili_nro

Rest Assured auttaa meitä välittämään jokaisen osan (kyselyn, polun, otsikkoparametrin) erikseen, mikä tekee koodista luettavampaa ja helpommin ylläpidettävää. Voimme myös parametrisoida ulkoisen tiedoston tiedot tarpeen mukaan.

Käytettäessä kyselyparametria palaamme syntaksin määritelmäämme ja katsomme, että ne kaikki välitetään osana annettua.

public static void getResponseBody(){

   given().queryParam("CUSTOMER_ID","68195")
           .queryParam("PASSWORD","1234!")
           .queryParam("Account_No","1")
           .when().get("https://demo.guru99.com/V4/sinkministatement.php").then().log()
           .body();
}

**Huomaa, että käytimme sanaa ”body” sanan ”all” sijaan; tämä auttaa meitä esim.**tracvain vastauksen runko.

lähtö:

Vastauksen tilakoodin saaminen

Seuraava skriptaamamme menetelmä on tilakoodin hakeminen ja sen validointi väitteen asettaminen.

Vaihe 1) Luo metodi nimeltä getResponseStatus().

Vaihe 2) Käytä samaa pyyntörakennetta kuin yllä. Kopioi ja liitä se.

Vaihe 3) Käytä lokikirjauksen sijaan 'getStatus'-funktiota.Code'Rest Assuredin sisäänrakennettu menetelmä tilakoodin arvon hakemiseen.'

Vaihe 4) Vahvistaaksesi, että statuskoodisi on 200, käytä avainsanoja – assertThat().statusCode(odotettuCode).

**Huomautus – URL on muuttuja, jota käytetään yksinkertaisuuden vuoksi. URL sisältää koko API-pyynnön URL.

public static void getResponseStatus(){
   int statusCode= given().queryParam("CUSTOMER_ID","68195")
           .queryParam("PASSWORD","1234!")
           .queryParam("Account_No","1") .when().get("https://demo.guru99.com/V4/sinkministatement.php").getStatusCode();
   System.out.println("The response status is "+statusCode);

   given().when().get(url).then().assertThat().statusCode(200);
}

lähtö:

Liiketoiminnan tarve

Yksi automaation perussäännöistä on, että meidän on asetettava tarkistuspisteet niin, että testi etenee vain, jos kaikki vaaditut ehdot täyttyvät. API-testauksessa yksinkertaisin validointi on tarkistaa, onko pyynnön tilakoodi 2XX-muodossa.

Täydellinen koodi tähän mennessä:

import java.util.ArrayList;
import static io.restassured.RestAssured.*;
import static java.util.concurrent.TimeUnit.MILLISECONDS;

public class myFirstRestAssuredClass {

   final static String url="https://demo.guru99.com/V4/sinkministatement.php?CUSTOMER_ID=68195&PASSWORD=1234!&Account_No=1";

   public static void main(String args[]) {

      getResponseBody();
     getResponseStatus();

; }

   //This will fetch the response body as is and log it. given and when are optional here
   public static void getResponseBody(){
       given().when().get(url).then().log()
      .all();

  given().queryParam("CUSTOMER_ID","68195")
               .queryParam("PASSWORD","1234!")
               .queryParam("Account_No","1") .when().get("https://demo.guru99.com/V4/sinkministatement.php").then().log().body();
   }

public static void getResponseStatus(){
   int statusCode= given().queryParam("CUSTOMER_ID","68195")
           .queryParam("PASSWORD","1234!")
           .queryParam("Account_No","1")
           .when().get("https://demo.guru99.com/V4/sinkministatement.php").getStatusCode();
   System.out.println("The response status is "+statusCode);

   given().when().get(url).then().assertThat().statusCode(200);
}

}

* Huom:

1. 200 on tässä tilanteessa onnistunut vastaus. Joskus pyynnön on ehkä epäonnistuttava, jolloin voit käyttää arvoa 4XX tai 5XX. Kokeile muuttaa tilakoodia antamalla virheelliset parametrit ja tarkista se.
2. Kun vaadimme ehtoa, konsoliin ei tulosteta, ellei ole virhe.

Komentosarja vastauksen eri osien hakemiseen

Vastaustekstin ja tilakoodin lisäksi REST Assured näyttää myös otsikot, vastausajan ja sisältötyypin ketjutettavan ex-funktion avulla.tractor-metodit. Avainsana 'extract' on välttämätön näiden tiettyjen osien hakemiseksi.

Ylätunniste

Rest Assured on hyvin suoraviivainen kieli, ja otsikoiden hakeminen on yhtä helppoa. Metodin nimi on headers(). Kuten ennenkin, luomme erillisen menetelmän tehdä sama.

public static void getResponseHeaders(){
   System.out.println("The headers in the response "+
                   get(url).then().extract()
           .headers());
}

Huomaa, että 'given().when()' ohitetaan tässä, ja koodirivi alkaa get():stä. Tämä johtuu siitä, että ennen pyyntöä ja vastauksen saamista ei tehdä ennakkoehtoja tai varmennusta. Tällaisissa tapauksissa niiden käyttö on valinnaista.

Lähtö:

Yrityksen tarve:

Usein seuraavaa pyyntöä varten tarvitaan valtuutustunnusta tai istuntoevästettä, ja nämä tiedot palautetaan enimmäkseen vastauksen otsikoina.

Vasteaika

Saadakseen ajan, joka tarvitaan vastauksen hakemiseen taustajärjestelmästä tai muista alavirran järjestelmistä, Rest Assured tarjoaa "timeIn"-nimisen menetelmän sopivalla aikayksiköllä saadakseen vastauksen palauttamiseen kuluvan ajan.

public static void getResponseTime(){
  System.out.println("The time taken to fetch the response "+get(url)
         .timeIn(TimeUnit.MILLISECONDS) + " milliseconds");
}

lähtö:

Yrityksen tarve:

Erittäin tärkeä ominaisuus API-rajapintojen testauksessa on niiden vasteaika, joka mittaa sovelluksen suorituskykyä. Kutsun kesto voi olla enemmän tai vähemmän riippuen internet-yhteyden nopeudesta, API:n suorituskyvystä kyseisellä hetkellä, palvelimen kuormituksesta ja muista aikaan vaikuttavista tekijöistä.

Content-Type

Voit saada palautetun vastauksen sisältötyypin käyttämällä metodia ”contentType()”.

public static void getResponseContentType(){
   System.out.println("The content type of response "+
           get(url).then().extract()
              .contentType());
}

ulostulo

Yrityksen tarve:

Sisältötyypin selvittäminen on joskus välttämätöntä sen varmistamiseksi, ettei alkuperästä riippumattomia uhkia vastaan ​​ole tietoturva-aukkoja ja että välitetty sisältö on API:n standardien mukaista.

Hae yksittäinen JSON-elementti

Annetusta vastauksesta sinua pyydetään laskemaan kokonaissumma. Sinun on haettava jokainen summa ja laskettava se yhteen.

Vaiheet:

Vaihe 1) Määrä-kenttä on taulukon sisällä, jonka avain on ”lausekkeet”, joka puolestaan ​​on listassa, jonka avain on ”tulos”.

Vaihe 2) Rest Assured tarjoaa mekanismin API:n arvojen saavuttamiseksi "polkua" käyttäen.

Vaihe 3) Polku määrien saavuttamiseen on ”result.statements.AMOUNT”. Ajattele sitä XPath-lausekkeena Selenium.

Vaihe 4) Hae kaikki kokoelman summat ja laske sitten summa käymällä läpi kaikki arvot.

public static void getSpecificPartOfResponseBody(){

ArrayList<String> amounts = when().get(url).then().extract().path("result.statements.AMOUNT") ;
int sumOfAll=0;
for(String a:amounts){

    System.out.println("The amount value fetched is "+a);
    sumOfAll=sumOfAll+Integer.valueOf(a);
}
System.out.println("The total amount is "+sumOfAll);

}

Huomautus: Koska amount-arvo on merkkijonotyyppinen, muunnamme sen kokonaisluvuksi summaa varten.

lähtö:

REST-varmistetun testiautomaation parhaat käytännöt

Kun olet ymmärtänyt perusasiat, kurinalaisten mallien soveltaminen pitää pakettisi luotettavana API-pinnan kasvaessa. Alla olevat käytännöt auttavat tiimejä välttämään epätasaisia ​​testejä ja ylläpitokuluja.

1. Keskitä tukikohta URL: Tallenna perus-URI ja todennustunnukset yhteen konfiguraatioluokkaan tai ominaisuustiedostoon. Tämä välttää päällekkäisyyksiä ja yksinkertaistaa ympäristön vaihtamista.
2. Käytä pyyntö- ja vastausmäärityksiä: Luo uudelleenkäytettäviä RequestSpecBuilder- ja ResponseSpecBuilder-objekteja. Ne yksinkertaistavat mallitestejä, kun useilla testeillä on yhteisiä otsikoita tai väitteitä.
3. JSON-skeeman validointi: Yhdistä REST Assured json-schema-validator-moduuliin varmistaaksesi con-koodin.tract-eheys. Skeema tarkistaa, havaitsevat rikkovat muutokset ennen kuin ne saavuttavat loppukäyttäjät.
4. Testidatan ulkoistaminen: Tallenna hyötykuormat JSON-tiedostoihin tai käytä datantarjoajia TestNGKovakoodattu data vanhenee nopeasti.
5. Suorita itsenäiset testit: Jokaisen testin tulisi luoda ja purkaa oma datansa. Järjestyksestä riippuvat paketit epäonnistuvat arvaamattomasti rinnakkaisissa CI-ajoissa.
6. Lokien valikoiva tallennus: Käytä log().ifError()-funktiota vakaissa ohjelmistopaketteissa ja log().all()-funktiota virheenkorjauksessa. Pitkät lokit hidastavat CI-prosessia ja peittävät todellisia ongelmia.
7. Liitä CI/CD-porttiin: Käynnistä REST Assured -paketit Maven Surefiren tai Failsafen kautta Jenkins, GitHub Actions tai GitLab. Suorita savutarkistuksia jokaisella commitilla ja täysi regressio yön aikana.

Näiden tapojen omaksuminen varhain muuttaa API-automaation pitkäaikaiseksi voimavaraksi hauraan pullonkaulan sijaan.

UKK