Skip to content

Commit

Permalink
MOSIP-37793 - Update the Readme file
Browse files Browse the repository at this point in the history
Signed-off-by: Mohanachandran S <[email protected]>
  • Loading branch information
mohanachandran-s authored Nov 26, 2024
1 parent 959e44c commit 3c8e1fb
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions apitest-commons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,17 @@ The API Test Commons is a shared codebase used for executing module-wise automat
- 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/))
- **Java 21** ([download here](https://jdk.java.net/)).
- **Maven 3.9.6** or higher ([installation guide](https://maven.apache.org/install.html)).
- **Lombok** (Refer to [Lombok Project](https://projectlombok.org/))

---

### For Windows

Expand All @@ -34,6 +38,8 @@ Ensure the following software is installed on the machine from where the automat
- Regular Maven conf folder
- Copy the same `settings.xml` under `/usr/local/maven/conf`

---

## Access Test Automation Code

### From Browser
Expand All @@ -50,13 +56,17 @@ Ensure the following software is installed on the machine from where the automat
```sh
git clone https://github.com/mosip/mosip-functional-tests

---

## Update the property file
1. Navigate to the kernel.properties file located at:
```sh
mosip-functional-tests\apitest-commons\src\main\resources\config\kernel.properties
2. Open the file in your preferred editor
3. Update the client secret values and other required credentials as per your environment
---
## Build Test Automation Code
1. From the already opened Git Bash, navigate to the apitest-commons directory:
```sh
Expand All @@ -65,5 +75,18 @@ Ensure the following software is installed on the machine from where the automat
```sh
mvn clean install -Dgpg.skip=true -Dmaven.gitcommitid.skip=true
---
## Using Apitest Commons as a dependency in the Project
- Add the following dependency in the POM of required project
```sh
<dependency>
<groupId>io.mosip.testrig.apirig.apitest.commons</groupId>
<artifactId>apitest-commons</artifactId>
<version>1.3.0</version>
</dependency>

---

## License
This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-platform/blob/master/LICENSE)

0 comments on commit 3c8e1fb

Please sign in to comment.