Issue #165: Support opening shell into application container

Author: eharris369

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

@@ -64,9 +64,9 @@ public class MCEclipseApplication extends MicroclimateApplication {
 	private ILaunch launch = null;
 
 	MCEclipseApplication(MicroclimateConnection mcConnection,
-			String id, String name, ProjectType projectType, String pathInWorkspace, String contextRoot)
+			String id, String name, ProjectType projectType, String pathInWorkspace, String containerId, String contextRoot)
 					throws MalformedURLException {
-		super(mcConnection, id, name, projectType, pathInWorkspace, contextRoot);
+		super(mcConnection, id, name, projectType, pathInWorkspace, containerId, contextRoot);
 	}
 
 	public synchronized boolean hasAppConsole() {

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

@@ -30,6 +30,7 @@ public class MicroclimateApplication {
 	public final String contextRoot;	// can be null
 	public final IPath fullLocalPath;
 	public final ProjectType projectType;
+	public final String containerId;
 
 	private StartMode startMode;
 	private AppState appState;
@@ -46,13 +47,14 @@ public class MicroclimateApplication {
 	private int httpPort = -1, debugPort = -1;
 
 	MicroclimateApplication(MicroclimateConnection mcConnection,
-			String id, String name, ProjectType projectType, String pathInWorkspace, String contextRoot)
+			String id, String name, ProjectType projectType, String pathInWorkspace, String containerId, String contextRoot)
 					throws MalformedURLException {
 
 		this.mcConnection = mcConnection;
 		this.projectID = id;
 		this.name = name;
 		this.projectType = projectType;
+		this.containerId = containerId;
 		this.contextRoot = contextRoot;
 		this.host = mcConnection.baseUrl.getHost();
 

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

@@ -89,13 +89,15 @@ public static MicroclimateApplication createApp(MicroclimateConnection mcConnect
 			}
 
 			String loc = appJso.getString(MCConstants.KEY_LOC_DISK);
+			
+			String containerId = appJso.getString(MCConstants.KEY_CONTAINER_ID);
 
 			String contextRoot = null;
 			if(appJso.has(MCConstants.KEY_CONTEXTROOT)) {
 				contextRoot = appJso.getString(MCConstants.KEY_CONTEXTROOT);
 			}
 
-			MicroclimateApplication mcApp = MicroclimateObjectFactory.createMicroclimateApplication(mcConnection, id, name, type, loc, contextRoot);
+			MicroclimateApplication mcApp = MicroclimateObjectFactory.createMicroclimateApplication(mcConnection, id, name, type, loc, containerId, contextRoot);
 
 			updateApp(mcApp, appJso);
 			return mcApp;

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

@@ -21,8 +21,8 @@ public static MicroclimateConnection createMicroclimateConnection(URI uri) throw
 	}
 
 	public static MicroclimateApplication createMicroclimateApplication(MicroclimateConnection mcConnection,
-			String id, String name, ProjectType projectType, String pathInWorkspace, String contextRoot) throws Exception {
-		return new MCEclipseApplication(mcConnection, id, name, projectType, pathInWorkspace, contextRoot);
+			String id, String name, ProjectType projectType, String pathInWorkspace, String containerId, String contextRoot) throws Exception {
+		return new MCEclipseApplication(mcConnection, id, name, projectType, pathInWorkspace, containerId, contextRoot);
 	}
 
 }

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

@@ -39,6 +39,7 @@ private MCConstants() {}
 			KEY_BUILD_TYPE = "buildType",
 			KEY_LOC_DISK = "locOnDisk",
 			KEY_CONTEXTROOT = "contextroot",
+			KEY_CONTAINER_ID = "containerId",
 
 			KEY_BUILD_LOG = "build-log",
 			KEY_BUILD_LOG_LAST_MODIFIED = "build-log-last-modified",

dev/com.ibm.microclimate.ui/META-INF/MANIFEST.MF

@@ -18,6 +18,9 @@ Require-Bundle: org.eclipse.ui,
 Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Automatic-Module-Name: com.ibm.microclimate.ui;singleton:=true
 Bundle-ActivationPolicy: lazy
-Import-Package: org.eclipse.ui.console,
+Import-Package: org.eclipse.tm.terminal.view.core.interfaces.constants,
+ org.eclipse.tm.terminal.view.ui.interfaces,
+ org.eclipse.tm.terminal.view.ui.launcher,
+ org.eclipse.ui.console,
  org.eclipse.ui.navigator,
  org.eclipse.ui.internal.wizards.datatransfer

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

@@ -16,6 +16,7 @@ Bundle-Name = Microclimate UI Plugin
 ACTION_REMOVE_CONNECTION=&Remove Connection
 
 ACTION_OPEN_APP=&Open Application
+ACTION_CONTAINER_SHELL=Open &container shell
 ACTION_START_BUILD=Start &Build
 ACTION_IMPORT_PROJECT=&Import Project
 ACTION_SHOW_APP_CONSOLE=&Show App Console

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

@@ -114,6 +114,12 @@
 				icon="%IMPORT_ICON_PATH"
 				label="%ACTION_IMPORT_PROJECT"
 				class="com.ibm.microclimate.ui.internal.actions.ImportProjectAction"/>
+			<action
+				id="com.ibm.microclimate.ui.containerShell"
+				enablesFor="1"
+				menubarPath="group.open"
+				label="%ACTION_CONTAINER_SHELL"
+				class="com.ibm.microclimate.ui.internal.actions.ContainerShellAction"/>
 			<action
 				id="com.ibm.microclimate.ui.openApplication"
 				enablesFor="1"

dev/com.ibm.microclimate.ui/src/com/ibm/microclimate/ui/internal/actions/ContainerShellAction.java

@@ -0,0 +1,91 @@
+/*******************************************************************************
+ * IBM Confidential
+ * OCO Source Materials
+ * (C) Copyright IBM Corp. 2018 All Rights Reserved.
+ * The source code for this program is not published or otherwise
+ * divested of its trade secrets, irrespective of what has
+ * been deposited with the U.S. Copyright Office.
+ *******************************************************************************/
+
+package com.ibm.microclimate.ui.internal.actions;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.eclipse.jface.action.IAction;
+import org.eclipse.jface.viewers.ISelection;
+import org.eclipse.jface.viewers.IStructuredSelection;
+import org.eclipse.tm.terminal.view.core.interfaces.constants.ITerminalsConnectorConstants;
+import org.eclipse.tm.terminal.view.ui.interfaces.ILauncherDelegate;
+import org.eclipse.tm.terminal.view.ui.launcher.LauncherDelegateManager;
+import org.eclipse.ui.IObjectActionDelegate;
+import org.eclipse.ui.IWorkbenchPart;
+
+import com.ibm.microclimate.core.internal.MCLogger;
+import com.ibm.microclimate.core.internal.MicroclimateApplication;
+
+public class ContainerShellAction implements IObjectActionDelegate {
+	
+	private static final String LAUNCHER_DELEGATE_ID = "org.eclipse.tm.terminal.connector.local.launcher.local"; //$NON-NLS-1$
+
+    protected MicroclimateApplication app;
+    protected ILauncherDelegate delegate;
+    
+    public ContainerShellAction() {
+    	delegate = LauncherDelegateManager.getInstance().getLauncherDelegate(LAUNCHER_DELEGATE_ID, false);
+    	if (delegate == null) {
+    		MCLogger.logError("Could not get the local terminal launcher delegate.");
+    	}
+    }
+
+    @Override
+    public void selectionChanged(IAction action, ISelection selection) {
+        if (delegate == null || !(selection instanceof IStructuredSelection)) {
+            action.setEnabled(false);
+            return;
+        }
+
+        IStructuredSelection sel = (IStructuredSelection) selection;
+        if (sel.size() == 1) {
+            Object obj = sel.getFirstElement();
+            if (obj instanceof MicroclimateApplication) {
+            	app = (MicroclimateApplication)obj;
+            	action.setEnabled(app.isEnabled());
+            	return;
+            }
+        }
+        action.setEnabled(false);
+    }
+
+    @Override
+    public void run(IAction action) {
+        if (app == null) {
+        	// should not be possible
+        	MCLogger.logError("ContainerShellAction ran but no Microclimate application was selected"); //$NON-NLS-1$
+			return;
+		}
+        
+        if (app.containerId == null || app.containerId.isEmpty()) {
+        	MCLogger.logError("ContainerShellAction ran but the container id for the application is not set: " + app.name); //$NON-NLS-1$
+			return;
+        }
+        
+        if (delegate == null) {
+        	// should not be possible
+        	MCLogger.logError("ContainerShellAction ran but the local terminal laucher delegate is null"); //$NON-NLS-1$
+			return;
+		}
+
+        Map<String, Object> properties = new HashMap<>();
+        properties.put(ITerminalsConnectorConstants.PROP_DELEGATE_ID, delegate.getId());
+        properties.put(ITerminalsConnectorConstants.PROP_TITLE, app.name);
+        properties.put(ITerminalsConnectorConstants.PROP_PROCESS_PATH, "docker");
+        properties.put(ITerminalsConnectorConstants.PROP_PROCESS_ARGS, "exec -it " + app.containerId + " bash");
+        delegate.execute(properties, null);
+    }
+
+	@Override
+	public void setActivePart(IAction arg0, IWorkbenchPart arg1) {
+		// nothing
+	}
+}