/* 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 org.camunda.bpm.engine.rest;
import com.jayway.restassured.http.ContentType;
import com.jayway.restassured.response.Response;
import org.camunda.bpm.engine.repository.CaseDefinition;
import org.camunda.bpm.engine.repository.CaseDefinitionQuery;
import org.camunda.bpm.engine.rest.exception.InvalidRequestException;
import org.camunda.bpm.engine.rest.helper.MockProvider;
import org.junit.Before;
import org.junit.Test;
import org.mockito.InOrder;
import org.mockito.Mockito;
import javax.ws.rs.core.Response.Status;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static com.jayway.restassured.RestAssured.expect;
import static com.jayway.restassured.RestAssured.given;
import static com.jayway.restassured.path.json.JsonPath.from;
import static org.fest.assertions.Assertions.assertThat;
import static org.hamcrest.Matchers.equalTo;
import static org.mockito.Mockito.*;
/**
* @author Roman Smirnov
*
*/
public abstract class AbstractCaseDefinitionRestServiceQueryTest extends AbstractRestServiceTest {
protected static final String CASE_DEFINITION_QUERY_URL = TEST_RESOURCE_ROOT_PATH + "/case-definition";
protected static final String CASE_DEFINITION_COUNT_QUERY_URL = CASE_DEFINITION_QUERY_URL + "/count";
private CaseDefinitionQuery mockedQuery;
@Before
public void setUpRuntime() {
mockedQuery = createMockCaseDefinitionQuery(MockProvider.createMockCaseDefinitions());
}
private CaseDefinitionQuery createMockCaseDefinitionQuery(List<CaseDefinition> mockedDefinitions) {
CaseDefinitionQuery sampleDefinitionsQuery = mock(CaseDefinitionQuery.class);
when(sampleDefinitionsQuery.list()).thenReturn(mockedDefinitions);
when(sampleDefinitionsQuery.count()).thenReturn((long) mockedDefinitions.size());
when(processEngine.getRepositoryService().createCaseDefinitionQuery()).thenReturn(sampleDefinitionsQuery);
return sampleDefinitionsQuery;
}
@Test
public void testEmptyQuery() {
given()
.then()
.expect()
.statusCode(Status.OK.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
verify(mockedQuery).list();
}
@Test
public void testInvalidNumericParameter() {
String anInvalidIntegerQueryParam = "aString";
given()
.queryParam("version", anInvalidIntegerQueryParam)
.then()
.expect()
.statusCode(Status.BAD_REQUEST.getStatusCode())
.contentType(ContentType.JSON)
.body("type", equalTo(InvalidRequestException.class.getSimpleName()))
.body("message", equalTo("Cannot set query parameter 'version' to value 'aString': "
+ "Cannot convert value aString to java type java.lang.Integer"))
.when()
.get(CASE_DEFINITION_QUERY_URL);
}
/**
* We assume that boolean query parameters that are not "true"
* or "false" are evaluated to "false" and don't cause a 400 error.
*/
@Test
public void testInvalidBooleanParameter() {
String anInvalidBooleanQueryParam = "neitherTrueNorFalse";
given()
.queryParam("active", anInvalidBooleanQueryParam)
.then()
.expect()
.statusCode(Status.OK.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
}
@Test
public void testInvalidSortingOptions() {
executeAndVerifySorting("anInvalidSortByOption", "asc", Status.BAD_REQUEST);
executeAndVerifySorting("id", "anInvalidSortOrderOption", Status.BAD_REQUEST);
}
@Test
public void testSortByParameterOnly() {
given()
.queryParam("sortBy", "id")
.then()
.expect()
.statusCode(Status.BAD_REQUEST.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
}
@Test
public void testSortOrderParameterOnly() {
given()
.queryParam("sortOrder", "asc")
.then()
.expect()
.statusCode(Status.BAD_REQUEST.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
}
protected void executeAndVerifySorting(String sortBy, String sortOrder, Status expectedStatus) {
given()
.queryParam("sortBy", sortBy)
.queryParam("sortOrder", sortOrder)
.then()
.expect()
.statusCode(expectedStatus.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
}
@Test
public void testSortingParameters() {
// asc
InOrder inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("id", "asc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionId();
inOrder.verify(mockedQuery).asc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("name", "asc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionName();
inOrder.verify(mockedQuery).asc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("version", "asc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionVersion();
inOrder.verify(mockedQuery).asc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("key", "asc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionKey();
inOrder.verify(mockedQuery).asc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("category", "asc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionCategory();
inOrder.verify(mockedQuery).asc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("deploymentId", "asc", Status.OK);
inOrder.verify(mockedQuery).orderByDeploymentId();
inOrder.verify(mockedQuery).asc();
// desc
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("id", "desc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionId();
inOrder.verify(mockedQuery).desc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("name", "desc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionName();
inOrder.verify(mockedQuery).desc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("version", "desc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionVersion();
inOrder.verify(mockedQuery).desc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("key", "desc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionKey();
inOrder.verify(mockedQuery).desc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("category", "desc", Status.OK);
inOrder.verify(mockedQuery).orderByCaseDefinitionCategory();
inOrder.verify(mockedQuery).desc();
inOrder = Mockito.inOrder(mockedQuery);
executeAndVerifySorting("deploymentId", "desc", Status.OK);
inOrder.verify(mockedQuery).orderByDeploymentId();
inOrder.verify(mockedQuery).desc();
}
@Test
public void testSuccessfulPagination() {
int firstResult = 0;
int maxResults = 10;
given()
.queryParam("firstResult", firstResult)
.queryParam("maxResults", maxResults)
.then()
.expect()
.statusCode(Status.OK.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
verify(mockedQuery).listPage(firstResult, maxResults);
}
/**
* If parameter "firstResult" is missing, we expect 0 as default.
*/
@Test
public void testMissingFirstResultParameter() {
int maxResults = 10;
given()
.queryParam("maxResults", maxResults)
.then()
.expect()
.statusCode(Status.OK.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
verify(mockedQuery).listPage(0, maxResults);
}
/**
* If parameter "maxResults" is missing, we expect Integer.MAX_VALUE as default.
*/
@Test
public void testMissingMaxResultsParameter() {
int firstResult = 10;
given()
.queryParam("firstResult", firstResult)
.then()
.expect()
.statusCode(Status.OK.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
verify(mockedQuery).listPage(firstResult, Integer.MAX_VALUE);
}
@Test
public void testCaseDefinitionRetrieval() {
Response response = given()
.then()
.expect()
.statusCode(Status.OK.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
// assert query invocation
InOrder inOrder = Mockito.inOrder(mockedQuery);
inOrder.verify(mockedQuery).list();
String content = response.asString();
List<Map<String, String>> caseDefinitions = from(content).getList("");
assertThat(caseDefinitions).hasSize(1);
assertThat(caseDefinitions.get(0)).isNotNull();
String returnedId = from(content).getString("[0].id");
String returnedKey = from(content).getString("[0].key");
String returnedCategory = from(content).getString("[0].category");
String returnedName = from(content).getString("[0].name");
int returnedVersion = from(content).getInt("[0].version");
String returnedResource = from(content).getString("[0].resource");
String returnedDeploymentId = from(content).getString("[0].deploymentId");
assertThat(returnedId).isEqualTo(MockProvider.EXAMPLE_CASE_DEFINITION_ID);
assertThat(returnedKey).isEqualTo(MockProvider.EXAMPLE_CASE_DEFINITION_KEY);
assertThat(returnedCategory).isEqualTo(MockProvider.EXAMPLE_CASE_DEFINITION_CATEGORY);
assertThat(returnedName).isEqualTo(MockProvider.EXAMPLE_CASE_DEFINITION_NAME);
assertThat(returnedVersion).isEqualTo(MockProvider.EXAMPLE_CASE_DEFINITION_VERSION);
assertThat(returnedResource).isEqualTo(MockProvider.EXAMPLE_CASE_DEFINITION_RESOURCE_NAME);
assertThat(returnedDeploymentId).isEqualTo(MockProvider.EXAMPLE_DEPLOYMENT_ID);
}
@Test
public void testAdditionalParameters() {
Map<String, String> queryParameters = getCompleteQueryParameters();
given()
.queryParams(queryParameters)
.expect()
.statusCode(Status.OK.getStatusCode())
.when()
.get(CASE_DEFINITION_QUERY_URL);
// assert query invocation
verify(mockedQuery).caseDefinitionId(queryParameters.get("caseDefinitionId"));
verify(mockedQuery).caseDefinitionCategory(queryParameters.get("category"));
verify(mockedQuery).caseDefinitionCategoryLike(queryParameters.get("categoryLike"));
verify(mockedQuery).caseDefinitionName(queryParameters.get("name"));
verify(mockedQuery).caseDefinitionNameLike(queryParameters.get("nameLike"));
verify(mockedQuery).deploymentId(queryParameters.get("deploymentId"));
verify(mockedQuery).caseDefinitionKey(queryParameters.get("key"));
verify(mockedQuery).caseDefinitionKeyLike(queryParameters.get("keyLike"));
verify(mockedQuery).caseDefinitionVersion(Integer.parseInt(queryParameters.get("version")));
verify(mockedQuery).latestVersion();
verify(mockedQuery).caseDefinitionResourceName(queryParameters.get("resourceName"));
verify(mockedQuery).caseDefinitionResourceNameLike(queryParameters.get("resourceNameLike"));
verify(mockedQuery).list();
}
@Test
public void testQueryCount() {
expect().statusCode(Status.OK.getStatusCode())
.body("count", equalTo(1))
.when().get(CASE_DEFINITION_COUNT_QUERY_URL);
verify(mockedQuery).count();
}
private Map<String, String> getCompleteQueryParameters() {
Map<String, String> parameters = new HashMap<String, String>();
parameters.put("caseDefinitionId", "anId");
parameters.put("category", "cat");
parameters.put("categoryLike", "catlike");
parameters.put("name", "name");
parameters.put("nameLike", "namelike");
parameters.put("deploymentId", "depId");
parameters.put("key", "key");
parameters.put("keyLike", "keylike");
parameters.put("version", "1");
parameters.put("latest", "true");
parameters.put("resourceName", "res");
parameters.put("resourceNameLike", "resLike");
return parameters;
}
}