From 13f79fce3c277d62fefdf8c2333044136da4eabb Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:32:07 +0530 Subject: [PATCH 01/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- apitest-commons/README.md | 67 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 65 insertions(+), 2 deletions(-) diff --git a/apitest-commons/README.md b/apitest-commons/README.md index 51b6226796a..113a321d170 100644 --- a/apitest-commons/README.md +++ b/apitest-commons/README.md @@ -1,3 +1,66 @@ -# Automation test +# API Test Commons -All automation test code. +## Overview + +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 + +## 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/)) + +### 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 + +### 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). + +### From Git Bash + +1. Copy the git link: `https://github.com/mosip/mosip-functional-tests` +2. Open Git Bash at your desired location on your local systemn. +3. Run the following command to clone the repository: + ```sh + git clone https://github.com/mosip/mosip-functional-tests + +## Update the property file +1. Navigate to the kernel.properties file located at: +`mosip-functional-tests\apitest-commons\src\main\resources\config\kernel.properties` +3. Open the file in your preferred editor +4. Update the client secret values and other required credentials as per your environment + +## Build Test Automation Code +1. Navigate to the apitest-commons directory: +2. `cd mosip-functional-tests/apitest-commons/` +3. Run the following Maven command: +4. `mvn clean install -Dgpg.skip=true -Dmaven.gitcommitid.skip=true` + +## License +This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-platform/blob/master/LICENSE) From 8d8d88e43d83e2bc4d5de5709c6672126e577154 Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:33:40 +0530 Subject: [PATCH 02/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- apitest-commons/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/apitest-commons/README.md b/apitest-commons/README.md index 113a321d170..962d6f2106a 100644 --- a/apitest-commons/README.md +++ b/apitest-commons/README.md @@ -52,6 +52,7 @@ Ensure the following software is installed on the machine from where the automat ## 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` 3. Open the file in your preferred editor 4. Update the client secret values and other required credentials as per your environment From e3b396fe93b64033ec251e0f53e4acdfbabde446 Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:34:31 +0530 Subject: [PATCH 03/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- apitest-commons/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/apitest-commons/README.md b/apitest-commons/README.md index 962d6f2106a..5bdf09ffae8 100644 --- a/apitest-commons/README.md +++ b/apitest-commons/README.md @@ -52,10 +52,10 @@ Ensure the following software is installed on the machine from where the automat ## 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` -3. Open the file in your preferred editor -4. Update the client secret values and other required credentials as per your environment + ```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. Navigate to the apitest-commons directory: From cb2237883d623b90e7785cd13e7e39ae47e800fa Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:36:12 +0530 Subject: [PATCH 04/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- apitest-commons/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apitest-commons/README.md b/apitest-commons/README.md index 5bdf09ffae8..7db79cce81b 100644 --- a/apitest-commons/README.md +++ b/apitest-commons/README.md @@ -52,7 +52,7 @@ Ensure the following software is installed on the machine from where the automat ## Update the property file 1. Navigate to the kernel.properties file located at: - ```sh + 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 From 4fa44d0633a0da7f2475a5575c7fe06392443f29 Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:37:33 +0530 Subject: [PATCH 05/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- apitest-commons/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/apitest-commons/README.md b/apitest-commons/README.md index 7db79cce81b..8997541b1a8 100644 --- a/apitest-commons/README.md +++ b/apitest-commons/README.md @@ -52,8 +52,7 @@ Ensure the following software is installed on the machine from where the automat ## 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` + `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 From c54734abb51e9617ed0d6f4813ef7aa92efbbaf0 Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:43:33 +0530 Subject: [PATCH 06/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- apitest-commons/README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/apitest-commons/README.md b/apitest-commons/README.md index 8997541b1a8..3dc59e5e91b 100644 --- a/apitest-commons/README.md +++ b/apitest-commons/README.md @@ -52,15 +52,18 @@ Ensure the following software is installed on the machine from where the automat ## 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` + ```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. Navigate to the apitest-commons directory: -2. `cd mosip-functional-tests/apitest-commons/` -3. Run the following Maven command: -4. `mvn clean install -Dgpg.skip=true -Dmaven.gitcommitid.skip=true` + ```sh + cd mosip-functional-tests/apitest-commons/ +2. Run the following Maven command: + ```sh + mvn clean install -Dgpg.skip=true -Dmaven.gitcommitid.skip=true ## License This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-platform/blob/master/LICENSE) From 47471a282724d12f38d70cc93f4618ed12b68e52 Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:45:06 +0530 Subject: [PATCH 07/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- apitest-commons/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apitest-commons/README.md b/apitest-commons/README.md index 3dc59e5e91b..12e50485464 100644 --- a/apitest-commons/README.md +++ b/apitest-commons/README.md @@ -58,7 +58,7 @@ Ensure the following software is installed on the machine from where the automat 3. Update the client secret values and other required credentials as per your environment ## Build Test Automation Code -1. Navigate to the apitest-commons directory: +1. From the already opened Git Bash, navigate to the apitest-commons directory: ```sh cd mosip-functional-tests/apitest-commons/ 2. Run the following Maven command: From 8b1fa4db507aecf8d94540ffcb0fe4caa3faa0e4 Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 11:26:34 +0530 Subject: [PATCH 08/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- README.md | 58 ++++++++++++++++++++++++++----------------------------- 1 file changed, 27 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index aceaa9cb937..657c019d175 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,43 @@ # MOSIP Functional Tests -## Overview +The **`mosip-functional-tests`** repository contains the reusable **`apitest-commons`** library, which simplifies API testing with pre-built utilities and helpers. The **`apitest-commons`** can be used as a dependency in POM files for MOSIP testrigs of all the modules and can consume the reusable codes. -The API Test Rig Commons is a shared code base that is used for the execution of module-wise automation API tests. This uses Java REST Assured and TestNG frameworks to automate testing for different modules like Pre-registration, Masterdata, Partner Management, PMS, ID Repository, IDA, Resident, E-Signet, and Mimoto. +--- -## Pre-requisites +## Repository Structure -Ensure the following software is installed on the machine from where the automation tests will be executed: +This repository consists of: +1. **`apitest-commons`**: + - A reusable library for API testing. + - Released independently to [Maven Central](https://search.maven.org/) under the artifact ID `apitest-commons`. + - Includes its own [README](apitest-commons/README.md) for detailed instructions on setup and usage. -- Java 21 -- Maven 3.9.6 or higher -- Lombok (Refer to [Lombok Project](https://projectlombok.org/)) +--- -### For Windows +## Prerequisites -- Git Bash 2.18.0 or higher -- `settings.xml` needs to be present in the `.m2` folder. +To use this repository, ensure you have: +- **Java 21** or later installed ([download here](https://jdk.java.net/)). +- **Maven** ([installation guide](https://maven.apache.org/install.html)). +- Access to necessary MOSIP services or mocked test environments. -### 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` +## Apitest Commons -## Access Test Automation Code +### Setting Up and Building the Project +- Refer to the ReadMe file [README](apitest-commons/README.md) -### From Browser +### Using it as dependency in the Project +- Add the following dependency in the POM of required project + ```sh + + org.mosip + apitest-commons + 1.3.0 + -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). - -### 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: - ```sh - git clone https://github.com/mosip/mosip-functional-tests - -## Build Test Automation Code -1. cd ../apitest-commons -2. `mvn clean install -Dgpg.skip=true -Dmaven.gitcommitid.skip=true` +--- ## License This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-platform/blob/master/LICENSE) From 959e44c2da69e816c22b545d63741bcbbc817886 Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 11:59:31 +0530 Subject: [PATCH 09/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 657c019d175..eee49919d72 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ This repository consists of: ## Prerequisites To use this repository, ensure you have: -- **Java 21** or later installed ([download here](https://jdk.java.net/)). -- **Maven** ([installation guide](https://maven.apache.org/install.html)). +- **Java 21** ([download here](https://jdk.java.net/)). +- **Maven 3.9.6** or higher ([installation guide](https://maven.apache.org/install.html)). - Access to necessary MOSIP services or mocked test environments. --- @@ -32,7 +32,7 @@ To use this repository, ensure you have: - Add the following dependency in the POM of required project ```sh - org.mosip + io.mosip.testrig.apirig.apitest.commons apitest-commons 1.3.0 From 3c8e1fbd15b1b610fd04e480de992db861585b05 Mon Sep 17 00:00:00 2001 From: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> Date: Tue, 26 Nov 2024 11:59:48 +0530 Subject: [PATCH 10/10] MOSIP-37793 - Update the Readme file Signed-off-by: Mohanachandran S <165888272+mohanachandran-s@users.noreply.github.com> --- apitest-commons/README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/apitest-commons/README.md b/apitest-commons/README.md index 12e50485464..60537aa0521 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)