Merge pull request #187 from eharris/185-supportValidationAndQuickFixes

Issue #185: Add support for validation and quick fixes

Author: eharris369

dev/com.ibm.microclimate.core/plugin.properties

@@ -17,4 +17,6 @@ MICROCLIMATE_SERVER_ID=microclimate.server
 SERVER_NAME=Microclimate Server
 SERVER_DESCRIPTION=Server representing a Microclimate project
 
-LAUNCH_CONFIG_NAME=Microclimate Project
+LAUNCH_CONFIG_NAME=Microclimate Project
+
+VALIDATION_MARKER=Microclimate Problem

dev/com.ibm.microclimate.core/plugin.xml

@@ -31,5 +31,11 @@
 	</sourcePathComputer>
 </extension>
 
+  <extension point="org.eclipse.core.resources.markers"
+    id="validationMarker"
+    name="%VALIDATION_MARKER">
+    <persistent value="true"/>
+    <super type="org.eclipse.core.resources.problemmarker"/>
+  </extension>
 
 </plugin>

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/MCEclipseApplication.java

@@ -14,8 +14,16 @@
 import java.util.List;
 
 import org.eclipse.core.resources.IContainer;
+import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IMarker;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IResource;
+import org.eclipse.core.resources.ResourcesPlugin;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.IStatus;
+import org.eclipse.core.runtime.Path;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.debug.core.DebugPlugin;
@@ -38,6 +46,13 @@
 
 public class MCEclipseApplication extends MicroclimateApplication {
 
+	// Validation marker
+	public static final String MARKER_TYPE = MicroclimateCorePlugin.PLUGIN_ID + ".validationMarker";
+	public static final String CONNECTION_URL = "connectionUrl";
+	public static final String PROJECT_ID = "projectId";
+	public static final String QUICK_FIX_ID = "quickFixId";
+	public static final String QUICK_FIX_DESCRIPTION = "quickFixDescription";
+	
 	// in seconds
 	public static final int DEFAULT_DEBUG_CONNECT_TIMEOUT = 3;
 
@@ -89,7 +104,7 @@ public synchronized ILaunch getLaunch() {
 	@Override
 	public void connectDebugger() {
 		final MCEclipseApplication app = this;
-		Job job = new Job("Reconnect debugger") {
+		Job job = new Job(Messages.ReconnectDebugJob) {
 			@Override
 			protected IStatus run(IProgressMonitor monitor) {
 				try {
@@ -152,4 +167,53 @@ public void dispose() {
 		super.dispose();
 	}
 
+	@Override
+	public void resetValidation() {
+		IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(name);
+		try {
+			project.deleteMarkers(MARKER_TYPE, true, IResource.DEPTH_INFINITE);
+		} catch (CoreException e) {
+			MCLogger.logError("Failed to delete existing markers for the " + name + " project.", e);
+		}
+	}
+	
+	@Override
+	public void validationError(String filePath, String message, String quickFixId, String quickFixDescription) {
+		validationEvent(IMarker.SEVERITY_ERROR, filePath, message, quickFixId, quickFixDescription);
+	}
+	
+	@Override
+	public void validationWarning(String filePath, String message, String quickFixId, String quickFixDescription) {
+		validationEvent(IMarker.SEVERITY_WARNING, filePath, message, quickFixId, quickFixDescription);
+	}
+	
+    private void validationEvent(int severity, String filePath, String message, String quickFixId, String quickFixDescription) {
+        try {
+        	IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(name);
+        	IResource resource = project;
+        	if (filePath != null && !filePath.isEmpty()) {
+	        	IPath path = new Path(filePath);
+	        	if (filePath.startsWith(project.getName())) {
+	        		path = path.removeFirstSegments(1);
+	        	}
+	        	IFile file = project.getFile(path);
+	        	if (file != null && file.exists()) {
+	        		resource = file;
+	        	}
+        	}
+            final IMarker marker = resource.createMarker(MARKER_TYPE);
+            marker.setAttribute(IMarker.SEVERITY, IMarker.SEVERITY_ERROR);
+            marker.setAttribute(IMarker.LINE_NUMBER, 1);
+            marker.setAttribute(IMarker.MESSAGE, message);
+            if (quickFixId != null && !quickFixId.isEmpty()) {
+            	marker.setAttribute(CONNECTION_URL, mcConnection.baseUrl.toString());
+            	marker.setAttribute(PROJECT_ID, projectID);
+            	marker.setAttribute(QUICK_FIX_ID, quickFixId);
+            	marker.setAttribute(QUICK_FIX_DESCRIPTION, quickFixDescription);
+            }
+        } catch (CoreException e) {
+            MCLogger.logError("Failed to create a marker for the " + name + " application: " + message, e);
+        }
+    }
+    
 }

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/MicroclimateApplication.java

@@ -203,6 +203,18 @@ public void reconnectDebugger() {
 	public void dispose() {
 		// Override as needed
 	}
+	
+	public void resetValidation() {
+		// Override as needed
+	}
+	
+	public void validationError(String filePath, String message, String quickFixId, String quickFixDescription) {
+		// Override as needed
+	}
+	
+	public void validationWarning(String filePath, String message, String quickFixId, String quickFixDescription) {
+		// Override as needed
+	}
 
 	@Override
 	public String toString() {

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/connection/MicroclimateConnection.java

@@ -368,6 +368,40 @@ public void requestProjectBuild(MicroclimateApplication app, String action)
 		HttpUtil.post(url, buildPayload);
 	}
 
+	public void requestValidate(MicroclimateApplication app) throws JSONException, IOException {
+		URI url = baseUrl.resolve(MCConstants.APIPATH_VALIDATE);
+		
+		JSONObject buildPayload = new JSONObject();
+		buildPayload.put(MCConstants.KEY_PROJECT_ID, app.projectID);
+		buildPayload.put(MCConstants.KEY_PROJECT_TYPE, app.projectType.internalType);
+		
+		HttpResult result = HttpUtil.post(url, buildPayload);
+		if (!result.isGoodResponse) {
+			final String msg = String.format("Received bad response from server %d with error message %s", //$NON-NLS-1$
+					result.responseCode, result.error);
+			throw new IOException(msg);
+		}
+	}
+	
+	public void requestValidateGenerate(MicroclimateApplication app) throws JSONException, IOException {
+		URI url = baseUrl.resolve(MCConstants.APIPATH_VALIDATE_GENERATE);
+		
+		JSONObject buildPayload = new JSONObject();
+		buildPayload.put(MCConstants.KEY_PROJECT_ID, app.projectID);
+		buildPayload.put(MCConstants.KEY_PROJECT_TYPE, app.projectType.internalType);
+		buildPayload.put(MCConstants.KEY_AUTO_GENERATE, true);
+		
+		HttpResult result = HttpUtil.post(url, buildPayload);
+		if (!result.isGoodResponse) {
+			final String msg = String.format("Received bad response from server %d with error message %s", //$NON-NLS-1$
+					result.responseCode, result.error);
+			throw new IOException(msg);
+		}
+		
+		// Perform validation again to clear the errors/warnings that have been fixed
+		requestValidate(app);
+	}
+	
 	public boolean isConnected() {
 		return isConnected;
 	}

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/connection/MicroclimateSocket.java

@@ -16,6 +16,7 @@
 import java.util.Set;
 
 import org.eclipse.osgi.util.NLS;
+import org.json.JSONArray;
 import org.json.JSONException;
 import org.json.JSONObject;
 
@@ -62,7 +63,8 @@ public class MicroclimateSocket {
 			EVENT_PROJECT_RESTART = "projectRestartResult", 		//$NON-NLS-1$
 			EVENT_PROJECT_CLOSED = "projectClosed", 				//$NON-NLS-1$
 			EVENT_PROJECT_DELETION = "projectDeletion", 			//$NON-NLS-1$
-			EVENT_CONTAINER_LOGS = "container-logs";				//$NON-NLS-1$
+			EVENT_CONTAINER_LOGS = "container-logs",				//$NON-NLS-1$
+			EVENT_PROJECT_VALIDATED = "projectValidated";			//$NON-NLS-1$
 
 	public MicroclimateSocket(MicroclimateConnection mcConnection) throws URISyntaxException {
 		this.mcConnection = mcConnection;
@@ -207,6 +209,19 @@ public void call(Object... arg0) {
 					MCLogger.logError("Error parsing JSON: " + arg0[0].toString(), e); //$NON-NLS-1$
 				}
 			}
+		})
+		.on(EVENT_PROJECT_VALIDATED, new Emitter.Listener() {
+			@Override
+			public void call(Object... arg0) {
+				MCLogger.log(EVENT_PROJECT_VALIDATED + ": " + arg0[0].toString()); //$NON-NLS-1$
+
+				try {
+					JSONObject event = new JSONObject(arg0[0].toString());
+					onValidationEvent(event);
+				} catch (JSONException e) {
+					MCLogger.logError("Error parsing JSON: " + arg0[0].toString(), e); //$NON-NLS-1$
+				}
+			}
 		});
 
 		socket.connect();
@@ -388,6 +403,51 @@ private void onLogUpdate(JSONObject event) throws JSONException {
 			}
 		}
 	}
+	
+	private void onValidationEvent(JSONObject event) throws JSONException {
+		String projectID = event.getString(MCConstants.KEY_PROJECT_ID);
+		MicroclimateApplication app = mcConnection.getAppByID(projectID);
+		if (app == null) {
+			MCLogger.logError("No application found for project: " + projectID);
+			return;
+		}
+		app.resetValidation();
+		
+		String status = event.getString(MCConstants.KEY_VALIDATION_STATUS);
+		if (MCConstants.VALUE_STATUS_SUCCESS.equals(status)) {
+			// Nothing to do
+			return;
+		}
+		
+		if (event.has(MCConstants.KEY_VALIDATION_RESULTS)) {
+			JSONArray results = event.getJSONArray(MCConstants.KEY_VALIDATION_RESULTS);
+			for (int i = 0; i < results.length(); i++) {
+				JSONObject result = results.getJSONObject(i);
+				String severity = result.getString(MCConstants.KEY_SEVERITY);
+				String filename = result.getString(MCConstants.KEY_FILENAME);
+				String filepath = result.getString(MCConstants.KEY_FILEPATH);
+				String type = null;
+				if (result.has(MCConstants.KEY_TYPE)) {
+					type = result.getString(MCConstants.KEY_TYPE);
+				}
+				String details = result.getString(MCConstants.KEY_DETAILS);
+				String quickFixId = null;
+				String quickFixDescription = null;
+				if (result.has(MCConstants.KEY_QUICKFIX)) {
+					JSONObject quickFix = result.getJSONObject(MCConstants.KEY_QUICKFIX);
+					quickFixId = quickFix.getString(MCConstants.KEY_FIXID);
+					quickFixDescription = quickFix.getString(MCConstants.KEY_DESCRIPTION);
+				}
+				if (MCConstants.VALUE_SEVERITY_WARNING.equals(severity)) {
+					app.validationWarning(filepath, details, quickFixId, quickFixDescription);
+				} else {
+					app.validationError(filepath, details, quickFixId, quickFixDescription);
+				}
+			}
+		} else {
+			MCLogger.log("Validation event indicates failure but no validation results,"); //$NON-NLS-1$
+		}
+	}
 
 	boolean blockUntilFirstConnection() {
 		final int delay = 100;

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/constants/MCConstants.java

@@ -25,6 +25,8 @@ private MCConstants() {}
 			// Portal API endpoints
 			APIPATH_PROJECT_LIST = "api/v1/projects",
 			APIPATH_ENV = "api/v1/environment",
+			APIPATH_VALIDATE = "api/v1/validate",
+			APIPATH_VALIDATE_GENERATE = "api/v1/validate/generate",
 			APIPATH_RESTART = "restart",
 			APIPATH_BUILD = "build",
 			APIPATH_CLOSE = "close",
@@ -33,7 +35,7 @@ private MCConstants() {}
 			// JSON keys
 			KEY_PROJECT_ID = "projectID",
 			KEY_NAME = "name",
-			// KEY_PROJECT_TYPE = "projectType",
+			KEY_PROJECT_TYPE = "projectType",
 			KEY_BUILD_TYPE = "buildType",
 			KEY_LOC_DISK = "locOnDisk",
 			KEY_CONTEXTROOT = "contextroot",
@@ -69,6 +71,26 @@ private MCConstants() {}
 			VALUE_ACTION_BUILD = "build",
 			VALUE_ACTION_ENABLEAUTOBUILD = "enableautobuild",
 			VALUE_ACTION_DISABLEAUTOBUILD = "disableautobuild",
+			
+			KEY_VALIDATION_STATUS = "validationStatus",
+			KEY_VALIDATION_RESULTS = "validationResults",
+			KEY_SEVERITY = "severity",
+			KEY_FILENAME = "filename",
+			KEY_FILEPATH = "filepath",
+			KEY_TYPE = "type",
+			KEY_LABEL = "label",
+			KEY_DETAILS = "details",
+			KEY_QUICKFIX = "quickfix",
+			KEY_FIXID = "fixID",
+			KEY_DESCRIPTION = "description",
+			VALUE_STATUS_SUCCESS = "success",
+			VALUE_STATUS_FAILED = "failed",
+			VALUE_SEVERITY_ERROR = "error",
+			VALUE_SEVERITY_WARNING = "warning",
+			VALUE_TYPE_MISSING = "missing",
+			VALUE_TYPE_INVALID = "invalid",
+			
+			KEY_AUTO_GENERATE = "autoGenerate",
 
 			// JSON attribute values
 			REQUEST_STATUS_SUCCESS = "success"

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/messages/Messages.java

@@ -70,6 +70,7 @@ public class Messages extends NLS {
 	public static String BuildStateUnknown;
 
 	public static String DebugLaunchError;
+	public static String ReconnectDebugJob;
 
 	static {
 		// initialize resource bundle

dev/com.ibm.microclimate.core/src/com/ibm/microclimate/core/internal/messages/messages.properties

@@ -66,3 +66,4 @@ BuildStateFailed=Build failed
 BuildStateUnknown=No build status information
 
 DebugLaunchError=An error occurred trying to launch the debugger for the {0} project.
+ReconnectDebugJob=Reconnect debugger

dev/com.ibm.microclimate.ui/plugin.xml

@@ -91,6 +91,15 @@
 					</or>
 				</enablement>
 			</actionProvider>
+			<actionProvider
+				id="com.ibm.microclimate.ui.microclimateApplicationActionProvider"
+				class="com.ibm.microclimate.ui.internal.actions.MicroclimateApplicationActionProvider">
+				<enablement>
+					<or>
+						<instanceof value="com.ibm.microclimate.core.internal.MicroclimateApplication" />
+					</or>
+				</enablement>
+			</actionProvider>
 		</navigatorContent>
 	</extension>
 
@@ -228,5 +237,11 @@
 			<selection class="org.eclipse.core.resources.IResource"/>
 		</wizard>
 	</extension>
+	
+	<extension point="org.eclipse.ui.ide.markerResolution">
+		<markerResolutionGenerator
+			markerType="com.ibm.microclimate.core.validationMarker"
+			class="com.ibm.microclimate.ui.internal.marker.MicroclimateMarkerResolutionGenerator"/>
+	</extension>
 
 </plugin>