aspera-cli 4.23.0 → 4.24.0

data/lib/aspera/ssh.rb

@@ -8,6 +8,8 @@ module Aspera
   # A simple wrapper around Net::SSH
   # executes one command and get its result from stdout
   class Ssh
+    class Error < Aspera::Error
+    end
     class << self
       def disable_ed25519_keys
         Log.log.debug('Disabling SSH ed25519 user keys')
@@ -42,17 +44,25 @@ module Aspera
       @ssh_options[:logger] = Log.log
     end
 
-    def execute(cmd, input=nil)
+    # Anything on stderr raises an exception
+    def execute(cmd, input: nil, exception: false)
       Aspera.assert_type(cmd, String)
       Log.log.debug{"cmd=#{cmd}"}
       response = []
+      error = []
       Net::SSH.start(@host, @username, @ssh_options) do |session|
         ssh_channel = session.open_channel do |channel|
           # prepare stdout processing
           channel.on_data{ |_chan, data| response.push(data)}
           # prepare stderr processing, stderr if type = 1
           channel.on_extended_data do |_chan, _type, data|
-            error_message = "#{cmd}: [#{data.chomp}]"
+            error.push(data)
+          end
+          channel.on_request('exit-status') do |_ch, data|
+            exit_code = data.read_long
+            next if exit_code.zero?
+            error_message = "#{cmd}: exit #{exit_code}, #{error.join.chomp}"
+            raise Error, error_message if  exception
             # Happens when windows user hasn't logged in and created home account.
             error_message += "\nHint: home not created in Windows?" if data.include?('Could not chdir to home directory')
             Log.log.debug(error_message)
@@ -62,7 +72,7 @@ module Aspera
         end
         # wait for channel to finish (command exit)
         ssh_channel.wait
-        # main ssh session loop
+        # main SSH session loop
         session.loop
       end
       # response as single string

data/lib/aspera/sync/args.schema.yaml

@@ -0,0 +1,102 @@
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: https://github.com/IBM/aspera-cli/tree/main/lib/aspera/transfer/sync_instance.schema.yaml
+$comment: >-
+  `x-` fields documented in `command_line_builder.rb`
+  This spec is specific to `ascli`.
+  The native async `conf` format is now preferred.
+title: SyncInstanceSpec
+description: Instance (global) and Session (per-sync) parameters for async.
+type: object
+properties:
+  alt_logdir:
+    type: string
+  watchd:
+    type: string
+  apply_local_docroot:
+    x-cli-switch: true
+  quiet:
+    x-cli-switch: true
+  ws_connect:
+    x-cli-switch: true
+  sessions:
+    type: array
+    items:
+      description: Session parameters for async.
+      type: object
+      properties:
+        name:
+          type: string
+        local_dir:
+          type: string
+        remote_dir:
+          type: string
+        local_db_dir:
+          type: string
+        remote_db_dir:
+          type: string
+        host:
+          type: string
+          x-ts-name: remote_host
+        user:
+          type: string
+          x-ts-name: remote_user
+        private_key_paths:
+          type: array
+          x-cli-option: "--private-key-path"
+        direction:
+          type: string
+        checksum:
+          type: string
+        tags:
+          type: object
+          x-cli-option: "--tags64"
+          x-cli-convert: json64
+          x-ts-name: tags
+        tcp_port:
+          type: integer
+          x-ts-name: ssh_port
+        rate_policy:
+          type: string
+        target_rate:
+          type: string
+        cooloff:
+          type: integer
+        pending_max:
+          type: integer
+        scan_intensity:
+          type: string
+        cipher:
+          type: string
+          x-cli-convert: remove_hyphen
+          x-ts-name: cipher
+        transfer_threads:
+          type: integer
+        preserve_time:
+          x-cli-switch: true
+          x-ts-name: preserve_times
+        preserve_access_time:
+          x-cli-switch: true
+        preserve_modification_time:
+          x-cli-switch: true
+        preserve_uid:
+          x-cli-switch: true
+          x-ts-name: preserve_file_owner_uid
+        preserve_gid:
+          x-cli-switch: true
+          x-ts-name: preserve_file_owner_gid
+        create_dir:
+          x-cli-switch: true
+          x-ts-name: create_dir
+        reset:
+          x-cli-switch: true
+        remote_password:
+          x-cli-envvar: ASPERA_SCP_PASS
+          x-ts-name: remote_password
+        cookie:
+          x-cli-envvar: ASPERA_SCP_COOKIE
+          x-ts-name: cookie
+        token:
+          x-cli-envvar: ASPERA_SCP_TOKEN
+          x-ts-name: token
+        license:
+          x-cli-envvar: ASPERA_SCP_LICENSE