org.jboss.as.subsystem.test

Class AbstractSubsystemTest

java.lang.Object

org.jboss.as.subsystem.test.AbstractSubsystemTest

Direct Known Subclasses:

AbstractSubsystemBaseTest

public abstract class AbstractSubsystemTest
extends Object

The base class for parsing tests which does the work of setting up the environment for parsing

Author:

Kabir Khan

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mainSubsystemName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSubsystemTest(String mainSubsystemName, Extension mainExtension)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertRemoveSubsystemResources(KernelServices kernelServices) Checks that the subystem resources can be removed, i.e.
protected void	assertRemoveSubsystemResources(KernelServices kernelServices, Set<PathAddress> ignoredChildAddresses) Checks that the subystem resources can be removed, i.e.
protected static org.jboss.dmr.ModelNode	checkResultAndGetContents(org.jboss.dmr.ModelNode result) Checks that the result was successful and gets the real result contents
void	cleanup()
protected void	compare(org.jboss.dmr.ModelNode node1, org.jboss.dmr.ModelNode node2) Compares two models to make sure that they are the same
protected void	compareXml(String configId, String original, String marshalled) Validate the marshalled xml without adjusting the namespaces for the original and marshalled xml.
protected void	compareXml(String configId, String original, String marshalled, boolean ignoreNamespace) Validate the marshalled xml without adjusting the namespaces for the original and marshalled xml.
protected Extension	getMainExtension()
String	getMainSubsystemName()
protected ProcessType	getProcessType() Gets the ProcessType to use.
protected Resource	grabRootResource(KernelServices kernelServices) Grabs the current root resource
void	initializeParser()
protected KernelServices	installInController(AdditionalInitialization additionalInit, List<org.jboss.dmr.ModelNode> bootOperations) Create a new controller with the passed in operations.
protected KernelServices	installInController(AdditionalInitialization additionalInit, String subsystemXml) Initializes the controller and populates the subsystem model from the passed in xml.
protected KernelServices	installInController(List<org.jboss.dmr.ModelNode> bootOperations) Create a new controller with the passed in operations.
protected KernelServices	installInController(String subsystemXml) Initializes the controller and populates the subsystem model from the passed in xml.
protected String	normalizeXML(String xml) Normalize and pretty-print XML so that it can be compared using string compare.
protected String	outputModel(org.jboss.dmr.ModelNode model) Output the model to xml
protected List<org.jboss.dmr.ModelNode>	parse(AdditionalParsers additionalParsers, String subsystemXml) Parse the subsystem xml and create the operations that will be passed into the controller
protected List<org.jboss.dmr.ModelNode>	parse(String subsystemXml) Parse the subsystem xml and create the operations that will be passed into the controller
protected String	readResource(String name) Read the classpath resource with the given name and return its contents as a string.

Methods inherited from class java.lang.Object

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

Field Detail

mainSubsystemName

protected final String mainSubsystemName

Constructor Detail

AbstractSubsystemTest

protected AbstractSubsystemTest(String mainSubsystemName,
                     Extension mainExtension)

Method Detail

getMainSubsystemName

public String getMainSubsystemName()

initializeParser

public void initializeParser()
                      throws Exception

Throws:

Exception

cleanup

public void cleanup()
             throws Exception

Throws:

Exception

getMainExtension

protected Extension getMainExtension()

readResource

protected String readResource(String name)
                       throws IOException

Read the classpath resource with the given name and return its contents as a string. Hook to for reading in classpath resources for subsequent parsing.

Parameters:

name - the name of the resource

Returns:

the contents of the resource as a string

Throws:

IOException

parse

protected List<org.jboss.dmr.ModelNode> parse(String subsystemXml)
                                       throws XMLStreamException

Parse the subsystem xml and create the operations that will be passed into the controller

Parameters:

subsystemXml - the subsystem xml to be parsed

Returns:

the created operations

Throws:

XMLStreamException - if there is a parsing problem

parse

protected List<org.jboss.dmr.ModelNode> parse(AdditionalParsers additionalParsers,
                                  String subsystemXml)
                                       throws XMLStreamException

Parse the subsystem xml and create the operations that will be passed into the controller

Parameters:

additionalParsers - additional initialization that should be done to the parsers before initializing our extension. These parsers will only be initialized the first time this method is called from within a test

subsystemXml - the subsystem xml to be parsed

Returns:

the created operations

Throws:

XMLStreamException - if there is a parsing problem

outputModel

protected String outputModel(org.jboss.dmr.ModelNode model)
                      throws Exception

Output the model to xml

Parameters:

model - the model to marshall

Returns:

the xml

Throws:

Exception

installInController

protected KernelServices installInController(String subsystemXml)
                                      throws Exception

Initializes the controller and populates the subsystem model from the passed in xml.

Parameters:

subsystemXml - the subsystem xml to be parsed

Returns:

the kernel services allowing access to the controller and service container

Throws:

Exception

installInController

protected KernelServices installInController(AdditionalInitialization additionalInit,
                                 String subsystemXml)
                                      throws Exception

Initializes the controller and populates the subsystem model from the passed in xml.

Parameters:

additionalInit - Additional initialization that should be done to the parsers, controller and service container before initializing our extension

subsystemXml - the subsystem xml to be parsed

Returns:

the kernel services allowing access to the controller and service container

Throws:

Exception

installInController

protected KernelServices installInController(List<org.jboss.dmr.ModelNode> bootOperations)
                                      throws Exception

Create a new controller with the passed in operations.

Parameters:

bootOperations - the operations

Throws:

Exception

installInController

protected KernelServices installInController(AdditionalInitialization additionalInit,
                                 List<org.jboss.dmr.ModelNode> bootOperations)
                                      throws Exception

Create a new controller with the passed in operations.

Parameters:

additionalInit - Additional initialization that should be done to the parsers, controller and service container before initializing our extension

bootOperations - the operations

Throws:

Exception

getProcessType

protected ProcessType getProcessType()

Gets the ProcessType to use. Defaults to ProcessType.EMBEDDED_SERVER

Returns:

the process type

checkResultAndGetContents

protected static org.jboss.dmr.ModelNode checkResultAndGetContents(org.jboss.dmr.ModelNode result)

Checks that the result was successful and gets the real result contents

Parameters:

result - the result to check

Returns:

the result contents

assertRemoveSubsystemResources

protected void assertRemoveSubsystemResources(KernelServices kernelServices)

Checks that the subystem resources can be removed, i.e. that people have registered working 'remove' operations for every 'add' level.

Parameters:

kernelServices - the kernel services used to access the controller

assertRemoveSubsystemResources

protected void assertRemoveSubsystemResources(KernelServices kernelServices,
                                  Set<PathAddress> ignoredChildAddresses)

Checks that the subystem resources can be removed, i.e. that people have registered working 'remove' operations for every 'add' level.

Parameters:

kernelServices - the kernel services used to access the controller

ignoredChildAddresses - child addresses that should not be removed, they are managed by one of the parent resources. This set cannot contain the subsystem resource itself

grabRootResource

protected Resource grabRootResource(KernelServices kernelServices)

Grabs the current root resource

Parameters:

kernelServices - the kernel services used to access the controller

compare

protected void compare(org.jboss.dmr.ModelNode node1,
           org.jboss.dmr.ModelNode node2)

Compares two models to make sure that they are the same

Parameters:

node1 - the first model

node2 - the second model

Throws:

junit.framework.AssertionFailedError - if the models were not the same

normalizeXML

protected String normalizeXML(String xml)
                       throws Exception

Normalize and pretty-print XML so that it can be compared using string compare. The following code does the following: - Removes comments - Makes sure attributes are ordered consistently - Trims every element - Pretty print the document

Parameters:

xml - The XML to be normalized

Returns:

The equivalent XML, but now normalized

Throws:

Exception

compareXml

protected void compareXml(String configId,
              String original,
              String marshalled)
                   throws Exception

Validate the marshalled xml without adjusting the namespaces for the original and marshalled xml.

Parameters:

configId - the id of the xml configuration

original - the original subsystem xml

marshalled - the marshalled subsystem xml

Throws:

Exception

compareXml

protected void compareXml(String configId,
              String original,
              String marshalled,
              boolean ignoreNamespace)
                   throws Exception

Validate the marshalled xml without adjusting the namespaces for the original and marshalled xml.

Parameters:

configId - TODO

original - the original subsystem xml

marshalled - the marshalled subsystem xml

ignoreNamespace - if true the subsystem's namespace is ignored, otherwise it is taken into account when comparing the normalized xml.

Throws:

Exception