org.cornutum.tcases.openapi.testwriter

Class TestWriter<S extends TestSource,T extends TestTarget>

java.lang.Object

org.cornutum.tcases.openapi.testwriter.TestWriter<S,T>

Direct Known Subclasses:

JavaTestWriter

public abstract class TestWriter<S extends TestSource,T extends TestTarget>
extends Object

Writes the source code for a test that executes API requests.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TestWriter(TestCaseWriter testCaseWriter) Creates a new TestWriter instance.

Method Summary

Modifier and Type	Method and Description
protected File	getTargetFile(T target, String testName) Returns the target file defined by the given target.
protected String	getTestBaseName(S source, T target) Returns the base test name defined by the given source and target.
protected TestCaseWriter	getTestCaseWriter() Returns the TestCaseWriter for this test.
File	getTestFile(S source, T target) Returns the test file written for the given source and target.
String	getTestName(S source, T target) Returns the test name derived from the given source and target.
protected abstract String	getTestName(String baseName) Returns the test name derived from the given base name.
protected File	getTestResourceDir(File targetFile, File resourceDir) Returns the resource directory derived from the given target file and resource directory options.
File	getTestResourceDir(S source, T target) Returns the resource directory derived from the given source and target
protected URI	getTestServer(RequestCase requestCase) Returns a URI for the API server used by the given test case.
protected void	prepareTestCases(List<RequestCase> requestCases) Prepare this writer to handle the given request cases.
String	toString()
protected abstract void	writeClosing(T target, String testName, IndentedWriter targetWriter) Writes the target test closing to the given stream.
protected abstract void	writeDeclarations(T target, String testName, IndentedWriter targetWriter) Writes the target test declarations to the given stream.
protected abstract void	writeDependencies(T target, String testName, IndentedWriter targetWriter) Writes the target test dependencies to the given stream.
protected void	writeEpilog(T target, String testName, IndentedWriter targetWriter) Writes the target test epilog to the given stream.
protected abstract void	writeOpening(T target, String testName, IndentedWriter targetWriter) Writes the target test opening to the given stream.
protected void	writeProlog(T target, String testName, IndentedWriter targetWriter) Writes the target test prolog to the given stream.
protected void	writeResponsesDef(ResponsesDef responses, File targetFile, File resourceDir) Writes the given responses definitions to a resource file associated with the test target file.
void	writeTest(S source, T target) Creates a test that executes the request test cases defined by the given source and writes the result to the given target.
protected void	writeTestCase(T target, String testName, RequestCase requestCase, IndentedWriter targetWriter) Writes a target test case to the given stream.
protected void	writeTestCases(T target, String testName, List<RequestCase> requestCases, IndentedWriter targetWriter) Writes the target test cases to the given stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestWriter

protected TestWriter(TestCaseWriter testCaseWriter)

Creates a new TestWriter instance.

Method Detail

writeTest

public void writeTest(S source,
                      T target)

Creates a test that executes the request test cases defined by the given source and writes the result to the given target.

getTestFile

public File getTestFile(S source,
                        T target)

Returns the test file written for the given source and target. Returns null if the test is written to a stream.

getTestName

public String getTestName(S source,
                          T target)

Returns the test name derived from the given source and target.

getTestName

protected abstract String getTestName(String baseName)

Returns the test name derived from the given base name.

getTestBaseName

protected String getTestBaseName(S source,
                                 T target)

Returns the base test name defined by the given source and target.

getTestResourceDir

public File getTestResourceDir(S source,
                               T target)

Returns the resource directory derived from the given source and target

getTestResourceDir

protected File getTestResourceDir(File targetFile,
                                  File resourceDir)

Returns the resource directory derived from the given target file and resource directory options.

getTargetFile

protected File getTargetFile(T target,
                             String testName)

Returns the target file defined by the given target.

prepareTestCases

protected void prepareTestCases(List<RequestCase> requestCases)

Prepare this writer to handle the given request cases.

writeProlog

protected void writeProlog(T target,
                           String testName,
                           IndentedWriter targetWriter)

Writes the target test prolog to the given stream.

writeOpening

protected abstract void writeOpening(T target,
                                     String testName,
                                     IndentedWriter targetWriter)

Writes the target test opening to the given stream.

writeDependencies

protected abstract void writeDependencies(T target,
                                          String testName,
                                          IndentedWriter targetWriter)

Writes the target test dependencies to the given stream.

writeDeclarations

protected abstract void writeDeclarations(T target,
                                          String testName,
                                          IndentedWriter targetWriter)

Writes the target test declarations to the given stream.

writeTestCases

protected void writeTestCases(T target,
                              String testName,
                              List<RequestCase> requestCases,
                              IndentedWriter targetWriter)

Writes the target test cases to the given stream.

writeTestCase

protected void writeTestCase(T target,
                             String testName,
                             RequestCase requestCase,
                             IndentedWriter targetWriter)

Writes a target test case to the given stream.

writeEpilog

protected void writeEpilog(T target,
                           String testName,
                           IndentedWriter targetWriter)

Writes the target test epilog to the given stream.

writeClosing

protected abstract void writeClosing(T target,
                                     String testName,
                                     IndentedWriter targetWriter)

Writes the target test closing to the given stream.

writeResponsesDef

protected void writeResponsesDef(ResponsesDef responses,
                                 File targetFile,
                                 File resourceDir)

Writes the given responses definitions to a resource file associated with the test target file.

getTestCaseWriter

protected TestCaseWriter getTestCaseWriter()

Returns the TestCaseWriter for this test.

getTestServer

protected URI getTestServer(RequestCase requestCase)

Returns a URI for the API server used by the given test case. If non-null, this supersedes the server URI defined by this request case.

toString

public String toString()

Overrides:

toString in class Object