Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mfaisalkhatri/speedwell
A power-packed keyword driven framework which is integrated with Allure reports and Log4j2.
https://github.com/mfaisalkhatri/speedwell
allure automation automation-framework framework keyword-driven-testing log4j2 open-source selenium-webdriver testing testng
Last synced: about 1 month ago
JSON representation
A power-packed keyword driven framework which is integrated with Allure reports and Log4j2.
- Host: GitHub
- URL: https://github.com/mfaisalkhatri/speedwell
- Owner: mfaisalkhatri
- License: apache-2.0
- Created: 2018-09-23T06:18:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-01-04T16:33:19.000Z (almost 3 years ago)
- Last Synced: 2024-05-01T17:25:15.397Z (7 months ago)
- Topics: allure, automation, automation-framework, framework, keyword-driven-testing, log4j2, open-source, selenium-webdriver, testing, testng
- Language: Java
- Size: 15.9 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**speedwell**
**A power-packed keyword driven framework which is integrated with Allure reports and Log4j2.**
**Getting Started**
*This page includes all the information you need to get started including setup, usage, advantages, sample test.*
**What to do when you need help?**
* Discuss your queries by writing to me at:
* Mail: [email protected]
* Twitter: @mfaisal_khatri
* LinkedIn: Mohammad Faisal Khatri
* 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.
**What you do if you like the project?**
* Spread the word with your network.
* Star the project to make the project popular.
* Stay updated with the project progress by Watching it.
**How to use this Framework:**
01. "Config.Properties" file is used in the framework for defining the Browser Type, storing the Url of website used for tests, User Id and Password of used for login, etc.
```
This is the config file extract:
browser=chrome //Here, browser value should be given like "Chrome" / "Firefox".
website=http://www.google.co.in
username=user001
password=pass01
```
02. PropertiesReader class is available in the Framework which is a helper class to read the config file in simplified way.
03. Getter/Setter is required to be created for the Config file key value pairs to be used in tests.
```
This is how Getter/Setter is created for fetching config file values:
public class ConfigProperties {
PropertiesReader prop = new PropertiesReader();
public String getBrowser() throws IOException {
return prop.getKey("browser");
}
public String getWebsite() throws IOException {
return prop.getKey("website");
}
public String getUserName() throws IOException {
return prop.getKey("username");
}
public String getPassword() throws IOException {
return prop.getKey("password");
}
```
04. For using this framework, you have to create a Setup class where browser will be set up. Use "testng" annotations "BeforeSuite"/"BeforeClass"/"BeforeMethod", according to your case and condition of automation tests and Extend "BrowserSetup" class in it.
05. Now you can use the "startBrowser" method directly in your tests which requires, "Browser Name" and "Website Url" as parameters.
06. For tearDown method, "stopBrowser" will quit the browsers.
**This is what Setup class looks like :**
```
public class Setup extends BrowserSetup {
@BeforeMethod
public void siteup() throws Exception {
ConfigProperties config = new ConfigProperties();
startBrowser(config.getBrowser(), config.getWebsite());
}
@AfterMethod
public void tearDown() {
stopBrowser();
}
}
```
07. I have created this framework keeping "Page Object Model" in mind, so, the next step would be defining a class with locators of the page which can be used in final tests.
Suppose, for example, Login Page is available and we need to find locators for "Username" and "Password" fields, enter their respective values, find locator of submit button and click on it.
**This is what the Login Page will look like:**
```
public class LoginPage {
private WebDriver driver;
private ElementSelectors selector;
private Utilities utility;
public LoginPage(WebDriver driver) {
this.driver = driver;
this.selector = new ElementSelectors(driver);
this.utility = new Utilities(driver);
}
@Step
public void loginSite(String usrName, String password) throws IOException {
WebElement pageHeader = driver.findElement(By.cssSelector(".nav"));
selector.clickField(pageHeader, By.linkText("Sign in"));
WebElement signInPage = driver.findElement(By.cssSelector(".columns-container"));
selector.fillField(signInPage, By.id("email"), usrName);
selector.fillField(signInPage, By.id("passwd"), password);
utility.captureScreenShot();
selector.clickField(signInPage, By.id("SubmitLogin"));
}
}
```
08. Now, comes the Test Class, it will be like this:
```
public class LoginTest extends Setup {
@Test
public void loginWebsite() throws IOException {
ConfigProperties config = new ConfigProperties();
LoginPage login = new LoginPage(driver);
login.loginSite(config.getUserName(), config.getPassword());
}
```
**Isn't this simple? Let me know your thoughts on this....?**