Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright (C) Commission Junction Inc.
*
* This file is part of rest-specs.
*
* rest-specs is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* rest-specs is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with rest-specs; see the file COPYING. If not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
* Linking this library statically or dynamically with other modules is
* making a combined work based on this library. Thus, the terms and
* conditions of the GNU General Public License cover the whole
* combination.
*
* As a special exception, the copyright holders of this library give you
* permission to link this library with independent modules to produce an
* executable, regardless of the license terms of these independent
* modules, and to copy and distribute the resulting executable under
* terms of your choice, provided that you also meet, for each linked
* independent module, the terms and conditions of the license of that
* module. An independent module is a module which is not derived from
* or based on this library. If you modify this library, you may extend
* this exception to your version of the library, but you are not
* obligated to do so. If you do not wish to do so, delete this
* exception statement from your version.
*/
package com.cj.restspecs.mockrunner;
import cj.restspecs.core.RestSpec;
import cj.restspecs.core.model.Representation;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.mockrunner.mock.web.MockHttpServletRequest;
import com.mockrunner.mock.web.MockHttpServletResponse;
import javax.servlet.http.HttpServlet;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
public class RestSpecServletValidator {
public static class ValidationResult {
public final List violations;
public ValidationResult(List violations) {
this.violations = Collections.unmodifiableList(violations);
}
public void assertNoViolations(){
if(violations.size()>0){
StringBuffer text = new StringBuffer();
for(Violation violation : violations){
text.append(violation.description + "\n");
}
throw new RuntimeException(text.toString());
}
}
public String description() {
return Violation.composeMessage(violations);
}
public boolean matches() {
return violations.isEmpty();
}
}
public static class Violation {
public final String description;
public Violation(String description) {
super();
this.description = description;
}
public static String composeMessage(List violations) {
StringBuilder message = new StringBuilder();
for (Violation violation : violations) {
message.append(violation.description).append("\n");
}
return message.toString();
}
}
private String stripLeadingQuestionMark(String query){
if(query!=null && query.startsWith("?")){
return query.substring(1);
}else{
return query;
}
}
public ValidationResult validate(RestSpec rs, HttpServlet testSubject) throws Exception {
//given
MockHttpServletRequest req = buildRequestFromRestSpec(rs);
MockHttpServletResponse res = new MockHttpServletResponse();
//when
testSubject.service(req, res);
//then
return validateResponseAgainstRestSpec(rs, res);
}
private MockHttpServletRequest buildRequestFromRestSpec(RestSpec restSpec) {
MockHttpServletRequest request;
request = new MockHttpServletRequest();
for(String name: restSpec.request().header().fieldNames()){
for(String value : restSpec.request().header().fieldsNamed(name)){
request.setHeader(name, value);
}
}
Representation requestRepresentation = restSpec.request().representation();
if (requestRepresentation != null) {
request.setBodyContent(requestRepresentation.asText());
}
request.setRequestURI(restSpec.pathMinusQueryStringAndFragment());
request.setPathInfo(restSpec.pathMinusQueryStringAndFragment());
request.setQueryString(stripLeadingQuestionMark(restSpec.queryString()));
RestSpec.QueryParameters queryParameters = restSpec.queryParameters();
for (String name : queryParameters.names()) {
request.setupAddParameter(name, queryParameters.values(name).toArray(new String[]{}));
}
request.setMethod(restSpec.request().method());
return request;
}
private ValidationResult validateResponseAgainstRestSpec(RestSpec restSpec, MockHttpServletResponse response) {
List violations;
violations = new ArrayList();
int expectedStatusCode = restSpec.response().statusCode();
int actualResponseCode = response.getStatusCode();
if (response.wasErrorSent()) {
actualResponseCode = response.getErrorCode();
}
if (expectedStatusCode != actualResponseCode) {
violations.add(new Violation("Status code should have been " + expectedStatusCode + " but was " + actualResponseCode));
}
violations.addAll(validateResponseHeaders(restSpec, response));
if (restSpec.response().representation() != null) {
violations.addAll(validateResponseBody(restSpec, response));
}
return new ValidationResult(violations);
}
private List validateResponseHeaders(RestSpec restSpec, MockHttpServletResponse response) {
List violations;
violations = new ArrayList();
List headerFieldNames = restSpec.response().header().fieldNames();
for (String fieldName : headerFieldNames) {
for (String fieldValue : restSpec.response().header().fieldsNamed(fieldName)) {
List headerList = response.getHeaderList(fieldName);
String realHeaderValue = response.getHeader(fieldName);
if (headerList == null || !headerList.contains(fieldValue)) {
violations.add(new Violation(String.format("Expected header '%s' set to '%s', but was '%s'", fieldName, fieldValue, realHeaderValue)));
}
}
}
return violations;
}
private List validateResponseBody(RestSpec restSpec, MockHttpServletResponse response) {
List violations = new ArrayList();
RepresentationsResult representationsResult = getRepresentations(restSpec, response);
if(representationsResult.hasViolations()) {
violations.addAll(representationsResult.violations());
} else {
boolean representationsAreEquivalent = representationsResult.expected().equals(representationsResult.actual());
if (!representationsAreEquivalent) {
violations.add(new Violation("The response representation should have been " + representationsResult.expected() + " but was " + representationsResult.actual()));
}
}
return violations;
}
private RepresentationsResult getRepresentations(RestSpec restSpec, MockHttpServletResponse response) {
List violations = new ArrayList();
String expected = null;
String actual = null;
if (isJsonContent(restSpec)) {
try {
expected = normalize(restSpec.response().representation().asText());
} catch(RuntimeException ex){
violations.add(new Violation("expected: " + ex.getMessage()));
}
try {
actual = normalize(response.getOutputStreamContent());
} catch(RuntimeException ex){
violations.add(new Violation("actual : " + ex.getMessage()));
}
} else {
expected = restSpec.response().representation().asText();
actual = response.getOutputStreamContent();
}
return new RepresentationsResult(expected, actual, violations);
}
private boolean isJsonContent(RestSpec restSpec) {
String contentType = restSpec.response().representation().contentType();
boolean isJsonContent = contentType.contains("/json");
return isJsonContent;
}
private String normalize(String inputJson) {
try {
String outputJson;
ObjectMapper mapper = new ObjectMapper();
mapper.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true);
Object mappedInput = mapper.readValue(inputJson, Object.class);
outputJson = mapper.writeValueAsString(mappedInput);
return outputJson;
} catch (Exception error) {
throw new RuntimeException(String.format("Failed to normalize JSON: '%s'", inputJson), error);
}
}
private static class RepresentationsResult {
private final String expected;
private final String actual;
private final List violations;
public RepresentationsResult(String expected, String actual, List violations) {
this.expected = expected;
this.actual = actual;
this.violations = violations;
}
public boolean hasViolations() {
return !violations.isEmpty();
}
public List violations() {
return violations;
}
public String expected() {
return expected;
}
public String actual() {
return actual;
}
}
}
