aspera-cli 4.27.3 → 4.27.5

data/lib/aspera/cli/option_value.rb

@@ -8,8 +8,6 @@ require 'aspera/schema/registry'
 require 'aspera/schema/validator'
 require 'aspera/log'
 require 'aspera/assert'
-require 'aspera/rainbow'
-using Rainbow
 
 module Aspera
   module Cli
@@ -19,7 +17,7 @@ module Aspera
       attr_reader :option
       # [Array<Class>, nil] List of allowed types, `nil` for no validation
       attr_reader :types
-      # [Symbol] How values are converted: :flag, :boolean, :integer, :enum, :enum_list, :string_list, :other
+      # [Symbol] How values are converted: :flag, :boolean, :integer, :float, :enum, :enum_list, :string_list, :other
       attr_reader :kind
       # [Symbol, nil] `OptionSource` of current value, `nil` if never set
       attr_reader :source
@@ -59,8 +57,8 @@ module Aspera
         @shorthand = shorthand
         @source = nil
         @value = nil
-        @on_set = nil
-        bind_on_set(on_set) unless on_set.nil?
+        Aspera.assert(on_set.nil? || on_set.respond_to?(:call)) { "#{@option}: on_set callback must respond to call" }
+        @on_set = on_set
         @types = nil
         @values = nil
         @kind = :other
@@ -68,19 +66,6 @@ module Aspera
         apply_allowed(allowed) unless allowed.nil?
       end
 
-      # Set the `on_set` callback, called with the new value each time the value is set.
-      # Safe to call after construction: used by `Parser#on_set` for a target object created after declaration.
-      # The callback is called with the current value, if any.
-      # @param callback [#call] e.g. a `Method` or a lambda
-      # @return [nil]
-      def bind_on_set(callback)
-        Aspera.assert(callback.respond_to?(:call)) { "#{@option}: on_set callback must respond to call" }
-        @on_set = callback
-        Log.log.trace1 { "bind_on_set: #{@option}".green }
-        @on_set.call(@value) unless @value.nil?
-        nil
-      end
-
       # @return [String] description of the option: explicit one, or first line of schema description
       def description
         return @description unless @description.nil?
@@ -232,6 +217,7 @@ module Aspera
           @kind =
             if allowed.sort_by(&:name).eql?(Type::BOOLEAN) then :boolean
             elsif allowed.eql?(Type::INTEGER) then :integer
+            elsif allowed.eql?(Type::FLOAT) then :float
             elsif allowed.eql?(Type::STRING_ARRAY) then :string_list
             else :other
             end
@@ -256,7 +242,18 @@ module Aspera
         when :boolean
           BoolValue.true?(value.is_a?(String) ? Parser.get_from_list(value, @option, BoolValue::ALL) : value)
         when :integer
-          value.nil? ? value : Integer(value)
+          # Decimal, also with leading zeros (e.g. `08`)
+          if value.is_a?(String)
+            Integer(value, 10, exception: false).tap { |i| raise BadArgument, "Option #{@option}: invalid integer: #{value}" if i.nil? }
+          else
+            value.nil? ? value : Integer(value)
+          end
+        when :float
+          if value.is_a?(String)
+            Float(value, exception: false).tap { |f| raise BadArgument, "Option #{@option}: invalid number: #{value}" if f.nil? }
+          else
+            value.nil? ? value : Float(value)
+          end
         when :string_list
           value.is_a?(String) ? [value] : value
         when :enum_list

data/lib/aspera/cli/options.schema.yaml

@@ -102,7 +102,10 @@ components:
           default: true
         quiet:
           type: boolean
-          description: Suppress the `ascp` progress bar display.
+          description: >-
+            Suppress the `ascp` progress bar display.
+
+            If `false`, the progress bar of option `progress_bar` is not displayed, unless that option is set.
           default: true
         file_list:
           type: boolean
@@ -595,18 +598,20 @@ components:
             Token expiry timestamp in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).
             Computed automatically from `_validity` when absent.
           example: "2030-01-01T00:00:00Z"
-    NodeSimulatorOptions:
+    NodeEmulatorOptions:
       type: object
       description: >-
-        Configuration for the embedded Node API simulator (`node simulator`).
-        The simulator starts a local WEBrick server that answers `/ops/transfers`,
-        `/ops/transfers/{id}`, `/files/browse`, and `/info` — sufficient to test
-        CLI commands against a live Node API without a real HSTS instance.
+        Configuration for the embedded Node API emulator (`node emulator`), for testing without HSTS.
+        The emulator starts a local web server that answers a subset of the Node API:
+        `/info`, `/ops/transfers` (list, start), `/ops/transfers/{id}` (show, modify, cancel) and `/files/browse`.
+        Transfers are executed by the Transfer Daemon (`transferd`), started by the emulator.
+        Clients authenticate with HTTP Basic when `username` and `password` are set.
+      additionalProperties: false
       properties:
         url:
           type: string
           description: >-
-            Address and port the simulator listens on.
+            Address and port the emulator listens on.
             Use `https://` with `cert`/`key` for TLS.
           default: http://localhost:8080
         cert:
@@ -624,13 +629,29 @@ components:
           type: string
           description: Path to the PEM certificate chain file (appended as extra chain certificates).
           example: /path/to/chain.pem
-        browse_root:
+        docroot:
           type: string
           description: >-
-            Root directory the simulator is allowed to expose via `/files/browse`.
-            Requests for paths outside this directory are rejected.
+            Local folder of the node files.
+            Paths of `/files/browse` and local paths of transfers (sources of `send`, destination of `receive`) are relative to it, and confined in it.
             Defaults to the current working directory.
           example: /data/aspera
+        retention_sec:
+          type: integer
+          minimum: 1
+          description: Time in seconds a transfer stays in the list of transfers after it ended (completed, failed or canceled, and no more retried).
+          default: 86400
+        username:
+          type: string
+          description: >-
+            Username expected from clients in HTTP Basic authentication.
+            Set together with `password`.
+            When not set, requests are accepted without authentication.
+          example: node_user
+        password:
+          type: string
+          description: Password expected from clients in HTTP Basic authentication, for the above `username`.
+          example: my_password
     NodeTelemetryOptions:
       type: object
       description: >-
@@ -685,6 +706,61 @@ components:
             Name of the output variable of `step` returned as result.
             Requires `step`, and implies `synchronous`.
           example: Complete_status_message
+    OrchestratorInitiateParameters:
+      type: object
+      description: >-
+        Input parameters for the workflow (key-value pairs).
+        Valid keys are defined by the workflow's input specification.
+        Use `orchestrator workflows inputs WORKFLOW_ID` to discover required parameters.
+      additionalProperties: true
+    OrchestratorImportWorkflow:
+      type: object
+      description: Workflow definition to import into Orchestrator.
+      required:
+        - name
+      properties:
+        name:
+          type: string
+          description: Workflow name.
+          example: My Workflow
+        description:
+          type: string
+          description: Workflow description.
+          example: This is a sample workflow
+        workflow_data:
+          type: object
+          description: Complete workflow definition.
+    OrchestratorImportWithConstraints:
+      type: object
+      description: Workflow definition to import with constraint resolution mappings.
+      required:
+        - workflow_data
+        - constraints
+      properties:
+        workflow_data:
+          type: object
+          description: Complete workflow definition to import.
+        constraints:
+          type: object
+          description: Constraint resolution mappings for conflicting resources.
+          example:
+            resource_pools: {}
+            queues: {}
+            monitors: {}
+    OrchestratorReloadPluginSet:
+      type: object
+      description: Set of plugins to reload.
+      required:
+        - plugin_names
+      properties:
+        plugin_names:
+          type: array
+          description: List of plugin names to reload.
+          items:
+            type: string
+          example:
+            - soap_requests
+            - frameio_operations
     TableOptions:
       type: object
       description: Terminal table rendering options.

data/lib/aspera/cli/parser.rb

@@ -97,7 +97,7 @@ module Aspera
           when 'true', BoolValue::YES_SYM.to_s then true
           when 'false', BoolValue::NO_SYM.to_s then false
           else
-            Integer(value, exception: false) ||
+            Integer(value, 10, exception: false) ||
               Float(value, exception: false) ||
               ExtendedValue.instance.evaluate(value, context: 'dotted expression')
           end
@@ -228,14 +228,15 @@ module Aspera
 
       # Resource identifier as positional parameter
       #
-      # @param description [String] description of the identifier
-      # @param block       [Proc] block to search for identifier based on attribute value
-      # @return [String, Array<String>] identifier or list of IDs (if `bulk` option is set)
+      # @param description [String]  description of the identifier
+      # @param multiple    [Boolean] `true`: read a list of IDs (bulk operation)
+      # @param block       [Proc]    block to search for identifier based on attribute value
+      # @return [String, Array<String>] identifier or list of IDs (if `multiple`)
       # @yieldparam field [String] The field name from percent selector
       # @yieldparam value [String] The value from percent selector
       # @yieldreturn [String] Resolved identifier
-      def instance_identifier(description: 'identifier', &block)
-        res_id = get_next_argument(description, multiple: get_option(:bulk))
+      def instance_identifier(description: 'identifier', multiple: false, &block)
+        res_id = get_next_argument(description, multiple: multiple)
         # Can be an Array
         if res_id.is_a?(String) && (m = Parser.percent_selector(res_id))
           Aspera.assert(block_given?, type: Cli::BadArgument) { "Percent syntax for #{description} not supported in this context" }
@@ -312,16 +313,6 @@ module Aspera
         option_def(option_symbol).clear
       end
 
-      # Bind (or re-bind) an `on_set` callback to an already-declared option, for a target object created after declaration.
-      # The callback is called with the current value, if any.
-      # @param option_symbol [Symbol] name of the already-declared option
-      # @param callback      [#call]  called with the new value each time the value is set (e.g. a `Method`)
-      # @return [nil]
-      def on_set(option_symbol, callback)
-        Aspera.assert_type(option_symbol, Symbol)
-        option_def(option_symbol).bind_on_set(callback)
-      end
-
       # Adds each of the keys of specified hash as an option.
       # Values are applied by the next parse, and never override a value from env or command line.
       # @param preset_hash [Hash]    Options to add
@@ -354,6 +345,14 @@ module Aspera
         @command_line.pending_arguments.empty?
       end
 
+      # Check the next pending positional argument, without consuming it
+      # @param values [Array<String>] values to compare with
+      # @return [Boolean] true if the next pending positional argument is one of values
+      def next_argument_in?(values)
+        ensure_parsed
+        values.include?(@command_line.pending_arguments.first)
+      end
+
       # Check for unprocessed options or arguments error messages
       # @return [Array<String>] list of error messages for unprocessed tokens
       def final_errors
@@ -410,6 +409,18 @@ module Aspera
         Log.log.trace1 { "unprocessed options: #{@command_line.pending_options}" }
       end
 
+      # Execute the block with interactive input of missing mandatory options and arguments, as with `--interactive=yes`.
+      # The previous state is restored afterwards, so that interactive input does not leak to the rest of the command.
+      # @param enabled [Boolean] `false`: execute the block with current state
+      # @return [Object] result of the block
+      def with_interactive(enabled: true)
+        previous = @ask_missing_mandatory
+        @ask_missing_mandatory = true if enabled
+        yield
+      ensure
+        @ask_missing_mandatory = previous
+      end
+
       # Prompt user for missing option or argument, or raise if not interactive
       # @param descr        [String] option name, or argument description
       # @param multiple     [Boolean, String] `true` if multiple values expected
@@ -428,7 +439,7 @@ module Aspera
         end
         # Ask interactively
         result = []
-        puts(' (one per line, end with empty line)') if multiple
+        $stderr.puts(' (one per line, end with empty line)') if multiple # rubocop:disable Style/StderrPuts
         loop do
           prompt = default_prompt
           prompt = "#{accept_list.join(' ')}\n#{default_prompt}" if accept_list
@@ -527,7 +538,7 @@ module Aspera
         # if value comes from JSON/YAML, it may come as Integer
         return value.to_s if value.is_a?(Integer) && validation.eql?(Type::STRING)
         return value unless value.is_a?(String) && validation.eql?(Type::INTEGER)
-        Integer(value, exception: false).tap { |i| raise Cli::BadArgument, "Invalid integer: #{value}" if i.nil? }
+        Integer(value, 10, exception: false).tap { |i| raise Cli::BadArgument, "Invalid integer: #{value}" if i.nil? }
       end
 
       # Validate a single argument value.
@@ -554,6 +565,7 @@ module Aspera
         when :flag    then nil
         when :boolean then 'yes|no'
         when :integer then 'INT'
+        when :float   then 'FLOAT'
         when :enum
           opt.values&.any? && opt.values.length <= 4 ? opt.values.join('|') : 'ENUM'
         else