server,extension: allow returning direct console url

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

Author: shwstppr

api/src/main/java/org/apache/cloudstack/api/command/user/consoleproxy/CreateConsoleEndpointCmd.java

@@ -35,6 +35,7 @@
 import org.apache.cloudstack.context.CallContext;
 import org.apache.cloudstack.utils.consoleproxy.ConsoleAccessUtils;
 import org.apache.commons.collections.MapUtils;
+import org.apache.commons.lang3.ObjectUtils;
 
 import javax.inject.Inject;
 import java.util.Map;
@@ -86,6 +87,10 @@ private CreateConsoleEndpointResponse createResponse(ConsoleEndpoint endpoint) {
     }
 
     private ConsoleEndpointWebsocketResponse createWebsocketResponse(ConsoleEndpoint endpoint) {
+        if (ObjectUtils.allNull(endpoint.getWebsocketHost(), endpoint.getWebsocketPort(), endpoint.getWebsocketPath(),
+                endpoint.getWebsocketToken(), endpoint.getWebsocketExtra())) {
+            return null;
+        }
         ConsoleEndpointWebsocketResponse wsResponse = new ConsoleEndpointWebsocketResponse();
         wsResponse.setHost(endpoint.getWebsocketHost());
         wsResponse.setPort(endpoint.getWebsocketPort());

core/src/main/java/com/cloud/agent/api/GetExternalConsoleAnswer.java

@@ -19,8 +19,9 @@
 
 public class GetExternalConsoleAnswer extends Answer {
 
+    private String url;
     private String host;
-    private int port;
+    private Integer port;
     @LogLevel(LogLevel.Log4jLevel.Off)
     private String password;
     private String protocol;
@@ -29,19 +30,24 @@ public GetExternalConsoleAnswer(Command command, String details) {
         super(command, false, details);
     }
 
-    public GetExternalConsoleAnswer(Command command, String host, int port, String password, String protocol) {
+    public GetExternalConsoleAnswer(Command command, String url, String host, Integer port, String password, String protocol) {
         super(command, true, "");
+        this.url = url;
         this.host = host;
         this.port = port;
         this.password = password;
         this.protocol = protocol;
     }
 
+    public String getUrl() {
+        return url;
+    }
+
     public String getHost() {
         return host;
     }
 
-    public int getPort() {
+    public Integer getPort() {
         return port;
     }
 

plugins/hypervisors/external/src/main/java/org/apache/cloudstack/hypervisor/external/provisioner/ExternalPathPayloadProvisioner.java

@@ -506,16 +506,17 @@ public GetExternalConsoleAnswer getInstanceConsole(String hostName, String exten
                         getSanitizedJsonStringForLog(output));
                 return new GetExternalConsoleAnswer(cmd, "Missing console object in output");
             }
+            String url = consoleObj.has("url") ? consoleObj.get("url").getAsString() : null;
             String host = consoleObj.has("host") ? consoleObj.get("host").getAsString() : null;
             Integer port = consoleObj.has("port") ? Integer.valueOf(consoleObj.get("port").getAsString()) : null;
             String password = consoleObj.has("password") ? consoleObj.get("password").getAsString() : null;
             String protocol = consoleObj.has("protocol") ? consoleObj.get("protocol").getAsString() : null;
-            if (ObjectUtils.anyNull(host, port)) {
+            if (url == null && ObjectUtils.anyNull(host, port)) {
                 logger.error("Missing required fields in external console output: {}",
                         getSanitizedJsonStringForLog(output));
                 return new GetExternalConsoleAnswer(cmd, "Missing required fields in output");
             }
-            return new GetExternalConsoleAnswer(cmd, host, port, password, protocol);
+            return new GetExternalConsoleAnswer(cmd, url, host, port, password, protocol);
         } catch (RuntimeException e) {
             logger.error("Failed to parse output for getInstanceConsole: {}", e.getMessage(), e);
             return new GetExternalConsoleAnswer(cmd, "Failed to parse output");

plugins/hypervisors/external/src/test/java/org/apache/cloudstack/hypervisor/external/provisioner/ExternalPathPayloadProvisionerTest.java

@@ -777,7 +777,8 @@ public void getInstanceConsoleReturnsAnswerWhenConsoleDetailsAreValid() {
 
         assertNotNull(result);
         assertEquals("127.0.0.1", result.getHost());
-        assertEquals(5900, result.getPort());
+        Integer port = 5900;
+        assertEquals(port, result.getPort());
         assertEquals("pass", result.getPassword());
         assertEquals("vnc", result.getProtocol());
     }

server/src/main/java/org/apache/cloudstack/consoleproxy/ConsoleAccessManagerImpl.java

@@ -441,8 +441,12 @@ protected ConsoleConnectionDetails getConsoleConnectionDetailsForExternalVm(Cons
             return null;
         }
         GetExternalConsoleAnswer getExternalConsoleAnswer = (GetExternalConsoleAnswer) answer;
+        details.setModeFromExternalProtocol(getExternalConsoleAnswer.getProtocol());
+        details.setDirectUrl(getExternalConsoleAnswer.getUrl());
         details.setHost(getExternalConsoleAnswer.getHost());
-        details.setPort(getExternalConsoleAnswer.getPort());
+        if (getExternalConsoleAnswer.getPort() != null) {
+            details.setPort(getExternalConsoleAnswer.getPort());
+        }
         if (StringUtils.isNotBlank(getExternalConsoleAnswer.getPassword())) {
             details.setSid(getExternalConsoleAnswer.getPassword());
         }
@@ -510,6 +514,11 @@ protected ConsoleEndpoint composeConsoleAccessEndpoint(String rootUrl, VirtualMa
             return new ConsoleEndpoint(false, null, "Console access to this instance cannot be provided");
         }
 
+        if (ConsoleConnectionDetails.Mode.Direct.equals(result.getMode())) {
+            persistConsoleSession(sessionUuid, vm.getId(), hostVo.getId(), addr);
+            return new ConsoleEndpoint(true, result.getDirectUrl());
+        }
+
         String ticket = genAccessTicket(result.getHost(), String.valueOf(result.getPort()), result.getSid(),
                 result.getTag(), sessionUuid);
         ConsoleProxyPasswordBasedEncryptor encryptor = new ConsoleProxyPasswordBasedEncryptor(getEncryptorPassword());
@@ -736,15 +745,22 @@ private String acquireVncTicketForVmwareVm(VirtualMachine vm) {
     }
 
     protected static class ConsoleConnectionDetails {
-        String host;
-        int port;
-        String sid;
-        String locale;
-        String tag;
-        String displayName;
-        String tunnelUrl = null;
-        String tunnelSession = null;
-        boolean usingRDP;
+        public enum Mode {
+            ConsoleProxy,
+            Direct
+        }
+
+        private Mode mode = Mode.ConsoleProxy;
+        private String host;
+        private int port = -1;
+        private String sid;
+        private String locale;
+        private String tag;
+        private String displayName;
+        private String tunnelUrl = null;
+        private String tunnelSession = null;
+        private boolean usingRDP;
+        private String directUrl;
 
         ConsoleConnectionDetails(String sid, String locale, String tag, String displayName) {
             this.sid = sid;
@@ -753,6 +769,20 @@ protected static class ConsoleConnectionDetails {
             this.displayName = displayName;
         }
 
+        public Mode getMode() {
+            return mode;
+        }
+
+        public void setModeFromExternalProtocol(String protocol) {
+            this.mode = Mode.ConsoleProxy;
+            if (StringUtils.isBlank(protocol)) {
+                return;
+            }
+            if (List.of("link", "url", "direct").contains(protocol.toLowerCase())) {
+                this.mode = Mode.Direct;
+            }
+        }
+
         public String getHost() {
             return host;
         }
@@ -812,5 +842,13 @@ public boolean isUsingRDP() {
         public void setUsingRDP(boolean usingRDP) {
             this.usingRDP = usingRDP;
         }
+
+        public String getDirectUrl() {
+            return directUrl;
+        }
+
+        public void setDirectUrl(String directUrl) {
+            this.directUrl = directUrl;
+        }
     }
 }