diff --git a/apitest-commons/README.md b/apitest-commons/README.md index 12e5048546..60537aa052 100644 --- a/apitest-commons/README.md +++ b/apitest-commons/README.md @@ -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 @@ -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 @@ -50,6 +56,8 @@ 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 @@ -57,6 +65,8 @@ Ensure the following software is installed on the machine from where the automat 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 @@ -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 + + io.mosip.testrig.apirig.apitest.commons + apitest-commons + 1.3.0 + + +--- + ## License This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-platform/blob/master/LICENSE)