AbstractGrounding

java.lang.Object
- uk.ac.sheffield.vtts.ground.AbstractGrounding

All Implemented Interfaces:

Grounding

Direct Known Subclasses:

JavaGrounding, JaxRsGrounding, JaxWsGrounding
```
public abstract class AbstractGrounding
extends java.lang.Object
implements Grounding
```
AbstractGrounding is the common ancestor of JUnit-based code generators. AbstractGrounding is the ancestor of JavaGrounding, JaxWsGrounding, JaxRsGrounding and other JUnit-based code generators. It provides the default implementation of many of the Java code-generation routines that are shared by subclasses. It is possible to set the name of the target package (for the generated Test Driver class) and the names of one or more source packages (for the service resources, including the class denoting the Service-Under-Test). It is possible to request full checking of all visited states and exercised transitions (meta-data used during test-mode) so long as the implemented service offers the additional inspection methods getState() and getScenario().

Version:

Broker@Cloud 1.0

Author:

Anthony J H Simons

Field Summary

Fields
Modifier and Type	Field and Description
`protected JavaDependency`	`dependency` Records package dependencies submitted by the end-user, so that the standard JavaFactory can create instances of these types.
`protected boolean`	`metaCheck` Boolean flag indicating whether to check full meta-information for triggered operation scenarios and reached states.
`protected int`	`stepIndex` The counter for TestSteps.
`protected int`	`testIndex` The counter for TestSequences.
`protected java.io.PrintWriter`	`writer` The output stream to which this Grounding writes generated code.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractGrounding(java.io.PrintWriter stream)
Creates an AbstractGrounding writing to a stream.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractGrounding(java.io.PrintWriter stream)` Creates an AbstractGrounding writing to a stream.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`setMetaCheck(boolean value)` Sets whether to generate full checks for service meta-data, such as the name of the last triggered scenario, or the last reached state.
`void`	`useEndpoint(java.lang.String serviceURI)` Tells this Grounding to use the given root URI as the endpoint for the service (optional).
`void`	`useSourcePackage(java.lang.String packageInfo)` Sets the name of the source Java package for the System-Under-Test.
`void`	`useTargetPackage(java.lang.String packageInfo)` Sets the name of the target Java package for the JUnit Test Driver.
`protected void`	`writeDriverConstructor(TestSuite testSuite)` Prints out the test driver's constructor, with or without the Factory.
`protected void`	`writeFactoryValue(Parameter parameter)` Prints out a factory expression to create the value of a complex Input or Output parameter.
`protected void`	`writeFailureTestStep(TestStep testStep)` Prints out a method invocation expecting to throw an exception.
`protected void`	`writeInputList(java.util.Set<Input> inputs)` Prints the list of argument value(s) for the operation inputs.
`protected void`	`writeJavaType(Parameter parameter)` Prints the type name of a Parameter as a Java type.
`protected void`	`writeJavaValue(Parameter parameter)` Grounds the value of an Input or Output parameter.
`protected void`	`writeLiteralValue(Parameter parameter)` Prints out the literal value of a simple Input or Output parameter.
`protected void`	`writeMetaDataAssertions(TestStep testStep)` Prints the JUnit assertions checking that the system executed the expected scenario and ended in the expected state.
`protected void`	`writeMethodComment(TestSequence sequence)` Prints out a method-level comment for one test-method of the JUnit driver class source file.
`protected void`	`writeOutputList(java.util.Set<Output> outputs)` Prints the initialisation list of literalTypes values for complex outputs.
`protected void`	`writeResultAssertions(java.util.Set<Output> outputs)` Prints the JUnit assertion(s) checking that the expected and actual result(s) corresponded.
`protected void`	`writeResultVariables(java.util.Set<Output> outputs)` Prints the appropriate kind of receiver variable(s) for the outputs.
`protected void`	`writeVoidAssertion()` Placeholder method for subclasses to override if they must check that the result from a call was void.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.ac.sheffield.vtts.ground.Grounding
groundTestSequence, groundTestStep, groundTestSuite

- Field Detail
  - dependency
```
protected JavaDependency dependency
```
    Records package dependencies submitted by the end-user, so that the standard JavaFactory can create instances of these types.
  - writer
```
protected java.io.PrintWriter writer
```
    The output stream to which this Grounding writes generated code. This is supplied at creation of this AbstractGrounding.
  - metaCheck
```
protected boolean metaCheck
```
    Boolean flag indicating whether to check full meta-information for triggered operation scenarios and reached states.
  - testIndex
```
protected int testIndex
```
    The counter for TestSequences. Starts with 1, for the first test.
  - stepIndex
```
protected int stepIndex
```
    The counter for TestSteps. Starts with step 0, for system creation.
- Constructor Detail
  - AbstractGrounding
```
protected AbstractGrounding(java.io.PrintWriter stream)
```
    Creates an AbstractGrounding writing to a stream. By default, the target package is the default (unnamed) Java package.
    
    Parameters:
    stream - the output stream.
- Method Detail
  - useTargetPackage
```
public void useTargetPackage(java.lang.String packageInfo)
```
    Sets the name of the target Java package for the JUnit Test Driver.
    
    Specified by:
    
    useTargetPackage in interface Grounding
    
    Parameters:
    packageInfo - the Test Driver package name.
  - useSourcePackage
```
public void useSourcePackage(java.lang.String packageInfo)
```
    Sets the name of the source Java package for the System-Under-Test.
    
    Specified by:
    
    useSourcePackage in interface Grounding
    
    Parameters:
    packageInfo - the Service package name.
  - useEndpoint
```
public void useEndpoint(java.lang.String serviceURI)
```
    Tells this Grounding to use the given root URI as the endpoint for the service (optional). This is a null operation, overridden in subclasses that need to accept an endpoint.
    
    Specified by:
    
    useEndpoint in interface Grounding
    
    Parameters:
    serviceURI - the root URI of the service.
  - setMetaCheck
```
public void setMetaCheck(boolean value)
```
    Sets whether to generate full checks for service meta-data, such as the name of the last triggered scenario, or the last reached state.
    
    Specified by:
    
    setMetaCheck in interface Grounding
    
    Parameters:
    value - true, to enable full checks of service meta-data; false to disable such checks for services that do not reveal this meta-data.
  - 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.
    
    Parameters:
    testSuite - the TestSuite.
  - writeMethodComment
```
protected void writeMethodComment(TestSequence sequence)
```
    Prints out a method-level comment for one test-method of the JUnit driver class source file.
    
    Parameters:
    sequence - the TestSequence
  - 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.
    
    Parameters:
    testStep - the TestStep.
  - writeResultVariables
```
protected void writeResultVariables(java.util.Set<Output> outputs)
```
    Prints the appropriate kind of receiver variable(s) for the outputs.
    
    Parameters:
    outputs - the ordered set of outputs.
  - writeInputList
```
protected void writeInputList(java.util.Set<Input> inputs)
```
    Prints the list of argument value(s) for the operation inputs.
    
    Parameters:
    inputs - the ordered set of inputs.
  - writeOutputList
```
protected void writeOutputList(java.util.Set<Output> outputs)
```
    Prints the initialisation list of literalTypes values for complex outputs.
    
    Parameters:
    outputs - the ordered set of outputs.
  - writeJavaType
```
protected void writeJavaType(Parameter parameter)
```
    Prints the type name of a Parameter as a Java type.
    
    Parameters:
    parameter - any Input or Output parameter.
  - writeJavaValue
```
protected void writeJavaValue(Parameter parameter)
```
    Grounds the value of an Input or Output parameter. If the value is of some basic or literal Java type, prints out its literal value; otherwise prints out a factory expression to create the value.
    
    Parameters:
    parameter - any Input or Output parameter.
  - writeLiteralValue
```
protected void writeLiteralValue(Parameter parameter)
```
    Prints out the literal value of a simple Input or Output parameter.
    
    Parameters:
    parameter - any simple Input or Output parameter.
  - writeFactoryValue
```
protected void writeFactoryValue(Parameter parameter)
```
    Prints out a factory expression to create the value of a complex Input or Output parameter.
    
    Parameters:
    parameter - any complex Input or Output parameter.
  - writeResultAssertions
```
protected void writeResultAssertions(java.util.Set<Output> outputs)
```
    Prints the JUnit assertion(s) checking that the expected and actual result(s) corresponded. In some groundings, we can also check that a void result was returned for an operation with no result specified.
    
    Parameters:
    outputs - the expected set of outputs.
  - writeVoidAssertion
```
protected void writeVoidAssertion()
```
    Placeholder method for subclasses to override if they must check that the result from a call was void. Services should not reveal any information. But the POJO grounding cannot do anything here.
  - writeMetaDataAssertions
```
protected void writeMetaDataAssertions(TestStep testStep)
```
    Prints the JUnit assertions checking that the system executed the expected scenario and ended in the expected state.
    
    Parameters:
    testStep - the TestStep to be asserted.

Class AbstractGrounding

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface uk.ac.sheffield.vtts.ground.Grounding

Field Detail

dependency

writer

metaCheck

testIndex

stepIndex

Constructor Detail

AbstractGrounding

Method Detail

useTargetPackage

useSourcePackage

useEndpoint

setMetaCheck

writeDriverConstructor

writeMethodComment

writeFailureTestStep

writeResultVariables

writeInputList

writeOutputList

writeJavaType

writeJavaValue

writeLiteralValue

writeFactoryValue

writeResultAssertions

writeVoidAssertion

writeMetaDataAssertions