# v1.3.1

**Release Name:** API Test Commons Releases

**Release version:** v1.3.1

**Release Date:** 28th Jan, 2025

### Overview

The v1.3.1 release of Api Test Commons introduces several enhancements and bug fixes to improve the functionality, usability, and performance of the MOSIP Functional Tests. These changes aim to provide a better user experience by enhancing existing features and addressing critical issues.

### Major Highlights

### Enhancements

1. **Report Generation**

* Improved the reporting module to provide detailed and comprehensive reports, enhancing the visibility and traceability of test results.
* Reports now segregate prerequisite test cases and main test cases into two separate sections.
* An additional report is generated exclusively for failed test cases.

2. **Component** **Base URL**

* Integrated mock identity system endpoints into the component base URL, facilitating mock identity plugin testing in API test rigs.
* These endpoints are configurable via the config maps of API test rigs.

3. **Removed Component-Specific Code**

* Transferred module-specific implementations from Api Test Commons to their respective modules.
* Cleaned up unused code, ensuring better maintainability and reducing bloat.

4. **Debug** Logs Disabled

* Debug logs are disabled by default for cleaner execution outputs. They can be enabled through the config maps of API test rigs if needed.

5. **Configurable** Schema Version

* Enhanced the schema-fetching mechanism to dynamically retrieve the schema version specified in the properties file of the API test rig, enabling seamless support for custom or specific schema versions when required.

### Bug Fixes

* Eliminated redundant log entries to streamline outputs and improve readability.
* Resolved issues causing intermittent crashes during API tests.
* Enhanced overall quality and performance of Api Test Commons.

### Pre-requisites 

Ensure the following software is installed on the machine from where the automation tests will be executed: 

* **Java**: Java 21 
* **Maven**: Version 3.9.6 or higher
* **Lombok**: Lombok (Refer to[ Lombok Project](https://projectlombok.org/download)) 

**For Windows** 

* Git Bash: 2.18.0 or higher 
* The `settings.xml` needs to be present in the `.m2` folder. 

**For** **Linux** 

The `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** 

1\. **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). 

2\. **From Git Bash** 

1. Copy the git link: <https://github.com/mosip/mosip-functional-tests> 
2. On your local system, open Git Bash at any location. 
3. Run the following command:

git clone <https://github.com/mosip/mosip-functional-tests>

**Build Test Automation Code** 

1. Navigate to the apitest-commons directory: `cd ../apitest-commons` 
2. Build the project: `mvn clean install -Dgpg.skip=true -Dmaven.gitcommitid.skip=true` 

Ensure all **prerequisites** are met before running the updated tests. Refer to the updated **README file** for detailed setup and execution instructions.

For any issues or further assistance, please open an issue on GitHub.