iljabauer/agileselenium

Getting Started

With the NatSpec Selenium Library you can create UI tests in natural language using NatSpec and Selenium in an easy way. If you are not familiar with NatSpec you should first read the NatSpec Getting Started. Knowledge of the Selenium library is not required.

Provider

To configure the NatSpec Selenium Library you have to create a class wich extends the AgileSeleniumProviderEN class and implements the ISyntaxPatternProvider interface. In this class all available pages of your application are registered with its components.

To create the provider class you have to import three dependencies from NatSpec:

de.devboost.natspec,
de.devboost.agileselenium.patternprovider,
de.devboost.natspec.testscripting.java

An example of this class could look like this:

package de.agileselenium.provider;

import de.devboost.agileselenium.patternprovider.AgileSeleniumProviderEN;
import de.devboost.agileselenium.patternprovider.Component;
import de.devboost.agileselenium.patternprovider.ComponentType;
import de.devboost.agileselenium.patternprovider.Page;
import de.devboost.natspec.patterns.ISyntaxPatternProvider;


public class PatternProvider extends AgileSeleniumProviderEN implements ISyntaxPatternProvider {

	public PatternProvider() {
		super("/de.agileselenium.test/", 
				
				new Page("HomeScreen", "/", 
						new Component("#password_field", "Password", ComponentType.PASSWORDFIELD),
						new Component("#username_field", "Username", ComponentType.TEXTFIELD),
						new Component("#submit", "Submit", ComponentType.BUTTON)	
				),
				
				new Page("OrderScreen", "/order", 
						new Component("#order_table", "OrderTable",ComponentType.TABLE)
						/* ... */
				)
				/* ... */
		);
	}
}

You have to implement a parameterless constructor for this class. The first argument of the super call is the qualified name of the package that contains your Selenium Tests. In this example it is "/de.agileselenium.test/". All other arguments are instances of the IPage interface which defines the registered Pages of your application. You can use the already implemented Page class:

new Page("HomeScreen", "/", 
  	new Component("#password_field", "Password", ComponentType.PASSWORDFIELD),
  	new Component("#username_field", "Username", ComponentType.TEXTFIELD),
  	new Component("#submit", "Submit", ComponentType.BUTTON)	
)

The first argument is the name of the screen which is used in your NatSpec tests, the second the url of the screen. All other arguments are instances of IComponent to specify the components that are in your page. To create a component you can use the Component class. You have to define the CSS-Selector of the component (e.g. #password_field) the name which is used in the tests (e.g. Password) and the type of the component (e.g. ComponentType.PASSWORDFIELD).

The pages and the components defined in the Provider class are used to generate the NatSpec sentences you can use in your Selenium Tests. For example you can use the Navigate to HomeScreen sentence when you have declared your HomeScreen in the provider class.

Testing with NatSpec and Selenium

After you have finished the configuration you can start writing your NatSpec tests. All you have to do is to create a _NatSpecTemplate in the same way you would create one for another NatSpec test. If you are not familiar with NatSpec you can read the NatSpec Getting Started. You can create one with the Eclipse wizard. Then you have add a field of the type SeleniumSupport to register the test support class for this template. In this example the _NatSpecTemplate could look like this:

package de.agileselenium.test;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import de.devboost.agileselenium.HtmlSeleniumSupport;
import de.devboost.agileselenium.SeleniumSupport;


@SuppressWarnings("unused")
public class _NatSpecTemplate {
	private SeleniumSupport seleniumSupport = new SeleniumSupport(new HtmlSeleniumSupport());

	@Test
	public void executeScript() throws Exception {
		/* @MethodBody */
	}

	@Before
	public void setUp() { /* ... */ }
	
	@After
	public void shutdown() { /* ... */ }
}

In this case we use new HtmlSeleniumSupport() to create the selenium support class for an HTML application. You can also use the VaadinSeleniumSupport class or create your own support class.

When you now create a new NatSpec test you should have sentences for navigating to all of your screens.

Note that all sentences are context specific. This means that you only get suggestions for components that are in your screens. Have fun writing natural language tests with Selenium and NatSpec.