io.github.microcks.util.soapui.SoapUITestStepsRunner Maven / Gradle / Ivy
/*
* Licensed to Laurent Broudoux (the "Author") under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. Author licenses this
* file to you 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.
*/
package io.github.microcks.util.soapui;
import com.eviware.soapui.impl.support.http.HttpRequestTestStep;
import com.eviware.soapui.impl.wsdl.WsdlProject;
import com.eviware.soapui.impl.wsdl.support.http.ProxyUtils;
import com.eviware.soapui.impl.wsdl.testcase.WsdlTestCase;
import com.eviware.soapui.impl.wsdl.testcase.WsdlTestCaseRunner;
import com.eviware.soapui.impl.wsdl.teststeps.RestRequestStepResult;
import com.eviware.soapui.impl.wsdl.teststeps.WsdlTestRequestStepResult;
import com.eviware.soapui.model.testsuite.*;
import com.eviware.soapui.model.testsuite.TestStepResult;
import com.eviware.soapui.model.testsuite.TestStepResult.TestStepStatus;
import com.eviware.soapui.support.types.StringToObjectMap;
import com.eviware.soapui.support.types.StringToStringsMap;
import io.github.microcks.util.test.AbstractTestRunner;
import io.github.microcks.domain.TestReturn;
import io.github.microcks.domain.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpMethod;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map.Entry;
import java.util.Set;
/**
* This is a utility class for running Service tests using assertions defined under a corresponding SoapUI
* project. Simply build a new SoapUITestStepsRunner referencing the local path to project file and
* call runAllTestSteps() or runTestSteps() to pick only some of them.
* For now, this class only runs SoapUI test steps corresponding to Request Test Steps (either SOAP, REST or HTTP).
* @author laurent
*/
public class SoapUITestStepsRunner extends AbstractTestRunner {
/** A simple logger for diagnostic messages. */
private static Logger log = LoggerFactory.getLogger(SoapUITestStepsRunner.class);
private WsdlProject project;
/**
* Build a new SoapUITestStepsRunner for a project.
* @param projectFilePath The path to SoapUI project file
* @throws java.io.IOException if file cannot be found or accessed.
*/
public SoapUITestStepsRunner(String projectFilePath) throws IOException{
try{
project = new WsdlProject(projectFilePath);
} catch (Exception e) {
throw new IOException("SoapUI project file cannot be found or accessed");
}
}
@Override
public List runTest(Service service, Operation operation, TestResult testResult,
List requests, String endpointUrl, HttpMethod method) throws URISyntaxException, IOException {
return runOperationTestSteps(operation, testResult, endpointUrl, null);
}
@Override
public HttpMethod buildMethod(String method) {
return null;
}
/**
* Run all the Operation test steps defined into the SoapUI project and having the name
* contained into testStepNames (if not null nor empty).
* @param operation The operation to run tests for
* @param testResult TestResults that aggregate results within.
* @param endpointUrl The URL of the endpoint to use for request test steps.
* @param testStepNames A list of test step names to execute
* @return A list of TestReturn wrapper objects (one by executed test step)
*/
public List runOperationTestSteps(Operation operation, TestResult testResult, String endpointUrl, List testStepNames){
// Remember to force no proxy otherwise SoapUI will use system settings and will
// make them generally applied to everything going out through Apache Http Client
// (and maybe also JDK HttpURLConnection ?).
ProxyUtils.setProxyEnabled(false);
String operationName = operation.getName();
List results = new ArrayList();
for (TestSuite testSuite : project.getTestSuiteList()){
for (TestCase testCase : testSuite.getTestCaseList()){
// Depending on testCase type build an accurate runner.
TestCaseRunner testCaseRunner = buildTestCaseRunner(testCase);
if (testCaseRunner != null){
for (TestStep testStep : testCase.getTestStepList()){
if (testStep instanceof HttpRequestTestStep
&& testStep instanceof OperationTestStep
&& (testStepNames == null || testStepNames.contains(testStep.getName()))){
log.debug("Looking up for testStep for operation '{}'", operationName);
if (operationName.equals( ((OperationTestStep)testStep).getOperation().getName() )) {
log.debug("Picking up step '{}' for running SoapUI test", testStep.getName());
// Set the endpointUrl using this common interface for Soap and Rest requests.
((HttpRequestTestStep) testStep).getHttpRequest().setEndpoint(endpointUrl);
// Add or override existing headers with test specific ones for operation and globals.
if (testResult.getOperationsHeaders() != null) {
Set headers = new HashSet<>();
if (testResult.getOperationsHeaders().getGlobals() != null) {
headers.addAll(testResult.getOperationsHeaders().getGlobals());
}
if (testResult.getOperationsHeaders().get(operationName) != null) {
headers.addAll(testResult.getOperationsHeaders().get(operationName));
}
if (headers.size() > 0) {
StringToStringsMap headersMap = new StringToStringsMap();
for (Header header : headers) {
headersMap.put(header.getName(), new ArrayList<>(header.getValues()));
}
((HttpRequestTestStep) testStep).getHttpRequest().setRequestHeaders(headersMap);
}
}
// Running tests also checks linked assertions.
TestStepResult result = testStep.run(testCaseRunner, testCaseRunner.getRunContext());
log.debug("SoapUI test result is " + result.getStatus());
results.add(extractTestReturn(testStep.getName(), result));
}
}
}
}
}
}
return results;
}
/** */
private TestCaseRunner buildTestCaseRunner(TestCase testCase){
if (testCase instanceof WsdlTestCase){
return new WsdlTestCaseRunner((WsdlTestCase)testCase, new StringToObjectMap());
}
return null;
}
/** */
private TestReturn extractTestReturn(String testStepName, TestStepResult result){
int code = TestReturn.FAILURE_CODE;
if (result.getStatus() == TestStepStatus.OK){
code = TestReturn.SUCCESS_CODE;
}
String message = null;
// Re-build request and response.
Request request = new Request();
request.setName(testStepName);
Response response = new Response();
// SoapUI step result class do not implement a common interface...
if (result instanceof WsdlTestRequestStepResult){
WsdlTestRequestStepResult wtrsr = (WsdlTestRequestStepResult)result;
request.setContent(wtrsr.getRequestContent());
request.setHeaders(buildHeaders(wtrsr.getRequestHeaders()));
response.setContent(wtrsr.getResponseContent());
response.setHeaders(buildHeaders(wtrsr.getResponseHeaders()));
message = buildConsolidatedMessage(wtrsr.getMessages());
}
if (result instanceof RestRequestStepResult){
RestRequestStepResult rrsr = (RestRequestStepResult)result;
request.setContent(rrsr.getRequestContent());
request.setHeaders(buildHeaders(rrsr.getRequestHeaders()));
response.setContent(rrsr.getResponseContent());
response.setHeaders(buildHeaders(rrsr.getResponseHeaders()));
message = buildConsolidatedMessage(rrsr.getMessages());
// Status may also be unknown if no assertion is present within a Rest request
// test step (see https://code.google.com/p/soap-ui-haufe/source/browse/branches/vit/src/java/com/eviware/soapui/impl/wsdl/teststeps/RestTestRequestStep.java?r=19#893)
// or if endpoint is not reached. Consider 404 as a failure in our case.
if (result.getStatus() == TestStepStatus.UNKNOWN){
if (rrsr.getResponse().getStatusCode() == 404){
code = TestReturn.FAILURE_CODE;
} else {
code = TestReturn.SUCCESS_CODE;
}
}
}
return new TestReturn(code, result.getTimeTaken(), message, request, response);
}
/** */
private Set buildHeaders(StringToStringsMap headers){
if (headers != null && headers.size() > 0){
Set results = new HashSet<>();
for (Entry> entry : headers.entrySet()){
Header header = new Header();
header.setName(entry.getKey());
header.setValues(new HashSet<>(entry.getValue()));
results.add(header);
}
return results;
}
return null;
}
/** */
private String buildConsolidatedMessage(String[] messages){
if (messages == null){
return null;
}
// Else build a consolidation by adding line delimiters.
StringBuilder result = new StringBuilder();
for (String message : messages){
result.append(message);
result.append("
").append(" ================ ").append("
");
}
return result.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy