forked from mosip/mosip-functional-tests
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MOSIP-37793 - Update the Readme file
Signed-off-by: Mohanachandran S <[email protected]>
- Loading branch information
1 parent
b451995
commit 13f79fc
Showing
1 changed file
with
65 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,66 @@ | ||
| # Automation test | ||
| # API Test Commons | ||
|
|
||
| All automation test code. | ||
| ## Overview | ||
|
|
||
| The API Test Commons is a shared codebase used for executing module-wise automation API tests. It utilizes Java REST Assured and TestNG frameworks to automate testing for various modules, including: | ||
| - Pre-registration | ||
| - Masterdata | ||
| - Partner Management | ||
| - PMS | ||
| - ID Repository | ||
| - IDA | ||
| - Resident | ||
| - ESignet | ||
| - ESignet-signup | ||
| - Mimoto | ||
| - Inji-Certify | ||
|
|
||
| ## Pre-requisites | ||
|
|
||
| Ensure the following software is installed on the machine from where the automation tests will be executed: | ||
|
|
||
| - Java 21 | ||
| - Maven 3.9.6 or higher | ||
| - Lombok (Refer to [Lombok Project](https://projectlombok.org/)) | ||
|
|
||
| ### For Windows | ||
|
|
||
| - Git Bash 2.18.0 or higher | ||
| - `settings.xml` needs to be present in the `.m2` folder. | ||
|
|
||
| ### For Linux | ||
|
|
||
| - `settings.xml` file needs to be present in two places: | ||
| - Regular Maven conf folder | ||
| - Copy the same `settings.xml` under `/usr/local/maven/conf` | ||
|
|
||
| ## Access Test Automation Code | ||
|
|
||
| ### From Browser | ||
|
|
||
| 1. Clone or download the repository as a zip file from [GitHub](https://github.com/mosip/mosip-functional-tests). | ||
| 2. Unzip the contents. | ||
| 3. Continue with the steps below from a terminal (Linux) or command prompt (Windows). | ||
|
|
||
| ### From Git Bash | ||
|
|
||
| 1. Copy the git link: `https://github.com/mosip/mosip-functional-tests` | ||
| 2. Open Git Bash at your desired location on your local systemn. | ||
| 3. Run the following command to clone the repository: | ||
| ```sh | ||
| git clone https://github.com/mosip/mosip-functional-tests | ||
|
|
||
| ## Update the property file | ||
| 1. Navigate to the kernel.properties file located at: | ||
| `mosip-functional-tests\apitest-commons\src\main\resources\config\kernel.properties` | ||
| 3. Open the file in your preferred editor | ||
| 4. Update the client secret values and other required credentials as per your environment | ||
|
|
||
| ## Build Test Automation Code | ||
| 1. Navigate to the apitest-commons directory: | ||
| 2. `cd mosip-functional-tests/apitest-commons/` | ||
| 3. Run the following Maven command: | ||
| 4. `mvn clean install -Dgpg.skip=true -Dmaven.gitcommitid.skip=true` | ||
|
|
||
| ## License | ||
| This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-platform/blob/master/LICENSE) |