Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mfarisgh/selenium_faris
Automation Test of OrangeHRM website using Selenium
https://github.com/mfarisgh/selenium_faris
cucumber java jira lambdatest maven selenium testng
Last synced: 28 days ago
JSON representation
Automation Test of OrangeHRM website using Selenium
- Host: GitHub
- URL: https://github.com/mfarisgh/selenium_faris
- Owner: mfarisgh
- Created: 2024-03-16T15:18:54.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-08-08T11:42:46.000Z (3 months ago)
- Last Synced: 2024-09-28T11:40:56.363Z (about 1 month ago)
- Topics: cucumber, java, jira, lambdatest, maven, selenium, testng
- Language: Java
- Homepage:
- Size: 280 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
## About The Project
This is a POC Java project for Automation Testing using Selenium to test OrangeHRM website.
The goal of this project is to demonstrate how an Automation Testing is done using various combination of tools/frameworks.
Of course this project is not limited to its current conditions.
You may clone it to your own environment and customize it further with more tools/frameworks depending on your needs.
* [Get to know about Automation Testing](https://www.techtarget.com/searchsoftwarequality/definition/automated-software-testing)
* [Get to know Selenium](https://www.selenium.dev/)
* [Get to know TestNG](https://testng.org/)
* [Get to know Cucumber](https://cucumber.io/)
OrangeHRM is an open-source human resource management (HRM) software platform. It provides a comprehensive set of HR functionalities to businesses of all sizes, including features for personnel information management, attendance tracking, leave management, performance evaluation, and other HR-related tasks.
* [Get to know OrangeHRM](https://www.orangehrm.com/)
* [OrangeHRM Live Demo site](https://opensource-demo.orangehrmlive.com/)
### Built With
* Java 17
* Maven 3
* Selenium 4
* Cucumber 7
* TestNG 7
* [Unofficial Jira Client 0.5](https://github.com/bobcarroll/jira-client)
### Test Scenarios
* OrangeHRM Successful Login
* OrangeHRM Failed Login
* OrangeHRM Successful Username Search
* OrangeHRM Failed Username Search
## Getting Started
The following are the instructions on setting up your project locally.
To get a local copy up and running, follow these simple steps.
### Prerequisites
The following prerequisites that you will need to get started:
1. This repo of course! You may download it as a zip file or "git clone" it to your computer.
2. [OpenJDK](https://adoptium.net/temurin/releases/) (I used v17 as a base).
3. An IDE ([Eclipse](https://www.eclipse.org/downloads/) or [IntelliJ IDEA Ultimate/Community Edition](https://www.jetbrains.com/idea/download/?section=windows)).
Optional
4. A LambdaTest account. [Get to know LambdaTest.](https://www.lambdatest.com/)
5. [A Jira Cloud account.](https://www.atlassian.com/try/cloud/signup?bundle=jira-software&edition=free&skipBundles=true)
6. A Linux server (for usage with CI). I recommend using [VirtualBox](https://www.instructables.com/How-to-install-Linux-on-your-Windows/) for starters. You can also checkout on [AWS EC2 instances](https://aws.amazon.com/ec2/) for running CI on cloud server (you need credit card to register for them).
7. [Jenkins](https://www.jenkins.io/doc/book/installing/linux/), if you intend to use the project with CI (I've only tested this, you may experiment with others at your own risk). [Get to know more about CI.](https://www.techtarget.com/searchsoftwarequality/definition/continuous-integration)
### Running the Automation Tests
1. Ensure that you have extracted or git-cloned the project folder into your local computer.
2. Open the project folder in your IDE.
3. Look for `local.properties` in `src/test/resources`. Configure it as follows:
```sh
location= # local or lambdatest
browser=chrome
browser.mode= # headful or headless
lt.username= # your LambdaTest username. You may leave it blank if platform used is local.
lt.accesskey= # your LambdaTest access key. You may leave it blank if platform used is local. Refer here on how to get them https://www.lambdatest.com/support/docs/hyperexecute-how-to-get-my-username-and-access-key/
web.url=https://opensource-demo.orangehrmlive.com/
jira.enabled= # true or false
jira.url= # your Jira URL. Do not forget the ending slash! You may leave it blank if false.
jira.username= # your Jira username (email address). You may leave it blank if false.
jira.token= # your Jira user token. You may leave it blank if false. Refer here on how to get them https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
jira.project= # your Jira project code. e.g. STC. You may leave it blank if false.
```
4. Run the tests through the `testng.xml` file.
5. If you use Jira and enabled Jira in `local.properties`, all the failed Test Cases will be recorded as a Bug in your Jira Backlog.
### Running the Automation Tests using CI
#### A. Jenkins
1. I will be referring to the use case of Jenkins in a Linux server where the [job will run as a pipeline](https://www.jenkins.io/doc/book/pipeline/getting-started/) and not involving any Docker images.
2. If you are not using/stating any Docker images in your pipeline, your Linux server (where Jenkins was installed or where the Jenkins job will be running) must have the following installed:
i. OpenJDK
```sh
sudo apt install openjdk-17-jdk
```
ii. Browser (I'll take Chrome as an example)
```sh
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
sudo apt --fix-broken install ./google-chrome-stable_current_amd64.deb
google-chrome --version
```
iii. Maven
```sh
sudo apt install maven
```
3. You can refer to the sample `jenkins_pipeline_selenium.txt` to assign respective values such as the platform to be used, browser, etc. Copy the contents (in the txt file) to your Jenkins job settings -> Pipeline (Pipeline script). Save and run the job.
*Side note: I have tried running Jenkins in 1GB RAM and 1 core CPU Linux virtual machine using VirtualBox, it works!*
*Although AWS EC2 Free Tier has almost the same specs (t2.micro with 1GB RAM, 1 core CPU, Linux OS), it doesn't work! No need to waste your time. It freezes on my Free Tier EC2 instances.*
*Just get a higher paid t2 instances to be able to run Jenkins properly.*
*[Explanation 1](https://stackoverflow.com/questions/57991172/aws-ec2-t2-micro-unlimited-jenkins-maven-very-slow-build-hangs), [Explanation 2](https://stackoverflow.com/questions/71038504/when-jenkins-job-in-running-ip-gets-frozen-and-inaccessible), [Explanation 3](https://serverfault.com/questions/932544/ec2-instance-freezes)*
## Contact
M. Faris - [Facebook](https://fb.me/its.me.eff) - [email protected]
GitHub : [mfarisgh](https://github.com/mfarisgh)
GitLab : [mfarisgl](https://gitlab.com/mfarisgl)
## Acknowledgements
* [QA Automation Expert](https://qaautomation.expert/2023/10/09/page-object-model-with-selenium-cucumber-and-testng/)
* [selenium.dev](https://www.selenium.dev/documentation/webdriver/troubleshooting/upgrade_to_selenium_4/)
* [Tools QA](https://toolsqa.com/testng/testng-data-provider-excel/)
* [Shreya Bose (BrowserStack)](https://www.browserstack.com/guide/wait-commands-in-selenium-webdriver)
* [Tim Lewis (Stack Overflow)](https://stackoverflow.com/questions/2263929/regarding-application-properties-file-and-environment-variable)
* [Arpan Saini (Stack Overflow)](https://stackoverflow.com/questions/4501215/can-testng-run-multiple-suites)
* [Ganesh Hegde (BrowserStack)](https://www.browserstack.com/guide/how-to-integrate-jira-with-selenium)