Release Name: Api Test Commons Releases

Release Version: 1.3.3

Release Date: 1st July, 2025

Overview

We are pleased to announce API Test Commons v1.3.3, a patch release that hardens the MOSIP Functional Test Framework through watchdog-based execution control, richer reporting, stronger database utilities, automated Slack notifications, and multiple security remediation's. These improvements build on v1.3.2 and earlier 1.3.x releases to deliver faster, safer, and more observable automated test runs across MOSIP modules.

Bug Fixes

Major Highlights (New Developments & Enhancements)

Repositories Released

Pre-requisites

Ensure the following before executing automated tests:

• Java: 21

• Maven: 3.9.6 or higher

• Lombok: Installed and configured

For Windows

• Git Bash 2.18.0 or higher

• settings.xml needs to be present in the .m2 folder.

For Linux

• settings.xml placed in both:

  • Maven conf folder

  • /usr/local/maven/conf

Repository & Build

Access Test Automation Code

1. From Browser

2. Clone or download the repository as a zip file from.

3. Unzip the contents.

4. Continue with the steps below from a terminal (Linux) or command prompt (Windows).

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 pre-requisites 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.

Release Name: Api Test Commons Releases

Release Version: 1.3.4

Release Date: 22nd September, 2025

Overview

We are pleased to announce API Test Commons v1.3.x, a patch release focused on Helm chart enhancements.

This release addresses a critical bug in the existing Helm chart and introduces Helm chart configurations and deployment scripts for UI Test Rigs, enabling easier and more reliable deployments across environments.

These updates build on previous 1.3.x releases, ensuring smoother setup, better automation support, and simplified deployment processes for MOSIP automated testing infrastructure.

Bug Fixes

Major Highlights (New Developments & Enhancements)

Repositories Released

Pre-requisites

Ensure the following before executing automated tests:

• Java: 21

• Maven: 3.9.6 or higher

• Lombok: Installed and configured

For Windows

• Git Bash 2.18.0 or higher

• settings.xml needs to be present in the .m2 folder.

For Linux

• settings.xml placed in both:

  • Maven conf folder

  • /usr/local/maven/conf

Repository & Build

Access Test Automation Code

1. From Browser

2. Clone or download the repository as a zip file from.

3. Unzip the contents.

4. Continue with the steps below from a terminal (Linux) or command prompt (Windows).

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 pre-requisites 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.

Release Name: API Test Commons Releases

Release version: v1.3.2

Release Date: 27th March, 2025

Overview

The v1.3.2 release of API Test Commons introduces new developments, enhancements, security fixes, and bug resolutions to improve the efficiency, usability, and security of the MOSIP Functional Tests. This update includes significant improvements in YAML loading, test efficiency, report generation, and dependency management. Additionally, it introduces new methods for eKYC data decryption and Inji Verify backend services support.

Major Highlights

New Development

• Support for Inji Verify Api Testrig

• Introduced supporting methods for Inji Verify, a new api testrig designed to test the Inji Verify backend services.

• These methods have been integrated into API Test Commons.

• New Method for eKYC Data Decryption for DSL

Enhancements

Report Enhancements

• Corrected width size mismatch in the report layout.

• Removed the test case name column from the report summary, combining the test case name and test case number into a single column.

Commons Cleanup

• Removed unnecessary folders, files, and unused URLs.

• Cleaned up unused configuration properties.

• Moved component-specific code into respective test rig modules.

Enhancing YAML Loading and Test Efficiency

• Ordered YAML Data: Ensured that YAML data maintains its original order by using LinkedHashMap when loading YAML files.

• Consistent Test Filtering: Fixed an issue where smoke test results appeared in a random order, ensuring consistent ordering.

• Efficient Test Case Storage: Switched from a slower test case storage method to an optimized ArrayList implementation.

Auto-Generated ID Handling

• Updated logic to write auto-generated IDs directly into a global map instead of storing them in a file.

• Enhanced the writeAutoGeneratedId method to handle responses without the keyword responses.

Security Fixes

• Set the log level for classes printing secrets in logs to prevent accidental exposure of sensitive information.

Configuration Updates

• Added new configuration properties in kernel.properties:

• pms_db_schema=pms

• expirationTime=120 (value in seconds)

Dependency Updates & Fixes

• Upgraded multiple dependencies to fix dependent bot issues.

Logic Introduced for Adding Expiry Time to Transaction

• The expiry time is now determined based on the expirationTime value provided in the configuration property.

• Expiry timestamps are generated in UTC format.

• The default expiration is set to 2 minutes, configurable through the config property.

• During test execution, the expiry time is dynamically inserted into API requests using the keyword $EXPIRYTIMESTAMP$.

Bug Fixes

• Updated OTP fetching logic to remove the pre-plus sign (+) from phone numbers when retrieving OTP from the OTP listener.

• Set serverErrorsToMonitor default value as empty to avoid conflicts across different modules.

• Introduced moduleNamePattern in kernel.properties, centralizing the module name property for easy retrieval across all modules.

Conclusion

The v1.3.2 release of API Test Commons brings crucial updates to enhance the API testing framework’s functionality, security, and performance. By introducing improved YAML handling, auto-generated ID management, transaction expiry logic, and security improvements, this release ensures a more robust and efficient testing experience for MOSIP Functional Tests.

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) 

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 

1. From Browser 

1. Clone or download the repository as a zip file from. 

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:  

2. On your local system, open Git Bash at any location. 

3. Run the following command: git clone  

Build Test Automation Code 

1. Navigate to the apitest-commons directory:

1. Build the project:

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 .

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.

1. 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.

1. 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.

1. 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.

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

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 samesettings.xml under /usr/local/maven/conf 

Access Test Automation Code 

1. From Browser 

1. Clone or download the repository as a zip file from. 

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:  

2. On your local system, open Git Bash at any location. 

3. Run the following command:

git clone

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.

Release Name: API Test Commons Releases

Release version: 1.3.0

Release Date: 12th December, 2024

Overview

The 1.3.0 release incorporates new features and enhancements to improve the functionality, usability, and performance of the MOSIP Functional Tests. This update addresses several critical issues to ensure a more seamless user experience.

Major Highlights

New Features include:

1. Migrated to Java 21:

• Migrated the Api Test Commons library from Java 11 to Java 21

• Removed “kernel-registration-packet-manager” and “kernel-crypto-jce” libraries as these are not compatible with Java 21 migration and implemented crypto core class inside the apitest commons for encrypt and decrypt utils

• Removed automatic dependency injection added for adopting crypto core class from “kernel-crypto-jce” library

1. Array Handles:

• Added functionality to generate and update the request body with an array of handles for Identity API to create the UIN through the Id-Repository module

• Refer to for api details, change the environment as per requirement in the URL

1. Skip and Report known Issues/Failures:

• Implementation of skipping the testcases for the known issues/failures with the bug that will be fixed in the future.

• Skipped details will be displayed in the report

1. Component Base URL’s:

• Added logic to handle dependent services, allowing them to run in different environments based on Base URLs provided in the configuration property

1. Unique Identifier:

• Introducing the unique identifier and mapping with the master testcase sheet for easy accessibility of the testcases between the api testrig and the master testcase sheet which helps to identify the api testrig easily failed testcases in the master testcase sheet

• Displaying the unique identifier in the report

1. Context URL:

• Now, the backward compatibility for the mimoto context URL

/residentmobileapp/v1/mimoto has been implemented.

1. Storing Reports in Mount/ Configured Path:

• Added flexibility for storing the Test reports in either an S3 bucket or mounted path.

• The config property used “push-reports-to-s3” is No.

• The configured mount volume path is “/home/mosip/testrig/report”.

• It helps when the service is deployed in non-MOSIP environments.

1. WebSocket util:

• Created the util class for creating the connection and sending the message through WebSocket to support the KYC process testing

Enhancements

1. Report Generation:

• Enhanced the reporting module to provide more detailed and comprehensive reports, improving the visibility and traceability of test results.

1. Restructured Config Manager:

• Restructured config manager to hold only the common configurations in apitest commons and moved the module specific properties to the respective modules

1. Removed Component Specific Code:

• Moved the module specific implementations from apitest commons to the respective modules.

• Moved the suite setup into respective modules test runner class.

1. Generic DB Manager:

• Optimized DB manager by removing the module specific code and making it more generic

• Module specific DB execution implementations are moved to respective modules

1. Renamed the Classes:

• MockSMTPListener class in the “io.mosip.testrig.apirig.testrunner” package is renamed to OTPListener as this class is used to listen to the OTP from the Mock SMTP

1. Mock MDS:

• Modified the quality score data type to be compatible with Java 21 migrated mock MDS library

Bug fixes

• Addressed compatibility issues with the latest versions of dependent services and libraries.

• Eliminated redundant log entries to streamline output and improve readability.

• Resolved issues causing intermittent crashes during API tests.

• Enhanced and improved the apitest commons quality.

Repository Released

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)

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

To access the Test Automation Code:

1. From Browser

1. Clone or download the repository as a zip file from.

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

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.

Release Name: Api Test Commons Releases

Release Version: 1.3.5

Release Date: 28th November, 2025

Overview

We are pleased to announce API Test Commons v1.3.5, a feature-enhanced and stability-focused update designed to strengthen the MOSIP Functional Test Framework.

This release brings major improvements in test dependency management, enhanced SMTP validation, better debugging tools, advanced certificate and key utilities, improved security in DSL reports, and updated support for Inji Web, delegated authentication, and eSignet DPoP scenarios.

Version 1.3.5 builds upon v1.3.4 and continues to improve reliability, traceability, and execution consistency across all MOSIP module test suites.

Bug Fixes

Major Highlights (New Developments & Enhancements)

Repositories Released