Vani

Vani should help to write and maintain UI tests based on Selenium. To reach this aim, it provides an extensions for Spring-Framework, so you can write your tests in spring-style.

Vani is written in Java and can only used in conjunction with the java version of Selenium.

Features

• auto instantiating and injecting of WebElement and PageObject of annotated fields (Details)
  • supports all FindBy-annotations (Details)
  • you can also use the power of JQuery's selectors by annotating with @FindByJQuery (Details)
  • injected instances are proxied (except page and fragment objects). So locating of annotated elements will be executing during a call on it.
• introduce FragmentObject, so you can declare reusable parts or reduce complexity of PageObjects by extracting code in fragments (Details)
• all annotations supports spring placeholders (also all Selenium's @FindBy)
• declaring a startpage which is automatically opened before your test method is called (Details)
• explicit waits for making a jQuery ajax requests by @Xhr (Details)
• conditional selection of fragment implementations by @ContentCondition (Details)
• provides a page crawling mechanism which opens specific links on testing pages (Details)
• convenience interface for injecting and executing javascript source code into testing pages (Details)

Requirements

• Java 8 JDK
• Spring-Framework (current tested version: 4.2.4)
• Selenium Java (current tested version 2.52.0)

Other Dependencies

• ByteBuddy
• Reflections
• jQuery

Usage

Example for declaring a test class:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration({ "/config/test-context.xml" })
public class LoginTest{
	@Page
	@Startpage
	private HomePage homePage;
	
	@Test
	public void login() {
		homePage.login("hello","world");
	}
}

After declaring a normal Junit test class with spring, it defines a page object as startpage. So Vani will instantiate and inject an instance of HomePage and opens it in default WebDriver instance.

The test method will only call a method of the injected page object.

In your context-configuration xml (test-context.xml in the above example) you only have to import the spring default configuration xml of Vani:

<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="
            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
            http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">

	<import resource="classpath:org/markysoft/vani/spring/vani-context.xml" />
</beans>

This will setup the default configuration of Vani. So you don't have to declare all required beans manual.

At the end, we declare the page object:

import org.markysoft.vani.core.locating.PageObject;
import org.markysoft.vani.core.locating.locator.FindByJQuery;

@PageUrl("${config.blogUrl}")
public class HomePage extends PageObject{
	@FindByJQuery("${content.jq.login.username}")
	private JQueryElement inputUsername;
	@FindByJQuery("${content.jq.login.password}")
	private JQueryElement inputPassword;
	@FindByJQuery("${content.jq.loginLink}")
	private JQueryElement loginLink;
	
	public void login(String username,String password) {
		inputUsername.sendKeys(username);
		inputPassword.sendKeys(password);
		loginLink.click();
		
		//this will mark current page object as invalid, so all cached elements will be relocated during next access
		this.invalidate();
	}
}

The @PageUrl annotation will be used to declare the url of the page object. It's important that you extends your PageObject-classes from the Vani's PageObject and not from the Selenium's one. At the next lines, we declare the required fields by jquery selectors.

The method will set the specified values of located input fields and click the login link. The locating of each JQueryElement will be executed during access on its wrapped html element. This provide you the possibility, to get an instance of your page object although its desired html elements are still unavailable. Finally, the current instance will be marked as invalid, so all cached elements are relocated at the next access. This is useful if you use @ContentCondition for selecting specific fragment implemenation.

LICENSE

MIT License

Copyright (c) 2016 markysoft1

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.