Remote Client: Add optional fields for config file based connection

Author: dalthviz

spyder/plugins/remoteclient/api/manager.py

@@ -621,7 +621,11 @@ async def __create_new_connection(self) -> bool:
             self._ssh_connection = await asyncssh.connect(
                 **connect_kwargs, client_factory=self.client_factory
             )
-        except (OSError, asyncssh.Error) as e:
+        except (
+            OSError,
+            asyncssh.Error,
+            asyncssh.public_key.KeyImportError,
+        ) as e:
             self.logger.error(f"Failed to open ssh connection: {e}")
             self.__emit_connection_status(
                 ConnectionStatus.Error,

spyder/plugins/remoteclient/plugin.py

@@ -213,19 +213,39 @@ def load_conf(self, config_id):
         if not options:
             return {}
 
-        if options["client_keys"]:
+        if options["config"]:
+            # Only `host` and list with path to config file as `config`
+            # are required
+            options["config"] = [options["config"]]
+
+            # Optional configuration vslues mapping (`port`, `username`,
+            # `client_keys`, `passphrase` and `password`)
+            if options["port"] == 0:
+                # If 0 is set (`From file` option) ignore value
+                options.pop("port")
+
+            if not options["username"]:
+                options.pop("username")
+
+            if not options["client_keys"]:
+                options.pop("client_keys")
+            else:
+                options["client_keys"] = [options["client_keys"]]
+
+            passphrase = self.get_conf(f"{config_id}/passphrase", secure=True)
+            if passphrase:
+                options["passphrase"] = passphrase
+
+            password = self.get_conf(f"{config_id}/password", secure=True)
+            if password:
+                options["password"] = password
+        elif options["client_keys"]:
             passphrase = self.get_conf(f"{config_id}/passphrase", secure=True)
             options["client_keys"] = [options["client_keys"]]
 
             # Passphrase is optional
             if passphrase:
                 options["passphrase"] = passphrase
-        elif options["config"]:
-            # Should have only `host` and list with path to config file as
-            # `config`
-            options.pop("port")
-            options.pop("username")
-            options.pop("client_keys")
         else:
             # Password is mandatory in this case
             password = self.get_conf(f"{config_id}/password", secure=True)

spyder/plugins/remoteclient/widgets/connectiondialog.py

@@ -65,7 +65,7 @@ class ValidationReasons(TypedDict):
 class BaseConnectionPage(SpyderConfigPage, SpyderFontsMixin):
     """Base class to create connection pages."""
 
-    MIN_HEIGHT = 450
+    MIN_HEIGHT = 700
     NEW_CONNECTION = False
     CONF_SECTION = "remoteclient"
 
@@ -186,8 +186,6 @@ def create_connection_info_widget(self):
             intro_layout.addWidget(intro_tip)
 
         # Authentication methods
-        # TODO: The config file method is not implemented yet, so we need to
-        # disable it for now.
         methods = (
             (_('Password'), AuthenticationMethod.Password),
             (_('Key file'), AuthenticationMethod.KeyFile),
@@ -423,6 +421,14 @@ def _create_configfile_subpage(self):
             status_icon=ima.icon("error"),
         )
 
+        configfile = self.create_browsefile(
+            text=_("Configuration file *"),
+            option=f"{self.host_id}/configfile",
+            tip=_("File with the OpenSSH client configuration to use"),
+            alignment=Qt.Vertical,
+            status_icon=ima.icon("error"),
+        )
+
         host = self.create_lineedit(
             text=_("Host *"),
             option=f"{self.host_id}/{AuthenticationMethod.ConfigFile}/address",
@@ -434,14 +440,55 @@ def _create_configfile_subpage(self):
             status_icon=ima.icon("error"),
         )
 
-        configfile = self.create_browsefile(
-            text=_("Configuration file *"),
-            option=f"{self.host_id}/configfile",
-            tip=_("File with the OpenSSH client configuration to use"),
+        port = self.create_spinbox(
+            prefix=_("Port"),
+            suffix="",
+            option=f"{self.host_id}/{AuthenticationMethod.ConfigFile}/port",
+            min_=0,
+            max_=65535,
+            tip=_("Introduce a the port to use for your connection."
+                  "Set <b>From file</b> (<b>0</b> value) to use the port "
+                  "configuration from the configuration file"),
+        )
+        port.spinbox.setSpecialValueText(_("From file"))
+        port.spinbox.setStyleSheet("margin-left: 5px")
+
+        username = self.create_lineedit(
+            text=_("Username"),
+            option=f"{self.host_id}/{AuthenticationMethod.ConfigFile}/username",
+            status_icon=ima.icon("error"),
+        )
+
+        password = self.create_lineedit(
+            text=_("Password"),
+            option=f"{self.host_id}/password",
+            tip=(
+                _("Your password will be saved securely by Spyder")
+                if self.NEW_CONNECTION
+                else _("Your password is saved securely by Spyder")
+            ),
+            status_icon=ima.icon("error"),
+            password=True
+        )
+
+        keyfile = self.create_browsefile(
+            text=_("Key file"),
+            option=f"{self.host_id}/keyfile",
             alignment=Qt.Vertical,
             status_icon=ima.icon("error"),
         )
 
+        passphrase = self.create_lineedit(
+            text=_("Passphrase"),
+            option=f"{self.host_id}/passphrase",
+            tip=(
+                _("Your passphrase will be saved securely by Spyder")
+                if self.NEW_CONNECTION
+                else _("Your passphrase is saved securely by Spyder")
+            ),
+            password=True
+        )
+
         validation_label = MessageLabel(self)
 
         # Add widgets to their required dicts
@@ -460,9 +507,19 @@ def _create_configfile_subpage(self):
         configfile_layout.setContentsMargins(0, 0, 0, 0)
         configfile_layout.addWidget(name)
         configfile_layout.addSpacing(5 * AppStyle.MarginSize)
+        configfile_layout.addWidget(configfile)
+        configfile_layout.addSpacing(5 * AppStyle.MarginSize)
         configfile_layout.addWidget(host)
         configfile_layout.addSpacing(5 * AppStyle.MarginSize)
-        configfile_layout.addWidget(configfile)
+        configfile_layout.addWidget(port)
+        configfile_layout.addSpacing(5 * AppStyle.MarginSize)
+        configfile_layout.addWidget(username)
+        configfile_layout.addSpacing(5 * AppStyle.MarginSize)
+        configfile_layout.addWidget(password)
+        configfile_layout.addSpacing(5 * AppStyle.MarginSize)
+        configfile_layout.addWidget(keyfile)
+        configfile_layout.addSpacing(5 * AppStyle.MarginSize)
+        configfile_layout.addWidget(passphrase)
         configfile_layout.addSpacing(7 * AppStyle.MarginSize)
         configfile_layout.addWidget(validation_label)
         configfile_layout.addStretch()
@@ -636,14 +693,13 @@ def save_server_info(self):
             ),
             port=self.get_option(
                 f"{self.host_id}/{self.auth_method()}/port",
-                default=""
             ),
             username=self.get_option(
                 f"{self.host_id}/{self.auth_method()}/username",
                 default=""
             ),
             client_keys=self.get_option(f"{self.host_id}/keyfile", default=""),
-            config=[self.get_option(f"{self.host_id}/configfile")],
+            config=self.get_option(f"{self.host_id}/configfile"),
         )
 
         servers = self.get_option("servers", default={})
@@ -671,6 +727,8 @@ def remove_config_options(self):
             "keyfile",
             "configfile_login/name",
             "configfile_login/address",
+            "configfile_login/port",
+            "configfile_login/username",
             "configfile",
         ]
         for option in options: