Skip to content

CDA-122 - Allows for round-tripping ratings #2000

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
rma-bryson wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

CDA-122 - Allows for round-tripping ratings #2000

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
7 changes: 7 additions & 0 deletions cwms-data-api/src/main/java/cwms/cda/data/dao/JsonRatingUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,14 @@ public static RatingSet toRatingSet(RatingsDocument ratings)
return RatingXmlFactory.ratingSet(writeXml(ratings));
}

/**
* Reads either the json written by writeJson(RatingsDocument) (GET /ratings/{rating-id})
* or the json returned by GET /ratings so that it can be round-tripped back to POST /ratings.
*/
public static RatingsDocument readJson(String json) throws JsonProcessingException {
if (RetrievedRatingsJsonConverter.isRetrievedFormat(JSON_MAPPER, json)) {
return RetrievedRatingsJsonConverter.toRatingsDocument(JSON_MAPPER, json);
}
return JSON_MAPPER.readValue(json, RatingsDocument.class);
}

Expand Down
592 changes: 592 additions & 0 deletions cwms-data-api/src/main/java/cwms/cda/data/dao/RetrievedRatingsJsonConverter.java
View file
Open in desktop

Large diffs are not rendered by default.

231 changes: 231 additions & 0 deletions cwms-data-api/src/test/java/cwms/cda/api/rating/RatingsControllerTestIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;
import java.util.Arrays;

import static cwms.cda.api.Controllers.*;
import static io.restassured.RestAssured.given;
Expand Down Expand Up @@ -559,5 +560,235 @@ void test_1206_rating_create_xml() throws IOException {
.statusCode(is(HttpServletResponse.SC_CREATED));
}

@Test
void test_1758_rating_post() throws IOException {
TestAccounts.KeyUser user = TestAccounts.KeyUser.SPK_NORMAL;
String ratingId = "FSMI.Stage;Flow.EXSA.PRODUCTION";
ratingId = ratingId.replaceAll("FSMI", EXISTING_LOC);
String body = readResourceFile("cwms/cda/data/dto/rating/rating_post.json");
body = body.replaceAll("FSMI", EXISTING_LOC);
String template = readResourceFile("cwms/cda/api/spk/rating_template.json");

//Create Template
given()
.log().ifValidationFails(LogDetail.ALL,true)
.contentType(Formats.JSONV2)
.body(template)
.header("Authorization", user.toHeaderValue())
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.post("/ratings/template")
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_CREATED));

// Create the set
given()
.log().ifValidationFails(LogDetail.ALL,true)
.contentType(Formats.JSONV2)
.accept(Formats.JSONV2)
.body(body)
.header("Authorization", user.toHeaderValue())
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.post("/ratings")
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_CREATED));

given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSONV2)
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.get("/ratings/" + ratingId)
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK))
.contentType(is(Formats.JSONV2))
.body("rating-spec.office-id", is(SPK))
.body("simple-rating.office-id", is(SPK));
}

@Test
void test_1758_rating_post_usgs_stream_rating() throws IOException {
TestAccounts.KeyUser user = TestAccounts.KeyUser.SPK_NORMAL;
String ratingId = "USGSTEST.Stage;Flow.USGS-EXSA.USGS-NWIS".replace("USGSTEST", EXISTING_LOC);
// json as returned by GET /ratings
String body = readResourceFile("cwms/cda/data/dto/rating/rating_post_usgs.json")
.replace("USGSTEST", EXISTING_LOC);

// Create the set
given()
.log().ifValidationFails(LogDetail.ALL,true)
.contentType(Formats.JSONV2)
.body(body)
.header("Authorization", user.toHeaderValue())
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.post("/ratings")
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_CREATED));

given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSONV2)
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.get("/ratings/" + ratingId)
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK))
.contentType(is(Formats.JSONV2))
.body("rating-spec.office-id", is(SPK))
.body("rating-spec.source-agency", is("USGS"))
.body("usgs-stream-rating.office-id", is(SPK))
.body("usgs-stream-rating.rating-spec-id", is(ratingId))
.body("usgs-stream-rating.units-id", is("ft;cfs"))
.body("usgs-stream-rating.height-shifts.point.size()", is(2))
.body("usgs-stream-rating.rating-points.point.size()", is(4));
}

@Test
void test_1758_rating_post_virtual_rating() throws IOException {
TestAccounts.KeyUser user = TestAccounts.KeyUser.SPK_NORMAL;
String ratingId = "VIRTTEST.Stage;Flow.Virtual.Production".replace("VIRTTEST", EXISTING_LOC);
// json as returned by GET /ratings, including the source ratings the virtual rating references
String body = readResourceFile("cwms/cda/data/dto/rating/rating_post_virtual.json")
.replace("VIRTTEST", EXISTING_LOC);

// Create the set
given()
.log().ifValidationFails(LogDetail.ALL,true)
.contentType(Formats.JSONV2)
.body(body)
.header("Authorization", user.toHeaderValue())
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.post("/ratings")
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_CREATED));

given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSONV2)
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.get("/ratings/" + ratingId)
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK))
.contentType(is(Formats.JSONV2))
.body("virtual-rating.office-id", is(SPK))
.body("virtual-rating.rating-spec-id", is(ratingId))
.body("virtual-rating.connections", is("R2I1=R1D"))
.body("virtual-rating.source-ratings.source-rating.size()", is(2));
}

@Test
void test_1758_rating_post_transitional_rating() throws IOException {
TestAccounts.KeyUser user = TestAccounts.KeyUser.SPK_NORMAL;
String ratingId = "TRANSTEST.Stage;Flow.Transitional.Production".replace("TRANSTEST", EXISTING_LOC);
// json as returned by GET /ratings, including the source ratings the transitional rating references
String body = readResourceFile("cwms/cda/data/dto/rating/rating_post_transitional.json")
.replace("TRANSTEST", EXISTING_LOC);

// Create the set
given()
.log().ifValidationFails(LogDetail.ALL,true)
.contentType(Formats.JSONV2)
.body(body)
.header("Authorization", user.toHeaderValue())
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.post("/ratings")
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_CREATED));

String retrieved = given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSONV2)
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.get("/ratings/" + ratingId)
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK))
.contentType(is(Formats.JSONV2))
.body("transitional-rating.office-id", is(SPK))
.body("transitional-rating.rating-spec-id", is(ratingId))
.body("transitional-rating.units-id", is("ft;cfs"))
// the database normalizes the condition from "I1 GT 20"
.body("transitional-rating.select.case.when", is("I1 gt 20.0"))
.body("transitional-rating.select.default", is("R1"))
.body("transitional-rating.source-ratings.rating-spec-id.size()", is(2))
.extract()
.asString();

// The source rating spec ids in that json keep the whitespace from the rating xml
// (e.g. "\n LOC.Stage;Flow.TransSrc.Low\n "), make sure it can still be stored as is.
given()
.log().ifValidationFails(LogDetail.ALL,true)
.contentType(Formats.JSONV2)
.body(retrieved)
.header("Authorization", user.toHeaderValue())
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.patch("/ratings/" + ratingId)
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK));

// The sources still resolve, so the whitespace wasn't stored with the ids
given()
.log().ifValidationFails(LogDetail.ALL,true)
.accept(Formats.JSONV2)
.queryParam(OFFICE, SPK)
.when()
.redirects().follow(true)
.redirects().max(3)
.get("/ratings/" + ratingId)
.then()
.log().ifValidationFails(LogDetail.ALL,true)
.assertThat()
.statusCode(is(HttpServletResponse.SC_OK))
.body("transitional-rating.source-ratings.rating-spec-id.element-value.collect { it.trim() }",
is(Arrays.asList(EXISTING_LOC + ".Stage;Flow.TransSrc.Low",
EXISTING_LOC + ".Stage;Flow.TransSrc.High")));
}

}

Loading
Loading