smartrics.rest.fitnesse.fixture.ext.RestScriptFixture Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of smartrics-RestFixtureExtensions Show documentation
Show all versions of smartrics-RestFixtureExtensions Show documentation
Extensions of the RestFixture.
An extension is a RestFixture with some specific/bespoke behaviour not generic enough to make it to the RestFixture itself.
/* Copyright 2012 Fabrizio Cannizzo
*
* This file is part of RestFixture.
*
* RestFixture (http://code.google.com/p/rest-fixture/) is free software:
* you can redistribute it and/or modify it under the terms of the
* GNU Lesser General Public License as published by the Free Software Foundation,
* either version 3 of the License, or (at your option) any later version.
*
* RestFixture 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with RestFixture. If not, see
*
*/
public class RestScriptFixture extends RestFixture {
public RestScriptFixture(String hostName) {
super(hostName);
initialize();
}
public RestScriptFixture(String hostName, String configName) {
super(hostName, configName);
initialize();
}
/**
* Constructor for test interfaces
*/
RestScriptFixture(PartsFactory partsFactory, String hostName, Runner runner) {
this(partsFactory, hostName, Config.DEFAULT_CONFIG_NAME);
initialize(runner);
}
/**
* Constructor for test interfaces
*/
RestScriptFixture(PartsFactory partsFactory, String hostName, String configName) {
super(partsFactory, hostName, configName);
}
private void initialize() {
initialize(Runner.SLIM);
}
/**
* | get | URL |
*
* executes a GET on the URL
*/
public void get(String resourceUrl) {
doMethod("Get", resourceUrl, null);
}
/**
* | post | URL |
*
* executes a POST on the URL
*/
public void post(String resourceUrl) {
doMethod("Post", resourceUrl, emptifyBody(requestBody));
}
/**
* | put | URL |
*
* executes a PUT on the URL
*/
public void put(String resourceUrl) {
doMethod("Put", resourceUrl, emptifyBody(requestBody));
}
/**
* | delete | URL |
*
* executes a DELETE on the URL
*/
public void delete(String resourceUrl) {
doMethod("Delete", resourceUrl, null);
}
/**
* | $var= | header | HEADER |
* | show | header | HEADER |
* | check | header | HEADER | ?value |
*
* Can extract value of a header element using a regular expression
*/
public String header(String expr) {
return applyExpressionToLastResponse("header", expr);
}
/**
* | $var= | body | BODY |
* | show | body | BODY |
* | check | body | BODY | ?value |
*
* Can extract part of the body using a xpath or regular expression
*/
public String body(String expr) {
return applyExpressionToLastResponse("body", expr);
}
/**
* | $var= | js | BODY |
* | show | js | BODY |
* | check | js | BODY | ?value |
*
* Can extract part of the body using a javascript expression
*/
public String js(String expr) {
return applyExpressionToLastResponse("js", expr);
}
/**
* |set file name |FILE|
*
* Set a file to use for a simple file post operation
*/
public void setFileName(String fileName) {
this.fileName = fileName;
}
/**
* |set multipart file name |FILE|
*
* Set a file to use for a post operation
*/
public void setMultipartFileName(String multipartFileName) {
this.multipartFileName = multipartFileName;
}
/**
* |set multipart file parameter name |FILENAME|
*
* Set a filename to use with a mutlipart file for a post operation
*/
public void setMultipartFileParameterName(String multipartFileParameterName) {
this.multipartFileParameterName = multipartFileParameterName;
}
/**
* | check | status code | ?code |
* | show | status code |
* | $var= | status code |
*
* Checks if the last url action returned a status code matching CODE. Show can
* be used to output the status code or it can be assigned to a variable
*/
public Integer statusCode() {
if (getLastResponse() == null) {
return -1;
}
return getLastResponse().getStatusCode();
}
/**
* | show | response body |
* | check | response body | ?body |
* | $var= | response body |
*
* Show the body from the last url action. Can be also used to check the contents
* but is only recommended for simple text body values
*/
public String responseBody() {
if (getLastResponse() == null) {
return null;
}
return getLastResponse().getBody();
}
/**
* | ensure | has body | ?body |
* | reject | has body | ?body |
*
* Compare the body from the last url action using a body value or
* special comparator type
*/
public boolean hasBody(String expected) throws Exception {
BodyTypeAdapter bodyTypeAdapter = createBodyTypeAdapter();
String actual = responseBody();
return equalsWithAdapter(expected, actual, bodyTypeAdapter);
}
/**
* | ensure | has body | ?body | using type | TYPE |
* | reject | has body | ?body | using type | TYPE |
*
* Compare the body from the last url action using special comparator type
* where the type application/json, text/plain or application/x-javascript
* can be forced
*/
public boolean hasBodyUsingType(String expected, String type) throws Exception {
ContentType ct = ContentType.typeFor(type);
BodyTypeAdapter bodyTypeAdapter = createBodyTypeAdapter(ct);
String actual = responseBody();
return equalsWithAdapter(expected, actual, bodyTypeAdapter);
}
/**
* Wrapper for hasHeaders
*/
public boolean hasHeaders(String expected) throws Exception {
return hasHeader(expected);
}
/**
* | ensure | has headers | ?header |
* | reject | has headers | ?header |
*
* Compare the headers from the last url action using a header value or
* special comparator type
*/
public boolean hasHeader(String expected) throws Exception {
return equalsWithAdapter(expected, getResponseHeaders(), new HeadersTypeAdapter());
}
/**
* | set body | BODY |
*
* Set the body used for a PUT or POST url action
*/
public void setBody(String text) {
requestBody = GLOBALS.substitute(text);
}
/**
* | set header | HEADER |
*
* Set the headers used for a url action
*/
public void setHeaders(String headers) {
String substitutedHeaders = GLOBALS.substitute(headers);
requestHeaders = parseHeaders(substitutedHeaders);
}
public void setHeader(String header) {
setHeaders(header);
}
private boolean equalsWithAdapter(String expected, Object actual, RestDataTypeAdapter typeAdapter) throws Exception {
typeAdapter.set(actual);
Object parse = typeAdapter.parse(expected);
return typeAdapter.equals(parse, actual);
}
private String applyExpressionToLastResponse(String type, String expr) {
LetHandler letHandler = LetHandlerFactory.getHandlerFor(type);
return GLOBALS.replaceNull(letHandler.handle(getLastResponse(), getNamespaceContext(), expr));
}
private List getResponseHeaders() {
if (getLastResponse() == null) {
return null;
}
return getLastResponse().getHeaders();
}
}