Separate UI physically from service layer (#118)

The UI transmits now a JobDescription when a diagnosis should be
performed, so the server creates necessary configuration files for DS to
run (identical to those locally configured on the client-side before)
using this data. The results are only saved on the server side now. The
configuration files and results are saved on a per job-id basis, so that
(not implemented yet) the client can request the results later via DS
service using the job id that was used to trigger the diagnosis run.

Change-Id: I990cc93a2851726dead0d33e2f1a935ddd5c46ad
Signed-off-by: Denis Knoepfle <denis.knoepfle@sap.com>

Author: DenisKnoepfle

org.spotter.client/src/org/spotter/client/SpotterServiceClient.java

@@ -22,6 +22,7 @@
 import org.lpe.common.config.ConfigParameterDescription;
 import org.lpe.common.util.web.LpeWebUtils;
 import org.spotter.shared.configuration.ConfigKeys;
+import org.spotter.shared.configuration.JobDescription;
 import org.spotter.shared.configuration.SpotterExtensionType;
 import org.spotter.shared.hierarchy.model.XPerformanceProblem;
 import org.spotter.shared.service.SpotterServiceResponse;
@@ -73,15 +74,15 @@ public void updateUrl(String host, String port) {
 	/**
 	 * Executes diagnostics process.
 	 * 
-	 * @param configurationFile
-	 *            path to the configuration file
-	 * @return job id for the started diagnosis task,
+	 * @param jobDescription
+	 *            the job description to use
+	 * @return job id for the started diagnosis task
 	 */
-	public long startDiagnosis(String configurationFile) {
+	public long startDiagnosis(JobDescription jobDescription) {
 		SpotterServiceResponse<Long> response = webResource.path(ConfigKeys.SPOTTER_REST_BASE)
 				.path(ConfigKeys.SPOTTER_REST_START_DIAG).type(MediaType.APPLICATION_JSON)
 				.accept(MediaType.APPLICATION_JSON).post(new GenericType<SpotterServiceResponse<Long>>() {
-				}, configurationFile);
+				}, jobDescription);
 
 		switch (response.getStatus()) {
 		case INVALID_STATE:

org.spotter.eclipse.ui/src/org/spotter/eclipse/ui/ServiceClientWrapper.java

@@ -31,6 +31,7 @@
 import org.spotter.eclipse.ui.model.ExtensionMetaobject;
 import org.spotter.eclipse.ui.util.DialogUtils;
 import org.spotter.eclipse.ui.util.SpotterProjectSupport;
+import org.spotter.shared.configuration.JobDescription;
 import org.spotter.shared.configuration.SpotterExtensionType;
 import org.spotter.shared.hierarchy.model.RawHierarchyFactory;
 import org.spotter.shared.hierarchy.model.XPerformanceProblem;
@@ -222,17 +223,17 @@ public boolean saveServiceClientSettings(String newHost, String newPort) {
 	}
 
 	/**
-	 * Starts the diagnosis using the given configuration file. Returns the
+	 * Starts the diagnosis using the given job description. Returns the
 	 * retrieved job id or <code>null</code> on failure.
 	 * 
-	 * @param configurationFile
-	 *            The configuration file to use.
+	 * @param jobDescription
+	 *            The job description to use.
 	 * @return The retrieved job id or <code>null</code> on failure.
 	 */
-	public Long startDiagnosis(final String configurationFile) {
+	public Long startDiagnosis(final JobDescription jobDescription) {
 		lastException = null;
 		try {
-			return client.startDiagnosis(configurationFile);
+			return client.startDiagnosis(jobDescription);
 		} catch (Exception e) {
 			handleException("startDiagnosis", MSG_START_DIAGNOSIS, e, false, false);
 		}

org.spotter.eclipse.ui/src/org/spotter/eclipse/ui/handlers/RunHandler.java

@@ -15,6 +15,7 @@
  */
 package org.spotter.eclipse.ui.handlers;
 
+import java.util.Properties;
 import java.util.Set;
 
 import org.eclipse.core.commands.AbstractHandler;
@@ -24,9 +25,16 @@
 import org.eclipse.core.resources.IProject;
 import org.spotter.eclipse.ui.Activator;
 import org.spotter.eclipse.ui.ServiceClientWrapper;
+import org.spotter.eclipse.ui.UICoreException;
 import org.spotter.eclipse.ui.jobs.DynamicSpotterRunJob;
+import org.spotter.eclipse.ui.model.xml.HierarchyFactory;
+import org.spotter.eclipse.ui.model.xml.MeasurementEnvironmentFactory;
 import org.spotter.eclipse.ui.util.DialogUtils;
+import org.spotter.eclipse.ui.util.SpotterProjectSupport;
 import org.spotter.shared.configuration.FileManager;
+import org.spotter.shared.configuration.JobDescription;
+import org.spotter.shared.environment.model.XMeasurementEnvironment;
+import org.spotter.shared.hierarchy.model.XPerformanceProblem;
 
 /**
  * A run handler for the DynamicSpotter run command which starts the
@@ -83,7 +91,7 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 		boolean startConfirm = DialogUtils.openConfirm(DIALOG_TITLE,
 				String.format(MSG_SPOTTER_STARTED, project.getName()));
 		if (startConfirm) {
-			startSpotterRun(project, client, spotterFilePath);
+			startSpotterRun(project, client);
 		}
 		return null;
 	}
@@ -93,8 +101,16 @@ public boolean isEnabled() {
 		return Activator.getDefault().getSelectedProjects().size() == 1;
 	}
 
-	private void startSpotterRun(IProject project, ServiceClientWrapper client, String spotterConfigPath) {
-		Long jobId = client.startDiagnosis(spotterConfigPath);
+	private void startSpotterRun(IProject project, ServiceClientWrapper client) {
+		JobDescription jobDescription;
+		try {
+			jobDescription = createJobDescription(project);
+		} catch (UICoreException e) {
+			String msg = "Unable to read and parse all configuration files!";
+			DialogUtils.openError(DIALOG_TITLE, DialogUtils.appendCause(msg, e.getMessage()));
+			return;
+		}
+		Long jobId = client.startDiagnosis(jobDescription);
 		if (jobId != null && jobId != 0) {
 			DynamicSpotterRunJob job = new DynamicSpotterRunJob(project, jobId);
 			job.schedule();
@@ -104,4 +120,24 @@ private void startSpotterRun(IProject project, ServiceClientWrapper client, Stri
 		}
 	}
 
+	private JobDescription createJobDescription(IProject project) throws UICoreException {
+		JobDescription jobDescription = new JobDescription();
+
+		IFile spotterFile = project.getFile(FileManager.SPOTTER_CONFIG_FILENAME);
+		Properties dynamicSpotterConfig = SpotterProjectSupport.getSpotterConfig(spotterFile);
+		jobDescription.setDynamicSpotterConfig(dynamicSpotterConfig);
+
+		MeasurementEnvironmentFactory envFactory = MeasurementEnvironmentFactory.getInstance();
+		String envFile = project.getFile(FileManager.ENVIRONMENT_FILENAME).getLocation().toString();
+		XMeasurementEnvironment measurementEnvironment = envFactory.parseXMLFile(envFile);
+		jobDescription.setMeasurementEnvironment(measurementEnvironment);
+
+		HierarchyFactory hierFactory = HierarchyFactory.getInstance();
+		String hierFile = project.getFile(FileManager.HIERARCHY_FILENAME).getLocation().toString();
+		XPerformanceProblem hierarchy = hierFactory.parseHierarchyFile(hierFile);
+		jobDescription.setHierarchy(hierarchy);
+
+		return jobDescription;
+	}
+
 }

org.spotter.service/.gitignore

@@ -10,4 +10,5 @@
 dependency-reduced-pom.xml
 default-hierarchy.xml
 /plugins
+/runtime-diagnosis
 /pom.xml.versionsBackup

org.spotter.service/src/org/spotter/service/SpotterServiceWrapper.java

@@ -15,6 +15,7 @@
  */
 package org.spotter.service;
 
+import java.io.IOException;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
@@ -23,11 +24,14 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
 
+import javax.xml.bind.JAXBException;
+
 import org.lpe.common.config.ConfigParameterDescription;
 import org.lpe.common.extension.ExtensionRegistry;
 import org.lpe.common.extension.Extensions;
 import org.lpe.common.extension.IExtension;
 import org.lpe.common.extension.IExtensionArtifact;
+import org.lpe.common.util.LpeFileUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.spotter.core.AbstractSpotterSatelliteExtension;
@@ -37,6 +41,8 @@
 import org.spotter.core.measurement.AbstractMeasurmentExtension;
 import org.spotter.core.workload.AbstractWorkloadExtension;
 import org.spotter.shared.configuration.ConfigKeys;
+import org.spotter.shared.configuration.FileManager;
+import org.spotter.shared.configuration.JobDescription;
 import org.spotter.shared.configuration.SpotterExtensionType;
 import org.spotter.shared.hierarchy.model.RawHierarchyFactory;
 import org.spotter.shared.hierarchy.model.XPerformanceProblem;
@@ -49,7 +55,20 @@
  * 
  */
 public class SpotterServiceWrapper {
+
 	private static final Logger LOGGER = LoggerFactory.getLogger(SpotterServiceWrapper.class);
+
+	/**
+	 * The path to the current working directory.
+	 */
+	private static final String WORKING_DIR = System.getProperty("user.dir").replace('\\', '/');
+
+	/**
+	 * The name of the folder where to put the configuration and results of
+	 * diagnosis runs.
+	 */
+	private static final String RUNTIME_FOLDER = "runtime-diagnosis";
+
 	private static SpotterServiceWrapper instance;
 
 	/**
@@ -74,23 +93,26 @@ public static synchronized SpotterServiceWrapper getInstance() {
 	/**
 	 * Executes diagnostics process.
 	 * 
-	 * @param configurationFile
-	 *            path to the configuration file
+	 * @param jobDescription
+	 *            job description object containing the whole DS setup such as
+	 *            config values, environment and hierarchy configuration
 	 * @return job id for the started diagnosis task, 0 if currently a diagnosis
 	 *         job is already running
 	 */
-	public synchronized long startDiagnosis(final String configurationFile) {
+	public synchronized long startDiagnosis(final JobDescription jobDescription) {
 		if (getState().equals(JobState.RUNNING)) {
 			return 0;
 		}
 		final long tempJobId = System.currentTimeMillis();
 		currentJob = tempJobId;
 		currentJobState = JobState.RUNNING;
+
 		futureObject = executor.submit(new Runnable() {
 
 			@Override
 			public void run() {
 				try {
+					String configurationFile = createDynamicSpotterConfiguration(tempJobId, jobDescription);
 					Spotter.getInstance().startDiagnosis(configurationFile, tempJobId);
 					currentJobState = JobState.FINISHED;
 				} catch (Throwable e) {
@@ -106,6 +128,26 @@ public void run() {
 		return tempJobId;
 	}
 
+	private String createDynamicSpotterConfiguration(long jobId, JobDescription jobDescription) {
+		FileManager fileManager = FileManager.getInstance();
+		String location = SpotterServiceWrapper.WORKING_DIR + "/" + SpotterServiceWrapper.RUNTIME_FOLDER + "/" + jobId;
+		LpeFileUtils.createDir(location);
+		String configurationFile = null;
+
+		try {
+			fileManager.writeEnvironmentConfig(location, jobDescription.getMeasurementEnvironment());
+			fileManager.writeHierarchyConfig(location, jobDescription.getHierarchy());
+			configurationFile = fileManager.writeSpotterConfig(location, jobDescription.getDynamicSpotterConfig());
+			LOGGER.info("Storing configuration for diagnosis run #" + jobId + " in " + location);
+		} catch (IOException | JAXBException e) {
+			String msg = "Failed to create DS configuration.";
+			LOGGER.error(msg + " Cause: {}", e.toString());
+			throw new RuntimeException(msg);
+		}
+
+		return configurationFile;
+	}
+
 	/**
 	 * Returns the current state of the last issued job.
 	 * 

org.spotter.service/src/org/spotter/service/rest/SpotterService.java

@@ -29,6 +29,7 @@
 import org.lpe.common.config.ConfigParameterDescription;
 import org.spotter.service.SpotterServiceWrapper;
 import org.spotter.shared.configuration.ConfigKeys;
+import org.spotter.shared.configuration.JobDescription;
 import org.spotter.shared.configuration.SpotterExtensionType;
 import org.spotter.shared.hierarchy.model.XPerformanceProblem;
 import org.spotter.shared.service.ResponseStatus;
@@ -49,8 +50,9 @@ public class SpotterService {
 	/**
 	 * Starts Dynamic Spotter diagnosis.
 	 * 
-	 * @param pathToConfigFile
-	 *            configuration file
+	 * @param jobDescription
+	 *            job description object containing the whole DS setup such as
+	 *            config values, environment and hierarchy configuration
 	 * @throws IOException
 	 *             thrown if experiment fails
 	 * @return job id, 0 if already running
@@ -59,9 +61,9 @@ public class SpotterService {
 	@Path(ConfigKeys.SPOTTER_REST_START_DIAG)
 	@Consumes(MediaType.APPLICATION_JSON)
 	@Produces(MediaType.APPLICATION_JSON)
-	public SpotterServiceResponse<Long> startDiagnosis(String pathToConfigFile) throws IOException {
+	public SpotterServiceResponse<Long> startDiagnosis(JobDescription jobDescription) throws IOException {
 		try {
-			long jobId = SpotterServiceWrapper.getInstance().startDiagnosis(pathToConfigFile);
+			long jobId = SpotterServiceWrapper.getInstance().startDiagnosis(jobDescription);
 			if (jobId == 0) {
 				return new SpotterServiceResponse<Long>(jobId, ResponseStatus.INVALID_STATE);
 			} else {

org.spotter.shared/src/org/spotter/shared/configuration/FileManager.java

@@ -18,11 +18,13 @@
 import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
+import java.util.HashMap;
 import java.util.Map;
 import java.util.Properties;
 
 import javax.xml.bind.JAXBException;
 
+import org.lpe.common.config.ConfigParameterDescription;
 import org.spotter.shared.environment.model.XMeasurementEnvironment;
 import org.spotter.shared.hierarchy.model.XPerformanceProblem;
 import org.spotter.shared.util.JAXBUtil;
@@ -68,10 +70,11 @@ public static synchronized FileManager getInstance() {
 	 *            the location where to place this file (without the filename)
 	 * @param properties
 	 *            the project specific properties to write
+	 * @return the filename of the created file
 	 * @throws IOException
 	 *             if an I/O error occurs
 	 */
-	public void writeSpotterConfig(String location, Properties properties) throws IOException {
+	public String writeSpotterConfig(String location, Properties properties) throws IOException {
 		Properties general = createGeneralSpotterProperties(location);
 
 		String file = stripFileSeparator(location) + "/" + FileManager.SPOTTER_CONFIG_FILENAME;
@@ -84,6 +87,8 @@ public void writeSpotterConfig(String location, Properties properties) throws IO
 				fileWriter.close();
 			}
 		}
+
+		return file;
 	}
 
 	/**
@@ -93,12 +98,14 @@ public void writeSpotterConfig(String location, Properties properties) throws IO
 	 *            the location where to place this file (without the filename)
 	 * @param environment
 	 *            the environment object to write
+	 * @return the filename of the created file
 	 * @throws JAXBException
 	 *             if a problem with the marshalling occurs
 	 */
-	public void writeEnvironmentConfig(String location, XMeasurementEnvironment environment) throws JAXBException {
+	public String writeEnvironmentConfig(String location, XMeasurementEnvironment environment) throws JAXBException {
 		String file = stripFileSeparator(location) + "/" + FileManager.ENVIRONMENT_FILENAME;
 		JAXBUtil.writeElementToFile(new File(file), environment);
+		return file;
 	}
 
 	/**
@@ -108,12 +115,14 @@ public void writeEnvironmentConfig(String location, XMeasurementEnvironment envi
 	 *            the location where to place this file (without the filename)
 	 * @param hierarchy
 	 *            the hierarchy object to write
+	 * @return the filename of the created file
 	 * @throws JAXBException
 	 *             if a problem with the marshalling occurs
 	 */
-	public void writeHierarchyConfig(String location, XPerformanceProblem hierarchy) throws JAXBException {
+	public String writeHierarchyConfig(String location, XPerformanceProblem hierarchy) throws JAXBException {
 		String file = stripFileSeparator(location) + "/" + FileManager.HIERARCHY_FILENAME;
 		JAXBUtil.writeElementToFile(new File(file), hierarchy);
+		return file;
 	}
 
 	/**
@@ -157,8 +166,12 @@ public String createSpotterConfigFileContent(Map<String, String> descriptionMapp
 		sb.append("\r\n\r\n");
 		writeHeading(sb, "SPECIFIED SETTINGS");
 
+		if (descriptionMapping == null) {
+			descriptionMapping = createDescriptionMapping();
+		}
+
 		for (String key : properties.stringPropertyNames()) {
-			String comment = descriptionMapping == null ? null : descriptionMapping.get(key);
+			String comment = descriptionMapping.get(key);
 			writeKeyValuePair(sb, properties, key, comment);
 		}
 		return sb.toString();
@@ -177,6 +190,15 @@ private void writeKeyValuePair(StringBuilder sb, Properties prop, String key, St
 		sb.append(key + " = " + prop.getProperty(key) + "\r\n");
 	}
 
+	private Map<String, String> createDescriptionMapping() {
+		Map<String, String> descriptionMapping = new HashMap<>();
+
+		for (ConfigParameterDescription desc : ConfigKeys.getSpotterConfigParamters()) {
+			descriptionMapping.put(desc.getName(), desc.getDescription());
+		}
+		return descriptionMapping;
+	}
+
 	private String stripFileSeparator(String path) {
 		if (path.endsWith("/") || path.endsWith("\\")) {
 			return path.substring(0, path.length() - 1);