Tartalomjegyzék

• Tartalomjegyzék
• Rest Assured alapjai (REST API tesztelés)
• Projekt létrehozása
  • pom.xml
  • BaseApiTest osztály
  • CI bekapcsolása
  • Gitignore
• Maven wrapper beállítása és használata
  • Teszt osztályok létrehozása
  • REST API tesztek röviden
• Logolások
  • Loggolás használata
• POJO
  • A REST Assured kérés felépítése
• given()
• when()
• then()
• extract()
• Response
• Gyakori HTTP státuszkódok
• Legfontosabb importok
  • Hamcrest Matcherek Rest Assured-ben
  • Leggyakrabban használtak
• Schema validáció hazsnálata
  • Schema json

Rest Assured alapjai (REST API tesztelés)

REST Assured Beginner Tutorial

REST API-s projektjeim magyarázatokkal:

• petstore
• reqres
• jsonplaceholder-demo-api

API-tesztekkel a szerződés ellenőrzését végezzük el, vagyis a segítségükkel ellenőrizhetjük többek között a végpontok működését, a státuszkódokat, a válasz törzsét, a fejléceket, a válaszidőt, az üzleti szabályokat és az API-szerződés betartását.

https://restful-booker.herokuapp.com/

Projekt létrehozása

Fájl -> new project -> maven -> create a simple project -> next group id: hu.tanulas artifact id: proba -> Finish

Jobb klikk a projekt mappán -> Build path -> Configure build path -> JRE System Library 21 legyen Utána bal oldalt kattints a Java Compiler-re és java 21-et állítsd be. Apply and close

A pom.xml-be az első sor végén lévő http-t írd át https-re!

És ezt másold be:

	  <dependencies>
	 
		  <!-- Source: https://mvnrepository.com/artifact/io.rest-assured/rest-assured -->
		<dependency>
		    <groupId>io.rest-assured</groupId>
		    <artifactId>rest-assured</artifactId>
		    <version>5.5.6</version>
		    <scope>test</scope>
		</dependency>
		
	  </dependencies>

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>hu.tanulas</groupId>
  <artifactId>proba</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  
  
	  <dependencies>
	  
		  <!-- Source: https://mvnrepository.com/artifact/io.rest-assured/rest-assured -->
		<dependency>
		    <groupId>io.rest-assured</groupId>
		    <artifactId>rest-assured</artifactId>
		    <version>5.5.6</version>
		    <scope>test</scope>
		</dependency>
		
		<!-- JUnit 5 tesztkeretrendszer -->
		<!-- Source: https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter -->
		<dependency>
		    <groupId>org.junit.jupiter</groupId>
		    <artifactId>junit-jupiter</artifactId>
		    <version>5.11.0</version>
		    <scope>test</scope>
		</dependency>
		
		<!-- Source: https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
		<dependency>
		    <groupId>org.apache.logging.log4j</groupId>
		    <artifactId>log4j-core</artifactId>
		    <version>2.26.0</version>
		    <scope>compile</scope>
		</dependency>
	
		<!--A response válaszokból esetleges objektumképzéshez szükség van json feldolgozó importra is, pl.: jackson -->
		<!-- JSON és Java objektumok közötti szerializációhoz/deszerializációhoz -->
		<!-- Source: https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core -->
		<dependency>
		    <groupId>com.fasterxml.jackson.core</groupId>
		    <artifactId>jackson-databind</artifactId>
		    <version>2.17.1</version>
		    <scope>compile</scope>
		</dependency>

	  </dependencies>
	  
	  <!--Verzió megadása, de nem kötelező ezeknél is működik. Ezzel még biztosabb lesz a program.-->
	  <properties>
	  	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	  	<maven.compiler.release>21</maven.compiler.release>
	  	<maven.compiler.target>21</maven.compiler.target>
	  </properties>
	  
	  
	  <build>
	    <plugins>
	        <plugin>
	            <groupId>org.apache.maven.plugins</groupId>
	            <artifactId>maven-surefire-plugin</artifactId>
	            <version>3.5.4</version>	         
	        </plugin>
	        
	        <plugin>
	            <groupId>org.apache.maven.plugins</groupId>
	            <artifactId>maven-compiler-plugin</artifactId>
	            <version>3.12.1</version>	
	            <configuration>      
	            	<release>21</release>
	            </configuration>     
	        </plugin>
	        <!--Utána navigálj el a cmd-ben a projekt mappáig, ahol a pom.xml van.
	        Aztán mvn clean test
	        -->
	    </plugins>
	</build>

	  
</project>

BaseApiTest osztály

A base package-be rakd és innen származtasd a többit teszt osztályt.

package api.base;

import org.junit.jupiter.api.BeforeEach;

import io.restassured.RestAssured;
import io.restassured.http.ContentType;

public class BaseApiTest {

	@BeforeEach
	protected void setup() {
        // Tesztelni kívánt weboldal címe.
		RestAssured.baseURI="https://jsonplaceholder.typicode.com/";
		
		RestAssured.requestSpecification=RestAssured
				.given()
					.accept(ContentType.JSON) // json formátumú választ várunk 
					.contentType(ContentType.JSON); // json formátumban küldjük a kérést

		/*
		Ha egy teszt elbukik (pl. nem a várt státuszkódot kapja), ez a beállítás automatikusan kiírja a konzolra a KÉRÉST (Request) ÉS a VÁLASZT (Response) is a teljes részletességükben.
		*/
		RestAssured.enableLoggingOfRequestAndResponseIfValidationFails();
	}
}

CI bekapcsolása

.github/workflows/maven-tests.yml

name: Run Rest Assured API Tests

on:
  push:
  pull_request:
  workflow_dispatch:

jobs:
  tests:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up JDK 21
        uses: actions/setup-java@v4
        with:
          distribution: temurin
          java-version: "21"
          cache: maven

      - name: Make Maven Wrapper executable
        run: chmod +x mvnw

      - name: Run Maven tests
        run: ./mvnw -B clean test

      - name: Upload Surefire test reports
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: surefire-reports
          path: target/surefire-reports
          if-no-files-found: warn

Gitignore

# =========================
# Java compiled files
# =========================
*.class

# =========================
# Maven
# =========================
target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties
dependency-reduced-pom.xml

# =========================
# IntelliJ IDEA
# =========================
.idea/
*.iml
out/

# =========================
# Eclipse
# =========================
.project
.classpath
.settings/
.metadata/
bin/

# =========================
# VS Code
# =========================
.vscode/

# =========================
# OS files
# =========================
.DS_Store
Thumbs.db

# =========================
# Logs
# =========================
*.log

# =========================
# Selenium / test outputs
# =========================
screenshots/
reports/
allure-results/
allure-report/

# =========================
# Sonar
# =========================
.scannerwork/
.sonar/

# =========================
# Coverage
# =========================
coverage/
jacoco.exec

# =========================
# Temporary files
# =========================
*.tmp
*.temp
*.swp

# =========================
# Secrets and env, config.properties
# =========================
.env
.secrets
config.properties

Maven wrapper beállítása és használata

A terminálban navigálj el a projekt mappájáig (pl.: cd GitHub/saucedemo) mvn -v Ezzel lecsekkoljuk, hogy van-e a gépen maven, ha nem ír verziót, a Mavent telepíteni kell: https://maven.apache.org/download.cgi

pl. apache-maven-3.9.16-bin.zip letöltés, kicsomagolás környezeti változókhoz felvenni a bin mappáját

Linux-on még ez is kell egyszer: sudo apt install maven

Utána ezt futtasd: mvn clean test

Ezután jöhet a csomagolás: mvn wrapper:wrapper Ezután létrejönnek ezek: mvnw és mvnw.cmd fájlok és .mvn mappa. Innentől kezdve nem mvn utasítást kell használni, hanem mvnw utasítást! Ezután nem gond, ha nincsen maven a gépen telepítve, simán lehet terminálból is futtatni a projektet.

Futtatás linux-on: ./mvnw clean test

win-on: mvnw clean test

Teszt osztályok létrehozása

Minden package-t az src/test/java-ban hozz létre. Az api package-n belül pl.: api.UserList -> JUnit Test Case, csekkold, hogy tuti a Jupiter van felül kijelölve.

REST API tesztek röviden

A body vizsgálatoknál két paraméter határozza meg az elvárt eredmény ellenőrzését:

1. paraméter - meghatározza az adatot, amire az ellenőrzés vonatkozik Ez egy json Path https://github.com/rest-assured/rest-assured/wiki/Usage#complex-json-paths

2. paraméter - Hamcrest matcher, ezen keresztül mondjuk meg, hogy mit várunk el az adattal kapcsolatban. Rengeteg matcher létezik, pl.: nullValue, notNullValue, greaterThan, lessThan, equalTo, hasItem, anEmptyMap stb.: https://hamcrest.org/JavaHamcrest/javadoc/2.2/org/hamcrest/Matchers.html

Lentebb lesz külön részletezve.

Logolások

Surefire report: A teszt eredményét foglalja össze. Futás utáni összegzés.

Log: A hibakeresést segíti. [.then után -> .log().ifValidationFails() // A jó log, csak baj esetén szól (ha pl.: létező id-t adunk meg)]

Futás közbeni összegzés.

Loggolás használata

package api.usersUpdate;

import static io.restassured.RestAssured.given;
import static org.hamcrest.Matchers.equalTo;

import org.apache.logging.log4j.LogManager;
import  org.apache.logging.log4j.Logger;

import org.junit.jupiter.api.Test;

import api.base.BaseApiTest;
import io.restassured.http.ContentType;

class UserUpdateTest extends BaseApiTest {

	//import org.apache.logging.log4j.Logger; 
	//A végén lévő zárójelben magát az osztályt kell megadni. 
	private static final Logger LOG=LogManager.getLogger(UserUpdateTest.class);
			
	@Test
	void userUpdateTestWithLog() {
		LOG.info("TC4.1 indítása, felhasználó módosítása");
		//Szövegblokk. Bemeneti adatok.
		String requestBody= """
				{	
					"name":"Teszt Elek",						
					"email":"tesztelek@teszt.com"
				}
				""";
		int userID=1;
		
		LOG.info("Módosítandó id: {} ",userID);
		
		//Kijelölöd a lento blokkot. Jobb klikk -> Surround with -> Try-catch Block
		try {
			//A restassured fluens api megoldást használ. 
			given()
				.contentType(ContentType.JSON)
				.body(requestBody)
			.when()	
				.put("/users/"+userID)
			.then()
				.log().ifValidationFails()
				.statusCode(200)
				.body("id", equalTo(1))
				.body("name", equalTo("Teszt Elek"))
				.body("email", equalTo("tesztelek@teszt.com"));
			
			LOG.info("TC4.1 sikeresen lefutott");
		} catch (Exception e) {
			LOG.error("Hiba történt a teszt futtatása közben: ",e);
			throw e;
		}
	}
}

Az src/test/resources/log4j2.xml fájlba:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN"> <!-- Log4j-nek a belső működésére vonatkozik.  -->

    <Appenders>
    <!-- A konzolra írja ki a szöveget. -->
        <Console name="Console" target="SYSTEM_OUT">
        <!-- Megjelenítési forma.  -->
            <PatternLayout
                pattern="%d{HH:mm:ss} %-5level %logger - %msg%n"/>
        </Console>
    </Appenders>

    <Loggers>
        <Root level="INFO"> <!-- INFO szintől felfelé kerül megjelenítésre a loggolás. -->
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>

</Configuration>

POJO

Külön package-et hozunk létre a POJO osztályok számára, amelyekben az objektumokat tároljuk.

A POJO (Plain Old Java Object) egyszerű Java osztály, amely általában csak adatokat tartalmaz, például mezőket, gettereket és settereket. Az elkülönített package segít a kód áttekinthetőségében és rendszerezésében.

Jackson-deszerializáció esetén a POJO-nak általában szüksége van paraméter nélküli konstruktorra, valamint írható propertykre, például setterekre.

Így néz ki egy osztálya:

package userPOJO;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

//Csak azokat a mezőket veszi figyelembe, 
//amiket az osztály adattagjaiként létrehozunk.
@JsonIgnoreProperties(ignoreUnknown=true)
public class User {
	
	private int id;
	private String name;
	private String username;
	private String email;
	
	// Kell paraméter nélküli és paraméteres konstruktor is. 

	public int getId() {
		return id;
	}
	public String getName() {
		return name;
	}
	public String getUsername() {
		return username;
	}
	public String getEmail() {
		return email;
	}
	
	 // A többi getter és setter...
}

A REST Assured kérés felépítése

Importja: import static io.restassured.RestAssured.*;

given()
    .header(...)
    .contentType(ContentType.JSON)
    .body(requestBody)

.when()
    .post("/users")

.then()
    .statusCode(201)
    .body("name", equalTo("John"));

given()

A kérés előkészítése.

	// A path paraméter ezzel szemben az URL része:
	// GET /comments/10
	given()
		.pathParam("id", 1)
	.when()
		.get("/comments/{id}"); // A {id} helyőrző.

	// A query paramétert nem kell beleírni az endpointba:
	// GET /comments?postId=1
	given()
		.queryParam("postId", 1) // Lehet akár kettőre is szűrni .queryParam("postId", 1, 2)
		.queryParam("email", "test@test.com")
	.when()
		.get("/comments");

	// A Map.of() létrehoz egy kulcs–érték párt:
	// A REST Assured ezt JSON-ná alakítja:
	/*{
 		 "email": "patched@test.com"
	}*/
	given()
		.pathParam("id", 10)
		.body(Map.of("email", "patched@test.com"))
	.when()
		.put("/comments/{id}");

when()

A HTTP kérés elküldése.

then()

A válasz ellenőrzése.

extract()

Az ellenőrzés után adatokat nyerhetsz ki.

Response

Importja: import io.restassured.response.Response;

A response.jsonPath().getObject("data",User.class)-nél a "data" a mezőköz (JSONPath-kifejezés vagy elérési útvonal). A User.class a POJO osztályból jön.

Ha a teljes response body egyetlen objektumot tartalmaz, közvetlenül használható az .extract().as(User.class). Ha az objektum egy beágyazott mezőben található, használható a jsonPath().getObject().

Példák:

	User user = response.as(User.class);

	// Ha az objektum egy beágyazott mezőben található, akkor kell a "data".
	User user = response.jsonPath()
        .getObject("data", User.class);

	// Lista esetén. Az "Album" rész a POJOból jön.
	List<Album> albums = response.jsonPath()
        .getList("", Album.class);

	// Így egy nem rendezhető lista lesz belőle.
	List <Integer> albumIds= response.jsonPath()
        .getList("id",Integer.class);

	// Így egy rendezhető lista lesz belőle.
	List <Integer> photoIds= new ArrayList<>(
		response.jsonPath().getList("id",Integer.class));

	// A lista első eleme.
	Album album = response.jsonPath()
        .getObject("[0]", Album.class);

	// Csak egy változó értékének lekérése.
	String searchedEmail = "Eliseo@gardner.biz";

	String extractedEmail =
		given()
			.queryParam("email", searchedEmail)
		.when()
			.get("/comments")
		.then()		
			.extract()
			.jsonPath()
			.getString("[0].email"); // Ha szám lenne, akkor getInt kéne.

Az assertEquals-el részletesebb hibaüzenetet kapunk.

Album album=given().when().get("/albums/25").then().log().ifValidationFails()
		.statusCode(200).extract().jsonPath().getObject("",Album.class);

assertEquals(3,album.getUserId());
assertEquals(25,album.getId());
assertEquals("vero maxime id possimus sunt neque et consequatur",album.getTitle());	

// Ez kell, ha azt csekkoljuk, hogy a lista, vagy az objektum nem null:
assertNotNull(album);
assertNotNull(album.getId());

//A isBlank() az üres és a kizárólag whitespace karakterekből álló szöveget is elutasítja.
assertFalse(album.getTitle().isBlank());

Keresés és az alapján történő törlés:

		String albumTitle = "quidem molestiae enim";
		
		Album album=
			given()	
				.queryParam("title", albumTitle)
			.when()
				.get("/albums")
			.then()
				.log().ifValidationFails()
				.statusCode(200)
				.body("$", not(empty()))
				.body("title",hasItem(album.getTitle()))
				.extract().jsonPath().getObject("[0]", Album.class);
		
		given()			
			.pathParam("id", album.getId())
		.when()
  			.delete("/albums/{id}")
		.then()
			.log().ifValidationFails()
			.statusCode(anyOf(is(200),is(204)))
			.body("$", anyOf(anEmptyMap(),nullValue()));		

Gyakori HTTP státuszkódok

Legfontosabb importok

import static io.restassured.RestAssured.given;
import static org.hamcrest.Matchers.*;

import io.restassured.http.ContentType;
import io.restassured.response.Response;

Hamcrest Matcherek Rest Assured-ben

Leggyakrabban használtak

Mezők létezését, így kell ellenőrizni: everyItem(allOf(hasKey("id"),hasKey("password")))

Nem üresek-e az id mezők: body("data.id", everyItem(notNullValue()));

String esetén: body("data.password", everyItem(not(isEmptyString())));

Nem üres (teljes body válasz, lista, tömb, map vagy string): not(empty())

Null érték biztosabb ellenőrzése: .body("$", anyOf(anEmptyMap(), nullValue(), empty()))

A lista legalább egy elemet tartalmaz: body("$.size()", greaterThan(0))

Példa kód:

	given()
			.queryParam("userId", 7) // Filtering
		.when()
			.get("/albums")
		.then()
			.log().ifValidationFails()
			.statusCode(200)
			.body("$", instanceOf(List.class))
			.body("size()", equalTo(10))			
			.body("userId", everyItem(equalTo(7)));

Példa kód a delete metódusra:

package api.photos.deletePhoto;

import static org.junit.jupiter.api.Assertions.*;

import java.util.List;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import base.BaseApiTest;
import io.restassured.response.Response;
import photoPOJO.Photo;

import static io.restassured.RestAssured.*;
import static org.hamcrest.Matchers.*;

class DeletePhotoTest extends BaseApiTest {
	
  /**
 	* Task 309 – Delete an Existing Photo
	
	Endpoint:
	
	DELETE /photos/{id}
	
	Test data:
	
	id = 250
	
	Requirements:
	
	Send a DELETE request using the photo ID as a path parameter.
	Verify that the status code is 200 or 204.
	Verify that the response body is either:
	an empty JSON object, or
	completely empty.
	Log the response only if validation fails.
	*/
	@Test
	@DisplayName("Task 309 – Delete an Existing Photo")
	void deleteAnExistingPhotoTest() {
		
		int id=250;
		
		given()	
			.pathParam("id",id)
		.when()
			.delete("/photos/{id}")
		.then()
			.log().ifValidationFails()
			.statusCode(anyOf(is(200),is(204)))
			.body("",anyOf(anEmptyMap(),nullValue(),empty()));
	}
	
	/**
	 * Task 310 – Find and Delete a Photo by Title
	
	Search endpoint:
	
	GET /photos?title={title}
	
	Delete endpoint:
	
	DELETE /photos/{id}
	
	Test data:
	
	title = "et inventore quae ut tempore eius voluptatum"
	
	Requirements:
	
	Send a GET request using the title as a query parameter.
	Verify that the GET response status code is 200.
	Deserialize the response into a List<Photo>.
	Verify that the list is not empty.
	Verify that the returned photo title exactly matches the searched title.
	Extract the ID of the first returned photo.
	Send a DELETE request to /photos/{id} using the extracted ID.
	Verify that the DELETE response status code is 200 or 204.
	Verify that the DELETE response body is either an empty JSON object or empty.
	Log responses only if validation fails.
	 */
	@Test
	@DisplayName("Task 310 – Find and Delete a Photo by Title")
	void findAndDeleteAPhotoByTitleTest() {
		
		String title = "et inventore quae ut tempore eius voluptatum";
		
		List <Photo> photoResponse=given()
			.queryParam("title",title)
		.when()
			.get("/photos")
		.then()
			.log().ifValidationFails()
			.statusCode(200)
			.extract().jsonPath().getList("",Photo.class);
		
		assertNotNull(photoResponse);
		assertFalse(photoResponse.isEmpty());
		
		for (Photo photo : photoResponse) {
			assertEquals(title,photo.getTitle());
		}
		
		int id=photoResponse.get(0).getId();
		System.out.println("Photo ID to delete: " + id);
		
		Response responseAfterDelete=given()
			.pathParam("id",id)
		.when()
			.delete("/photos/{id}")
		.then()
			.log().ifValidationFails()		    
			.statusCode(anyOf(is(200),is(204)))
			.extract().response();
		
		String responseBody=responseAfterDelete.getBody().asString();
		
		assertTrue(responseBody.trim().isEmpty() || responseBody.trim().equals("{}"));
			
	}

}

Schema validáció hazsnálata

Ez egy nagyon hasznos kiegészítő, mert nemcsak azt tudod ellenőrizni, hogy milyen értékek érkeznek vissza, hanem azt is, hogy a JSON válasz szerkezete megfelel-e az előre meghatározott elvárásoknak.

A JSON Schema segítségével viszont azt is ellenőrizheted, hogy:

• Létezik-e az id mező?
• Az id egész szám-e?
• A title szöveges típusú-e?
• Az completed mező megfelelő formátumú-e?
• Minden kötelező mező szerepel-e a válaszban?

A pom.xml-ben a dependecies részre ezt másold be:

     <!-- JSON Schema validation-->
		<dependency>
		    <groupId>io.rest-assured</groupId>
		    <artifactId>json-schema-validator</artifactId>
		    <version>5.5.0</version>
		    <scope>test</scope>
		</dependency>

Schema json

Példa: Ide hozd létre: src/test/resources/schemas/todos-schema.json

Json tartalma:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "required": [
    "userId",
    "id",
    "title",
    "completed"
  ],
  "properties": {
    "userId": {
      "type": "integer"
    },
    "id": {
      "type": "integer"
    },
    "title": {
      "type": "string"
    },
    "completed": {
      "type": "boolean"
    }
  }
}

Így használd a tesztben:

// Szükséges import
import static io.restassured.module.jsv.JsonSchemaValidator.matchesJsonSchemaInClasspath;

@Test
void getPhotoSchemaTest() {

    given()
    .when()
        .get("/todos/1")
    .then()
        .statusCode(200)
        .body(matchesJsonSchemaInClasspath("schemas/photo-schema.json"));
}

A REST Assured megkeresi a schema fájlt a src/test/resources mappában, és összehasonlítja vele az API válaszát.