Skip to content

Validate active job pagination parameters #869

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
codingkiddo wants to merge 1 commit into
base: master
Choose a base branch
from
+123 −6
Open

Validate active job pagination parameters #869

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
41 changes: 35 additions & 6 deletions ...ain/java/io/mantisrx/master/api/akka/route/v1/ResourceClustersNonLeaderRedirectRoute.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,13 +292,42 @@ private Route listClusters() {
return withFuture(gateway.listActiveClusters());
}

private Route getActiveJobOverview(ClusterID clusterID, Optional<String> startingIndex,
private Route getActiveJobOverview(
ClusterID clusterID,
Optional<String> startingIndex,
Optional<String> pageSize) {
CompletableFuture<PagedActiveJobOverview> jobsOverview =
gateway.getClusterFor(clusterID).getActiveJobOverview(
startingIndex.map(Integer::parseInt),
pageSize.map(Integer::parseInt));
return withFuture(jobsOverview);

Optional<Integer> parsedStartingIndex =
parseNonNegativeInteger(startingIndex);
Optional<Integer> parsedPageSize =
parseNonNegativeInteger(pageSize);

return validate(
() -> startingIndex.isEmpty() || parsedStartingIndex.isPresent(),
"startingIndex must be a non-negative integer",
() -> validate(
() -> pageSize.isEmpty() || parsedPageSize.isPresent(),
"pageSize must be a non-negative integer",
() -> withFuture(
gateway.getClusterFor(clusterID)
.getActiveJobOverview(
parsedStartingIndex,
parsedPageSize))));
}

private Optional<Integer> parseNonNegativeInteger(
Optional<String> parameterValue) {

return parameterValue.flatMap(value -> {
try {
int parsedValue = Integer.parseInt(value);
return parsedValue >= 0
? Optional.of(parsedValue)
: Optional.empty();
} catch (NumberFormatException exception) {
return Optional.empty();
}
});
}

private Route getResourceOverview(ClusterID clusterID) {
Expand Down
88 changes: 88 additions & 0 deletions .../java/io/mantisrx/master/api/akka/route/v1/ResourceClusterNonLeaderRedirectRouteTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@
import org.junit.BeforeClass;
import org.junit.Test;
import org.mockito.ArgumentMatchers;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.verifyNoInteractions;

import akka.http.javadsl.testkit.TestRouteResult;

public class ResourceClusterNonLeaderRedirectRouteTest extends JUnitRouteTest {
private static final UnitTestResourceProviderAdapter resourceProviderAdapter =
Expand Down Expand Up @@ -152,6 +156,7 @@ public void testGetActiveJobOverview() {
PagedActiveJobOverview overview1 = new PagedActiveJobOverview(ImmutableList.of(), 0);
PagedActiveJobOverview overview2 = new PagedActiveJobOverview(ImmutableList.of("test"), 1);
PagedActiveJobOverview overview3 = new PagedActiveJobOverview(ImmutableList.of("test"), 99);
PagedActiveJobOverview zeroPageSizeOverview = new PagedActiveJobOverview(ImmutableList.of("test"), 1);

ResourceCluster resourceCluster = mock(ResourceCluster.class);
when(resourceCluster.getActiveJobOverview(Optional.empty(), Optional.empty()))
Expand All @@ -161,6 +166,10 @@ public void testGetActiveJobOverview() {
when(resourceCluster.getActiveJobOverview(Optional.empty(), Optional.of(99)))
.thenReturn(CompletableFuture.completedFuture(overview3));
when(resourceClusters.getClusterFor(ClusterID.of("myCluster"))).thenReturn(resourceCluster);
when(resourceCluster.getActiveJobOverview(
Optional.of(0),
Optional.of(0)))
.thenReturn(CompletableFuture.completedFuture(zeroPageSizeOverview));

testRouteWithNoopAdapter.run(HttpRequest.GET(
"/api/v1/resourceClusters/myCluster/activeJobOverview"))
Expand All @@ -176,6 +185,24 @@ public void testGetActiveJobOverview() {
"/api/v1/resourceClusters/myCluster/activeJobOverview?pageSize=99"))
.assertStatusCode(200)
.assertEntityAs(Jackson.unmarshaller(PagedActiveJobOverview.class), overview3);

testRouteWithNoopAdapter.run(HttpRequest.GET(
"/api/v1/resourceClusters/myCluster/activeJobOverview"
+ "?startingIndex=0&pageSize=0"))
.assertStatusCode(StatusCodes.OK)
.assertEntityAs(
Jackson.unmarshaller(PagedActiveJobOverview.class),
zeroPageSizeOverview);
}

@Test
public void testGetActiveJobOverviewRejectsNegativeStartingIndex() {
testRouteWithNoopAdapter.run(HttpRequest.GET(
"/api/v1/resourceClusters/myCluster/activeJobOverview"
+ "?startingIndex=-1&pageSize=9"))
.assertStatusCode(StatusCodes.BAD_REQUEST);

verifyNoInteractions(resourceClusters);
}

@Test
Expand Down Expand Up @@ -402,6 +429,67 @@ public void testResourceClusterUpgradeRoutes() throws IOException {
.build());
}

@Test
public void testGetActiveJobOverviewRejectsInvalidStartingIndex() {
assertInvalidActiveJobOverviewQuery(
"startingIndex=abc",
"startingIndex must be a non-negative integer");

assertInvalidActiveJobOverviewQuery(
"startingIndex=-1",
"startingIndex must be a non-negative integer");

assertInvalidActiveJobOverviewQuery(
"startingIndex=2147483648",
"startingIndex must be a non-negative integer");

assertInvalidActiveJobOverviewQuery(
"startingIndex=",
"startingIndex must be a non-negative integer");

verifyNoInteractions(resourceClusters);
}

@Test
public void testGetActiveJobOverviewRejectsInvalidPageSize() {
assertInvalidActiveJobOverviewQuery(
"pageSize=abc",
"pageSize must be a non-negative integer");

assertInvalidActiveJobOverviewQuery(
"pageSize=-1",
"pageSize must be a non-negative integer");

assertInvalidActiveJobOverviewQuery(
"pageSize=2147483648",
"pageSize must be a non-negative integer");

assertInvalidActiveJobOverviewQuery(
"pageSize=",
"pageSize must be a non-negative integer");

verifyNoInteractions(resourceClusters);
}

private void assertInvalidActiveJobOverviewQuery(
String query,
String expectedErrorMessage) {

TestRouteResult result = testRouteWithNoopAdapter.run(
HttpRequest.GET(
"/api/v1/resourceClusters/myCluster/activeJobOverview?"
+ query));

result.assertStatusCode(StatusCodes.BAD_REQUEST);

String responseBody = result.entityString();

assertTrue(
responseBody,
responseBody.contains(
"\"error\":\"" + expectedErrorMessage + "\""));
}

final String getResourceClusterEndpoint() {
return "/api/v1/resourceClusters";
}
Expand Down