TD-34: Solved comments made by reviewer

api/api.yml

@@ -59,9 +59,9 @@ components:
       required:
         - username
     #############################################
-    #  PlayerApiModel                                   #
+    #  AdministratablePlayer                                   #
     #############################################
-    PlayerApiModel:
+    AdministratablePlayer:
       description: a Player
       type: object
       properties:
@@ -205,7 +205,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: "#/components/schemas/PlayerApiModel"
+                  $ref: "#/components/schemas/AdministratablePlayer"
         401:
           $ref: "#/components/responses/401Unauthorized"
         500:

src/main/java/de/towerdefence/server/admin/AdminApiController.java

@@ -4,8 +4,8 @@ import com.fasterxml.jackson.databind.ObjectMapper;
 import de.towerdefence.server.auth.UserSession;
 import de.towerdefence.server.oas.AdminApi;
 import de.towerdefence.server.oas.models.AdminAuthInfo;
+import de.towerdefence.server.oas.models.AdministratablePlayer;
 import de.towerdefence.server.oas.models.GetAllPlayersConfigurationData;
-import de.towerdefence.server.oas.models.PlayerApiModel;
 import de.towerdefence.server.player.Player;
 import de.towerdefence.server.player.PlayerRepository;
 import de.towerdefence.server.utils.PlayerMapperService;
@@ -54,7 +54,7 @@ public class AdminApiController implements AdminApi {
     }
 
     @Override
-    public ResponseEntity<List<PlayerApiModel>> getAllPlayers(GetAllPlayersConfigurationData body) {
+    public ResponseEntity<List<AdministratablePlayer>> getAllPlayers(GetAllPlayersConfigurationData body) {
 
         var order = body.getOrder();
         var page = body.getPage();
@@ -76,8 +76,12 @@ public class AdminApiController implements AdminApi {
             playerPage = playerRepository.findAll(pageable);
         }
 
-        List<PlayerApiModel> playersMapped = playerMapperService.mapPlayerToApiPlayers(playerPage.getContent());
+        List<AdministratablePlayer> playersMapped = playerMapperService.mapPlayersToAdministratablePlayers(playerPage.getContent());
 
-        return playersMapped.isEmpty() ? ResponseEntity.noContent().build() : ResponseEntity.ok(playersMapped);
+        if (playersMapped.isEmpty()) {
+            return ResponseEntity.noContent().build();
+        } else {
+            return ResponseEntity.ok(playersMapped);
+        }
     }
 }

src/main/java/de/towerdefence/server/utils/PlayerMapperService.java

@@ -1,6 +1,6 @@
 package de.towerdefence.server.utils;
 
-import de.towerdefence.server.oas.models.PlayerApiModel;
+import de.towerdefence.server.oas.models.AdministratablePlayer;
 import de.towerdefence.server.player.Player;
 import org.springframework.stereotype.Component;
 
@@ -10,13 +10,19 @@ import java.util.List;
 @Component
 public class PlayerMapperService {
 
-    public List<PlayerApiModel> mapPlayerToApiPlayers(List<Player> players) {
+    public List<AdministratablePlayer> mapPlayersToAdministratablePlayers(List<Player> players) {
-        List<PlayerApiModel> apiPlayers = new ArrayList<>();
+        List<AdministratablePlayer> apiPlayers = new ArrayList<>();
         for (Player player : players) {
-            PlayerApiModel apiPlayer = new PlayerApiModel();
+            AdministratablePlayer apiPlayer = new AdministratablePlayer();
             apiPlayer.setUsername(player.getUsername());
             apiPlayers.add(apiPlayer);
         }
         return apiPlayers;
     }
+
+    public AdministratablePlayer mapPlayerToAdministratablePlayer(Player player) {
+        AdministratablePlayer apiPlayer = new AdministratablePlayer();
+        apiPlayer.setUsername(player.getUsername());
+        return apiPlayer;
+    }
 }

src/test/java/de/towerdefence/server/server/GetAllPlayersTest.java

@@ -0,0 +1,83 @@
+package de.towerdefence.server.server;
+
+import de.towerdefence.server.IntegrationTest;
+import org.junit.jupiter.api.Test;
+import org.springframework.http.MediaType;
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
+import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
+
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+
+class GetAllPlayersTest extends IntegrationTest {
+
+    private MockHttpServletRequestBuilder createGetAllPlayersRequest(String requestBody) {
+        return MockMvcRequestBuilders.get(baseUri + "/admin/players")
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(requestBody);
+    }
+
+    @Test
+    void playersExist() throws Exception {
+        String requestBody = "{" +
+                "\"page\": 0," +
+                "\"pageSize\": 10," +
+                "\"sortBy\": \"username\"," +
+                "\"order\": \"descending\"," +
+                "\"username\": \"\"" +
+                "}";
+
+        this.mvc.perform(createGetAllPlayersRequest(requestBody))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$").isArray())
+                .andExpect(jsonPath("$[0]").exists());
+    }
+
+    @Test
+    void playersSortedByAsc() throws Exception {
+        String requestBody = "{" +
+                "\"page\": 0," +
+                "\"pageSize\": 10," +
+                "\"sortBy\": \"username\"," +
+                "\"order\": \"ascending\"," +
+                "\"username\": \"\"" +
+                "}";
+
+        this.mvc.perform(createGetAllPlayersRequest(requestBody))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$[0].username").value("Alex"))
+                .andExpect(jsonPath("$[1].username").value("Zorro"));
+    }
+
+    @Test
+    void playersSortedByDesc() throws Exception {
+        String requestBody = "{" +
+                "\"page\": 0," +
+                "\"pageSize\": 10," +
+                "\"sortBy\": \"username\"," +
+                "\"order\": \"descending\"," +
+                "\"username\": \"\"" +
+                "}";
+
+        this.mvc.perform(createGetAllPlayersRequest(requestBody))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$[1].username").value("Alex"))
+                .andExpect(jsonPath("$[0].username").value("Zorro"));
+    }
+
+    @Test
+    void playersFiltered() throws Exception {
+        String requestBody = "{" +
+                "\"page\": 0," +
+                "\"pageSize\": 10," +
+                "\"username\": \"Alex\","+
+                "\"order\": \"ascending\""+
+                "}";
+
+        this.mvc.perform(createGetAllPlayersRequest(requestBody))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$").isArray())
+                .andExpect(jsonPath("$[0].username").value("Alex"))
+                .andExpect(jsonPath("$").isNotEmpty());
+    }
+}