fix:API-paging (#172)

* fix:API-paging Updating converter classes and adding tests for paging * Adding tests Added test to HousekeepingMetadataResponseTest to ensure paging works with multiple pages and elements add another test where these values are not the default ones (more than 1 page and total num of elements is higher than the page size) * Update BeekeeperApiIntegrationTest.java * Update CHANGELOG.md * Update CHANGELOG.md * Update CHANGELOG.md Co-authored-by: Andreea Paduraru <40387422+andreeapad@users.noreply.github.com> * [maven-release-plugin] prepare release beekeeper-parent-3.5.5 * [maven-release-plugin] prepare for next development iteration * Update pom.xml * Update pom.xml * Update pom.xml * Update pom.xml * Update pom.xml * Update pom.xml * Update pom.xml * Update pom.xml * Update pom.xml * Update pom.xml * Remove surplus comments * Update CHANGELOG.md * Update CHANGELOG.md * Update beekeeper-api/src/test/java/com/expediagroup/beekeeper/api/response/PathResponseConverterTest.java * Update beekeeper-api/src/main/java/com/expediagroup/beekeeper/api/response/PathResponseConverter.java Co-authored-by: Abhimanyu Gupta <abhimanyu.gupta07@gmail.com> * Update MetadataResponseConverter.java * Update PathResponseConverter.java * Update CHANGELOG.md * Update BeekeeperApiIntegrationTest.java Extracting sections as code constants * Update BeekeeperApiIntegrationTest.java * Update BeekeeperApiIntegrationTest.java Remove comment from Integration test * Update BeekeeperApiIntegrationTest.java Remove comment from Integration test * Refactoring tests * Update beekeeper-integration-tests/src/test/java/com/expediagroup/beekeeper/integration/api/BeekeeperApiIntegrationTest.java Co-authored-by: Andreea Paduraru <40387422+andreeapad@users.noreply.github.com> * Refactoring tests --------- Co-authored-by: Hamza Jugon <hjugon@expediagroup.com> Co-authored-by: Andreea Paduraru <40387422+andreeapad@users.noreply.github.com> Co-authored-by: eg-oss-ci <oss@expediagroup.com> Co-authored-by: Abhimanyu Gupta <abhimanyu.gupta07@gmail.com>
ExpediaGroup · Nov 27, 2023 · 9912e0e · 9912e0e
1 parent 20db8ad
commit 9912e0e
Show file tree

Hide file tree

Showing 7 changed files with 189 additions and 86 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.5.5] - 2023-11-10
+### Fixed
+- Fixed paged API response by updating 'MetadataResponseConverter' and 'PathResponseConverter' to pass complete information about the number of pages and elements to the response Page.
+
 ## [3.5.4] - 2023-09-14
 ### Fixed
 - Added localisation normalization so locations like `s3:/a/b` and `s3:/a/b/` will be considered the same and path won't be scheduled for deletion.

diff --git a/...-api/src/main/java/com/expediagroup/beekeeper/api/response/MetadataResponseConverter.java b/...-api/src/main/java/com/expediagroup/beekeeper/api/response/MetadataResponseConverter.java
@@ -39,11 +39,12 @@ public static Page<HousekeepingMetadataResponse> convertToHousekeepingMetadataRe
     List<HousekeepingMetadata> housekeepingMetadataList = housekeepingMetadataPage.getContent();
     List<HousekeepingMetadataResponse> housekeepingMetadataResponseList = new ArrayList<>();
     for (HousekeepingMetadata housekeepingMetadata : housekeepingMetadataList) {
-      HousekeepingMetadataResponse housekeepingMetadataResponse = convertToHousekeepingMetadataResponse(
-          housekeepingMetadata);
+      HousekeepingMetadataResponse housekeepingMetadataResponse = convertToHousekeepingMetadataResponse(housekeepingMetadata);
       housekeepingMetadataResponseList.add(housekeepingMetadataResponse);
     }
-    return new PageImpl<>(housekeepingMetadataResponseList);
+    PageImpl<HousekeepingMetadataResponse> housekeepingMetadataResponses = new PageImpl<>(
+        housekeepingMetadataResponseList, housekeepingMetadataPage.getPageable(), housekeepingMetadataPage.getTotalElements());
+    return housekeepingMetadataResponses;
   }
 
   private static HousekeepingMetadataResponse convertToHousekeepingMetadataResponse(

diff --git a/...eper-api/src/main/java/com/expediagroup/beekeeper/api/response/PathResponseConverter.java b/...eper-api/src/main/java/com/expediagroup/beekeeper/api/response/PathResponseConverter.java
@@ -56,7 +56,9 @@ public static Page<HousekeepingPathResponse> convertToHousekeepingPathResponsePa
       HousekeepingPathResponse housekeepingPathResponse = convertToHousekeepingPathResponse(housekeepingPath);
       housekeepingPathResponseList.add(housekeepingPathResponse);
     }
-    return new PageImpl<>(housekeepingPathResponseList);
+    PageImpl<HousekeepingPathResponse> housekeepingPathResponses = new PageImpl<>(
+        housekeepingPathResponseList, housekeepingPathPage.getPageable(), housekeepingPathPage.getTotalElements());
+    return housekeepingPathResponses;
   }
 
 }
diff --git a/...c/test/java/com/expediagroup/beekeeper/api/response/HousekeepingMetadataResponseTest.java b/...c/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.
@@ -21,11 +21,13 @@
 import static com.expediagroup.beekeeper.api.util.DummyHousekeepingEntityGenerator.generateDummyHousekeepingMetadata;
 import static com.expediagroup.beekeeper.api.util.DummyHousekeepingEntityGenerator.generateDummyHousekeepingMetadataResponse;
 
+import java.util.ArrayList;
 import java.util.List;
 
 import org.junit.jupiter.api.Test;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageImpl;
+import org.springframework.data.domain.PageRequest;
 
 import com.expediagroup.beekeeper.core.model.HousekeepingMetadata;
 
@@ -46,7 +48,22 @@ 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()));
   }
 
+  @Test
+  public void testConvertToHouseKeepingMetadataResponsePageWithMultiplePages() {
+    List<HousekeepingMetadata> housekeepingMetadataList = new ArrayList<>();
+    for (int i = 0; i < 50; i++) {
+      housekeepingMetadataList.add(generateDummyHousekeepingMetadata("some_database" + i, "some_table" + i));
+    }
+
+    Page<HousekeepingMetadata> metadataPage = new PageImpl<>(housekeepingMetadataList, PageRequest.of(0, 10), 50);
+    Page<HousekeepingMetadataResponse> metadataResponsePage = convertToHousekeepingMetadataResponsePage(metadataPage);
+
+    assertThat(metadataResponsePage.getTotalElements()).isEqualTo(50L);
+    assertThat(metadataResponsePage.getTotalPages()).isEqualTo(5L);
+  }
 }
diff --git a/...-api/src/test/java/com/expediagroup/beekeeper/api/response/PathResponseConverterTest.java b/...-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()));
+  }
+}
diff --git a/...i/src/test/java/com/expediagroup/beekeeper/api/util/DummyHousekeepingEntityGenerator.java b/...i/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();
+  }
 }