Add help for connecting HDinsigh by using SSH into Spark Debug

Signed-off-by: Zhang Wei <[email protected]>

Author: wezhang

PluginsAndFeatures/azure-toolkit-for-intellij/src/com/microsoft/azure/hdinsight/spark/ui/SparkSubmissionAdvancedConfigDialog.java

@@ -22,14 +22,19 @@
 
 package com.microsoft.azure.hdinsight.spark.ui;
 
+import com.intellij.icons.AllIcons;
+import com.intellij.ide.BrowserUtil;
 import com.intellij.openapi.fileChooser.FileChooser;
 import com.intellij.openapi.fileChooser.FileChooserDescriptor;
 import com.intellij.openapi.ui.TextFieldWithBrowseButton;
+import com.intellij.openapi.ui.popup.IconButton;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.ui.DocumentAdapter;
+import com.intellij.ui.InplaceButton;
 import com.intellij.util.ui.JBUI;
 import com.microsoft.azure.hdinsight.common.CallBack;
 import com.microsoft.azure.hdinsight.common.ClusterManagerEx;
+import com.microsoft.azure.hdinsight.common.Docs;
 import com.microsoft.azure.hdinsight.sdk.cluster.IClusterDetail;
 import com.microsoft.azure.hdinsight.sdk.common.HDIException;
 import com.microsoft.azure.hdinsight.spark.common.SparkBatchDebugSession;
@@ -45,6 +50,7 @@
 import javax.swing.event.DocumentListener;
 import java.awt.*;
 import java.io.File;
+import java.util.Locale;
 import java.util.concurrent.TimeUnit;
 
 import static com.microsoft.azure.hdinsight.spark.common.SparkSubmitAdvancedConfigModel.SSHAuthType.UseKeyFile;
@@ -62,6 +68,10 @@ public class SparkSubmissionAdvancedConfigDialog extends JDialog{
         this.advancedConfigModel = advancedConfigModel;
 
         this.updateCallBack = updateCallBack;
+
+        // FIXME!!! Since the Intellij has no locale setting, just set en-us here.
+        this.helpUrl = new Docs(Locale.US).getDocUrlByTopic(Docs.TOPIC_CONNECT_HADOOP_LINUX_USING_SSH);
+
         this.sshCheckSubject = PublishSubject.create();
         this.inputListener = new DocumentAdapter() {
             @Override
@@ -118,6 +128,7 @@ public SparkSubmitAdvancedConfigModel getAdvancedConfigModel() {
 
     private SparkSubmitModel submitModel;
     private SparkSubmitAdvancedConfigModel advancedConfigModel;
+    private String helpUrl;
 
     private final int margin = 12;
 
@@ -135,6 +146,9 @@ public SparkSubmitAdvancedConfigModel getAdvancedConfigModel() {
     JButton cancelButton;
     BackgroundTaskIndicator checkSshCertIndicator;
     DocumentListener inputListener;
+    IconButton helpButton;
+    JPanel helpPanel;
+    JPanel operationPanel;
 
     private PublishSubject<String> sshCheckSubject;
     private Subscription sshCheckSubscription;
@@ -228,7 +242,7 @@ private void addMainPanel() {
     }
 
     private void addOperationPanel() {
-        JPanel operationPanel = new JPanel();
+        operationPanel = new JPanel();
         operationPanel.setLayout(new FlowLayout());
 
         okButton = new JButton("Ok");
@@ -239,8 +253,16 @@ private void addOperationPanel() {
 
         getRootPane().setDefaultButton(cancelButton);
 
+        helpPanel = new JPanel();
+        helpPanel.setLayout(new BoxLayout(helpPanel, BoxLayout.LINE_AXIS));
+
+        helpButton = new IconButton("Help about connection to HDInsight using SSH", AllIcons.Actions.Help);
         checkSshCertIndicator = new BackgroundTaskIndicator("Verify SSH Authentication...");
-        add(checkSshCertIndicator,
+
+        helpPanel.add(new InplaceButton(helpButton, e -> BrowserUtil.browse(this.helpUrl)));
+        helpPanel.add(checkSshCertIndicator);
+
+        add(helpPanel,
                 new GridBagConstraints(0, ++displayLayoutCurrentRow,
                         0, 1,
                         1, 0,

Utils/hdinsight-node-common/src/com/microsoft/azure/hdinsight/common/Docs.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) Microsoft Corporation
+ * <p/>
+ * All rights reserved.
+ * <p/>
+ * MIT License
+ * <p/>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
+ * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * <p/>
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
+ * the Software.
+ * <p/>
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+ * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ */
+
+package com.microsoft.azure.hdinsight.common;
+
+import java.util.Formatter;
+import java.util.Locale;
+
+public class Docs {
+    private static final String DOC_URL_PATTERN = "https://docs.microsoft.com/%s-%s/azure/hdinsight/%s";
+
+    static public final String TOPIC_CONNECT_HADOOP_LINUX_USING_SSH = "hdinsight-hadoop-linux-use-ssh-unix";
+
+    private Locale locale;
+
+    public Docs(Locale locale) {
+        this.locale = locale;
+    }
+
+    public String getDocUrlByTopic(String topic) {
+        StringBuilder sb = new StringBuilder();
+        Formatter formatter = new Formatter(sb, this.locale);
+
+        return formatter.format(DOC_URL_PATTERN,
+                                this.locale.getLanguage().toLowerCase(),
+                                this.locale.getCountry().toLowerCase(),
+                                topic)
+                .toString();
+    }
+}