MOSIP-44864: Automated ESIGNET Testcases For OIDC Client.

api-test/src/main/java/io/mosip/testrig/apirig/esignet/testscripts/AuditValidator.java

@@ -0,0 +1,117 @@
+package io.mosip.testrig.apirig.esignet.testscripts;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.log4j.Level;
+import org.apache.log4j.Logger;
+import org.testng.ITest;
+import org.testng.ITestContext;
+import org.testng.ITestResult;
+import org.testng.SkipException;
+import org.testng.annotations.AfterMethod;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+import io.mosip.testrig.apirig.dbaccess.DBManager;
+import io.mosip.testrig.apirig.dto.OutputValidationDto;
+import io.mosip.testrig.apirig.dto.TestCaseDTO;
+import io.mosip.testrig.apirig.esignet.utils.EsignetConfigManager;
+import io.mosip.testrig.apirig.esignet.utils.EsignetUtil;
+import io.mosip.testrig.apirig.testrunner.BaseTestCase;
+import io.mosip.testrig.apirig.testrunner.HealthChecker;
+import io.mosip.testrig.apirig.utils.AdminTestException;
+import io.mosip.testrig.apirig.utils.AuthenticationTestException;
+import io.mosip.testrig.apirig.utils.GlobalConstants;
+import io.mosip.testrig.apirig.utils.OutputValidationUtil;
+import io.mosip.testrig.apirig.utils.SecurityXSSException;
+import io.restassured.response.Response;
+
+public class AuditValidator extends EsignetUtil implements ITest {
+	private static final Logger logger = Logger.getLogger(AuditValidator.class);
+	protected String testCaseName = "";
+	public static List<String> templateFields = new ArrayList<>();
+	public Response response = null;
+
+	/**
+	 * get current testcaseName
+	 */
+	@Override
+	public String getTestName() {
+		return testCaseName;
+	}
+
+	@BeforeClass
+	public static void setLogLevel() {
+		if (EsignetConfigManager.IsDebugEnabled())
+			logger.setLevel(Level.ALL);
+		else
+			logger.setLevel(Level.ERROR);
+	}
+
+	/**
+	 * Data provider class provides test case list
+	 * 
+	 * @return object of data provider
+	 */
+	@DataProvider(name = "testcaselist")
+	public Object[] getTestCaseList(ITestContext context) {
+		String ymlFile = context.getCurrentXmlTest().getLocalParameters().get("ymlFile");
+		logger.info("Started executing yml: " + ymlFile);
+		return getYmlTestData(ymlFile);
+	}
+
+	@Test(dataProvider = "testcaselist")
+	public void test(TestCaseDTO testCaseDTO) throws AuthenticationTestException, AdminTestException, SecurityXSSException {
+		testCaseName = testCaseDTO.getTestCaseName();
+		testCaseName = EsignetUtil.isTestCaseValidForExecution(testCaseDTO);
+		if (HealthChecker.signalTerminateExecution) {
+			throw new SkipException(
+					GlobalConstants.TARGET_ENV_HEALTH_CHECK_FAILED + HealthChecker.healthCheckFailureMapS);
+		}
+		String[] templateFields = testCaseDTO.getTemplateFields();
+		List<String> queryProp = Arrays.asList(templateFields);
+		logger.info(queryProp);
+		String query = "select * from audit.app_audit_log where cr_by = '" + BaseTestCase.currentModule + "-"
+				+ EsignetConfigManager.getproperty("partner_userName") + "'";
+
+		logger.info(query);
+		Map<String, Object> response = DBManager.executeQueryAndGetRecord(testCaseDTO.getRole(), query);
+
+		Map<String, List<OutputValidationDto>> objMap = new HashMap<>();
+		List<OutputValidationDto> objList = new ArrayList<>();
+		OutputValidationDto objOpDto = new OutputValidationDto();
+		if (response.size() > 0) {
+
+			objOpDto.setStatus("PASS");
+		} else {
+			objOpDto.setStatus(GlobalConstants.FAIL_STRING);
+		}
+
+		objList.add(objOpDto);
+		objMap.put(GlobalConstants.EXPECTED_VS_ACTUAL, objList);
+
+		if (!OutputValidationUtil.publishOutputResult(objMap))
+			throw new AdminTestException("Failed at output validation");
+	}
+
+	/**
+	 * The method ser current test name to result
+	 * 
+	 * @param result
+	 */
+	@AfterMethod(alwaysRun = true)
+	public void setResultTestName(ITestResult result) {
+
+		String deleteQuery = "delete from audit.app_audit_log where cr_by = '"
+				+ EsignetConfigManager.getproperty("partner_userName") + "'";
+		logger.info(deleteQuery);
+		DBManager.executeQueryAndDeleteRecord("audit", deleteQuery);
+
+		result.setAttribute("TestCaseName", testCaseName);
+	}
+}

api-test/src/main/java/io/mosip/testrig/apirig/esignet/testscripts/DBValidator.java

@@ -0,0 +1,122 @@
+package io.mosip.testrig.apirig.esignet.testscripts;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.TreeSet;
+
+import org.apache.log4j.Level;
+import org.apache.log4j.Logger;
+import org.json.JSONObject;
+import org.testng.ITest;
+import org.testng.ITestContext;
+import org.testng.ITestResult;
+import org.testng.SkipException;
+import org.testng.annotations.AfterMethod;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+import io.mosip.testrig.apirig.dbaccess.DBManager;
+import io.mosip.testrig.apirig.dto.OutputValidationDto;
+import io.mosip.testrig.apirig.dto.TestCaseDTO;
+import io.mosip.testrig.apirig.esignet.utils.EsignetConfigManager;
+import io.mosip.testrig.apirig.esignet.utils.EsignetUtil;
+import io.mosip.testrig.apirig.testrunner.HealthChecker;
+import io.mosip.testrig.apirig.utils.AdminTestException;
+import io.mosip.testrig.apirig.utils.AuthenticationTestException;
+import io.mosip.testrig.apirig.utils.GlobalConstants;
+import io.mosip.testrig.apirig.utils.OutputValidationUtil;
+import io.mosip.testrig.apirig.utils.SecurityXSSException;
+import io.restassured.response.Response;
+
+public class DBValidator extends EsignetUtil implements ITest {
+	private static final Logger logger = Logger.getLogger(DBValidator.class);
+	protected String testCaseName = "";
+	public static List<String> templateFields = new ArrayList<>();
+	public Response response = null;
+
+	@BeforeClass
+	public static void setLogLevel() {
+		if (EsignetConfigManager.IsDebugEnabled())
+			logger.setLevel(Level.ALL);
+		else
+			logger.setLevel(Level.ERROR);
+	}
+
+	/**
+	 * get current testcaseName
+	 */
+	@Override
+	public String getTestName() {
+		return testCaseName;
+	}
+
+	/**
+	 * Data provider class provides test case list
+	 * 
+	 * @return object of data provider
+	 */
+	@DataProvider(name = "testcaselist")
+	public Object[] getTestCaseList(ITestContext context) {
+		String ymlFile = context.getCurrentXmlTest().getLocalParameters().get("ymlFile");
+		logger.info("Started executing yml: " + ymlFile);
+		return getYmlTestData(ymlFile);
+	}
+
+	@Test(dataProvider = "testcaselist")
+	public void test(TestCaseDTO testCaseDTO) throws AuthenticationTestException, AdminTestException, SecurityXSSException {
+		testCaseName = testCaseDTO.getTestCaseName();
+		testCaseName = EsignetUtil.isTestCaseValidForExecution(testCaseDTO);
+		if (HealthChecker.signalTerminateExecution) {
+			throw new SkipException(
+					GlobalConstants.TARGET_ENV_HEALTH_CHECK_FAILED + HealthChecker.healthCheckFailureMapS);
+		}
+
+		String inputJson = getJsonFromTemplate(testCaseDTO.getInput(), testCaseDTO.getInputTemplate());
+		String replaceId = inputJsonKeyWordHandeler(inputJson, testCaseName);
+
+		JSONObject jsonObject = new JSONObject(replaceId);
+		logger.info(jsonObject.keySet());
+		Set<String> set = new TreeSet<>();
+		set.addAll(jsonObject.keySet());
+		String filterId = "";
+
+		if (set.stream().findFirst().isPresent())
+			filterId = set.stream().findFirst().get();
+
+		logger.info(filterId);
+		String query = testCaseDTO.getEndPoint() + " " + filterId + " = " + "'" + jsonObject.getString(filterId) + "'";
+
+		logger.info(query);
+		Map<String, Object> response = DBManager.executeQueryAndGetRecord(testCaseDTO.getRole(), query);
+
+		Map<String, List<OutputValidationDto>> objMap = new HashMap<>();
+		List<OutputValidationDto> objList = new ArrayList<>();
+		OutputValidationDto objOpDto = new OutputValidationDto();
+		if (response.size() > 0) {
+
+			objOpDto.setStatus("PASS");
+		} else {
+			objOpDto.setStatus(GlobalConstants.FAIL_STRING);
+		}
+
+		objList.add(objOpDto);
+		objMap.put(GlobalConstants.EXPECTED_VS_ACTUAL, objList);
+
+		if (!OutputValidationUtil.publishOutputResult(objMap))
+			throw new AdminTestException("Failed at output validation");
+	}
+
+	/**
+	 * The method ser current test name to result
+	 * 
+	 * @param result
+	 */
+	@AfterMethod(alwaysRun = true)
+	public void setResultTestName(ITestResult result) {
+		result.setAttribute("TestCaseName", testCaseName);
+	}
+}

api-test/src/main/java/io/mosip/testrig/apirig/esignet/testscripts/PostWithBodyAndPathParams.java

@@ -35,6 +35,7 @@
 public class PostWithBodyAndPathParams extends EsignetUtil implements ITest {
 	private static final Logger logger = Logger.getLogger(PostWithBodyAndPathParams.class);
 	protected String testCaseName = "";
+	public String idKeyName = null;
 	String pathParams = null;
 	String headers = null;
 	public Response response = null;
@@ -64,6 +65,7 @@ public String getTestName() {
 	public Object[] getTestCaseList(ITestContext context) {
 		String ymlFile = context.getCurrentXmlTest().getLocalParameters().get("ymlFile");
 		pathParams = context.getCurrentXmlTest().getLocalParameters().get("pathParams");
+		idKeyName = context.getCurrentXmlTest().getLocalParameters().get("idKeyName");
 		headers = context.getCurrentXmlTest().getLocalParameters().get("headers");
 		logger.info("Started executing yml: " + ymlFile);
 		return getYmlTestData(ymlFile);
@@ -135,6 +137,10 @@ public void test(TestCaseDTO testCaseDTO) throws AuthenticationTestException, Ad
 			if (!OutputValidationUtil.publishOutputResult(ouputValid))
 				throw new AdminTestException("Failed at output validation");
 		}
+
+		if (testCaseName.toLowerCase().contains("_sid")) {
+			writeAutoGeneratedId(response, idKeyName, testCaseName);
+		}
 
 	}
 

api-test/src/main/resources/esignet/AuditLog/AuditLog.yml

@@ -0,0 +1,16 @@
+addContact:
+  Esignet_AddContact_All_Valid_Smoke:
+    endPoint: SELECT module_name,cr_by FROM audit.app_audit_log where module_name LIKE 'esignet%' order by action_dtimes desc LIMIT 5
+    uniqueIdentifier: TC_Esignet_addContact_01
+    description: Validate that a contact is successfully added when all input parameters are valid
+    role: audit
+    templateFields: ["partnerQuery","partner service"]
+    restMethod: post
+    inputTemplate: esignet/AuditLog/auditlog
+    outputTemplate: esignet/AuditLog/AuditLogResult
+    input: '{
+  }'
+    output: '{
+      "module_name": "esignet-service"
+      "cr_by": "111997"
+   }'

api-test/src/main/resources/esignet/AuditLog/AuditLogResult.hbs

@@ -0,0 +1,4 @@
+{
+   "module_name": "{{module_name}}",
+   "cr_by": "{{cr_by}}"
+}

api-test/src/main/resources/esignet/AuditLog/auditlog.hbs

@@ -0,0 +1,2 @@
+{
+}

api-test/src/main/resources/esignet/DBValidatorAndAuditValidator/DBValidatorTest.hbs

@@ -0,0 +1,6 @@
+{
+  {{#each this}}
+    "{{@key}}": "{{this}}"
+    {{#unless @last}},{{/unless}}
+  {{/each}}
+}

api-test/src/main/resources/esignet/DBValidatorAndAuditValidator/DBValidatorTest.yml

@@ -0,0 +1,42 @@
+DBValidator:
+  Esignet_DBValidator_All_Valid_Smoke_data_created_for_OIDCClient:
+    endPoint: SELECT * FROM pms.oidc_client where
+    uniqueIdentifier: TC_Esignet_DBValidator_01
+    description: Validate that data created for OIDCClient is correctly stored and consistent in the pms database
+    role: partner
+    restMethod: post
+    inputTemplate: esignet/DBValidatorAndAuditValidator/DBValidatorTest
+    outputTemplate: esignet/DBValidatorAndAuditValidator/DBValidatorTestResult
+    input: '{
+      "id": "$ID:CreateOIDCClient_all_Valid_Smoke_sid_clientId$"
+    }'
+    output: '{
+    }'
+
+  Esignet_DBValidator_All_Valid_Smoke_data_created_for_OIDCClient_Client_detail:
+    endPoint: SELECT * FROM esignet.client_detail where
+    uniqueIdentifier: TC_Esignet_DBValidator_02
+    description: Validate that data created for OIDCClient client details is correctly stored and consistent in the esignet database
+    role: partner
+    restMethod: post
+    inputTemplate: esignet/DBValidatorAndAuditValidator/DBValidatorTest
+    outputTemplate: esignet/DBValidatorAndAuditValidator/DBValidatorTestResult
+    input: '{
+      "id": "$ID:CreateOIDCClient_all_Valid_Smoke_sid_clientId$"
+    }'
+    output: '{
+    }'
+
+  Esignet_DBValidator_All_Valid_Smoke_data_created_for_OIDCClient_Using_IDA:
+    endPoint: SELECT * FROM ida.oidc_client_data where
+    uniqueIdentifier: TC_Esignet_DBValidator_03
+    description: Validate that data created for OIDCClient client details is correctly stored and consistent in the ida database
+    role: partner
+    restMethod: post
+    inputTemplate: esignet/DBValidatorAndAuditValidator/DBValidatorTest
+    outputTemplate: esignet/DBValidatorAndAuditValidator/DBValidatorTestResult
+    input: '{
+      "oidc_client_id": "$ID:CreateOIDCClient_all_Valid_Smoke_sid_clientId$"
+    }'
+    output: '{
+    }'

api-test/src/main/resources/esignet/DBValidatorAndAuditValidator/DBValidatorTestResult.hbs

@@ -0,0 +1,2 @@
+{
+}