Java tutorial
package com.gatf.executor.validator; /* Copyright 2013-2014, Sumeet Chhetri Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import javax.xml.xpath.XPath; import javax.xml.xpath.XPathConstants; import javax.xml.xpath.XPathExpressionException; import javax.xml.xpath.XPathFactory; import org.apache.commons.lang3.exception.ExceptionUtils; import org.junit.Assert; import org.w3c.dom.Attr; import org.w3c.dom.Document; import org.w3c.dom.Node; import org.w3c.dom.NodeList; import com.gatf.executor.core.AcceptanceTestContext; import com.gatf.executor.core.GatfFunctionHandler; import com.gatf.executor.core.TestCase; import com.gatf.executor.core.WorkflowContextHandler.ResponseType; import com.gatf.executor.report.TestCaseReport; import com.gatf.executor.report.TestCaseReport.TestFailureReason; import com.gatf.executor.report.TestCaseReport.TestStatus; import com.ning.http.client.Response; import com.ning.http.client.cookie.Cookie; /** * @author Sumeet Chhetri * Defines contract for response level node validations after test case execution */ public abstract class ResponseValidator { protected abstract Object getInternalObject(TestCaseReport testCaseReport) throws Exception; protected abstract ResponseType getType(); protected abstract String getNodeValue(Object intObj, String node) throws Exception; protected abstract List<Map<String, String>> getResponseMappedValue(String expression, String propNames, Object nodeLst) throws Exception; protected abstract int getResponseMappedCount(String expression, Object nodeLst) throws Exception; public boolean hasValidationFunction(String node) { return node != null && node.endsWith("]") && (node.startsWith("#providerValidation[") || node.startsWith("#liveProviderValidation[") || node.startsWith("#responseHeader[") || node.startsWith("#responseCookie[")); } public void doNodeLevelValidation(String lhs, String lhsv, String oper, String rhsv, AcceptanceTestContext context, TestCase testCase, TestCaseReport testCaseReport) { if (hasValidationFunction(lhs)) { boolean isLiveProvider = lhs.startsWith("#liveProviderValidation["); boolean isResponseHeader = lhs.startsWith("#responseHeader["); boolean isResponseCookie = lhs.startsWith("#responseCookie["); String path = lhs.substring(lhs.indexOf("[") + 1, lhs.length() - 1); if (isResponseHeader) { Assert.assertTrue("Specified header not found - " + path, testCaseReport.getResHeaders() != null && testCaseReport.getResHeaders().containsKey(path)); lhsv = testCaseReport.getResHeaders().get(path).get(0); } else if (isResponseCookie) { Map<String, String> cookieMap = context.getWorkflowContextHandler().getCookies(testCase); Assert.assertTrue("Specified Cookie not found - " + path, cookieMap != null && cookieMap.containsKey(path)); lhsv = cookieMap.get(path); } else { String[] pathelements = path.split("\\."); if (pathelements.length < 3) { throw new AssertionError( "Invalid nomenclature for provider validation node, can have only 3 elements) - " + lhs); } List<Map<String, String>> provData = null; if (isLiveProvider) provData = context.getLiveProviderData(pathelements[0], testCase); else provData = context.getProviderTestDataMap().get(pathelements[0]); Assert.assertNotNull("Provider not found - " + pathelements[0], provData); int index = -1; try { index = Integer.parseInt(pathelements[1]); } catch (Exception e) { Assert.assertNotNull("Provider index has to be a number - " + pathelements[1], null); } Assert.assertTrue("Specified index is outside provider data range - " + pathelements[1], index >= 0 && index < provData.size()); Map<String, String> row = provData.get(index); Assert.assertNotNull("Provider row not found - " + index, row); Assert.assertTrue("Specified provider property not found - " + pathelements[2], row.containsKey(pathelements[2])); lhsv = row.get(pathelements[2]); } } compare(lhsv, oper, rhsv, lhs); } private void compare(String lhsv, String oper, String rhsv, String lhs) { if (oper.equals("==")) { Assert.assertEquals("Node validation failed for " + lhs, lhsv, rhsv); } else if (oper.equals("<")) { Assert.assertTrue("Node validation failed for " + lhs, lhsv.compareTo(rhsv) == -1); } else if (oper.equals(">")) { Assert.assertTrue("Node validation failed for " + lhs, lhsv.compareTo(rhsv) == 1); } else if (oper.equals("<=")) { Assert.assertTrue("Node validation failed for " + lhs, lhsv.compareTo(rhsv) == -1 || lhsv.compareTo(rhsv) == 0); } else if (oper.equals(">=")) { Assert.assertTrue("Node validation failed for " + lhs, lhsv.compareTo(rhsv) == 1 || lhsv.compareTo(rhsv) == 0); } else if (oper.equals("!=")) { Assert.assertTrue("Node validation failed for " + lhs, !lhsv.equals(rhsv)); } else if (oper.equals("regex")) { Assert.assertTrue("Regex validation failed for " + lhs, lhsv.matches(rhsv)); } else if (oper.equals("startswith")) { Assert.assertTrue("Node validation failed for " + lhs, lhsv.startsWith(rhsv)); } else if (oper.equals("endswith")) { Assert.assertTrue("Node validation failed for " + lhs, lhsv.endsWith(rhsv)); } else if (oper.equals("contains")) { Assert.assertTrue("Node validation failed for " + lhs, lhsv.contains(rhsv)); } } public List<String> getNodeProperties(String node) { List<String> nodeProps = new ArrayList<String>(); if (node.indexOf(",") != -1) { nodeProps.add(node.substring(0, node.indexOf(",")));//The attributeName or validation function node = node.substring(node.indexOf(",") + 1); if (node.indexOf(",") != -1) { nodeProps.add(node.substring(0, node.indexOf(",")));//The value to compare or the comprarison function node = node.substring(node.indexOf(",") + 1); if (node.indexOf(",") != -1) { nodeProps.add(node.substring(0, node.indexOf(",")));//The value to compare node = node.substring(node.indexOf(",") + 1); } else nodeProps.add(node);//The value to compare } else nodeProps.add(node);//The value to compare } else { nodeProps.add(node);//The attributeName } Assert.assertTrue("Invalid node properties specified", nodeProps.size() <= 3); if (nodeProps.size() == 3) { Assert.assertTrue("Invalid comparison operator specified, only one of (<, >, <=, >= , =, !=, " + "regex, startswith, endswith, contains) allowed", isValidOperator(nodeProps.get(1))); } return nodeProps; } private boolean isValidOperator(String oper) { return oper.equals("<") || oper.equals(">") || oper.equals("<=") || oper.equals(">=") || oper.equals("==") || oper.equals("!=") || oper.equals("regex") || oper.equals("startswith") || oper.equals("endswith") || oper.equals("contains"); } public static String getXMLNodeValue(Node node) { String xmlValue = null; if (node.getNodeType() == Node.TEXT_NODE || node.getNodeType() == Node.CDATA_SECTION_NODE) { xmlValue = node.getNodeValue(); } else if (node.getNodeType() == Node.ATTRIBUTE_NODE) { xmlValue = ((Attr) node).getValue(); } else if (node.getNodeType() == Node.ELEMENT_NODE && node.getChildNodes().getLength() >= 1 && (node.getFirstChild().getNodeType() == Node.TEXT_NODE || node.getFirstChild().getNodeType() == Node.CDATA_SECTION_NODE)) { xmlValue = node.getFirstChild().getNodeValue(); } return xmlValue; } public NodeList getNodeByXpath(String xpathStr, Document xmlDocument, String messagePrefix) throws XPathExpressionException { if (messagePrefix == null) { messagePrefix = "Expected Node "; } String oxpathStr = xpathStr; xpathStr = xpathStr.replaceAll("\\.", "\\/"); if (xpathStr.charAt(0) != '/') xpathStr = "/" + xpathStr; XPath xPath = XPathFactory.newInstance().newXPath(); NodeList xmlNodeList = (NodeList) xPath.compile(xpathStr).evaluate(xmlDocument, XPathConstants.NODESET); Assert.assertTrue(messagePrefix + oxpathStr + " is null", xmlNodeList != null && xmlNodeList.getLength() > 0); return xmlNodeList; } public void validate(Response response, TestCase testCase, TestCaseReport testCaseReport, AcceptanceTestContext context) { try { Object intObj = getInternalObject(testCaseReport); if (intObj != null && testCase.getAexpectedNodes() != null && !testCase.getAexpectedNodes().isEmpty()) { for (String node : testCase.getAexpectedNodes()) { List<String> nodeProps = getNodeProperties(node); String nodeVal = null; if (nodeProps.size() == 1 || !hasValidationFunction(nodeProps.get(0))) { nodeVal = getNodeValue(intObj, nodeProps.get(0)); Assert.assertNotNull("Expected Node value for " + nodeProps.get(0) + " is null", nodeVal); } if (nodeProps.size() > 1) { String lhs = nodeProps.get(0); String lhsv = nodeVal; String oper = nodeProps.size() > 2 ? nodeProps.get(1) : "=="; String rhsv = nodeProps.get(nodeProps.size() - 1); doNodeLevelValidation(lhs, lhsv, oper, rhsv, context, testCase, testCaseReport); } } } if (testCase.getRepeatScenarios() == null && testCase.getRepeatScenarioProviderName() == null) { validateLogicalConditions(testCase, context, null); } extractWorkflowVariables(testCase, testCaseReport, intObj, context); List<Cookie> cookies = response.getCookies(); context.getWorkflowContextHandler().storeCookies(testCase, cookies); boolean authEnabled = testCase.isServerApiAuth() ? context.getGatfExecutorConfig().isServerLogsApiAuthEnabled() : context.getGatfExecutorConfig().isAuthEnabled(); String authUrl = testCase.isServerApiAuth() ? testCase.getUrl() : context.getGatfExecutorConfig().getAuthUrl(); String[] authExtractAuthParams = testCase.isServerApiAuth() ? context.getGatfExecutorConfig().getServerApiAuthExtractAuthParams() : context.getGatfExecutorConfig().getAuthExtractAuthParams(); if (authEnabled && authUrl.equals(testCase.getUrl())) { String identifier = null; String authext = ""; if (authExtractAuthParams[1].equalsIgnoreCase("cookie")) { authext = "cookie "; for (Cookie cookie : cookies) { if (authExtractAuthParams[0].equals(cookie.getName())) { identifier = cookie.getValue(); break; } } } else if (authExtractAuthParams[1].equalsIgnoreCase("header")) { authext = "header "; identifier = response.getHeader(authExtractAuthParams[0]); } else { authext = "response-content "; identifier = getNodeValue(intObj, authExtractAuthParams[0]); } Assert.assertNotNull( "Authentication token not found for " + authext + "(" + authExtractAuthParams[0] + ")", identifier); context.setSessionIdentifier(identifier, testCase); context.getWorkflowContextHandler().getSuiteWorkflowContext(testCase).put(authExtractAuthParams[2], identifier); Assert.assertNotNull("Authentication token is null", context.getSessionIdentifier(testCase)); } testCaseReport.setStatus(TestStatus.Success.status); } catch (AssertionError e) { testCaseReport.setStatus(TestStatus.Failed.status); testCaseReport.setFailureReason(TestFailureReason.NodeValidationFailed.status); testCaseReport.setError(e.getMessage()); testCaseReport.setErrorText(ExceptionUtils.getStackTrace(e)); if (e.getMessage() == null && testCaseReport.getErrorText() != null && testCaseReport.getErrorText().indexOf("\n") != -1) { testCaseReport.setError( testCaseReport.getErrorText().substring(0, testCaseReport.getErrorText().indexOf("\n"))); } e.printStackTrace(); } catch (Throwable e) { testCaseReport.setStatus(TestStatus.Failed.status); testCaseReport.setFailureReason(TestFailureReason.Exception.status); testCaseReport.setError(e.getMessage()); testCaseReport.setErrorText(ExceptionUtils.getStackTrace(e)); if (e.getMessage() == null && testCaseReport.getErrorText() != null && testCaseReport.getErrorText().indexOf("\n") != -1) { testCaseReport.setError( testCaseReport.getErrorText().substring(0, testCaseReport.getErrorText().indexOf("\n"))); } e.printStackTrace(); } } public static void validateLogicalConditions(TestCase testCase, AcceptanceTestContext context, Map<String, String> smap) { if (testCase.getLogicalValidations() != null && !testCase.getLogicalValidations().isEmpty()) { for (String node : testCase.getLogicalValidations()) { boolean validationResult = context.getWorkflowContextHandler().velocityValidate(testCase, node, smap, context); Assert.assertTrue("Logical Validation failed for (" + node + ")", validationResult); } } } public boolean hasWorkflowFunction(String node) { return node != null && node.endsWith("]") && (node.startsWith("#responseMappedValue[") || node.startsWith("#responseMappedCount[") || node.startsWith("#responseHeader[") || node.startsWith("#responseCookie[")); } public void extractWorkflowVariables(TestCase testCase, TestCaseReport testCaseReport, Object intObj, AcceptanceTestContext context) throws Exception { if (testCase.getWorkflowContextParameterMap() != null && !testCase.getWorkflowContextParameterMap().isEmpty()) { for (Map.Entry<String, String> entry : testCase.getWorkflowContextParameterMap().entrySet()) { String nodeName = entry.getValue().trim(); if (nodeName.startsWith("#responseHeader[") && nodeName.endsWith("]")) { String path = nodeName.substring(nodeName.indexOf("[") + 1, nodeName.length() - 1); Assert.assertTrue("Specified header not found - " + path, testCaseReport.getResHeaders() != null && testCaseReport.getResHeaders().containsKey(path)); String nodeValue = testCaseReport.getResHeaders().get(path).get(0); Assert.assertNotNull("Workflow json variable " + entry.getValue() + " is null", nodeValue); context.getWorkflowContextHandler().getSuiteWorkflowContext(testCase).put(entry.getKey(), nodeValue); } else if (nodeName.startsWith("#responseCookie[") && nodeName.endsWith("]")) { String path = nodeName.substring(nodeName.indexOf("[") + 1, nodeName.length() - 1); Map<String, String> cookieMap = context.getWorkflowContextHandler().getCookies(testCase); Assert.assertTrue("Specified Cookie not found - " + path, cookieMap != null && cookieMap.containsKey(path)); String nodeValue = cookieMap.get(path); Assert.assertNotNull("Workflow json variable " + entry.getValue() + " is null", nodeValue); context.getWorkflowContextHandler().getSuiteWorkflowContext(testCase).put(entry.getKey(), nodeValue); } else if (nodeName.startsWith("#responseMappedValue[") && nodeName.endsWith("]")) { nodeName = nodeName.substring(nodeName.indexOf("[") + 1, nodeName.length() - 1); String propNames = nodeName.substring(nodeName.indexOf(" ") + 1).trim(); String path = nodeName.substring(0, nodeName.indexOf(" ")).trim(); List<Map<String, String>> nodeValues = getResponseMappedValue(path, propNames, intObj); if (!propNames.endsWith("*")) { String[] props = propNames.split(","); for (Map<String, String> nodeV : nodeValues) { for (String propName : props) { if (!nodeV.containsKey(propName)) { nodeV.remove(propName); } } } } context.getWorkflowContextHandler().getSuiteWorkflowScnearioContext(testCase) .put(entry.getKey(), nodeValues); Assert.assertNotNull("Workflow json mapping variable " + nodeName + " is null", nodeValues); } else if (nodeName.startsWith("#responseMappedCount[") && nodeName.endsWith("]")) { nodeName = nodeName.substring(nodeName.indexOf("[") + 1, nodeName.length() - 1); int responseCount = getResponseMappedCount(nodeName, intObj); List<Map<String, String>> jsonValues = new ArrayList<Map<String, String>>(); for (int i = 0; i < responseCount; i++) { Map<String, String> row = new HashMap<String, String>(); row.put("index", (i + 1) + ""); jsonValues.add(row); } context.getWorkflowContextHandler().getSuiteWorkflowScnearioContext(testCase) .put(entry.getKey(), jsonValues); Assert.assertNotNull("Workflow json mapping variable " + entry.getValue() + " is null", jsonValues); } else if (nodeName.startsWith("#")) { String jsonValue = GatfFunctionHandler.handleFunction(nodeName.substring(1)); Assert.assertNotNull( "Workflow function " + entry.getValue() + " is not valid, only " + "one of alpha, alphanum, number, boolean, float" + " -number, +number, date(format) and date(format (-|+) value(unit)) allowed", jsonValue); context.getWorkflowContextHandler().getSuiteWorkflowContext(testCase).put(entry.getKey(), jsonValue); } else { String nodeValue = null; try { nodeValue = getNodeValue(intObj, nodeName); } catch (Exception e) { throw new AssertionError("Workflow json variable " + nodeName + " not found"); } Assert.assertNotNull("Workflow json variable " + entry.getValue() + " is null", nodeValue); context.getWorkflowContextHandler().getSuiteWorkflowContext(testCase).put(entry.getKey(), nodeValue); } } } } }