fix:API-paging

beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/response/MetadataResponseConverter.java

@@ -37,13 +37,18 @@ public final class MetadataResponseConverter {
   public static Page<HousekeepingMetadataResponse> convertToHousekeepingMetadataResponsePage(
       Page<HousekeepingMetadata> housekeepingMetadataPage) {
     List<HousekeepingMetadata> housekeepingMetadataList = housekeepingMetadataPage.getContent();
+    //Create a new ArrayList to store the HousekeepingMetadataResponse objects.
     List<HousekeepingMetadataResponse> housekeepingMetadataResponseList = new ArrayList<>();
+    //Iterate over the list of HousekeepingMetadata objects and convert each one to a HousekeepingMetadataResponse object.
     for (HousekeepingMetadata housekeepingMetadata : housekeepingMetadataList) {
-      HousekeepingMetadataResponse housekeepingMetadataResponse = convertToHousekeepingMetadataResponse(
-          housekeepingMetadata);
+      HousekeepingMetadataResponse housekeepingMetadataResponse = convertToHousekeepingMetadataResponse(housekeepingMetadata);
       housekeepingMetadataResponseList.add(housekeepingMetadataResponse);
     }
-    return new PageImpl<>(housekeepingMetadataResponseList);
+    //Create a new PageImpl<HousekeepingMetadataResponse> object using the HousekeepingMetadataResponse list, the Pageable
+    // object from the HousekeepingMetadataPage object, and the total number of elements from the HousekeepingMetadataPage object.
+    PageImpl<HousekeepingMetadataResponse> housekeepingMetadataResponses = new PageImpl<>(
+        housekeepingMetadataResponseList, housekeepingMetadataPage.getPageable(), housekeepingMetadataPage.getTotalElements());
+    return housekeepingMetadataResponses;
   }
 
   private static HousekeepingMetadataResponse convertToHousekeepingMetadataResponse(

beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/response/PathResponseConverter.java

@@ -51,12 +51,16 @@ private static HousekeepingPathResponse convertToHousekeepingPathResponse(Housek
   public static Page<HousekeepingPathResponse> convertToHousekeepingPathResponsePage(
       Page<HousekeepingPath> housekeepingPathPage) {
     List<HousekeepingPath> housekeepingPathList = housekeepingPathPage.getContent();
+    //Create a new ArrayList to store the HousekeepingPathResponse objects.
     List<HousekeepingPathResponse> housekeepingPathResponseList = new ArrayList<>();
+    //Iterate over the list of HousekeepingPath objects and convert each one to a HousekeepingPathResponse object.
     for (HousekeepingPath housekeepingPath : housekeepingPathList) {
       HousekeepingPathResponse housekeepingPathResponse = convertToHousekeepingPathResponse(housekeepingPath);
       housekeepingPathResponseList.add(housekeepingPathResponse);
     }
-    return new PageImpl<>(housekeepingPathResponseList);
+    PageImpl<HousekeepingPathResponse> HousekeepingPathResponses = new PageImpl<>(
+        housekeepingPathResponseList, housekeepingPathPage.getPageable(), housekeepingPathPage.getTotalElements());
+    return HousekeepingPathResponses;
   }
 
 }

beekeeper-api/src/test/java/com/expediagroup/beekeeper/api/response/HousekeepingMetadataResponseTest.java

@@ -1,5 +1,5 @@
 /**
- * Copyright (C) 2019-2021 Expedia, Inc.
+ * Copyright (C) 2019-2023 Expedia, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -46,6 +46,8 @@ public void testConvertToHouseKeepingMetadataResponsePage() {
 
     assertThat(metadataResponsePageList.get(0)).isEqualTo(metadataResponse1);
     assertThat(metadataResponsePageList.get(1)).isEqualTo(metadataResponse2);
+    assertThat(metadataResponsePage.getTotalElements()).isEqualTo(2L);
+    assertThat(metadataResponsePage.getTotalPages()).isEqualTo(1L);
     assertThat(metadataResponsePage.getPageable()).isEqualTo((new PageImpl<>(housekeepingMetadataList).getPageable()));
   }
 

beekeeper-api/src/test/java/com/expediagroup/beekeeper/api/response/PathResponseConverterTest.java

@@ -0,0 +1,53 @@
+/**
+ * Copyright (C) 2019-2023 Expedia, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.expediagroup.beekeeper.api.response;
+
+import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
+
+import static com.expediagroup.beekeeper.api.response.PathResponseConverter.convertToHousekeepingPathResponsePage;
+import static com.expediagroup.beekeeper.api.util.DummyHousekeepingEntityGenerator.generateDummyHousekeepingPath;
+import static com.expediagroup.beekeeper.api.util.DummyHousekeepingEntityGenerator.generateDummyHousekeepingPathResponse;
+
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageImpl;
+
+import com.expediagroup.beekeeper.core.model.HousekeepingPath;
+
+public class PathResponseConverterTest {
+
+  @Test
+  public void testConvertToHousekeepingPathResponsePage() {
+    HousekeepingPath housekeepingPath1 = generateDummyHousekeepingPath("some_database1", "some_table1");
+    HousekeepingPath housekeepingPath2 = generateDummyHousekeepingPath("some_database2", "some_table2");
+    HousekeepingPathResponse housekeepingPathResponse1 = generateDummyHousekeepingPathResponse(housekeepingPath1);
+    HousekeepingPathResponse housekeepingPathResponse2 = generateDummyHousekeepingPathResponse(housekeepingPath2);
+
+    List<HousekeepingPath> housekeepingPathList = List.of(housekeepingPath1, housekeepingPath2);
+    Page<HousekeepingPathResponse> housekeepingPathResponsePage = convertToHousekeepingPathResponsePage(
+        new PageImpl<>(housekeepingPathList));
+
+    List<HousekeepingPathResponse> housekeepingPathResponsePageList = housekeepingPathResponsePage.getContent();
+
+    assertThat(housekeepingPathResponsePageList.get(0)).isEqualTo(housekeepingPathResponse1);
+    assertThat(housekeepingPathResponsePageList.get(1)).isEqualTo(housekeepingPathResponse2);
+    assertThat(housekeepingPathResponsePage.getTotalElements()).isEqualTo(2L);
+    assertThat(housekeepingPathResponsePage.getTotalPages()).isEqualTo(1L);
+    assertThat(housekeepingPathResponsePage.getPageable()).isEqualTo((new PageImpl<>(housekeepingPathList).getPageable()));
+  }
+}

beekeeper-api/src/test/java/com/expediagroup/beekeeper/api/util/DummyHousekeepingEntityGenerator.java

@@ -23,6 +23,7 @@
 import java.time.ZoneId;
 
 import com.expediagroup.beekeeper.api.response.HousekeepingMetadataResponse;
+import com.expediagroup.beekeeper.api.response.HousekeepingPathResponse;
 import com.expediagroup.beekeeper.core.model.HousekeepingMetadata;
 import com.expediagroup.beekeeper.core.model.HousekeepingPath;
 import com.expediagroup.beekeeper.core.model.PeriodDuration;
@@ -88,4 +89,19 @@ public static HousekeepingPath generateDummyHousekeepingPath(String databaseName
         .build();
   }
 
+  public static HousekeepingPathResponse generateDummyHousekeepingPathResponse(HousekeepingPath housekeepingPath) {
+    return HousekeepingPathResponse
+        .builder()
+        .path("s3://some/path/")
+        .databaseName(housekeepingPath.getDatabaseName())
+        .tableName(housekeepingPath.getTableName())
+        .housekeepingStatus(SCHEDULED)
+        .creationTimestamp(CREATION_TIMESTAMP)
+        .modifiedTimestamp(CREATION_TIMESTAMP)
+        .cleanupTimestamp(housekeepingPath.getCleanupTimestamp())
+        .cleanupDelay(CLEANUP_DELAY_STRING)
+        .cleanupAttempts(0)
+        .lifecycleType(EXPIRED.toString())
+        .build();
+  }
 }

beekeeper-integration-tests/src/test/java/com/expediagroup/beekeeper/integration/api/BeekeeperApiIntegrationTest.java

@@ -181,11 +181,107 @@ public void testGetPathsWhenThereIsFiltering() throws SQLException, InterruptedE
     Page<HousekeepingPathResponse> responsePage = mapper
         .readValue(body, new TypeReference<RestResponsePage<HousekeepingPathResponse>>() {});
     List<HousekeepingPathResponse> result = responsePage.getContent();
-
+    assertThat(responsePage.getTotalElements()).isEqualTo(1L);
     assertThatPathsEqualsResponse(testPath1, result.get(0));
     assertThat(result.size()).isEqualTo(1);
   }
 
+  @Test
+  public void testPathsPageable() throws SQLException, InterruptedException, IOException {
+    // Test the total elements on different pages by setting the page size to 1.
+    int pageSize = 1;
+
+    // Create three new HousekeepingPath objects
+    HousekeepingPath testPath1 = createHousekeepingPath("some_table",
+        "s3://some/path/event_date=2020-01-01/event_hour=0/event_type=A", LifecycleEventType.EXPIRED,
+        Duration.parse("P3D").toString());
+    HousekeepingPath testPath2 = createHousekeepingPath("some_table",
+        "s3://some/path/event_date=2020-01-01/event_hour=0/event_type=B", LifecycleEventType.UNREFERENCED,
+        Duration.parse("P3D").toString());
+    HousekeepingPath testPath3 = createHousekeepingPath("some_table",
+        "s3://some/path/event_date=2020-01-01/event_hour=0/event_type=D", LifecycleEventType.UNREFERENCED,
+        Duration.parse("P3D").toString());
+
+    // Set the housekeepingStatus and cleanupTimestamp properties
+    testPath1.setHousekeepingStatus(HousekeepingStatus.FAILED);
+    testPath2.setHousekeepingStatus(HousekeepingStatus.FAILED);
+    testPath3.setHousekeepingStatus(HousekeepingStatus.FAILED);
+    testPath1.setCleanupTimestamp(LocalDateTime.parse("1999-05-05T10:41:20"));
+    testPath2.setCleanupTimestamp(LocalDateTime.parse("1999-05-05T10:41:20"));
+    testPath3.setCleanupTimestamp(LocalDateTime.parse("1999-05-05T10:41:20"));
+
+    // Insert the three objects into the database
+    insertUnreferencedPath(testPath1);
+    insertUnreferencedPath(testPath2);
+    insertUnreferencedPath(testPath3);
+
+    // Call the getUnreferencedPaths() method with the relevant filters
+    String filters = "?housekeeping_status=FAILED&page=1&size=" + pageSize; // Concat the pageSize set initially
+    HttpResponse<String> response = testClient.getUnreferencedPaths("some_database", "some_table", filters);
+
+    // Assert that the response contains the entries in the database
+    assertThat(response.statusCode()).isEqualTo(OK.value());
+    String body = response.body();
+    Page<HousekeepingPathResponse> responsePage = mapper
+        .readValue(body, new TypeReference<RestResponsePage<HousekeepingPathResponse>>() {});
+    List<HousekeepingPathResponse> result = responsePage.getContent();
+
+    // Assert that each page contains exactly one element
+    assertThat(result.size()).isEqualTo(1);
+    // Assert that there are a total of three elements
+    assertThat(responsePage.getTotalElements()).isEqualTo(3L);
+    // Assert that there are a total of three pages.
+    assertThat(responsePage.getTotalPages()).isEqualTo(3L);
+  }
+
+  @Test
+  public void testMetadataPageable() throws SQLException, InterruptedException, IOException {
+    // Test the total elements on different pages by setting the page size to 1.
+    int pageSize = 1;
+
+    // Create three new HousekeepingMetadata objects
+    HousekeepingMetadata testMetadata1 = createHousekeepingMetadata("some_table",
+        "s3://some/path/event_date=2020-01-01/event_hour=0/event_type=A",
+        "event_date=2020-01-01/event_hour=0/event_type=A", LifecycleEventType.EXPIRED, "P3D");
+    HousekeepingMetadata testMetadata2 = createHousekeepingMetadata("some_table",
+        "s3://some/path/event_date=2020-01-01/event_hour=0/event_type=B",
+        "event_date=2020-01-01/event_hour=0/event_type=B", LifecycleEventType.UNREFERENCED, "P3D");
+    HousekeepingMetadata testMetadata3 = createHousekeepingMetadata("some_table",
+        "s3://some/path/event_date=2020-01-01/event_hour=0/event_type=C",
+        "event_date=2020-01-01/event_hour=0/event_type=C", LifecycleEventType.UNREFERENCED, "P3D");
+
+    // Set the housekeepingStatus and cleanupTimestamp properties
+    testMetadata1.setHousekeepingStatus(HousekeepingStatus.FAILED);
+    testMetadata2.setHousekeepingStatus(HousekeepingStatus.FAILED);
+    testMetadata3.setHousekeepingStatus(HousekeepingStatus.FAILED);
+    testMetadata1.setCleanupTimestamp(LocalDateTime.parse("1999-05-05T10:41:20"));
+    testMetadata2.setCleanupTimestamp(LocalDateTime.parse("1999-05-05T10:41:20"));
+    testMetadata3.setCleanupTimestamp(LocalDateTime.parse("1999-05-05T10:41:20"));
+
+    // Insert the three objects into the database
+    insertExpiredMetadata(testMetadata1);
+    insertExpiredMetadata(testMetadata2);
+    insertExpiredMetadata(testMetadata3);
+
+    // Call the getUnreferencedPaths() method with the relevant filters
+    String filters = "?housekeeping_status=FAILED&page=1&size=" + pageSize; // Concat the pageSize set initially
+    HttpResponse<String> response = testClient.getMetadata("some_database", "some_table", filters);
+
+    // Assert that the response contains the entries in the database
+    assertThat(response.statusCode()).isEqualTo(OK.value());
+    String body = response.body();
+    Page<HousekeepingMetadataResponse> responsePage = mapper
+        .readValue(body, new TypeReference<RestResponsePage<HousekeepingMetadataResponse>>() {});
+    List<HousekeepingMetadataResponse> result = responsePage.getContent();
+
+    // Assert that each page contains exactly one element
+    assertThat(result.size()).isEqualTo(1);
+    // Assert that there are a total of three elements
+    assertThat(responsePage.getTotalElements()).isEqualTo(3L);
+    // Assert that there are a total of three pages.
+    assertThat(responsePage.getTotalPages()).isEqualTo(3L);
+  }
+
   // This test is to manually test the API
   @Disabled
   @Test