uk.ac.sheffield.vtts.ground

Class JaxRsGrounding

java.lang.Object

uk.ac.sheffield.vtts.ground.AbstractGrounding

uk.ac.sheffield.vtts.ground.JaxRsGrounding

All Implemented Interfaces:

Grounding

public class JaxRsGrounding
extends AbstractGrounding

JaxRsGrounding assumes that the tested artifact is a REST web service that was created using JAX-RS. We assume the Apache Jersey reference implementation of a JAX-RS REST service and @PathParam as the mechanism for marshalling simple input parameters, which are added to the REST URL. We expect the service to return results in the JSON format. We use the Google Gson parser to unmarshal results. We assume the REST service is offered through a root URI in the format: http://your_domain:port/display-name/url-pattern/service_class/, where display-name and url-pattern are elements used in the web.xml configuration file. This root URI must be set using the method useEndpoint(). It is also possible to specify where to place the generated Test Driver with useTargetPackage() and where to find the JAX-RS client implementation, and any other user-defined types, with useSourcePacakge for each included package. Calls against the REST service are built by extending the root URI with the name of an operation and any further input parameters, separated by a forward slash. Operations expect to be invoked using the HTTP POST method. If full testing of visited states and exercised transitions is requested, by setMetaCheck(true), the service must provide two additional methods getState() and getScenario(), which expect to be invoked using the HTTP GET method. The JAX-RS service implementation must annotate the corresponding methods with @POST and @GET, respectively. A JaxWsGrounding is supplied at creation with the PrintWriter to use for streaming the output.

Version:

Broker@Cloud 1.0

Author:

Raluca Lefticaru, Anthony J H Simons

Field Summary

Fields inherited from class uk.ac.sheffield.vtts.ground.AbstractGrounding

dependency, metaCheck, stepIndex, testIndex, writer

Constructor Summary

Constructors

Constructor and Description
JaxRsGrounding(java.io.PrintWriter stream) Creates a JaxRsGrounding writing to a stream.

Method Summary

Methods

Modifier and Type	Method and Description
void	groundTestSequence(TestSequence sequence) Translates one abstract TestSequence into a JUnit test-method.
void	groundTestStep(TestStep testStep) Translates one abstract TestStep into Java set-up and evaluation code.
void	groundTestSuite(TestSuite testSuite) Translates an abstract TestSuite into a grounded suite of tests.
void	useEndpoint(java.lang.String serviceURI) Tells this Grounding to use the given root URI as the endpoint.
protected void	writeCallMethod() Prints out an extra secret method used by the Test Driver to build the complete URI path for the REST call, make the REST call and extract the JSON String response.
protected void	writeClassComment(TestSuite testSuite) Prints out a class-level comment for the JUnit test driver class source file.
protected void	writeDriverConstructor(TestSuite testSuite) Prints out the test driver's constructor, with or without the Factory.
protected void	writeDriverFields(TestSuite testSuite) Prints out the private attributes used by the JUnit Test Driver class.
protected void	writeFailureTestStep(TestStep testStep) Prints out a method invocation expecting to throw an exception.
protected void	writeInitialTestStep(TestStep testStep) Optionally prints out an assertion check on the result of the set-up code that created the service.
protected void	writeInputList(java.util.Set<Input> inputs) Prints the list of argument value(s) for the operation inputs, in the format needed for building the URI path for the RESTful service.
protected void	writeMetaDataAssertions(TestStep testStep) Prints the JUnit assertions checking that the system executed the expected scenario in this TestStep and ended in the expected state.
protected void	writeNormalTestStep(TestStep testStep) Prints out a method invocation expecting a normal return value.
protected void	writePackageInfo(TestSuite testSuite) Prints out package information at the head of the generated JUnit test driver class source file.
protected void	writeResultVariables(java.util.Set<Output> outputs) Prints the appropriate kind of receiver variable(s) for the outputs, and initialises these to the result of decoding the JSON response.
protected void	writeStatusMethods() Prints out an extra couple of methods used to make status checks on the service.
protected void	writeSystemSetUp(TestSuite testSuite) Prints out the set-up method for creating or reseting the System-Under-Test.
protected void	writeVoidAssertion() Special assertion to check that an operation specified as returning a void result actually returned nothing useful.

Methods inherited from class uk.ac.sheffield.vtts.ground.AbstractGrounding

setMetaCheck, useSourcePackage, useTargetPackage, writeFactoryValue, writeJavaType, writeJavaValue, writeLiteralValue, writeMethodComment, writeOutputList, writeResultAssertions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JaxRsGrounding

public JaxRsGrounding(java.io.PrintWriter stream)

Creates a JaxRsGrounding writing to a stream. By default, the target package is the default (unnamed) Java package.

Parameters:

stream - the output stream.

Method Detail

groundTestSuite

public void groundTestSuite(TestSuite testSuite)

Translates an abstract TestSuite into a grounded suite of tests.

Parameters:

testSuite - the abstract TestSuite.

groundTestSequence

public void groundTestSequence(TestSequence sequence)

Translates one abstract TestSequence into a JUnit test-method. Each test-method is styled "void testN() {...}", where N is the index of the TestSequence in the TestSuite. Each method is prefixed by "@Test" and has a body consisting of set-up and evaluation test steps. Thereafter, visits each TestStep to generate the method body.

Parameters:

sequence - the high-level test sequence.

groundTestStep

public void groundTestStep(TestStep testStep)

Translates one abstract TestStep into Java set-up and evaluation code. The first TestStep in a TestSequence translates into a creation step, which instantiates the SUT. Subsequent TestSteps translate into method calls on the SUT's interface. Methods that return results store these in variables of the given types, which are named according to the names of the Outputs, in the style "outputN", where N is the index of the TestStep in the TestSequence. If a TestStep is validated, generates code to compare the actual result(s) with the expected result(s) and invokes additional methods to query the state of the metadata.

Parameters:

testStep - the high-level test step.

writeDriverFields

protected void writeDriverFields(TestSuite testSuite)

Prints out the private attributes used by the JUnit Test Driver class. These field declarations provide hooks to access the RESTful service and optionally a JavaFactory, if the TestSuite requires it.

Parameters:

testSuite - the TestSuite.

writeDriverConstructor

protected void writeDriverConstructor(TestSuite testSuite)

Prints out the test driver's constructor, with or without the Factory. If the JUnit test driver class needs the JavaFactory, adds extra creation and initialisation instructions in the constructor.

Overrides:

writeDriverConstructor in class AbstractGrounding

Parameters:

testSuite - the TestSuite.

writeSystemSetUp

protected void writeSystemSetUp(TestSuite testSuite)

Prints out the set-up method for creating or reseting the System-Under-Test. This is a @Before method that resets the RESTful client before each test method.

Parameters:

testSuite - the test suite.

writeCallMethod

protected void writeCallMethod()

Prints out an extra secret method used by the Test Driver to build the complete URI path for the REST call, make the REST call and extract the JSON String response. This simplifies the writing of individual tests.

writeStatusMethods

protected void writeStatusMethods()

Prints out an extra couple of methods used to make status checks on the service. These simplify the checking of which scenario executed and which state was reached. Does nothing if metaCheck == false.

writePackageInfo

protected void writePackageInfo(TestSuite testSuite)

Prints out package information at the head of the generated JUnit test driver class source file. If a target package was set, prints this out first; then prints the standard JUnit imports; then prints out any other Java package imports.

Parameters:

testSuite - the TestSuite.

writeClassComment

protected void writeClassComment(TestSuite testSuite)

Prints out a class-level comment for the JUnit test driver class source file. This includes the name of the test driver and the date it was created. Prints out the test conditions under which the file was generated.

Parameters:

testSuite - the TestSuite.

writeInitialTestStep

protected void writeInitialTestStep(TestStep testStep)

Optionally prints out an assertion check on the result of the set-up code that created the service. This should only be done once, if this TestStep is to be verified.

Parameters:

testStep - the TestStep.

writeNormalTestStep

protected void writeNormalTestStep(TestStep testStep)

Prints out a method invocation expecting a normal return value. If this TestStep is to be verified, prints out variables to receive the return value(s) and adds assertion checks to compare expected with actual results.

Parameters:

testStep - the TestStep to translate.

writeFailureTestStep

protected void writeFailureTestStep(TestStep testStep)

Prints out a method invocation expecting to throw an exception. If this TestStep is to be verified, inserts an automatic JUnit fail() assertion after the tested method, which causes this test to fail, if the method was executed without throwing an exception.

Overrides:

writeFailureTestStep in class AbstractGrounding

Parameters:

testStep - the TestStep.

useEndpoint

public void useEndpoint(java.lang.String serviceURI)

Tells this Grounding to use the given root URI as the endpoint.

Specified by:

useEndpoint in interface Grounding

Overrides:

useEndpoint in class AbstractGrounding

Parameters:

serviceURI - the root URI of the service.

writeInputList

protected void writeInputList(java.util.Set<Input> inputs)

Prints the list of argument value(s) for the operation inputs, in the format needed for building the URI path for the RESTful service. e.g. + param1 + "/" + param2 + "/"

Overrides:

writeInputList in class AbstractGrounding

Parameters:

inputs - the ordered set of inputs.

writeResultVariables

protected void writeResultVariables(java.util.Set<Output> outputs)

Prints the appropriate kind of receiver variable(s) for the outputs, and initialises these to the result of decoding the JSON response.

Overrides:

writeResultVariables in class AbstractGrounding

Parameters:

outputs - the ordered set of outputs.

writeVoidAssertion

protected void writeVoidAssertion()

Special assertion to check that an operation specified as returning a void result actually returned nothing useful.

Overrides:

writeVoidAssertion in class AbstractGrounding

writeMetaDataAssertions

protected void writeMetaDataAssertions(TestStep testStep)

Prints the JUnit assertions checking that the system executed the expected scenario in this TestStep and ended in the expected state.

Overrides:

writeMetaDataAssertions in class AbstractGrounding

Parameters:

testStep - the TestStep whose properties are to be asserted.