Detailed documentation on main project site is under development.
This is a Selenium WebDriver wrapper Framework which enables robust, maintainable and easy to write test scripting. It supports latest Selenium WebDriver 4.0 (Alpha) and is ready for main Selenium upgrade.
Nobody uses anything without knowing what it offers. Some of the key features which this framework offers are as follows:
- Latest Selenium WebDriver 4.0 (Alpha 2)
- On-demand highlighting of Elements
- On-demand delay of test execution by allowing predefined delays
- On-demand headless mode
- Parallel execution of tests on different browsers
- Support Chrome, Safari, Firefox, IE and Edge
- CI / CD ready
Writing tests involves the following steps:
- π§ Config file
- π Page object
- π Page Action
- βοΈ Tests
Config file is by default searched in src/test/resources
folder. The name of the config file is by default considered as selenium-config.yaml
. But the same can be overridden by using System property coteafs.selenium.config
where you can specify the new config file for the test.
src/test/resources/selenium-config.yaml
browser: CHROME # CHROME, SAFARI, EDGE, FIREFOX, IE.
url: http://demo.guru99.com/V4/ # Application URL.
headless_mode: false # true, for headless, else false.
params: # test specific map.
user: <test-specific-user>
password: <test-specific-password>
playback: # Playback settings.
screen_state: NORMAL # FULL_SCREEN, MAXIMIZED, NORMAL
highlight: true # true, to highlight elements, else false.
screen_resolution: # Screen resolution settings.
width: 1280 # Screen width.
height: 768 # Screen height.
delays: # On demand delay settings.
implicit: 60 # Implicit waits in seconds.
explicit: 60 # Explicit waits in seconds.
before_key_press: 0 # delay before key press in milliseconds.
after_key_press: 0 # delay after key press in milliseconds.
before_mouse_move: 0 # delay before mouse move in milliseconds.
after_mouse_move: 0 # delay after mouse move in milliseconds.
before_click: 0 # delay before mouse click in milliseconds.
after_click: 0 # delay after mouse click in milliseconds.
page_load: 60 # page load timeout in seconds.
script_load: 60 # script load timeout in seconds.
highlight: 500 # highlight delay in milliseconds.
screenshot: # Screenshot settings.
path: ~/screenshots # default screenshot path.
prefix: SCR # screenshot file prefix.
extension: jpeg # screenshot file extension.
capture_on_error: false # screenshot on error.
Note: If you find any config not working, feel free to raise an issue.
To know how to write tests, it's best to see the example as it is self explanatory. Lets have a look at the Login page of Guru99 demo site.
Remember,
BrowserPage
class needs to be extended for every page and also a flavour of inheritance can be added as per requirement.
package com.github.wasiqb.coteafs.selenium.pages;
import org.openqa.selenium.By;
import com.github.wasiqb.coteafs.selenium.core.BrowserPage;
import com.github.wasiqb.coteafs.selenium.core.element.IElementActions;
import com.github.wasiqb.coteafs.selenium.core.element.IMouseActions;
import com.github.wasiqb.coteafs.selenium.core.element.ITextboxActions;
public class LoginPage extends BrowserPage {
public ITextboxActions password () {
return form ().find (By.name ("password"));
}
public IMouseActions signIn () {
return form ().find (By.name ("btnLogin"));
}
public ITextboxActions userId () {
return form ().find (By.name ("uid"));
}
private IElementActions form () {
return onElement (By.name ("frmLogin"));
}
}
This is a new concept, here you can define actions specific to each page. This approach abstracts out the page action flows and helps in modularising the classes. So whenever the flow of the page changes, you need to change only at single place.
For every page action you need to extend
AbstractPageAction
. Since it is a generic class, you need to pass the action class name as it's generic type. Also,perform
method needs to be implemented for every action class.
package com.github.wasiqb.coteafs.selenium.pages.action;
import com.github.wasiqb.coteafs.selenium.core.page.AbstractPageAction;
import com.github.wasiqb.coteafs.selenium.pages.LoginPage;
import com.github.wasiqb.coteafs.selenium.pages.MainPage;
public class LoginPageAction extends AbstractPageAction <LoginPageAction> {
@Override
public void perform () {
final LoginPage login = new LoginPage ();
login.userId ()
.enterText (value ("UserId"));
login.password ()
.enterText (value ("Password"));
login.signIn ()
.click ();
final MainPage main = new MainPage ();
main.managerIdBanner ()
.verifyText ()
.endsWith ("Manger Id : " + value ("UserId"));
}
}
Test which are written using this framework are slightly different than usual. In the tests, Page actions is used instead of page objects. This can be demonstrated as shown below:
Every test class extends
BrowserTest
class.
package com.github.wasiqb.coteafs.selenium;
import static com.github.wasiqb.coteafs.selenium.config.ConfigUtil.appSetting;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import com.github.wasiqb.coteafs.selenium.core.BrowserTest;
import com.github.wasiqb.coteafs.selenium.pages.MainPage;
import com.github.wasiqb.coteafs.selenium.pages.action.LoginPageAction;
public class SeleniumTest extends BrowserTest {
private MainPage main;
@BeforeClass
public void setupMethod () {
this.main = new MainPage ();
this.main.onDriver ()
.navigateTo (appSetting ().getUrl ());
}
@Test
public void testSignIn () {
final LoginPageAction login = new LoginPageAction ();
login.addInputValue ("UserId", appSetting ().getParams ()
.get ("user"))
.addInputValue ("Password", appSetting ().getParams ()
.get ("password"))
.perform ();
}
}
You can use the following dependency into your pom.xml
to use this library.
<dependency>
<groupId>com.github.wasiqb.coteafs</groupId>
<artifactId>selenium</artifactId>
<version>2.1.0</version>
</dependency>
Or you can add the following into your build.gradle
file.
compile "com.github.wasiqb.coteafs:selenium:2.0.0"
- Directly chat with me on my site and I'll revert to you as soon as possible.
- Discuss your queries by writing to me @ wasbhamla2005@gmail.com
- If you find any issue which is bottleneck for you, search the issue tracker to see if it is already raised.
- If not raised, then you can create a new issue with required details as mentioned in the issue template.
- Spread the word with your network.
- Star the project to make the project popular.
- Stay updated with the project progress by Watching it.
- Contribute to fix open issues, documentations or add new features. To know more, see our contributing page.
- I would be delighted if you can Sponsor this project and provide your support to open source development by clicking on the Sponsor button on the top of this repository.