aspera-cli 4.28.0 → 4.29.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/BUGS.md +5 -10
- data/CHANGELOG.md +217 -2
- data/CODE_OF_CONDUCT.md +18 -0
- data/CONTRIBUTING.md +135 -56
- data/GOVERNANCE.md +30 -0
- data/LICENSE +201 -0
- data/README.md +122 -26
- data/SECURITY.md +84 -0
- data/bin/ascli +8 -5
- data/bin/asession +9 -6
- data/docs/README.md +1895 -632
- data/docs/test-mcp-with-ai.md +8 -8
- data/lib/aspera/agent/base.rb +23 -2
- data/lib/aspera/agent/connect.rb +16 -12
- data/lib/aspera/agent/desktop.rb +10 -7
- data/lib/aspera/agent/direct.rb +20 -19
- data/lib/aspera/agent/factory.rb +6 -3
- data/lib/aspera/agent/httpgw.rb +7 -5
- data/lib/aspera/agent/node.rb +15 -7
- data/lib/aspera/agent/transferd.rb +167 -43
- data/lib/aspera/api/alee.rb +4 -1
- data/lib/aspera/api/aoc.rb +14 -11
- data/lib/aspera/api/ats.rb +4 -2
- data/lib/aspera/api/cos_node.rb +7 -4
- data/lib/aspera/api/faspex.rb +16 -9
- data/lib/aspera/api/httpgw.rb +9 -6
- data/lib/aspera/api/node.rb +29 -22
- data/lib/aspera/ascmd.rb +8 -5
- data/lib/aspera/ascp/installation.rb +95 -67
- data/lib/aspera/ascp/log.schema.yaml +1084 -0
- data/lib/aspera/ascp/log_analyzer/advice.rb +97 -0
- data/lib/aspera/ascp/log_analyzer/diagnostics.rb +344 -0
- data/lib/aspera/ascp/log_analyzer/lines.rb +75 -0
- data/lib/aspera/ascp/log_analyzer/log_file.rb +593 -0
- data/lib/aspera/ascp/log_analyzer/records.rb +379 -0
- data/lib/aspera/ascp/log_analyzer/rules.rb +172 -0
- data/lib/aspera/ascp/log_analyzer/session.rb +782 -0
- data/lib/aspera/ascp/log_analyzer.rb +370 -0
- data/lib/aspera/ascp/log_locations.rb +163 -0
- data/lib/aspera/ascp/management.rb +16 -8
- data/lib/aspera/ascp/session_errors.rb +217 -0
- data/lib/aspera/assert.rb +4 -0
- data/lib/aspera/cli/ascp_actions.rb +12 -19
- data/lib/aspera/cli/ascp_logs_actions.rb +188 -0
- data/lib/aspera/cli/async_transfer_store.rb +7 -4
- data/lib/aspera/cli/bootstrapper.rb +38 -33
- data/lib/aspera/cli/command_line.rb +63 -8
- data/lib/aspera/cli/command_registry.rb +9 -1
- data/lib/aspera/cli/command_spec.rb +47 -7
- data/lib/aspera/cli/completion/ascli.bash +19 -5
- data/lib/aspera/cli/completion/ascli.fish +13 -2
- data/lib/aspera/cli/completion/ascli.ps1 +31 -9
- data/lib/aspera/cli/completion/ascli.zsh +22 -6
- data/lib/aspera/cli/completion_actions.rb +303 -69
- data/lib/aspera/cli/context.rb +9 -4
- data/lib/aspera/cli/deprecation.rb +5 -2
- data/lib/aspera/cli/error.rb +6 -0
- data/lib/aspera/cli/extended_value.rb +66 -31
- data/lib/aspera/cli/formatter.rb +43 -30
- data/lib/aspera/cli/gem_checker.rb +9 -6
- data/lib/aspera/cli/hints.rb +22 -10
- data/lib/aspera/cli/http.rb +38 -10
- data/lib/aspera/cli/info.rb +12 -7
- data/lib/aspera/cli/mailer.rb +6 -3
- data/lib/aspera/cli/mcp/http_servlet.rb +7 -8
- data/lib/aspera/cli/mcp/secrets.rb +8 -5
- data/lib/aspera/cli/mcp/tool.rb +20 -17
- data/lib/aspera/cli/option_declarator.rb +10 -4
- data/lib/aspera/cli/option_registry.rb +6 -3
- data/lib/aspera/cli/option_types.rb +17 -2
- data/lib/aspera/cli/option_value.rb +77 -18
- data/lib/aspera/cli/options.schema.yaml +641 -80
- data/lib/aspera/cli/parser.rb +71 -35
- data/lib/aspera/cli/plugins/alee.rb +7 -4
- data/lib/aspera/cli/plugins/aoc.rb +248 -37
- data/lib/aspera/cli/plugins/ats.rb +10 -9
- data/lib/aspera/cli/plugins/base.rb +50 -18
- data/lib/aspera/cli/plugins/basic_auth.rb +5 -2
- data/lib/aspera/cli/plugins/config.rb +210 -104
- data/lib/aspera/cli/plugins/console.rb +6 -3
- data/lib/aspera/cli/plugins/cos.rb +8 -4
- data/lib/aspera/cli/plugins/factory.rb +21 -7
- data/lib/aspera/cli/plugins/faspex5.rb +31 -26
- data/lib/aspera/cli/plugins/faspio.rb +7 -5
- data/lib/aspera/cli/plugins/httpgw.rb +7 -4
- data/lib/aspera/cli/plugins/mcp.rb +42 -22
- data/lib/aspera/cli/plugins/node.rb +39 -38
- data/lib/aspera/cli/plugins/oauth.rb +23 -6
- data/lib/aspera/cli/plugins/orchestrator.rb +287 -83
- data/lib/aspera/cli/plugins/preview.rb +72 -45
- data/lib/aspera/cli/plugins/server.rb +66 -14
- data/lib/aspera/cli/plugins/shares.rb +87 -18
- data/lib/aspera/cli/plugins/transferd.rb +228 -0
- data/lib/aspera/cli/poll.rb +236 -0
- data/lib/aspera/cli/preset_actions.rb +144 -30
- data/lib/aspera/cli/preset_manager.rb +113 -35
- data/lib/aspera/cli/prompt.rb +157 -9
- data/lib/aspera/cli/result.rb +12 -8
- data/lib/aspera/cli/runner.rb +89 -48
- data/lib/aspera/cli/secret_finder.rb +4 -1
- data/lib/aspera/cli/security.rb +89 -9
- data/lib/aspera/cli/special_values.rb +4 -1
- data/lib/aspera/cli/sync_actions.rb +15 -10
- data/lib/aspera/cli/table_fitter.rb +3 -0
- data/lib/aspera/cli/terminal_formatter.rb +9 -6
- data/lib/aspera/cli/transfer_actions.rb +11 -8
- data/lib/aspera/cli/transfer_agent.rb +43 -20
- data/lib/aspera/cli/transfer_progress.rb +14 -45
- data/lib/aspera/cli/vault_actions.rb +45 -0
- data/lib/aspera/cli/vault_manager.rb +188 -42
- data/lib/aspera/cli/version.rb +4 -1
- data/lib/aspera/cli/web_secret.rb +12 -10
- data/lib/aspera/cli/wizard.rb +42 -39
- data/lib/aspera/command_line_builder.rb +9 -5
- data/lib/aspera/command_line_converter.rb +4 -1
- data/lib/aspera/coverage.rb +103 -33
- data/lib/aspera/data_repository.rb +4 -1
- data/lib/aspera/dot_container.rb +4 -1
- data/lib/aspera/environment.rb +23 -12
- data/lib/aspera/exec_spec.rb +3 -0
- data/lib/aspera/faspex_gw.rb +13 -9
- data/lib/aspera/faspex_postproc.rb +15 -12
- data/lib/aspera/formatter_interface.rb +4 -1
- data/lib/aspera/graphql.rb +5 -1
- data/lib/aspera/hash_ext.rb +3 -0
- data/lib/aspera/id_generator.rb +20 -5
- data/lib/aspera/inflate.rb +43 -0
- data/lib/aspera/json_rpc/client.rb +6 -5
- data/lib/aspera/json_rpc/version.rb +3 -0
- data/lib/aspera/line_logger.rb +4 -1
- data/lib/aspera/link_header.rb +4 -1
- data/lib/aspera/log.rb +18 -5
- data/lib/aspera/markdown.rb +5 -2
- data/lib/aspera/mime.rb +3 -0
- data/lib/aspera/nagios.rb +6 -4
- data/lib/aspera/node_emulator.rb +15 -13
- data/lib/aspera/oauth/client/base.rb +124 -73
- data/lib/aspera/oauth/client/boot.rb +7 -4
- data/lib/aspera/oauth/client/factory.rb +41 -18
- data/lib/aspera/oauth/client/generic.rb +5 -1
- data/lib/aspera/oauth/client/json_credentials.rb +7 -3
- data/lib/aspera/oauth/client/jwt.rb +6 -3
- data/lib/aspera/oauth/client/shares_web.rb +94 -0
- data/lib/aspera/oauth/client/url_json.rb +7 -3
- data/lib/aspera/oauth/client/web.rb +40 -13
- data/lib/aspera/oauth/server/pkce.rb +6 -5
- data/lib/aspera/orchestrator_workflow_checker.rb +129 -2
- data/lib/aspera/persistency_action_once.rb +5 -3
- data/lib/aspera/persistency_folder.rb +6 -3
- data/lib/aspera/preview/file_types.rb +6 -3
- data/lib/aspera/preview/generator.rb +9 -5
- data/lib/aspera/preview/options.schema.yaml +3 -3
- data/lib/aspera/preview/terminal.rb +16 -6
- data/lib/aspera/preview/utils.rb +6 -4
- data/lib/aspera/products/connect.rb +5 -2
- data/lib/aspera/products/desktop.rb +17 -2
- data/lib/aspera/products/other.rb +4 -2
- data/lib/aspera/products/transferd.rb +6 -2
- data/lib/aspera/products/transferd_service.rb +610 -0
- data/lib/aspera/proxy_auto_config.js +2 -2
- data/lib/aspera/proxy_auto_config.rb +5 -2
- data/lib/aspera/rainbow.rb +3 -0
- data/lib/aspera/rest/aspera_errors.rb +4 -1
- data/lib/aspera/rest/call_error.rb +3 -0
- data/lib/aspera/rest/client.rb +45 -34
- data/lib/aspera/rest/error_analyzer.rb +5 -2
- data/lib/aspera/rest/list.rb +8 -4
- data/lib/aspera/rest/parameters.rb +3 -0
- data/lib/aspera/rest/util.rb +8 -5
- data/lib/aspera/rest.rb +9 -6
- data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +9 -9
- data/lib/aspera/schema/IBM Aspera Orchestrator API-v1-enhanced.yaml +118 -30
- data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +11 -11
- data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2437 -1437
- data/lib/aspera/schema/async_tables.yaml +11 -10
- data/lib/aspera/schema/documentation.rb +8 -2
- data/lib/aspera/schema/reader.rb +7 -0
- data/lib/aspera/schema/registry.rb +44 -28
- data/lib/aspera/schema/transferd-config.schema.json +333 -0
- data/lib/aspera/schema/validator.rb +4 -1
- data/lib/aspera/sealed_hash.rb +150 -0
- data/lib/aspera/secret/hider.rb +213 -0
- data/lib/aspera/secret/reference.rb +150 -0
- data/lib/aspera/secret/resolver.rb +212 -0
- data/lib/aspera/secret/store/base.rb +153 -0
- data/lib/aspera/secret/store/encrypted_hash.rb +329 -0
- data/lib/aspera/secret/store/factory.rb +103 -0
- data/lib/aspera/secret/store/hashicorp_vault.rb +390 -0
- data/lib/aspera/secret/store/keeper.rb +141 -0
- data/lib/aspera/secret/store/macos_security.rb +284 -0
- data/lib/aspera/secret/store/one_password_api.rb +99 -0
- data/lib/aspera/secret/store/one_password_base.rb +42 -0
- data/lib/aspera/secret/store/one_password_cli.rb +112 -0
- data/lib/aspera/secret/store/secret_service.rb +125 -0
- data/lib/aspera/secret/strength.rb +119 -0
- data/lib/aspera/servlet_helpers.rb +5 -2
- data/lib/aspera/ssh.rb +10 -7
- data/lib/aspera/ssl.rb +5 -2
- data/lib/aspera/string_ext.rb +3 -0
- data/lib/aspera/sync/args.schema.yaml +3 -0
- data/lib/aspera/sync/conf.schema.yaml +9 -4
- data/lib/aspera/sync/database.rb +3 -0
- data/lib/aspera/sync/operations.rb +17 -15
- data/lib/aspera/temp_file_manager.rb +8 -4
- data/lib/aspera/timer_limiter.rb +3 -0
- data/lib/aspera/transfer/error.rb +4 -1
- data/lib/aspera/transfer/faux_file.rb +4 -1
- data/lib/aspera/transfer/parameters.rb +17 -14
- data/lib/aspera/transfer/result.rb +23 -0
- data/lib/aspera/transfer/resumer.rb +6 -4
- data/lib/aspera/transfer/spec.rb +9 -22
- data/lib/aspera/units/decimal.rb +67 -0
- data/lib/aspera/units/duration.rb +109 -0
- data/lib/aspera/uri_reader.rb +64 -9
- data/lib/aspera/web_auth/index.html.erb +6 -2
- data/lib/aspera/web_auth/paste.rb +109 -0
- data/lib/aspera/web_auth/receiver.rb +50 -0
- data/lib/aspera/web_auth/relay.rb +76 -0
- data/lib/aspera/web_auth/reply.html.erb +150 -0
- data/lib/aspera/web_auth/server.rb +47 -10
- data/lib/aspera/web_page.rb +7 -2
- data/lib/aspera/web_server_simple.rb +6 -3
- data/lib/aspera/yaml.rb +5 -1
- data/llms-install.md +88 -0
- data/llms.txt +87 -0
- data/skills/ascli/SKILL.md +94 -0
- data.tar.gz.sig +0 -0
- metadata +77 -20
- metadata.gz.sig +0 -0
- data/lib/aspera/duration.rb +0 -42
- data/lib/aspera/keychain/base.rb +0 -30
- data/lib/aspera/keychain/encrypted_hash.rb +0 -192
- data/lib/aspera/keychain/factory.rb +0 -58
- data/lib/aspera/keychain/hashicorp_vault.rb +0 -77
- data/lib/aspera/keychain/macos_security.rb +0 -277
- data/lib/aspera/keychain/one_password_api.rb +0 -91
- data/lib/aspera/keychain/one_password_base.rb +0 -39
- data/lib/aspera/keychain/one_password_cli.rb +0 -100
- data/lib/aspera/secret_hider.rb +0 -196
- data/lib/aspera/secret_strength.rb +0 -114
data/lib/aspera/cli/parser.rb
CHANGED
|
@@ -1,20 +1,24 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative 'preset_manager'
|
|
7
|
+
require_relative 'extended_value'
|
|
8
|
+
require_relative 'error'
|
|
9
|
+
require_relative 'special_values'
|
|
10
|
+
require_relative 'terminal_formatter'
|
|
11
|
+
require_relative 'option_types'
|
|
12
|
+
require_relative 'option_value'
|
|
13
|
+
require_relative 'option_registry'
|
|
14
|
+
require_relative 'command_line'
|
|
15
|
+
require_relative 'prompt'
|
|
16
|
+
require_relative '../schema/validator'
|
|
17
|
+
require_relative '../log'
|
|
18
|
+
require_relative '../assert'
|
|
19
|
+
require_relative '../dot_container'
|
|
20
|
+
require_relative '../rainbow'
|
|
16
21
|
require 'terminal-table'
|
|
17
|
-
require 'aspera/rainbow'
|
|
18
22
|
using Rainbow
|
|
19
23
|
|
|
20
24
|
module Aspera
|
|
@@ -90,16 +94,18 @@ module Aspera
|
|
|
90
94
|
|
|
91
95
|
# Using dotted hash notation, convert value to bool, int, float or extended value
|
|
92
96
|
# `true` and `yes` are converted to `true`, `false` and `no` to `false`
|
|
93
|
-
# @param value
|
|
97
|
+
# @param value [String] The value to convert to appropriate type
|
|
98
|
+
# @param context [String] Where the value comes from, for error messages
|
|
99
|
+
# @param allowed [Class, Array, nil] Types accepted for an extended value
|
|
94
100
|
# @return [Boolean, Integer, Float, String, Array, Hash] the converted value
|
|
95
|
-
def smart_convert(value)
|
|
101
|
+
def smart_convert(value, context: 'dotted expression', allowed: nil)
|
|
96
102
|
case value
|
|
97
103
|
when 'true', BoolValue::YES_SYM.to_s then true
|
|
98
104
|
when 'false', BoolValue::NO_SYM.to_s then false
|
|
99
105
|
else
|
|
100
106
|
Integer(value, 10, exception: false) ||
|
|
101
107
|
Float(value, exception: false) ||
|
|
102
|
-
ExtendedValue.instance.evaluate(value, context:
|
|
108
|
+
ExtendedValue.instance.evaluate(value, context: context, allowed: allowed)
|
|
103
109
|
end
|
|
104
110
|
end
|
|
105
111
|
end
|
|
@@ -146,10 +152,13 @@ module Aspera
|
|
|
146
152
|
# @param on_set [#call] Called with the new value each time the value is set (e.g. a `Method`, or a lambda).
|
|
147
153
|
# For a flag (`Type::NONE`): called without argument when the flag is found
|
|
148
154
|
# @param shorthand [String] For a `Hash` option: a `String` value is stored as `{shorthand => value}`
|
|
155
|
+
# @param convert [#call] For a `Hash` option: called with a new `Hash` value, returns the value to store, before merge (e.g. conversion of a deprecated form)
|
|
149
156
|
# @param deprecation [Hash, nil] deprecation: `{last:, message:}`, see `Deprecation`
|
|
150
157
|
# @param schema [String] schema path documenting the Hash form of this option
|
|
158
|
+
# @param complete [Symbol, nil] values proposed by shell completion, one of `Complete::KINDS`
|
|
159
|
+
# @param security [Symbol, nil] most restrictive security level at which the option is available, see `Security`
|
|
151
160
|
# @param block [Proc] Block to execute when option is found
|
|
152
|
-
def declare(option_symbol, description: nil, short: nil, allowed: nil, default: nil, on_set: nil, shorthand: nil, deprecation: nil, schema: nil, &block)
|
|
161
|
+
def declare(option_symbol, description: nil, short: nil, allowed: nil, default: nil, on_set: nil, shorthand: nil, convert: nil, deprecation: nil, schema: nil, complete: nil, security: nil, &block)
|
|
153
162
|
Aspera.assert_type(option_symbol, Symbol)
|
|
154
163
|
Aspera.assert(!@registry.declared?(option_symbol)) { "#{option_symbol} already declared" }
|
|
155
164
|
if on_set && allowed.eql?(Type::NONE)
|
|
@@ -170,8 +179,11 @@ module Aspera
|
|
|
170
179
|
allowed: allowed,
|
|
171
180
|
on_set: on_set,
|
|
172
181
|
shorthand: shorthand,
|
|
182
|
+
convert: convert,
|
|
173
183
|
deprecation: deprecation,
|
|
174
|
-
schema: schema
|
|
184
|
+
schema: schema,
|
|
185
|
+
complete: complete,
|
|
186
|
+
security: security
|
|
175
187
|
),
|
|
176
188
|
short: short
|
|
177
189
|
)
|
|
@@ -205,9 +217,9 @@ module Aspera
|
|
|
205
217
|
# @param validation [Class, Array, nil] Accepted value type(s) or list of Symbols
|
|
206
218
|
# @param aliases [Hash] map of aliases: key = alias, value = real value
|
|
207
219
|
# @param default [Object] default value
|
|
208
|
-
# @param
|
|
220
|
+
# @param evaluate [Symbol] `:extended`: extended value, `:smart`: also `true`, `yes`, `false`, `no` and numbers, `:none`: as typed
|
|
209
221
|
# @return [Object, Array, nil] one value, list or nil (if optional and no default)
|
|
210
|
-
def get_next_argument(descr, mandatory: true, multiple: false, accept_list: nil, validation: Type::STRING, aliases: nil, default: nil, schema: nil,
|
|
222
|
+
def get_next_argument(descr, mandatory: true, multiple: false, accept_list: nil, validation: Type::STRING, aliases: nil, default: nil, schema: nil, evaluate: :extended)
|
|
211
223
|
ensure_parsed
|
|
212
224
|
Aspera.assert_array_all(accept_list, Symbol) unless accept_list.nil?
|
|
213
225
|
Aspera.assert_hash_all(aliases, Symbol, Symbol) unless aliases.nil?
|
|
@@ -216,7 +228,7 @@ module Aspera
|
|
|
216
228
|
Aspera.assert_array_all(validation, Class) { 'validation' } unless validation.nil?
|
|
217
229
|
descr = "#{descr}#{add_types_info(validation)}"
|
|
218
230
|
result =
|
|
219
|
-
if !@command_line.pending_arguments.empty? then read_arguments(descr, multiple: multiple, validation: validation, accept_list: accept_list, aliases: aliases,
|
|
231
|
+
if !@command_line.pending_arguments.empty? then read_arguments(descr, multiple: multiple, validation: validation, accept_list: accept_list, aliases: aliases, evaluate: evaluate)
|
|
220
232
|
elsif !default.nil? then default
|
|
221
233
|
elsif mandatory then get_interactive(descr, multiple: multiple, accept_list: accept_list, aliases: aliases, schema: schema)
|
|
222
234
|
end
|
|
@@ -231,13 +243,15 @@ module Aspera
|
|
|
231
243
|
#
|
|
232
244
|
# @param description [String] description of the identifier
|
|
233
245
|
# @param multiple [Boolean] `true`: read a list of IDs (bulk operation)
|
|
246
|
+
# @param mandatory [Boolean] `false`: the identifier may be absent, then `default` is returned
|
|
247
|
+
# @param default [Object] value when the identifier is absent and not mandatory
|
|
234
248
|
# @param block [Proc] block to search for identifier based on attribute value
|
|
235
249
|
# @return [String, Array<String>] identifier or list of IDs (if `multiple`)
|
|
236
250
|
# @yieldparam field [String] The field name from percent selector
|
|
237
251
|
# @yieldparam value [String] The value from percent selector
|
|
238
252
|
# @yieldreturn [String] Resolved identifier
|
|
239
|
-
def instance_identifier(description: 'identifier', multiple: false, &block)
|
|
240
|
-
res_id = get_next_argument(description, multiple: multiple)
|
|
253
|
+
def instance_identifier(description: 'identifier', multiple: false, mandatory: true, default: nil, &block)
|
|
254
|
+
res_id = get_next_argument(description, multiple: multiple, mandatory: mandatory, default: default)
|
|
241
255
|
# Can be an Array
|
|
242
256
|
if res_id.is_a?(String) && (m = Parser.percent_selector(res_id))
|
|
243
257
|
Aspera.assert(block_given?, type: Cli::BadArgument) { "Percent syntax for #{description} not supported in this context" }
|
|
@@ -250,7 +264,11 @@ module Aspera
|
|
|
250
264
|
# @param command_list [Array<Symbol>] accepted command names
|
|
251
265
|
# @param aliases [Hash, nil] command aliases
|
|
252
266
|
# @return [Symbol] selected command
|
|
253
|
-
def get_next_command(command_list, aliases: nil)
|
|
267
|
+
def get_next_command(command_list, aliases: nil)
|
|
268
|
+
command = get_next_argument('command', accept_list: command_list, aliases: aliases)
|
|
269
|
+
@command_line.mark_command
|
|
270
|
+
command
|
|
271
|
+
end
|
|
254
272
|
|
|
255
273
|
# Check whether an option has already been declared in this manager
|
|
256
274
|
# @param option_symbol [Symbol] name of the option
|
|
@@ -363,8 +381,9 @@ module Aspera
|
|
|
363
381
|
end
|
|
364
382
|
|
|
365
383
|
# Check for unprocessed options or arguments error messages
|
|
384
|
+
# @param after_error [Boolean] `true` if an error was already reported: positional arguments are then not consumed because of this error, not reported
|
|
366
385
|
# @return [Array<String>] list of error messages for unprocessed tokens
|
|
367
|
-
def final_errors
|
|
386
|
+
def final_errors(after_error: false)
|
|
368
387
|
begin
|
|
369
388
|
ensure_parsed
|
|
370
389
|
rescue StandardError => e
|
|
@@ -373,19 +392,21 @@ module Aspera
|
|
|
373
392
|
end
|
|
374
393
|
result = []
|
|
375
394
|
result.push("unprocessed options: #{@command_line.pending_options}") unless @command_line.pending_options.empty?
|
|
376
|
-
result.push("unprocessed values: #{@command_line.pending_arguments}") unless @command_line.pending_arguments.empty?
|
|
395
|
+
result.push("unprocessed values: #{@command_line.pending_arguments}") unless after_error || @command_line.pending_arguments.empty?
|
|
377
396
|
result
|
|
378
397
|
end
|
|
379
398
|
|
|
380
|
-
# Get
|
|
399
|
+
# Get long options with a value from command line, used to generate a config in config file.
|
|
381
400
|
# They are marked as processed.
|
|
401
|
+
# @param after_command [Boolean] `true`: only options placed after the last command word
|
|
382
402
|
# @return [Hash] options with value, dotted notation expanded
|
|
383
|
-
def unprocessed_options_with_value
|
|
403
|
+
def unprocessed_options_with_value(after_command: false)
|
|
384
404
|
ensure_parsed
|
|
385
405
|
result = {}
|
|
386
|
-
@command_line.each_long_option_with_value do |tok|
|
|
406
|
+
@command_line.each_long_option_with_value(after_command: after_command) do |tok|
|
|
387
407
|
path = [tok.name, *tok.dot_path]
|
|
388
|
-
|
|
408
|
+
declare_secrets(path.last, tok.value)
|
|
409
|
+
Log.log.debug { "option #{path.join(DotContainer::SEPARATOR)}=#{Secret::Hider.instance.hidden_copy(tok.value)}" }
|
|
389
410
|
DotContainer.dotted_to_container(path, Parser.smart_convert(tok.value), result)
|
|
390
411
|
end
|
|
391
412
|
result
|
|
@@ -471,7 +492,7 @@ module Aspera
|
|
|
471
492
|
result = nil
|
|
472
493
|
@command_line.with_arguments_after_current_option do
|
|
473
494
|
get_next_argument('args', multiple: end_marker).each do |argument|
|
|
474
|
-
Aspera.assert(argument.include?(Option::VALUE_SEP)) { "
|
|
495
|
+
Aspera.assert(argument.include?(Option::VALUE_SEP), type: BadArgument) { "Argument collected by @: does not include #{Option::VALUE_SEP}: #{argument} (end marker: #{end_marker})" }
|
|
475
496
|
path, value = argument.split(Option::VALUE_SEP, 2)
|
|
476
497
|
result = DotContainer.dotted_to_container(path.split(DotContainer::SEPARATOR), Parser.smart_convert(value), result)
|
|
477
498
|
end
|
|
@@ -525,11 +546,17 @@ module Aspera
|
|
|
525
546
|
" (#{types.map(&:name).join(', ')})"
|
|
526
547
|
end
|
|
527
548
|
|
|
528
|
-
# Consume positional arguments, and evaluate them
|
|
549
|
+
# Consume positional arguments, and evaluate them as told by `evaluate`
|
|
529
550
|
# @return [Object, Array] one value, or list if `multiple`
|
|
530
|
-
def read_arguments(descr, multiple:, validation:, accept_list:, aliases:,
|
|
551
|
+
def read_arguments(descr, multiple:, validation:, accept_list:, aliases:, evaluate:)
|
|
531
552
|
values = @command_line.shift_arguments(multiple)
|
|
532
|
-
|
|
553
|
+
context = "argument: #{descr}"
|
|
554
|
+
case evaluate
|
|
555
|
+
when :extended then values = values.map { |v| ExtendedValue.instance.evaluate(v, context: context, allowed: validation) }
|
|
556
|
+
when :smart then values = values.map { |v| Parser.smart_convert(v, context: context, allowed: validation) }
|
|
557
|
+
when :none then nil
|
|
558
|
+
else Aspera.error_unexpected_value(evaluate)
|
|
559
|
+
end
|
|
533
560
|
# If expecting list and only one arg of type array : it is the list
|
|
534
561
|
values = values.first if multiple && values.length.eql?(1) && values.first.is_a?(Array)
|
|
535
562
|
if accept_list
|
|
@@ -668,6 +695,7 @@ module Aspera
|
|
|
668
695
|
# @param source [Symbol] `OptionSource`
|
|
669
696
|
# @param replace [Boolean] replace a pending value from same source
|
|
670
697
|
def add_pending_value(option_symbol, value, source, replace:)
|
|
698
|
+
declare_secrets(option_symbol, value)
|
|
671
699
|
entries = (@pending_values[option_symbol] ||= [])
|
|
672
700
|
index = entries.index { |e| e[:source].eql?(source) }
|
|
673
701
|
if index.nil?
|
|
@@ -677,6 +705,14 @@ module Aspera
|
|
|
677
705
|
end
|
|
678
706
|
end
|
|
679
707
|
|
|
708
|
+
# Declare secret values of an option not declared yet, by option name (as `OptionValue#store` does for a declared option),
|
|
709
|
+
# so that they are hidden wherever they appear (logs, results), also in a structure (e.g. `{value:, source:}` of a pending value)
|
|
710
|
+
# @param name [Symbol, String] option name
|
|
711
|
+
# @param value [Object] value
|
|
712
|
+
def declare_secrets(name, value)
|
|
713
|
+
Secret::Hider.instance.add_named_secrets(name, value)
|
|
714
|
+
end
|
|
715
|
+
|
|
680
716
|
# Apply pending values (presets, env) of declared options, lowest priority first
|
|
681
717
|
def apply_pending_values
|
|
682
718
|
ready = @pending_values.select { |k, _| @registry.declared?(k) }
|
|
@@ -1,9 +1,12 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative '../../assert'
|
|
7
|
+
require_relative '../../api/alee'
|
|
8
|
+
require_relative '../../nagios'
|
|
9
|
+
require_relative 'basic_auth'
|
|
7
10
|
|
|
8
11
|
module Aspera
|
|
9
12
|
module Cli
|