White_SeleniumFramework

A Selenium Framework that will help to execute tests and functions faster and reduce the effort to access many sections Selenium related.

What is this repository for?

• Quick summary.

The framework will help you structure your classes and give you some EXTRA tools to automate your scenarios faster. For example instead of doing this to click on the first element:

List<WebElement> divSimulatesButtons=webDriver.findElements(By.xpath("//*[text() = '"+text+"']"));
if(divSimulatesButtons !=null && divSimulatesButtons.size()>0){
	WebElement firstButton=divSimulatesButtons.get(0);
	firstButton.click();
}else{
	throw new RuntimeException("Button not found");
}

You can instead do :

util.clickText(text);

and will perform the same action.

The framework will force the structure of your classes to be ordered and encourage the use of its utility, but you can still use WebDriver methods by taking it from the util.

WebDriver webDriver=util.driver;

The framework will also take care of the entire configuration of the Drivers, you just need to specify what supported WebExplorers do you want to run your scenarios on.

• Version: 2.2.1

  This is still in development and some methods are being constantly added as they are used. Please help us by requesting those you need or need more detailed documentation.

How do I get set up?

• Summary of set up.

look for the library on maven (" White_SeleniumFramework") and import the library into your project by including it in your POM.

	<!-- https://jitpack.io/#WhiteOrganization/White_SeleniumFramework -->
	<dependency>
    		<groupId>io.github.whiteorganization</groupId>
    		<artifactId>white-selenium-framework</artifactId>
    		<version>2.2.1</version>
	</dependency>

If used on a long-term heavy-use project we recommend:

<dependencies>
	...
	
	<!--region White_SeleniumFramework + bonigarcia-webdriver-->
        <!-- https://mvnrepository.com/artifact/com.github.white-sdev/White_SeleniumFramework -->
        <dependency>
            <groupId>io.github.whiteorganization</groupId>
            <artifactId>white-selenium-framework</artifactId>
            <version>2.2.1</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.github.bonigarcia/webdrivermanager -->
        <dependency>
            <groupId>io.github.bonigarcia</groupId>
            <artifactId>webdrivermanager</artifactId>
            <version>RELEASE</version>
        </dependency>
        <!--endregion White_SeleniumFramework + bonigarcia-webdriver-->
	
	...
</dependencies>

if you are pulling the artifact from Jitpack, specify the repositories:

	<repositories>
	...
	
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	
	...
	</repositories>

and import the dependency like this:

	<!-- https://jitpack.io/#WhiteOrganization/White_SeleniumFramework/ -->
	<dependency>
	    <groupId>com.github.WhiteOrganization</groupId>
	    <artifactId>White_SeleniumFramework</artifactId>
	    <version>white-selenium-framework-2.2.1</version>
	</dependency>

Alternatively you can manually import the .jar file into your project.

• Configuration.

Define your test cases or scenario classes by implementing TestCase in classes extending from TestCase

public class LoginApp implements AutomationScenario{
	//...
}

To run the scenarios you need to register your TestCases under TestSuite and then run them any time you need.

	AutomationSuite.registerAutomationScenario(new LoginApp());
	AutomationSuite.registerAutomationScenario(new MyTestCase());
	AutomationSuite.launchExecutions();

Some useful configuration you can establish on your project context [src/main/resources/application.properties on maven projects]

white-selenium-framework.execute.web-driver.chrome=true
white-selenium-framework.execute.web-driver.ie=true
white-selenium-framework.execute.web-driver.edge=true
white-selenium-framework.execute.web-driver.firefox=true
white-selenium-framework.execute.web-driver.browserless=false
white-selenium-framework.execute.default-explicit-wait=5
white-selenium-framework.maximize-on-open=true
white-selenium-framework.close-on-error=false

#my custom websites
mywebsite.url=mywebsite.mydomain.com

You can just copy and paste this into your project or edit it

• Dependencies.

this library uses

• lombok to log errors and general logs.
  • Slf4j

• Database configuration None
• Deployment instructions No need for those. Some working projects using this library are:

• White_LoLPicker

Contributions

How to Deploy?

use maven to release new version to any Dependency Repository.

GitHub and JitPack

You usually don't need to execute manually a release, configured GitHub actions will take care of the Build and release process for SNAPSHOT's but in case of a version you can do

mvn release:clean release:prepare -D target=github

Sonatype - Nexus - Maven Central Repository

for SNAPSHOT's use:

mvn clean deploy -D target=sonatype
mvn release:clean release:prepare -D target=sonatype

For Releases use version set if required (if you didn't manually setted in last commit):

mvn versions:set -DnewVersion=1.x.x -D target=sonatype

Followed by the DEPLOY command:

mvn clean deploy -D target=sonatype

And if you want to bump to SNAPSHOT version:

mvn release:perform -D target=sonatype

Contribution guidelines

• Writing tests.

Please do. Only some basic Unit testing is set up at the moment.

Request if you need more specification

• Code review.

Forced for pull requests

• Other guidelines.

Ask for the code standard to use as guidelines and reflect them in here.

Who do I talk to?

Role	Contact
developer	[email protected]
developer	[email protected]
Supporters	we have supporters with knowledge on the setup process of the project only
Community	send us a message in our Discord Server

Please contact us if you want to help, we are developing, maintaining and supporting this project on our own with no help or support of anyone and any tip, comment, change or help in general is well-received.