Merge pull request #2 from jneprz/personal/johnli1/simplify_sftp

Personal/johnli1/simplify sftp

Author: jneprz

src/sftp/azext_sftp/__init__.py

@@ -33,13 +33,11 @@ def __init__(self, cli_ctx=None):
         from azure.cli.core.commands import CliCommandType
         from azext_sftp._client_factory import cf_sftp
 
-        sftp_custom = CliCommandType(
-            operations_tmpl='azext_sftp.custom#{}',
-            client_factory=cf_sftp)
-
-        super(SftpCommandsLoader, self).__init__(
+        super().__init__(
             cli_ctx=cli_ctx,
-            custom_command_type=sftp_custom)
+            custom_command_type=CliCommandType(
+                operations_tmpl='azext_sftp.custom#{}',
+                client_factory=cf_sftp))
 
     def load_command_table(self, args):
         """Load the command table for SFTP commands."""

src/sftp/azext_sftp/_help.py

@@ -9,7 +9,7 @@
 
 helps['sftp'] = """
     type: group
-    short-summary: Commands to connect to Azure Storage Accounts via SFTP
+    short-summary: Generate SSH certificates and access Azure Storage blob data via SFTP
     long-summary: |
         These commands allow you to generate certificates and connect to Azure Storage Accounts using SFTP.
 
@@ -46,16 +46,16 @@
         The certificate can be used with 'az sftp connect' or with standard SFTP clients.
     examples:
         - name: Generate a certificate using an existing public key
-          text: az sftp cert --public-key-file ~/.ssh/id_rsa.pub --file ~/my_cert.pub
+          text: az sftp cert --public-key-file ~/.ssh/id_rsa.pub --output-file ~/my_cert.pub
         - name: Generate a certificate and create a new key pair in the same directory
-          text: az sftp cert --file ~/my_cert.pub
+          text: az sftp cert --output-file ~/my_cert.pub
         - name: Generate a certificate with custom SSH client folder
-          text: az sftp cert --file ~/my_cert.pub --ssh-client-folder "C:\\Program Files\\OpenSSH"
+          text: az sftp cert --output-file ~/my_cert.pub --ssh-client-folder "C:\\Program Files\\OpenSSH"
 """
 
 helps['sftp connect'] = """
     type: command
-    short-summary: Connect to Azure Storage Account via SFTP
+    short-summary: Access Azure Storage blob data via SFTP
     long-summary: |
         Establish an SFTP connection to an Azure Storage Account.
 
@@ -79,7 +79,7 @@
         SECURITY:
         - Generated credentials are automatically cleaned up after connection
         - Temporary files stored in secure temporary directories
-        - Certificate validity is checked and renewed if expired
+        - OpenSSH handles certificate validation during connection
     examples:
         - name: Connect with automatic certificate generation (fully managed - RECOMMENDED)
           text: az sftp connect --storage-account mystorageaccount

src/sftp/azext_sftp/_params.py

@@ -8,11 +8,11 @@
 def load_arguments(self, _):
 
     with self.argument_context('sftp cert') as c:
-        c.argument('cert_path', options_list=['--file', '-f'],
+        c.argument('cert_path', options_list=['--output-file', '-o'],
                    help='The file path to write the SSH cert to, defaults to public key path with -aadcert.pub appended')
         c.argument('public_key_file', options_list=['--public-key-file', '-p'],
                    help='The RSA public key file path. If not provided, '
-                   'generated key pair is stored in the same directory as --file.')
+                   'generated key pair is stored in the same directory as --output-file.')
         c.argument('ssh_client_folder', options_list=['--ssh-client-folder'],
                    help='Folder path that contains ssh executables (ssh-keygen, ssh). '
                    'Default to ssh executables in your PATH or C:\\Windows\\System32\\OpenSSH on Windows.')
@@ -35,10 +35,8 @@ def load_arguments(self, _):
                    'a certificate will be generated automatically from this key.')
         c.argument('sftp_args', options_list=['--sftp-args'],
                    help='Additional arguments to pass to the SFTP client. '
-                   'Example: "-v" for verbose output, "-o ConnectTimeout=30" for custom timeout.')
+                   'Example: "-v" for verbose output, "-b batchfile.txt" for batch commands, '
+                   '"-o ConnectTimeout=30" for custom timeout.')
         c.argument('ssh_client_folder', options_list=['--ssh-client-folder'],
                    help='Path to folder containing SSH client executables (ssh, sftp, ssh-keygen). '
                    'Default: Uses executables from PATH or C:\\Windows\\System32\\OpenSSH on Windows.')
-        c.argument('sftp_batch_commands', options_list=['--batch-commands'],
-                   help='SFTP batch commands to execute after connecting (non-interactive mode). '
-                   'Separate commands with \\n. Example: "ls\\nget file.txt\\nbye"')

src/sftp/azext_sftp/_validators.py

@@ -13,7 +13,7 @@ def storage_account_name_or_id_validator(cmd, namespace):
     Validator for storage account name or resource ID.
     Converts storage account name to full resource ID if needed.
     """
-    if namespace.storage_account:
+    if hasattr(namespace, 'storage_account') and namespace.storage_account:
         if not is_valid_resource_id(namespace.storage_account):
             if not hasattr(namespace, 'resource_group_name') or not namespace.resource_group_name:
                 raise azclierror.RequiredArgumentMissingError(

src/sftp/azext_sftp/commands.py

@@ -3,22 +3,11 @@
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # --------------------------------------------------------------------------------------------
 
-"""
-Command definitions for the Azure CLI SFTP extension.
-
-This module defines the available SFTP commands and their routing
-to the appropriate custom functions.
-"""
+"""Command definitions for the Azure CLI SFTP extension."""
 
 
 def load_command_table(self, _):
-    """
-    Load command table for SFTP extension.
-
-    Commands:
-    - sftp cert: Generate SSH certificates for SFTP authentication
-    - sftp connect: Connect to Azure Storage Account via SFTP
-    """
+    """Load command table for SFTP extension."""
     with self.command_group('sftp') as g:
         g.custom_command('cert', 'sftp_cert')
         g.custom_command('connect', 'sftp_connect')

src/sftp/azext_sftp/connectivity_utils.py

@@ -12,18 +12,15 @@
 
 
 def format_relay_info_string(relay_info):
-    relay_info_string = json.dumps(
-        {
-            "relay": {
-                "namespaceName": relay_info['namespaceName'],
-                "namespaceNameSuffix": relay_info['namespaceNameSuffix'],
-                "hybridConnectionName": relay_info['hybridConnectionName'],
-                "accessKey": relay_info['accessKey'],
-                "expiresOn": relay_info['expiresOn'],
-                "serviceConfigurationToken": relay_info['serviceConfigurationToken']
-            }
-        })
-    result_bytes = relay_info_string.encode("ascii")
-    enc = base64.b64encode(result_bytes)
-    base64_result_string = enc.decode("ascii")
-    return base64_result_string
+    """Format relay information as base64-encoded JSON string."""
+    relay_data = {
+        "relay": {
+            "namespaceName": relay_info['namespaceName'],
+            "namespaceNameSuffix": relay_info['namespaceNameSuffix'],
+            "hybridConnectionName": relay_info['hybridConnectionName'],
+            "accessKey": relay_info['accessKey'],
+            "expiresOn": relay_info['expiresOn'],
+            "serviceConfigurationToken": relay_info['serviceConfigurationToken']
+        }
+    }
+    return base64.b64encode(json.dumps(relay_data).encode("ascii")).decode("ascii")

src/sftp/azext_sftp/constants.py

@@ -8,10 +8,8 @@
 # File system constants
 WINDOWS_INVALID_FOLDERNAME_CHARS = "\\/*:<>?\"|"
 
-# Default SSH/SFTP configuration
-DEFAULT_SSH_PORT = 22
-DEFAULT_SFTP_PORT = 22
-AZURE_STORAGE_SFTP_PORT = 22
+# Default ports
+DEFAULT_SSH_PORT = DEFAULT_SFTP_PORT = AZURE_STORAGE_SFTP_PORT = 22
 
 # SSH/SFTP client configuration
 SSH_CONNECT_TIMEOUT = 30