com.centurylink.mdw.services.test.StandaloneTestCaseRun Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mdw-services Show documentation
Show all versions of mdw-services Show documentation
MDW is a workflow framework specializing in microservice orchestration
/*
* Copyright (C) 2017 CenturyLink, Inc.
*
* 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.
*/
package com.centurylink.mdw.services.test;
import com.centurylink.mdw.common.service.Query;
import com.centurylink.mdw.common.service.types.StatusMessage;
import com.centurylink.mdw.constant.OwnerType;
import com.centurylink.mdw.model.JsonObject;
import com.centurylink.mdw.model.Value;
import com.centurylink.mdw.model.Yamlable;
import com.centurylink.mdw.model.asset.Asset;
import com.centurylink.mdw.model.event.Event;
import com.centurylink.mdw.model.task.TaskInstance;
import com.centurylink.mdw.model.task.UserTaskAction;
import com.centurylink.mdw.model.variable.VariableInstance;
import com.centurylink.mdw.model.workflow.Package;
import com.centurylink.mdw.model.workflow.Process;
import com.centurylink.mdw.model.workflow.*;
import com.centurylink.mdw.task.types.TaskList;
import com.centurylink.mdw.test.*;
import com.centurylink.mdw.util.HttpHelper;
import com.centurylink.mdw.util.file.FileHelper;
import groovy.lang.Binding;
import groovy.lang.GroovyCodeSource;
import groovy.lang.GroovyShell;
import org.codehaus.groovy.control.CompilerConfiguration;
import org.json.JSONException;
import org.json.JSONObject;
import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.text.ParseException;
import java.util.*;
/**
* Executes a test outside of the runtime container.
* Used by Designer when debugging. Will eventually be used for all Designer runs.
* Will also be used by our upcoming Gradle custom task for test execution.
*/
public class StandaloneTestCaseRun extends TestCaseRun {
public StandaloneTestCaseRun(TestCase testCase, String user, File mainResultsDir, int run,
String masterRequestId, LogMessageMonitor monitor, Map processCache,
TestExecConfig config) throws IOException {
super(testCase, user, mainResultsDir, run, masterRequestId, monitor, processCache, config);
}
/**
* Standalone execution for Gradle.
*/
public void run() {
startExecution();
CompilerConfiguration compilerConfig = new CompilerConfiguration(System.getProperties());
compilerConfig.setScriptBaseClass(TestCaseScript.class.getName());
Binding binding = new Binding();
binding.setVariable("testCaseRun", this);
ClassLoader classLoader = this.getClass().getClassLoader();
GroovyShell shell = new GroovyShell(classLoader, binding, compilerConfig);
shell.setProperty("out", getLog());
setupContextClassLoader(shell);
try {
shell.run(new GroovyCodeSource(getTestCase().file()), new String[0]);
finishExecution(null);
}
catch (IOException ex) {
throw new RuntimeException(ex.getMessage(), ex);
}
}
@Override
void startProcess(TestCaseProcess process) throws TestException {
if (isVerbose())
getLog().println("starting process " + process.getLabel() + "...");
this.testCaseProcess = process;
try {
Process proc = process.getProcess();
Map params = process.getParams();
HttpHelper httpHelper = getHttpHelper("POST", "services/Processes/run/" + proc.getId() + "?app=autotest");
ProcessRun run = new ProcessRun();
run.setDefinitionId(proc.getId());
run.setMasterRequestId(getMasterRequestId());
run.setOwnerType(OwnerType.TESTER);
run.setOwnerId(0L);
if (params != null && !params.isEmpty()) {
Map values = new HashMap<>();
for (String name : params.keySet())
values.put(name, new Value(name, params.get(name)));
run.setValues(values);
}
String response = httpHelper.post(run.getJson().toString(2));
run = new ProcessRun(new JsonObject(response));
if (run.getInstanceId() == null)
throw new TestException("Failed to start " + process.getLabel());
else
getLog().println(process.getLabel() + " instance " + run.getInstanceId() + " started");
}
catch (Exception ex) {
throw new TestException("Failed to start " + process.getLabel(), ex);
}
}
@Override
protected List loadResults(List processes, Asset expectedResults, TestCaseProcess mainTestProc)
throws IOException, JSONException, ParseException {
List mainProcessInsts = new ArrayList<>();
Map> fullProcessInsts = new TreeMap<>();
Map fullActivityNameMap = new HashMap<>();
for (Process proc : processes) {
Query query = new Query();
query.setFilter("masterRequestId", getMasterRequestId());
query.setFilter("processId", proc.getId().toString());
query.setDescending(true);
query.setFilter("app", "autotest");
HttpHelper httpHelper = getHttpHelper("GET", "services/Processes?" + query);
String response = httpHelper.get();
ProcessList processList = new ProcessList(ProcessList.PROCESS_INSTANCES, new JsonObject(response));
List processInstances = processList.getProcesses();
Map activityNameMap = new HashMap<>();
for (Activity act : proc.getActivities()) {
activityNameMap.put(act.getId(), act.getName());
fullActivityNameMap.put(proc.getId() + "-" + act.getId(), act.getName());
}
if (proc.getSubprocesses() != null) {
for (Process subproc : proc.getSubprocesses()) {
for (Activity act : subproc.getActivities()) {
activityNameMap.put(act.getId(), act.getName());
fullActivityNameMap.put(proc.getId() + "-" + act.getId(), act.getName());
}
}
}
for (ProcessInstance procInst : processInstances) {
httpHelper = getHttpHelper("GET", "services/Processes/" + procInst.getId() + "?app=autotest");
procInst = new ProcessInstance(new JsonObject(httpHelper.get()));
mainProcessInsts.add(procInst);
List procInsts = fullProcessInsts.get(proc.getName());
if (procInsts == null)
procInsts = new ArrayList<>();
procInsts.add(procInst);
fullProcessInsts.put(proc.getName(), procInsts);
if (proc.getSubprocesses() != null) {
Query q = new Query();
q.setFilter("owner", OwnerType.MAIN_PROCESS_INSTANCE);
q.setFilter("ownerId", procInst.getId().toString());
q.setFilter("processId", proc.getId().toString());
List embeddedProcInstList;
q.setFilter("app", "autotest");
httpHelper = getHttpHelper("GET", "services/Processes?" + q);
response = httpHelper.get();
embeddedProcInstList = new ProcessList(ProcessList.PROCESS_INSTANCES, new JsonObject(response)).getProcesses();
for (ProcessInstance embeddedProcInst : embeddedProcInstList) {
httpHelper = getHttpHelper("GET", "services/Processes/" + embeddedProcInst.getId() + "?app=autotest");
ProcessInstance fullChildInfo = new ProcessInstance(new JsonObject(httpHelper.get()));
String childProcName = "unknown_subproc_name";
for (Process subproc : proc.getSubprocesses()) {
if (subproc.getId().toString().equals(embeddedProcInst.getComment())) {
childProcName = subproc.getName();
if (!childProcName.startsWith(proc.getName()))
childProcName = proc.getName() + " " + childProcName;
break;
}
}
List pis = fullProcessInsts.get(childProcName);
if (pis == null)
pis = new ArrayList<>();
pis.add(fullChildInfo);
fullProcessInsts.put(childProcName, pis);
}
}
}
}
String newLine = "\n";
if (!isCreateReplace()) {
if (expectedResults == null || expectedResults.getFile() == null || !expectedResults.getFile().exists()) {
throw new IOException("Expected results file not found for " + getTestCase().getPath());
}
else {
// try to determine newline chars from expectedResultsFile
if (expectedResults.getText().contains("\r\n"))
newLine = "\r\n";
}
}
String yaml = translateToYaml(fullProcessInsts, fullActivityNameMap, mainTestProc, newLine);
if (isCreateReplace()) {
getLog().println("creating expected results: " + expectedResults.getFile());
FileHelper.writeToFile(expectedResults.getFile().toString(), yaml, false);
expectedResults.setText(yaml);
}
String fileName = getResultsDir() + "/" + expectedResults.getName();
if (isVerbose())
getLog().println("creating actual results file: " + fileName);
FileHelper.writeToFile(fileName, yaml, false);
// set friendly statuses
for (ProcessInstance pi : mainProcessInsts)
pi.setStatus(WorkStatuses.getWorkStatuses().get(pi.getStatusCode()));
return mainProcessInsts;
}
@Override
protected String getStringValue(VariableInstance var, Package pkg) throws TestException {
String val = var.getStringValue(pkg);
if (val != null && val.startsWith("DOCUMENT:")) {
try {
HttpHelper httpHelper = getHttpHelper("GET", "services/Processes/" + var.getProcessInstanceId() + "/values/" + var.getName());
Value value = new Value(var.getName(), new JsonObject(httpHelper.get()));
return value.getValue();
}
catch (Exception ex) {
throw new TestException(ex.getMessage(), ex);
}
}
return val;
}
@Override
Process getProcess(String target) throws TestException {
target = qualify(target);
Process process = getProcessCache().get(target);
if (process == null) {
try {
Query query = getProcessQuery(target);
HttpHelper httpHelper = getHttpHelper("GET", "services/Workflow/" + query);
String response = httpHelper.get();
process = Process.fromString(response);
Long id = null;
if (response.startsWith("{")) {
JSONObject json = new JSONObject(response);
if (json.has("id"))
id = json.getLong("id");
if (json.has("package"))
process.setPackageName(json.getString("package"));
}
else {
Map yaml = Yamlable.fromString(response);
if (yaml.containsKey("id"))
id = Long.getLong(yaml.get("id").toString());
if (yaml.containsKey("package"))
process.setPackageName(yaml.get("package").toString());
}
if (id == null)
throw new TestException("Missing process id");
process.setId(id);
getProcessCache().put(target, process);
}
catch (TestException ex) {
throw ex;
}
catch (Exception ex) {
throw new TestException("Cannot load " + target, ex);
}
}
return process;
}
@Override
void performTaskAction(TestCaseTask task) throws TestException {
if (isVerbose())
getLog().println("performing " + task.getOutcome() + " on task '" + task.getName() + "'");
try {
Query query = getTaskQuery(task.getName());
HttpHelper httpHelper = getHttpHelper("GET", "services/Tasks/" + query);
String response = httpHelper.get();
TaskList taskList = new TaskList(TaskList.TASKS, new JsonObject(response));
List taskInstances = taskList.getTasks();
if (taskInstances.isEmpty())
throw new TestException("Cannot find task instances: " + query);
TaskInstance taskInstance = taskInstances.get(0); // latest
task.setId(taskInstance.getTaskInstanceId());
UserTaskAction taskAction = new UserTaskAction();
taskAction.setTaskAction(task.getOutcome());
taskAction.setUser(getUser());
taskAction.setTaskInstanceId(task.getId());
if (task.getVariables() != null) {
JSONObject valuesJson = new JsonObject();
for (String name : task.getVariables().keySet())
valuesJson.put(name, task.getVariables().get(name).toString());
httpHelper = getHttpHelper("PUT", "services/Processes/" + taskInstance.getOwnerId() + "/values?app=autotest");
response = httpHelper.put(valuesJson.toString(2));
StatusMessage statusMsg = new StatusMessage(new JsonObject(response));
if (!statusMsg.isSuccess())
throw new TestException("Error updating task values: " + statusMsg.getMessage());
}
httpHelper = getHttpHelper("POST", "services/Tasks/" + task.getOutcome() + "?app=autotest");
response = httpHelper.post(taskAction.getJson().toString(2));
StatusMessage statusMsg = new StatusMessage(new JsonObject(response));
if (!statusMsg.isSuccess())
throw new TestException("Error actioning task: " + task.getId() + ": " + statusMsg.getMessage());
}
catch (TestException ex) {
throw ex;
}
catch (Exception ex) {
throw new TestException("Error actioning task: " + task.getId(), ex);
}
}
@Override
void notifyEvent(TestCaseEvent event) throws TestException {
if (isVerbose())
getLog().println("notifying event: '" + event.getId() + "'");
try {
Event evt = new Event();
evt.setId(event.getId());
evt.setMessage(event.getMessage());
HttpHelper httpHelper = getHttpHelper("POST", "services/Events/" + event.getId() + "?app=autotest");
String response = httpHelper.post(evt.getJson().toString(2));
StatusMessage statusMsg = new StatusMessage(new JsonObject(response));
if (!statusMsg.isSuccess())
throw new TestException("Error notifying event: " + statusMsg.getMessage());
}
catch (Exception ex) {
throw new TestException("Unable to notifyEvent: " + ex.getMessage());
}
}
@Override
protected HttpHelper getHttpHelper(String method, String endpoint, String user, String password) throws MalformedURLException {
String url = endpoint;
if (!endpoint.startsWith("http://") && !endpoint.startsWith("https://")) {
url = getConfig().getServerUrl();
if (!endpoint.startsWith("/"))
endpoint = "/" + endpoint;
url += endpoint;
}
HttpHelper helper = new HttpHelper(new URL(url), user, password);
helper.getConnection().setHeader("Content-Type", "application/json");
return helper;
}
// GROOVY-6771
@SuppressWarnings("unchecked")
private static void setupContextClassLoader(GroovyShell shell) {
final Thread current = Thread.currentThread();
@SuppressWarnings("rawtypes")
class DoSetContext implements PrivilegedAction {
ClassLoader classLoader;
public DoSetContext(ClassLoader loader) {
classLoader = loader;
}
public Object run() {
current.setContextClassLoader(classLoader);
return null;
}
}
AccessController.doPrivileged(new DoSetContext(shell.getClassLoader()));
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy