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
Ensure the following software is installed on the machine from where the automation tests will be executed:
- Java 21 (download here).
- Maven 3.9.6 or higher (installation guide).
- Lombok (Refer to Lombok Project)
- setting.xml (download here)
- Git Bash 2.18.0 or higher
settings.xml
needs to be present in the.m2
folder.
settings.xml
file needs to be present in two places:- Regular Maven conf folder
- Copy the same
settings.xml
under/usr/local/maven/conf
- Clone or download the repository as a zip file from GitHub.
- Unzip the contents.
- Continue with the steps below from a terminal (Linux) or command prompt (Windows).
- Copy the git link:
https://github.com/mosip/mosip-functional-tests
- Open Git Bash at your desired location on your local systemn.
- Run the following command to clone the repository:
git clone https://github.com/mosip/mosip-functional-tests
- Navigate to the kernel.properties file located at:
mosip-functional-tests\apitest-commons\src\main\resources\config\kernel.properties
- Open the file in your preferred editor
- Update the client secret values and other required credentials as per your environment
- From the already opened Git Bash, navigate to the apitest-commons directory:
cd mosip-functional-tests/apitest-commons/
- Run the following Maven command:
mvn clean install -Dgpg.skip=true -Dmaven.gitcommitid.skip=true
- Add the following dependency in the POM of required project
<dependency> <groupId>io.mosip.testrig.apirig.apitest.commons</groupId> <artifactId>apitest-commons</artifactId> <version>1.3.0</version> </dependency>
This project is licensed under the terms of Mozilla Public License 2.0