Skip to content

Extend test of catalog pagination to include locations. #1556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MikeNeilson wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Extend test of catalog pagination to include locations. #1556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 76 additions & 52 deletions cwms-data-api/src/test/java/cwms/cda/api/CatalogControllerTestIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
import cwms.cda.formatters.ContentType;
import cwms.cda.formatters.json.JsonV2;
import fixtures.TestAccounts;

import java.util.HashMap;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
Expand Down Expand Up @@ -43,14 +45,17 @@
import io.restassured.filter.log.LogDetail;
import io.restassured.response.Response;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import org.junit.jupiter.params.provider.ValueSource;

import static org.hamcrest.Matchers.*;

@Tag("integration")
public class CatalogControllerTestIT extends DataApiTestIT {

public static final String OFFICE = "SPK";
public static final String OFFICE1 = "SPK";
public static final String OFFICE2 = "MVP";
public static final String OFFICE3 = "LRL";

//// These have to match the groups in ts_catalog_setup.sql
public static final String A_TO_M = "A to M";
Expand All @@ -62,24 +67,34 @@
@BeforeAll
static void setup_data() throws Exception {
// Create some locations and create some ts.
createLocation("Alder Springs",true, OFFICE);
createLocation("Wet Meadows",true, OFFICE);
createLocation("Pine Flat-Outflow",true, OFFICE);
createLocation("Flat Lake",true, OFFICE);

createProject("Flat Project", OFFICE);
createTimeseries(OFFICE,"Alder Springs.Precip-Cumulative.Inst.15Minutes.0.raw-cda");
createTimeseries(OFFICE,"Alder Springs.Precip-INC.Total.15Minutes.15Minutes.calc-cda");
createTimeseries(OFFICE,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.raw-cda");
createTimeseries(OFFICE,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.one");
createTimeseries(OFFICE,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.two");
createTimeseries(OFFICE,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.three");
createTimeseries(OFFICE,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.four");
createTimeseries(OFFICE,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.raw-cda");
createTimeseries(OFFICE,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.one");
createTimeseries(OFFICE,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.two");
createTimeseries(OFFICE,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.three");
createTimeseries(OFFICE,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.four");
createLocation("Alder Springs",true, OFFICE1);
createLocation("Wet Meadows",true, OFFICE1);
createLocation("Pine Flat-Outflow",true, OFFICE1);
createLocation("Flat Lake",true, OFFICE1);

createLocation("LockDam_10", true, OFFICE2);
createLocation("LockDam_01", true, OFFICE2);
for (int i=0; i < 30; i++) {
createLocation(String.format("LOckDam_%03d", i*10), true, OFFICE2);
}

createLocation("Barkley", true, OFFICE2);
createLocation("Franklin", true, OFFICE2);
createLocation("HorseBranch", true, OFFICE2);

createProject("Flat Project", OFFICE1);
createTimeseries(OFFICE1,"Alder Springs.Precip-Cumulative.Inst.15Minutes.0.raw-cda");
createTimeseries(OFFICE1,"Alder Springs.Precip-INC.Total.15Minutes.15Minutes.calc-cda");
createTimeseries(OFFICE1,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.raw-cda");
createTimeseries(OFFICE1,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.one");
createTimeseries(OFFICE1,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.two");
createTimeseries(OFFICE1,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.three");
createTimeseries(OFFICE1,"Pine Flat-Outflow.Stage.Inst.15Minutes.0.four");
createTimeseries(OFFICE1,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.raw-cda");
createTimeseries(OFFICE1,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.one");
createTimeseries(OFFICE1,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.two");
createTimeseries(OFFICE1,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.three");
createTimeseries(OFFICE1,"Wet Meadows.Depth-SWE.Inst.15Minutes.0.four");

// Complicated
loadSqlDataFromResource("cwms/cda/data/sql/ts_catalog_setup.sql");
Expand All @@ -89,7 +104,7 @@

private static void createProject(String id, String office) throws SQLException {
CwmsDataApiSetupCallback.getDatabaseLink().connection(c -> {
DSLContext dsl = dslContext(c, OFFICE);
DSLContext dsl = dslContext(c, OFFICE1);
ProjectDao projectDao = new ProjectDao(dsl);
Project project = new Project.Builder()
.withLocation(new Location.Builder(id,
Expand All @@ -107,7 +122,7 @@

private static void deleteProject(String id, String office) throws SQLException {
CwmsDataApiSetupCallback.getDatabaseLink().connection(c -> {
DSLContext dsl = dslContext(c, OFFICE);
DSLContext dsl = dslContext(c, OFFICE1);
ProjectDao projectDao = new ProjectDao(dsl);

projectDao.delete(office, id, DeleteRule.DELETE_KEY);
Expand All @@ -117,7 +132,7 @@
@AfterAll
static void deload_data() throws Exception {
loadSqlDataFromResource("cwms/cda/data/sql/ts_catalog_cleanup.sql");
deleteProject("Flat Project", OFFICE);
deleteProject("Flat Project", OFFICE1);
cleanupBasins();
cleanupStreams();
}
Expand All @@ -128,7 +143,7 @@
given()
.accept(format)
.log().ifValidationFails(LogDetail.ALL, true)
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(EXCLUDE_EMPTY,false)
.queryParam(LIKE,".*-cda$")
.when()
Expand All @@ -148,7 +163,7 @@
Integer numAliases = given()
.accept(format)
.log().ifValidationFails(LogDetail.ALL, true)
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(EXCLUDE_EMPTY, false)
.when()
.get("/catalog/TIMESERIES")
Expand All @@ -167,7 +182,7 @@
void test_aliases_returned(String format) {
Integer numAliases = given().accept(format)
.log().ifValidationFails(LogDetail.ALL, true)
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(EXCLUDE_EMPTY,false)
.queryParam(INCLUDE_ALIASES,true)
.when()
Expand All @@ -187,7 +202,7 @@
void test_alias_is_correct(String format) throws JsonProcessingException {
Response response = given().accept(format)
.log().ifValidationFails(LogDetail.ALL, true)
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(EXCLUDE_EMPTY, false)
.queryParam(INCLUDE_ALIASES, true)
.when()
Expand Down Expand Up @@ -225,7 +240,7 @@
void test_queries_are_case_insensitive() {
given()
.accept("application/json;version=2")
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(EXCLUDE_EMPTY,false)
.queryParam(LIKE,"alder spRINgs.*-CDA$")
.when()
Expand All @@ -240,18 +255,27 @@
}

@ParameterizedTest
@ValueSource(strings = {Formats.JSONV2, Formats.DEFAULT})
void test_all_office_pagination_works(String format) {
@CsvSource({
// Formats.JSONV2 + ",TIMESERIES",
//Formats.DEFAULT + ",TIMESERIES",
Formats.JSONV2 + ",LOCATIONS" //,
// Formats.DEFAULT + ",LOCATIONS"
})
void test_all_office_pagination_works(String format, String endpoint) {
assertTimeout(Duration.ofMinutes(5), () -> {

Check failure on line 265 in cwms-data-api/src/test/java/cwms/cda/api/CatalogControllerTestIT.java

View workflow job for this annotation

GitHub Actions / build and test (jdk 11, schema latest)

CatalogControllerTestIT.[1] application/json;version=2, LOCATIONS 

java.lang.AssertionError: 1 expectation failed.
Expected status code is <200> but was <400>.

Check failure on line 265 in cwms-data-api/src/test/java/cwms/cda/api/CatalogControllerTestIT.java

View workflow job for this annotation

GitHub Actions / build and test (jdk 11, schema release)

CatalogControllerTestIT.[1] application/json;version=2, LOCATIONS 

java.lang.AssertionError: 1 expectation failed.
Expected status code is <200> but was <400>.
final int pageSize = 50;
final int pageSize = 10; // artificially low size to force pagination
final HashMap<String,Object> queryParams = new HashMap<>();
queryParams.put("page-size", pageSize);
if (endpoint.equals("TIMESERIES")) {
queryParams.put(EXCLUDE_EMPTY,false);
}
Response initialResponse =
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(format)
.queryParam("page-size",pageSize)
.queryParam(EXCLUDE_EMPTY,false)
.queryParams(queryParams)
.when()
.get("/catalog/TIMESERIES")
.get("/catalog/{data}", endpoint)
.then()
.log().ifValidationFails(LogDetail.ALL, true)
.assertThat()
Expand All @@ -268,7 +292,7 @@
int totalRetrieved = initialResponse.path("entries.size()");

String lastRowPreviousPage = initialResponse.path("entries.last().name");

queryParams.remove("page-size");
do {
Response pageN =
given()
Expand All @@ -277,7 +301,7 @@
.queryParam("page",nextPage)
.queryParam(EXCLUDE_EMPTY,false)
.when()
.get("/catalog/TIMESERIES")
.get("/catalog/{data}", endpoint)
.then()
.log().ifValidationFails(LogDetail.ALL, true)
.assertThat()
Expand Down Expand Up @@ -309,7 +333,7 @@
// filter by loc group and ts group should find the intersection
given()
.accept("application/json;version=2")
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(LOCATION_CATEGORY_LIKE, TEST_CATEGORY)
.queryParam(LOCATION_GROUP_LIKE, N_TO_Z)
.queryParam(TIMESERIES_CATEGORY_LIKE, TEST_CATEGORY)
Expand Down Expand Up @@ -339,7 +363,7 @@
// filter by just loc group
given()
.accept("application/json;version=2")
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(LOCATION_CATEGORY_LIKE, TEST_CATEGORY)
.queryParam(LOCATION_GROUP_LIKE, A_TO_M)
.queryParam(EXCLUDE_EMPTY,false)
Expand All @@ -362,7 +386,7 @@
// filter by just loc group
given()
.accept("application/json;version=2")
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(LOCATION_CATEGORY_LIKE, TEST_CATEGORY)
.queryParam(LOCATION_GROUP_LIKE, N_TO_Z)
.queryParam(EXCLUDE_EMPTY,false)
Expand Down Expand Up @@ -397,7 +421,7 @@
// we create Wet Meadows with a bounding office of SPK
given()
.accept("application/json;version=2")
.queryParam(BOUNDING_OFFICE_LIKE, OFFICE)
.queryParam(BOUNDING_OFFICE_LIKE, OFFICE1)
.queryParam(LIKE, "^Wet Meadows.*")
.queryParam(EXCLUDE_EMPTY,false)
.when()
Expand All @@ -422,7 +446,7 @@
// First with just the regex. This should match Flat Lake and Flat Project
given()
.accept("application/json;version=2")
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(LIKE, pattern)
.when()
.get("/catalog/LOCATIONS")
Expand All @@ -439,7 +463,7 @@
// Now add the LOCATION_KIND filter
given()
.accept("application/json;version=2")
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(LIKE, pattern)
.queryParam(LOCATION_KIND_LIKE, "PROJECT") // just Flat Project
.when()
Expand All @@ -464,7 +488,7 @@
// Retrieve without aliases
given()
.accept("application/json;version=2")
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(LIKE, pattern)
.queryParam(INCLUDE_ALIASES, false)
.when()
Expand All @@ -483,7 +507,7 @@
// retrieve with aliases
given()
.accept("application/json;version=2")
.queryParam(Controllers.OFFICE, OFFICE)
.queryParam(Controllers.OFFICE, OFFICE1)
.queryParam(LIKE, pattern)
.queryParam(INCLUDE_ALIASES, true)
.when()
Expand Down Expand Up @@ -550,7 +574,7 @@
given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSON)
.queryParam(OFFICE, officeId)
.queryParam(OFFICE1, officeId)
.queryParam(LIKE, String.format("%s*", baseLocationName))
.queryParam(UNIT_SYSTEM, UnitSystem.SI.getValue())
.when()
Expand All @@ -571,7 +595,7 @@
given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSON)
.queryParam(OFFICE, officeId)
.queryParam(OFFICE1, officeId)
.queryParam(LIKE, stringToMatch)
.queryParam(UNIT_SYSTEM, UnitSystem.SI.getValue())
.when()
Expand All @@ -591,7 +615,7 @@
given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSON)
.queryParam(OFFICE, officeId)
.queryParam(OFFICE1, officeId)
.queryParam(LIKE, stringToMatch)
.queryParam(LOCATION_KIND_LIKE, "^(BASIN)$")
.queryParam(NEGATE_LOCATION_KIND_LIKE, true)
Expand All @@ -612,7 +636,7 @@
given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSON)
.queryParam(OFFICE, officeId)
.queryParam(OFFICE1, officeId)
.queryParam(LIKE, stringToMatch)
.queryParam(LOCATION_KIND_LIKE, "^(STREAM)*$")
.queryParam(NEGATE_LOCATION_KIND_LIKE, true)
Expand All @@ -632,7 +656,7 @@
given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSON)
.queryParam(OFFICE, officeId)
.queryParam(OFFICE1, officeId)
.queryParam(LIKE, stringToMatch)
.queryParam(LOCATION_KIND_LIKE, "NOT:^(STREAM)*$")
.queryParam(UNIT_SYSTEM, UnitSystem.SI.getValue())
Expand All @@ -651,7 +675,7 @@
given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSON)
.queryParam(OFFICE, officeId)
.queryParam(OFFICE1, officeId)
.queryParam(LIKE, stringToMatch)
.queryParam(LOCATION_KIND_LIKE, "NOT:^(STREAM)*$")
.queryParam(UNIT_SYSTEM, UnitSystem.SI.getValue())
Expand All @@ -671,7 +695,7 @@
given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSON)
.queryParam(OFFICE, officeId)
.queryParam(OFFICE1, officeId)
.queryParam(LIKE, stringToMatch)
.queryParam(UNIT_SYSTEM, UnitSystem.SI.getValue())
.queryParam(LOCATION_KIND_LIKE, "^(BASIN|STREAM)*$")
Expand All @@ -695,7 +719,7 @@
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(Formats.JSON)
.queryParam(OFFICE, OFFICE)
.queryParam(OFFICE1, OFFICE1)
.queryParam(INCLUDE_EXTENTS, true)
.when()
.get("/catalog/LOCATIONS")
Expand All @@ -720,7 +744,7 @@
given()
.log().ifValidationFails(LogDetail.ALL, true)
.accept(Formats.JSON)
.queryParam(OFFICE, OFFICE)
.queryParam(OFFICE1, OFFICE1)
.queryParam(INCLUDE_EXTENTS, true)
.queryParam(EXCLUDE_EMPTY, true)
.when()
Expand Down
Loading
Loading