Package net.officefloor.model.test.changes

Class AbstractChangesTestCase<M extends Model,O>

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

net.officefloor.frame.test.OfficeFrameTestCase

net.officefloor.model.test.changes.AbstractChangesTestCase<M,O>

All Implemented Interfaces:

junit.framework.Test

public abstract class AbstractChangesTestCase<M extends Model,O>
extends OfficeFrameTestCase

Abstract operations TestCase.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.frame.test.OfficeFrameTestCase

OfficeFrameTestCase.FailOperation, OfficeFrameTestCase.GuiTest, OfficeFrameTestCase.MultithreadedTestLogic<T extends java.lang.Throwable>, OfficeFrameTestCase.StressTest, OfficeFrameTestCase.TestCapture<T extends java.lang.Throwable>, OfficeFrameTestCase.TestLogic<R,T extends java.lang.Throwable>, OfficeFrameTestCase.UsesDockerTest, OfficeFrameTestCase.UsesGCloudTest, OfficeFrameTestCase.WaitForTruePredicate<T extends java.lang.Throwable>

Field Summary

Fields

Modifier and Type	Field	Description
protected M	model	Model loaded for testing.
protected O	operations	Operations.

Fields inherited from class net.officefloor.frame.test.OfficeFrameTestCase

CLASS_LOADER_EXTRA_CLASS_NAME, CLASS_LOADER_EXTRA_PACKAGE_NAME, classLoaderTestSupport, END_OF_LINE, fileTestSupport, logTestSupport, mockTestSupport, threadedTestSupport

Constructor Summary

Constructors

Constructor	Description
AbstractChangesTestCase()	Initiate.
AbstractChangesTestCase(boolean isSpecificSetupFilePerTest)	Initiate.

Method Summary

Modifier and Type	Method	Description
protected <T> void	assertChange(Change<T> change, T expectedTarget, java.lang.String expectedChangeDescription, boolean expectCanApply, java.lang.String... expectedConflictDescriptions)	Asserts the Change is correct.
protected void	assertChanges(Change<?>... changes)	Assets all the Change instances result in a correct change.
protected void	assertModels(M expected, M actual)	Asserts the models are the same.
protected abstract O	createModelOperations(M model)	Creates the Model operations.
protected abstract java.lang.String	getModelFileExtension()	Obtains the extension for the file containing the Model.
protected abstract M	retrieveModel(ConfigurationItem configurationItem)	Retrieves the Model.
protected void	setUp()
protected abstract void	storeModel(M model, WritableConfigurationItem configurationItem)	Stores the Model.
protected void	useTestSetupModel()	Allows particular tests of a TestCase to override using the default setup ConfigurationItem and use the specific test ConfigurationItem.
protected void	validateAsSetupModel()	Validates the Model against the Model setup for testing.
protected void	validateModel()	Validates the Model against the default Model file for the test.
protected void	validateModel(java.lang.String specific)	Validates the Model against the specific Model file for the test.

Methods inherited from class net.officefloor.frame.test.OfficeFrameTestCase

assertContents, assertContents, assertFail, assertFail, assertFail, assertGraph, assertList, assertList, assertList, assertList, assertList, assertProperties, assertTextEquals, assertXmlEquals, captureLoggerOutput, clearDirectory, copyDirectory, createFile, createMock, createNewClassLoader, createPlatformIndependentText, createSynchronizedMock, deleteDirectory, displayGraph, displayGraph, doMultiThreadedTest, doMultiThreadedTest, doTest, fail, findFile, findFile, findInputStream, getDisplayRunTime, getDisplayRunTime, getFileContents, getFileLocation, getItem, getPackageRelativePath, getProperty, isGuiAvailable, isPrintMessages, isSkipStressTests, isSkipTestsUsingDocker, isSkipTestsUsingGCloud, param, paramType, printHeapMemoryDiagnostics, printMessage, printMessage, printMessage, recordReturn, recordReturn, recordThrows, recordVoid, removeXmlWhiteSpacing, replayMockObjects, runBare, setDebugVerbose, setLogGC, setName, setVerbose, sleep, throwException, timeout, timeout, verifyMockObjects, waitForTrue, waitForTrue

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runTest, tearDown, toString

Methods inherited from class java.lang.Object

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

Field Detail

model

protected M extends Model model

Model loaded for testing.

operations

protected O operations

Operations.

Constructor Detail

AbstractChangesTestCase

public AbstractChangesTestCase()

Initiate.

AbstractChangesTestCase

public AbstractChangesTestCase(boolean isSpecificSetupFilePerTest)

Initiate.

Parameters:

isSpecificSetupFilePerTest - Flags if there is a specific setup file per test.

Method Detail

setUp

protected void setUp()
              throws java.lang.Exception

Overrides:

setUp in class junit.framework.TestCase

Throws:

java.lang.Exception

retrieveModel

protected abstract M retrieveModel(ConfigurationItem configurationItem)
                            throws java.lang.Exception

Retrieves the Model.

Parameters:

configurationItem - ConfigurationItem containing the Model.

Returns:

Model.

Throws:

java.lang.Exception - If fails to retrieve the Model.

storeModel

protected abstract void storeModel(M model,
                                   WritableConfigurationItem configurationItem)
                            throws java.lang.Exception

Stores the Model.

Parameters:

model - Model.

configurationItem - WritableConfigurationItem to store the Model.

Throws:

java.lang.Exception - If fails to store the Model.

createModelOperations

protected abstract O createModelOperations(M model)

Creates the Model operations.

Parameters:

model - Model to create operations for.

Returns:

Model operations.

getModelFileExtension

protected abstract java.lang.String getModelFileExtension()

Obtains the extension for the file containing the Model.

Returns:

Extension for the file containing the Model.

useTestSetupModel

protected void useTestSetupModel()

Allows particular tests of a TestCase to override using the default setup ConfigurationItem and use the specific test ConfigurationItem.

assertChange

protected <T> void assertChange(Change<T> change,
                                T expectedTarget,
                                java.lang.String expectedChangeDescription,
                                boolean expectCanApply,
                                java.lang.String... expectedConflictDescriptions)

Asserts the Change is correct.

Type Parameters:

T - Expected target.

Parameters:

change - Change to verify.

expectedTarget - Expected target.

expectedChangeDescription - Expected description of the Change.

expectCanApply - Expected if can apply the Change. Should it be able to be applied, both the Change.apply() and Change.revert() will be also tested.

expectedConflictDescriptions - Expected descriptions for the Conflict instances on the Change.

assertChanges

protected void assertChanges(Change<?>... changes)

Assets all the Change instances result in a correct change.

Parameters:

changes - Change instances to verify.

validateModel

protected void validateModel()

Validates the Model against the default Model file for the test.

validateModel

protected void validateModel(java.lang.String specific)

Validates the Model against the specific Model file for the test.

Parameters:

specific - Indicates the specific Model file for the test.

validateAsSetupModel

protected void validateAsSetupModel()

Validates the Model against the Model setup for testing.

This is useful to test the revert functionality of a Change.

assertModels

protected void assertModels(M expected,
                            M actual)
                     throws java.lang.Exception

Asserts the models are the same.

Parameters:

expected - Expected model.

actual - Actual model.

Throws:

java.lang.Exception - If fails.