TD-34: Endpoint for getting all players and tests
Some checks failed
Quality Check / Validate OAS (push) Successful in 38s
Quality Check / Validate OAS (pull_request) Successful in 37s
Quality Check / Static Analysis (push) Failing after 1m6s
Quality Check / Testing (push) Failing after 1m16s
Quality Check / Linting (push) Successful in 1m16s
Quality Check / Linting (pull_request) Successful in 1m8s
Quality Check / Static Analysis (pull_request) Failing after 1m13s
Quality Check / Testing (pull_request) Failing after 52s

This commit is contained in:
mehdiboudjoudi 2025-03-05 08:43:26 +01:00
parent 2740cc53be
commit 35b538c7ef
6 changed files with 90 additions and 78 deletions

View file

@ -7,7 +7,7 @@ servers:
- url: /api/v1 - url: /api/v1
- url: http://localhost:8080/api/v1 - url: http://localhost:8080/api/v1
security: security:
- JWTAuth: [] - JWTAuth: [ ]
components: components:
securitySchemes: securitySchemes:
@ -55,7 +55,7 @@ components:
type: object type: object
properties: properties:
username: username:
type: string type: string
required: required:
- username - username
############################################# #############################################
@ -70,31 +70,32 @@ components:
required: required:
- username - username
############################################# #############################################
# GetAllPlayersConfigurationData # # PlayerFilter #
############################################# #############################################
GetAllPlayersConfigurationData: PlayerFilter:
description: Configuration data for query for the getting all players endpoint description: Configuration data for query for the getting all players endpoint
type: object type: object
properties: properties:
page: page:
type: integer type: integer
default: 0
description: "Page number (zero-based index)." description: "Page number (zero-based index)."
pageSize: pageSize:
type: integer type: integer
default: 10
description: "Number of players per page." description: "Number of players per page."
sortBy: sortBy:
type: string type: string
default: "username"
description: "Field to sort by (default is username)." description: "Field to sort by (default is username)."
order: order:
type: string type: string
enum: [ascending, descending] enum: [ ascending, descending ]
description: "Sorting order (asc or desc)." description: "Sorting order (asc or desc)."
username: username:
type: string type: string
description: "Filter players by username (case-insensitive, partial match)." description: "Filter players by username (case-insensitive, partial match)."
required:
- page
- pageSize
- order
responses: responses:
201PlayerCreated: 201PlayerCreated:
description: "201 - Player Created" description: "201 - Player Created"
@ -188,15 +189,15 @@ paths:
/admin/players: /admin/players:
get: get:
operationId: "GetAllPlayers" operationId: "GetAllPlayers"
tags:
- admin
summary: "Retrieve a paginated list of players" summary: "Retrieve a paginated list of players"
description: "Returns a paginated list of players, optionally filtered by username." description: "Returns a paginated list of players, optionally filtered by username."
requestBody: requestBody:
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/GetAllPlayersConfigurationData" $ref: "#/components/schemas/PlayerFilter"
tags:
- admin
responses: responses:
200: 200:
description: "A List of all Player" description: "A List of all Player"

View file

@ -5,9 +5,10 @@ import de.towerdefence.server.auth.UserSession;
import de.towerdefence.server.oas.AdminApi; import de.towerdefence.server.oas.AdminApi;
import de.towerdefence.server.oas.models.AdminAuthInfo; import de.towerdefence.server.oas.models.AdminAuthInfo;
import de.towerdefence.server.oas.models.AdministratablePlayer; import de.towerdefence.server.oas.models.AdministratablePlayer;
import de.towerdefence.server.oas.models.GetAllPlayersConfigurationData; import de.towerdefence.server.oas.models.PlayerFilter;
import de.towerdefence.server.player.Player; import de.towerdefence.server.player.Player;
import de.towerdefence.server.player.PlayerRepository; import de.towerdefence.server.player.PlayerRepository;
import de.towerdefence.server.utils.OrderToDirectionMapperService;
import de.towerdefence.server.utils.PlayerMapperService; import de.towerdefence.server.utils.PlayerMapperService;
import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletRequest;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
@ -35,6 +36,9 @@ public class AdminApiController implements AdminApi {
@Autowired @Autowired
PlayerMapperService playerMapperService; PlayerMapperService playerMapperService;
@Autowired
OrderToDirectionMapperService orderToDirectionMapperService;
@Override @Override
public Optional<ObjectMapper> getObjectMapper() { public Optional<ObjectMapper> getObjectMapper() {
@ -54,30 +58,21 @@ public class AdminApiController implements AdminApi {
} }
@Override @Override
public ResponseEntity<List<AdministratablePlayer>> getAllPlayers(GetAllPlayersConfigurationData body) { public ResponseEntity<List<AdministratablePlayer>> getAllPlayers(PlayerFilter body) {
var order = body.getOrder(); PlayerFilter.OrderEnum order = body.getOrder();
var page = body.getPage(); Integer page = body.getPage();
var pageSize = body.getPageSize(); Integer pageSize = body.getPageSize();
var sortBy = body.getSortBy(); String sortBy = body.getSortBy();
var username = body.getUsername(); String username = body.getUsername();
if (order == null) { Sort.Direction direction = orderToDirectionMapperService.OrderToDirection(order);
order = GetAllPlayersConfigurationData.OrderEnum.DESCENDING;
}
Sort.Direction direction;
if (order == GetAllPlayersConfigurationData.OrderEnum.ASCENDING) {
direction = Sort.Direction.ASC;
} else {
direction = Sort.Direction.DESC;
}
Pageable pageable = PageRequest.of(page, pageSize, Sort.by(direction, sortBy)); Pageable pageable = PageRequest.of(page, pageSize, Sort.by(direction, sortBy));
Page<Player> playerPage; Page<Player> playerPage;
if (username != null && !username.trim().isEmpty()) { if (username != null && !username.isEmpty()) {
playerPage = playerRepository.findByUsernameContainingIgnoreCase(username, pageable); playerPage = playerRepository.findByUsernameContainingIgnoreCase(username, pageable);
} else { } else {
playerPage = playerRepository.findAll(pageable); playerPage = playerRepository.findAll(pageable);
@ -86,10 +81,6 @@ public class AdminApiController implements AdminApi {
List<AdministratablePlayer> playersMapped = List<AdministratablePlayer> playersMapped =
playerMapperService.mapPlayersToAdministratablePlayers(playerPage.getContent()); playerMapperService.mapPlayersToAdministratablePlayers(playerPage.getContent());
if (playersMapped.isEmpty()) { return ResponseEntity.ok(playersMapped);
return ResponseEntity.noContent().build();
} else {
return ResponseEntity.ok(playersMapped);
}
} }
} }

View file

@ -0,0 +1,18 @@
package de.towerdefence.server.utils;
import de.towerdefence.server.oas.models.PlayerFilter;
import org.springframework.data.domain.Sort;
import org.springframework.stereotype.Component;
@Component
public class OrderToDirectionMapperService {
public Sort.Direction OrderToDirection(PlayerFilter.OrderEnum order) {
if (order == PlayerFilter.OrderEnum.ASCENDING) {
return Sort.Direction.ASC;
} else {
return Sort.Direction.DESC;
}
}
}

View file

@ -11,18 +11,18 @@ import java.util.List;
public class PlayerMapperService { public class PlayerMapperService {
public List<AdministratablePlayer> mapPlayersToAdministratablePlayers(List<Player> players) { public List<AdministratablePlayer> mapPlayersToAdministratablePlayers(List<Player> players) {
List<AdministratablePlayer> apiPlayers = new ArrayList<>(); List<AdministratablePlayer> administratablePlayers = new ArrayList<>();
for (Player player : players) { for (Player player : players) {
AdministratablePlayer apiPlayer = new AdministratablePlayer(); AdministratablePlayer apiPlayer = new AdministratablePlayer();
apiPlayer.setUsername(player.getUsername()); apiPlayer.setUsername(player.getUsername());
apiPlayers.add(apiPlayer); administratablePlayers.add(apiPlayer);
} }
return apiPlayers; return administratablePlayers;
} }
public AdministratablePlayer mapPlayerToAdministratablePlayer(Player player) { public AdministratablePlayer mapPlayerToAdministratablePlayer(Player player) {
AdministratablePlayer apiPlayer = new AdministratablePlayer(); AdministratablePlayer administratablePlayer = new AdministratablePlayer();
apiPlayer.setUsername(player.getUsername()); administratablePlayer.setUsername(player.getUsername());
return apiPlayer; return administratablePlayer;
} }
} }

View file

@ -45,7 +45,7 @@ public abstract class IntegrationTest {
player.setUsername(username); player.setUsername(username);
try { try {
playerService.setPassword(player, password); playerService.setPassword(player, password);
playerRepository.save(player); playerRepository.saveAndFlush(player);
} catch (NoSuchAlgorithmException e) { } catch (NoSuchAlgorithmException e) {
System.err.println("Error setting password for player: " + username); System.err.println("Error setting password for player: " + username);
} }

View file

@ -1,6 +1,7 @@
package de.towerdefence.server.server; package de.towerdefence.server.server;
import de.towerdefence.server.IntegrationTest; import de.towerdefence.server.IntegrationTest;
import de.towerdefence.server.oas.models.PlayerFilter;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.springframework.http.MediaType; import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
@ -19,13 +20,13 @@ class GetAllPlayersTest extends IntegrationTest {
@Test @Test
void playersExist() throws Exception { void playersExist() throws Exception {
String requestBody = "{" + PlayerFilter playerFilter = new PlayerFilter();
"\"page\": 0," + playerFilter.setPage(0);
"\"pageSize\": 10," + playerFilter.setPageSize(10);
"\"sortBy\": \"username\"," + playerFilter.setOrder(PlayerFilter.OrderEnum.DESCENDING);
"\"order\": \"descending\"," + playerFilter.setUsername("");
"\"username\": \"\"" + playerFilter.setSortBy("username");
"}"; String requestBody = this.objectMapper.writeValueAsString(playerFilter);
this.mvc.perform(createGetAllPlayersRequest(requestBody)) this.mvc.perform(createGetAllPlayersRequest(requestBody))
.andExpect(status().isOk()) .andExpect(status().isOk())
@ -35,29 +36,14 @@ class GetAllPlayersTest extends IntegrationTest {
@Test @Test
void playersSortedByAsc() throws Exception { void playersSortedByAsc() throws Exception {
String requestBody = "{" +
"\"page\": 0," +
"\"pageSize\": 10," +
"\"sortBy\": \"username\"," +
"\"order\": \"ascending\"," +
"\"username\": \"\"" +
"}";
this.mvc.perform(createGetAllPlayersRequest(requestBody)) PlayerFilter playerFilter = new PlayerFilter();
.andExpect(status().isOk()) playerFilter.setPage(0);
.andExpect(jsonPath("$[0].username").value("Alex")) playerFilter.setPageSize(10);
.andExpect(jsonPath("$[1].username").value("Zorro")); playerFilter.setOrder(PlayerFilter.OrderEnum.ASCENDING);
} playerFilter.setUsername("");
playerFilter.setSortBy("username");
@Test String requestBody = this.objectMapper.writeValueAsString(playerFilter);
void playersSortedByDesc() throws Exception {
String requestBody = "{" +
"\"page\": 0," +
"\"pageSize\": 10," +
"\"sortBy\": \"username\"," +
"\"order\": \"descending\"," +
"\"username\": \"\"" +
"}";
this.mvc.perform(createGetAllPlayersRequest(requestBody)) this.mvc.perform(createGetAllPlayersRequest(requestBody))
.andExpect(status().isOk()) .andExpect(status().isOk())
@ -66,17 +52,33 @@ class GetAllPlayersTest extends IntegrationTest {
} }
@Test @Test
void playersFiltered() throws Exception { void playersSortedByDesc() throws Exception {
String requestBody = "{" + PlayerFilter playerFilter = new PlayerFilter();
"\"page\": 0," + playerFilter.setPage(0);
"\"pageSize\": 10," + playerFilter.setPageSize(10);
"\"username\": \"Alex\","+ playerFilter.setOrder(PlayerFilter.OrderEnum.DESCENDING);
"\"order\": \"ascending\""+ playerFilter.setUsername("");
"}"; playerFilter.setSortBy("username");
String requestBody = this.objectMapper.writeValueAsString(playerFilter);
this.mvc.perform(createGetAllPlayersRequest(requestBody))
.andExpect(status().isOk())
.andExpect(jsonPath("$[0].username").value("Alex"))
.andExpect(jsonPath("$[1].username").value("Zorro"));
}
@Test
void playersFiltered() throws Exception {
PlayerFilter playerFilter = new PlayerFilter();
playerFilter.setPage(0);
playerFilter.setPageSize(10);
playerFilter.setOrder(PlayerFilter.OrderEnum.ASCENDING);
playerFilter.setUsername("Alex");
playerFilter.setSortBy("username");
String requestBody = this.objectMapper.writeValueAsString(playerFilter);
this.mvc.perform(createGetAllPlayersRequest(requestBody)) this.mvc.perform(createGetAllPlayersRequest(requestBody))
.andExpect(status().isOk()) .andExpect(status().isOk())
.andExpect(jsonPath("$").isArray())
.andExpect(jsonPath("$[0].username").value("Alex")) .andExpect(jsonPath("$[0].username").value("Alex"))
.andExpect(jsonPath("$").isNotEmpty()); .andExpect(jsonPath("$").isNotEmpty());
} }