org.jboss.arquillian.drone.spi

Interface DroneConfiguration<C extends DroneConfiguration<C>>

Type Parameters:

C - Configuration type

public interface DroneConfiguration<C extends DroneConfiguration<C>>

Configuration of arbitrary drone web UI test framework. It allows to get configured from both Arquillian Descriptor and System properties which takes precedence.

A matching extension in the descriptor with is searched by using configuration name. If org.jboss.arquillian.drone.spi.Qualifier extension differs from Default, it is used to get the configuration if it exists, otherwise the default one is used.

See following example which explains the mapping

If configuration is named ajocado, then <extension qualifier="selenium"> is looked in the descriptor file and properties are mapped to configuration values. Then System properties with prefix arquillian.ajocado.* are mapped to the configuration values, possibly overriding values provided within descriptor file.

    <extension qualifier="ajocado">
    <configuration>
       <property name="seleniumPort">5000</property>
    </configuration>
    </extension>
 

A system property is passed as -Darquillian.ajocado.selenium.port=6000

Then configuration will read descriptor and set value 5000 for port which becomes later overridden by value 6000 passed from the command line.

For more complex example, see following rules are applied to compute qualifier value, system property prefix and property name:

• qualifier = {@code WebTestConfiguration#getConfigurationName() + - + @Qualifier, where all letters are lower case
• System property prefix = arquillian. + {@code WebTestConfiguration#getConfigurationName() + ., where all configuration name is converted to lower case characters and or non-letter characters are replaced with a dot (.)
• property names for descriptors = fields (getters) are not modified
• property names for System properties = fields (getters) of configuration are converted from camel case to replacing every upper case latter with a dot (.) and lower case equivalent

Author:

Method Summary

Methods

Modifier and Type	Method and Description
C	configure(org.jboss.arquillian.config.descriptor.api.ArquillianDescriptor descriptor, Class<? extends Annotation> qualifier) Configures configuration from descriptor and System properties
String	getConfigurationName() Returns the name of the configuration.

Method Detail

getConfigurationName

String getConfigurationName()

Returns the name of the configuration.

Returns:

Name of the configuration

configure

C configure(org.jboss.arquillian.config.descriptor.api.ArquillianDescriptor descriptor,
          Class<? extends Annotation> qualifier)

Configures configuration from descriptor and System properties

Parameters:

descriptor - Arquillian Descriptor

qualifier - Qualifier

Returns:

Configured configuration instance