org.rhq.core.plugin.testutil

Class AbstractAgentPluginTest

java.lang.Object

org.jboss.arquillian.testng.Arquillian

org.rhq.core.plugin.testutil.AbstractAgentPluginTest

All Implemented Interfaces:

org.testng.IHookable, org.testng.ITestNGListener

public abstract class AbstractAgentPluginTest
extends org.jboss.arquillian.testng.Arquillian

The base class for an Agent plugin integration test class.

Author:

Ian Springer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.rhq.core.pc.PluginContainer	pluginContainer
protected org.rhq.core.pc.PluginContainerConfiguration	pluginContainerConfiguration
protected org.rhq.test.arquillian.MockingServerServices	serverServices

Fields inherited from class org.jboss.arquillian.testng.Arquillian

ARQUILLIAN_DATA_PROVIDER

Constructor Summary

Constructors

Constructor and Description
AbstractAgentPluginTest()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertOperationSucceeded(String operationName, org.rhq.core.domain.configuration.Configuration params, org.rhq.core.pluginapi.operation.OperationResult result)
protected org.rhq.core.domain.measurement.MeasurementReport	collectMetric(org.rhq.core.domain.resource.Resource resource, String metricName) Collect a metric for a Resource synchronously, with a 7 second timeout.
protected String	collectTrait(org.rhq.core.domain.resource.Resource resource, String traitName)
protected void	executeNoArgOperations(org.rhq.core.domain.resource.Resource rootResource, List<String> ignoredResources, List<String> ignoredOperations) Test that executes all the no arg operations for all the subresources of a provided resource.
protected org.rhq.core.domain.measurement.AvailabilityType	getAvailability(org.rhq.core.domain.resource.Resource resource) Get availability for a Resource synchronously, with a 5 second timeout.
protected static org.rhq.test.shrinkwrap.RhqAgentPluginArchive	getPlatformPlugin()
protected static File	getPluginJarFile()
protected abstract String	getPluginName()
protected static org.rhq.test.shrinkwrap.RhqAgentPluginArchive	getPluginUnderTest()
protected static int	getResCount(org.rhq.core.domain.resource.Resource resource)
protected org.rhq.core.domain.resource.Resource	getResourceByTypeAndKey(org.rhq.core.domain.resource.Resource parent, org.rhq.core.domain.resource.ResourceType type, String key, boolean isCommitted)
protected org.rhq.test.arquillian.FakeServerInventory	getServerInventory()
protected void	injectMocks(org.rhq.test.arquillian.MockingServerServices serverServices) Superclass can override this to add additional mocked services to those already defined in this abstract base class.
protected org.rhq.core.pluginapi.operation.OperationResult	invokeOperation(org.rhq.core.domain.resource.Resource resource, String operationName, org.rhq.core.domain.configuration.Configuration params) Execute an operation on a Resource synchronously, with the same timeout that the PC would use.
protected org.rhq.core.pluginapi.operation.OperationResult	invokeOperationAndAssertSuccess(org.rhq.core.domain.resource.Resource resource, String operationName, org.rhq.core.domain.configuration.Configuration params)
protected org.rhq.core.domain.configuration.Configuration	loadResourceConfiguration(org.rhq.core.domain.resource.Resource resource)
protected int	loadUpdateConfigChildResources(org.rhq.core.domain.resource.Resource rootResource, List<String> ignoredResources) Test that loads a resource configuration and then immediately updates the resource with the exact same loaded settings.
protected void	resetServerServices() Set up our fake server discovery ServerService, which will auto-import all Resources in reports it receives.
protected org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport	updateResourceConfiguration(org.rhq.core.domain.resource.Resource resource, org.rhq.core.domain.configuration.Configuration resourceConfig)
protected void	waitForAsyncDiscoveryToStabilize(org.rhq.core.domain.resource.Resource root) This waits until the discovered tree size stabilizes.
protected void	waitForAsyncDiscoveryToStabilize(org.rhq.core.domain.resource.Resource root, long checkInterval, int stableCount) This waits until the discovered tree size stabilizes.
protected org.rhq.core.domain.resource.Resource	waitForResourceByTypeAndKey(org.rhq.core.domain.resource.Resource platform, org.rhq.core.domain.resource.Resource parent, org.rhq.core.domain.resource.ResourceType type, String key) Convenience, same as calling {{waitForResourceByTypeAndKey(platform, parent, type, key, 600)}}.
protected org.rhq.core.domain.resource.Resource	waitForResourceByTypeAndKey(org.rhq.core.domain.resource.Resource platform, org.rhq.core.domain.resource.Resource parent, org.rhq.core.domain.resource.ResourceType type, String key, int timeoutInSeconds) A method that looks for a child resource, given the parent, and will wait for the resource to show up (and be committed) under the parent if it isn't there already - on the assumption that discovery is still taking place.

Methods inherited from class org.jboss.arquillian.testng.Arquillian

arquillianAfterClass, arquillianAfterSuite, arquillianAfterTest, arquillianArgumentProvider, arquillianBeforeClass, arquillianBeforeSuite, arquillianBeforeTest, run

Methods inherited from class java.lang.Object

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

Field Detail

serverServices

@ArquillianResource
protected org.rhq.test.arquillian.MockingServerServices serverServices

pluginContainerConfiguration

@ArquillianResource
protected org.rhq.core.pc.PluginContainerConfiguration pluginContainerConfiguration

pluginContainer

@ArquillianResource
protected org.rhq.core.pc.PluginContainer pluginContainer

Constructor Detail

AbstractAgentPluginTest

public AbstractAgentPluginTest()

Method Detail

getPlatformPlugin

@Deployment(name="platform",
            order=1)
protected static org.rhq.test.shrinkwrap.RhqAgentPluginArchive getPlatformPlugin()
                                                                          throws Exception

Throws:

Exception

getPluginUnderTest

@Deployment(name="pluginUnderTest",
            order=2)
protected static org.rhq.test.shrinkwrap.RhqAgentPluginArchive getPluginUnderTest()
                                                                           throws Exception

Throws:

Exception

getPluginJarFile

protected static File getPluginJarFile()

injectMocks

protected void injectMocks(org.rhq.test.arquillian.MockingServerServices serverServices)

Superclass can override this to add additional mocked services to those already defined in this abstract base class. The base class will call for injection each time the mocks are reset.

Parameters:

serverServices -

resetServerServices

protected void resetServerServices()
                            throws Exception

Set up our fake server discovery ServerService, which will auto-import all Resources in reports it receives.

Throws:

Exception - if an error occurs

waitForAsyncDiscoveryToStabilize

protected void waitForAsyncDiscoveryToStabilize(org.rhq.core.domain.resource.Resource root)

This waits until the discovered tree size stabilizes.

This is equivalent to {{waitForAsyncDiscoveryToStabilize(root, 5000L, 7)}}. As such it will wait for at least 35s.

waitForAsyncDiscoveryToStabilize

protected void waitForAsyncDiscoveryToStabilize(org.rhq.core.domain.resource.Resource root,
                                    long checkInterval,
                                    int stableCount)

This waits until the discovered tree size stabilizes.

Parameters:

root -

checkInterval - how long between checks of the tree size

stableCount - how many checks must be the same before we're convinced we're stable

getResCount

protected static int getResCount(org.rhq.core.domain.resource.Resource resource)

waitForResourceByTypeAndKey

protected org.rhq.core.domain.resource.Resource waitForResourceByTypeAndKey(org.rhq.core.domain.resource.Resource platform,
                                                                org.rhq.core.domain.resource.Resource parent,
                                                                org.rhq.core.domain.resource.ResourceType type,
                                                                String key)

Convenience, same as calling {{waitForResourceByTypeAndKey(platform, parent, type, key, 600)}}.

See Also:

waitForResourceByTypeAndKey(Resource, Resource, ResourceType, String, int)

waitForResourceByTypeAndKey

protected org.rhq.core.domain.resource.Resource waitForResourceByTypeAndKey(org.rhq.core.domain.resource.Resource platform,
                                                                org.rhq.core.domain.resource.Resource parent,
                                                                org.rhq.core.domain.resource.ResourceType type,
                                                                String key,
                                                                int timeoutInSeconds)

A method that looks for a child resource, given the parent, and will wait for the resource to show up (and be committed) under the parent if it isn't there already - on the assumption that discovery is still taking place. If the resource still does not show up after the timeout period, an assertion failure is generated.

Parameters:

parent -

type -

key -

timeoutInSeconds - minimum timeout is 10s.

Returns:

getResourceByTypeAndKey

protected org.rhq.core.domain.resource.Resource getResourceByTypeAndKey(org.rhq.core.domain.resource.Resource parent,
                                                            org.rhq.core.domain.resource.ResourceType type,
                                                            String key,
                                                            boolean isCommitted)

getAvailability

@NotNull
protected org.rhq.core.domain.measurement.AvailabilityType getAvailability(org.rhq.core.domain.resource.Resource resource)
                                                                    throws org.rhq.core.clientapi.agent.PluginContainerException

Get availability for a Resource synchronously, with a 5 second timeout.

Parameters:

resource - the Resource

Returns:

the report containing the collected data

Throws:

org.rhq.core.clientapi.agent.PluginContainerException

invokeOperation

@NotNull
protected org.rhq.core.pluginapi.operation.OperationResult invokeOperation(org.rhq.core.domain.resource.Resource resource,
                                                                       String operationName,
                                                                       @Nullable
                                                                       org.rhq.core.domain.configuration.Configuration params)
                                                                    throws org.rhq.core.clientapi.agent.PluginContainerException

Execute an operation on a Resource synchronously, with the same timeout that the PC would use.

Parameters:

resource - the Resource

operationName - the name of the operation

params - parameters to pass to the operation; may be null if the operation does not define any parameters

Returns:

the result of the operation

Throws:

org.rhq.core.clientapi.agent.PluginContainerException

loadResourceConfiguration

@NotNull
protected org.rhq.core.domain.configuration.Configuration loadResourceConfiguration(org.rhq.core.domain.resource.Resource resource)
                                                                             throws Exception

Throws:

Exception

updateResourceConfiguration

@NotNull
protected org.rhq.core.pluginapi.configuration.ConfigurationUpdateReport updateResourceConfiguration(org.rhq.core.domain.resource.Resource resource,
                                                                                                 org.rhq.core.domain.configuration.Configuration resourceConfig)
                                                                                              throws Exception

Throws:

Exception

invokeOperationAndAssertSuccess

protected org.rhq.core.pluginapi.operation.OperationResult invokeOperationAndAssertSuccess(org.rhq.core.domain.resource.Resource resource,
                                                                               String operationName,
                                                                               @Nullable
                                                                               org.rhq.core.domain.configuration.Configuration params)
                                                                                    throws org.rhq.core.clientapi.agent.PluginContainerException

Throws:

org.rhq.core.clientapi.agent.PluginContainerException

assertOperationSucceeded

protected void assertOperationSucceeded(String operationName,
                            org.rhq.core.domain.configuration.Configuration params,
                            org.rhq.core.pluginapi.operation.OperationResult result)

getPluginName

protected abstract String getPluginName()

getServerInventory

protected org.rhq.test.arquillian.FakeServerInventory getServerInventory()

loadUpdateConfigChildResources

protected int loadUpdateConfigChildResources(org.rhq.core.domain.resource.Resource rootResource,
                                 List<String> ignoredResources)
                                      throws InterruptedException,
                                             org.rhq.core.clientapi.agent.PluginContainerException

Test that loads a resource configuration and then immediately updates the resource with the exact same loaded settings. Notes: 1) load/update is not executed on the root resource provided. 2) if a resource is ignored then all of subresource of that resources are ignored

Parameters:

rootResource - root resource

ignoredResources - resources to be ignored

Returns:

number of errors

Throws:

InterruptedException

org.rhq.core.clientapi.agent.PluginContainerException

executeNoArgOperations

protected void executeNoArgOperations(org.rhq.core.domain.resource.Resource rootResource,
                          List<String> ignoredResources,
                          List<String> ignoredOperations)
                               throws org.rhq.core.clientapi.agent.PluginContainerException

Test that executes all the no arg operations for all the subresources of a provided resource. Notes: 1) no operations are executed on the root resource provided. 2) if a resource is ignored then all of subresource of that resources are ignored

Parameters:

rootResource - root resource

ignoredResources - resources to be ignored

ignoredOperations - operations to be ignored

Throws:

org.rhq.core.clientapi.agent.PluginContainerException

collectTrait

@Nullable
protected String collectTrait(org.rhq.core.domain.resource.Resource resource,
                           String traitName)
                       throws Exception

Throws:

Exception

collectMetric

@NotNull
protected org.rhq.core.domain.measurement.MeasurementReport collectMetric(org.rhq.core.domain.resource.Resource resource,
                                                                      String metricName)
                                                                   throws Exception

Collect a metric for a Resource synchronously, with a 7 second timeout.

Parameters:

resource - the Resource

metricName - the name of the metric

Returns:

the report containing the collected data

Throws:

Exception