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
|
@@ -1,62 +1,208 @@
|
|
|
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 'error'
|
|
7
|
+
require_relative 'info'
|
|
8
|
+
require_relative 'security'
|
|
9
|
+
require_relative 'deprecation'
|
|
10
|
+
require_relative '../secret/reference'
|
|
11
|
+
require_relative '../log'
|
|
12
|
+
require_relative '../assert'
|
|
7
13
|
|
|
8
14
|
module Aspera
|
|
9
15
|
module Cli
|
|
10
|
-
#
|
|
11
|
-
#
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
16
|
+
# Secrets of the vault, shared in `Context#vault`: read by `@vault:`, managed by `config vault`, written by presets.
|
|
17
|
+
# Option `vault`: named stores (`stores`), the name of the default store (`default`) and the cache of references (`cache_ttl`), see `Secret::Resolver`.
|
|
18
|
+
# - `<label>.<field>`: secret of the default store, unlocked with option `vault_password`, managed by label
|
|
19
|
+
# - `//<store>/<path>[?<options>][#<field>]`: reference to a secret of a store, read only
|
|
20
|
+
#
|
|
21
|
+
# Values `@file:<path>` in these options (e.g. `token`) are read by `Secret::Bootstrap`, not by `ExtendedValue`:
|
|
22
|
+
# they are checked here as extended value `@file:`, so that option `security` applies (e.g. in MCP server mode).
|
|
23
|
+
class VaultManager
|
|
24
|
+
# Beginning of a reference after `@vault:`, `secret://` without `secret:`
|
|
25
|
+
REFERENCE_PREFIX = '//'
|
|
26
|
+
# File of type `file`, in the configuration folder
|
|
27
|
+
DEFAULT_FILE = 'vault.bin'
|
|
28
|
+
# Name of the default store, not given to `Secret::Resolver`
|
|
29
|
+
DEFAULT_KEY = 'default'
|
|
30
|
+
STORES_KEY = 'stores'
|
|
31
|
+
# Keys of option `vault`, others are parameters of a store (deprecated form)
|
|
32
|
+
OPTION_KEYS = [DEFAULT_KEY, 'cache_ttl', STORES_KEY].freeze
|
|
33
|
+
private_constant :DEFAULT_FILE, :DEFAULT_KEY, :STORES_KEY, :OPTION_KEYS
|
|
34
|
+
|
|
35
|
+
class << self
|
|
36
|
+
# Value of option `vault` when set (`convert` of option): the parameters of one store (deprecated) are
|
|
37
|
+
# a store named after its type, which is the default store.
|
|
38
|
+
# @param value [Hash] Value of option `vault`
|
|
39
|
+
# @return [Hash] Value with `stores`
|
|
40
|
+
def convert_option(value)
|
|
41
|
+
value = value.transform_keys(&:to_s)
|
|
42
|
+
params = value.except(*OPTION_KEYS)
|
|
43
|
+
return value if params.empty?
|
|
44
|
+
params['type'] ||= 'file'
|
|
45
|
+
name = params['type'].to_s
|
|
46
|
+
Log.log.warn do
|
|
47
|
+
"option vault: parameters of one store are #{Deprecation.new(last: '4.28.0', message: "set a store in #{STORES_KEY}, and its name in #{DEFAULT_KEY}: {\"#{DEFAULT_KEY}\":\"#{name}\",\"#{STORES_KEY}\":{\"#{name}\":{...}}}")}"
|
|
48
|
+
end
|
|
49
|
+
value.slice(*OPTION_KEYS).merge(DEFAULT_KEY => name, STORES_KEY => (value[STORES_KEY] || {}).merge(name => params))
|
|
18
50
|
end
|
|
19
51
|
end
|
|
20
52
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
53
|
+
# @param options [Parser] Options `vault` and `vault_password`
|
|
54
|
+
# @param main_folder [String] Folder of relative paths of vault files
|
|
55
|
+
def initialize(options, main_folder)
|
|
56
|
+
@options = options
|
|
57
|
+
@main_folder = main_folder
|
|
58
|
+
@resolver = nil
|
|
59
|
+
# Name of the default store, `nil` if none
|
|
60
|
+
@default = nil
|
|
61
|
+
# Name and type of stores, without parameters (may contain secrets)
|
|
62
|
+
@stores = []
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# Stores of option `vault`, without their parameters
|
|
66
|
+
# @return [Array<Hash>] `name`, `type`, `default` of each store, empty if not configured
|
|
67
|
+
def stores
|
|
68
|
+
resolver
|
|
69
|
+
@stores
|
|
26
70
|
end
|
|
27
71
|
|
|
28
|
-
#
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
72
|
+
# Default store, opened when first used.
|
|
73
|
+
# @param mandatory [Boolean] Raise if not configured
|
|
74
|
+
# @return [Secret::Store::Base, nil] Store, `nil` if not configured
|
|
75
|
+
def store(mandatory: false)
|
|
76
|
+
return if resolver(mandatory: mandatory).nil?
|
|
77
|
+
Aspera.assert(!mandatory || !@default.nil?, type: BadArgument) { "option vault: no default store: set #{DEFAULT_KEY}" }
|
|
78
|
+
@resolver.store(@default) unless @default.nil?
|
|
32
79
|
end
|
|
33
80
|
|
|
34
|
-
#
|
|
35
|
-
|
|
81
|
+
# Value of `@vault:`
|
|
82
|
+
# @param name [String] `<label>.<field>` or `//<store>/<path>[?<options>][#<field>]`
|
|
83
|
+
# @return [String] Value of secret
|
|
84
|
+
def value(name)
|
|
85
|
+
return resolver(mandatory: true).resolve(reference_text(name)) if name.start_with?(REFERENCE_PREFIX)
|
|
36
86
|
# Label may contain dots (e.g. preset name)
|
|
37
87
|
label, _, param = name.rpartition('.')
|
|
38
88
|
Aspera.assert(!label.empty? && !param.empty?, type: BadArgument) { 'vault name shall match <name>.<param>' }
|
|
39
|
-
info =
|
|
89
|
+
info = store(mandatory: true).get(label: label)
|
|
40
90
|
value = info[param.to_sym]
|
|
41
91
|
raise "no such entry value: #{param}" if value.nil?
|
|
42
|
-
|
|
43
|
-
end
|
|
44
|
-
|
|
45
|
-
#
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
)
|
|
92
|
+
value
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# Checks that a reference can be read, without its value
|
|
96
|
+
# @param name [String] `//<store>/<path>[?<options>][#<field>]`
|
|
97
|
+
# @return [Hash] `store`, `version`, `updated_time`
|
|
98
|
+
def metadata(name)
|
|
99
|
+
Aspera.assert(name.start_with?(REFERENCE_PREFIX), type: BadArgument) { "expecting a reference: @vault:#{REFERENCE_PREFIX}<store>/<path>[?<options>][#<field>]" }
|
|
100
|
+
resolver(mandatory: true).metadata(reference_text(name))
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Field names of a secret of the default store, without values
|
|
104
|
+
# @param label [String] Label of secret
|
|
105
|
+
# @return [Array<String>] Names of fields that a reference can read
|
|
106
|
+
def fields(label)
|
|
107
|
+
store(mandatory: true)
|
|
108
|
+
reference = Secret.reference_text(store: @default, path: label)
|
|
109
|
+
resolver(mandatory: true).fields(reference)[:fields]
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
private
|
|
113
|
+
|
|
114
|
+
# Resolver of the stores of option `vault`, created when first used.
|
|
115
|
+
# Not kept when not configured: options may be set later (e.g. by the global preset).
|
|
116
|
+
# @param mandatory [Boolean] Raise if not configured
|
|
117
|
+
# @return [Secret::Resolver, nil] Resolver, `nil` if not configured
|
|
118
|
+
def resolver(mandatory: false)
|
|
119
|
+
@resolver ||= create_resolver
|
|
120
|
+
Aspera.assert(!mandatory || !@resolver.nil?, type: BadArgument) { 'Missing mandatory option: vault' }
|
|
121
|
+
@resolver
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# @return [Secret::Resolver, nil] Resolver of option `vault`, `nil` if not configured
|
|
125
|
+
def create_resolver
|
|
126
|
+
config = @options.get_option(:vault, mandatory: false)
|
|
127
|
+
return if config.nil? || (config.is_a?(Hash) && config.empty?)
|
|
128
|
+
Aspera.assert_type(config, Hash, type: BadArgument) { 'option vault' }
|
|
129
|
+
config = config.transform_keys(&:to_s)
|
|
130
|
+
stores = config[STORES_KEY]
|
|
131
|
+
Aspera.assert_type(stores, Hash, type: BadArgument) { "option vault: #{STORES_KEY}" }
|
|
132
|
+
stores = stores.to_h { |name, params| [name.to_s, store_parameters(params)] }
|
|
133
|
+
default = config.delete(DEFAULT_KEY)&.to_s
|
|
134
|
+
Aspera.assert(default.nil? || stores.key?(default), type: BadArgument) { "option vault: #{DEFAULT_KEY}: no store #{default}" }
|
|
135
|
+
check_file_values(:vault, stores)
|
|
136
|
+
add_vault_password(stores[default]) unless default.nil?
|
|
137
|
+
require_relative '../secret/resolver'
|
|
138
|
+
resolver = Secret::Resolver.new(config.merge(STORES_KEY => stores))
|
|
139
|
+
@default = default
|
|
140
|
+
@stores = stores.map { |name, params| {'name' => name, 'type' => params[:type], 'default' => name.eql?(default)} }
|
|
141
|
+
resolver
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# Parameters of a store, with the defaults of `ascli`
|
|
145
|
+
# @param params [Hash] Parameters of a store of option `vault`
|
|
146
|
+
# @return [Hash] Parameters of `Secret::Store::Factory`, Symbol keys
|
|
147
|
+
def store_parameters(params)
|
|
148
|
+
Aspera.assert_type(params, Hash, type: BadArgument) { 'option vault: store' }
|
|
149
|
+
params = params.transform_keys(&:to_sym)
|
|
150
|
+
case params[:type]
|
|
151
|
+
when 'file'
|
|
152
|
+
# `name`: same as `file`, for compatibility
|
|
153
|
+
file = params.delete(:name) || params[:file] || DEFAULT_FILE
|
|
154
|
+
params[:file] = file.is_a?(String) && !File.absolute_path?(file) ? File.join(@main_folder, file) : file
|
|
155
|
+
when 'system', 'secret_service'
|
|
156
|
+
params[:name] ||= Info::CMD_NAME
|
|
157
|
+
end
|
|
158
|
+
params
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
# Option `vault_password` is the secret of the default store, if not in its parameters
|
|
162
|
+
# @param params [Hash] Parameters of the default store, modified
|
|
163
|
+
def add_vault_password(params)
|
|
164
|
+
key =
|
|
165
|
+
case params[:type]
|
|
166
|
+
when 'file' then :password
|
|
167
|
+
when 'vault' then :token unless params.key?(:approle)
|
|
168
|
+
when '1password' then :token unless params[:source].eql?('cli')
|
|
169
|
+
when 'keeper' then :config
|
|
170
|
+
end
|
|
171
|
+
return if key.nil? || params.key?(key)
|
|
172
|
+
password = @options.get_option(:vault_password)
|
|
173
|
+
Aspera.assert(!password.nil? || !params[:type].eql?('file'), type: BadArgument) { 'Missing mandatory option: vault_password' }
|
|
174
|
+
return if password.nil?
|
|
175
|
+
check_file_values(:vault_password, password)
|
|
176
|
+
params[key] = password
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
# Values `@file:<path>` are read like extended value `@file:`, see `Security`
|
|
180
|
+
# @param option [Symbol] Name of option, for errors
|
|
181
|
+
# @param value [Object] Value of option
|
|
182
|
+
# @raise [BadArgument] Reading a file is refused at current security level
|
|
183
|
+
def check_file_values(option, value)
|
|
184
|
+
file_paths(value).each do |path|
|
|
185
|
+
Security.instance.check_extended_value(:file)
|
|
186
|
+
Security.instance.readable_path(path)
|
|
187
|
+
end
|
|
188
|
+
rescue BadArgument => e
|
|
189
|
+
raise BadArgument, "option #{option}: #{e.message}"
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# @param value [Object] Value of option
|
|
193
|
+
# @return [Array<String>] Paths of values `@file:<path>`, also in nested values
|
|
194
|
+
def file_paths(value)
|
|
195
|
+
case value
|
|
196
|
+
when Hash then value.values.flat_map { |v| file_paths(v) }
|
|
197
|
+
when Array then value.flat_map { |v| file_paths(v) }
|
|
198
|
+
when String then value.start_with?(Secret::Bootstrap::FILE_PREFIX) ? [value.delete_prefix(Secret::Bootstrap::FILE_PREFIX)] : []
|
|
199
|
+
else []
|
|
200
|
+
end
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# @return [String] Reference `secret://...` of value of `@vault://...`
|
|
204
|
+
def reference_text(name)
|
|
205
|
+
"#{Secret::SCHEME}#{name.delete_prefix(REFERENCE_PREFIX)}"
|
|
60
206
|
end
|
|
61
207
|
end
|
|
62
208
|
end
|
data/lib/aspera/cli/version.rb
CHANGED
|
@@ -1,9 +1,12 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
3
6
|
module Aspera
|
|
4
7
|
module Cli
|
|
5
8
|
# For beta add extension : .beta1
|
|
6
9
|
# For dev version add extension : .pre
|
|
7
|
-
VERSION = '4.
|
|
10
|
+
VERSION = '4.29.1'
|
|
8
11
|
end
|
|
9
12
|
end
|
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
#
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative '../log'
|
|
7
|
+
require_relative '../assert'
|
|
8
|
+
require_relative '../environment'
|
|
9
|
+
require_relative '../web_page'
|
|
10
|
+
require_relative '../servlet_helpers'
|
|
11
|
+
require_relative 'error'
|
|
12
|
+
require_relative 'info'
|
|
12
13
|
require 'openssl'
|
|
13
14
|
require 'securerandom'
|
|
15
|
+
require 'uri'
|
|
14
16
|
|
|
15
17
|
module Aspera
|
|
16
18
|
module Cli
|
|
@@ -198,7 +200,7 @@ module Aspera
|
|
|
198
200
|
# Start a local web server for the pages
|
|
199
201
|
# @return [String] URL of the local server
|
|
200
202
|
def start_local_server
|
|
201
|
-
|
|
203
|
+
require_relative '../web_server_simple'
|
|
202
204
|
servlet = Class.new(WEBrick::HTTPServlet::AbstractServlet) do
|
|
203
205
|
include ServletHelpers
|
|
204
206
|
|
data/lib/aspera/cli/wizard.rb
CHANGED
|
@@ -1,29 +1,24 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative '../oauth/client/jwt'
|
|
7
|
+
require_relative '../assert'
|
|
8
|
+
require_relative '../environment'
|
|
9
|
+
require_relative '../id_generator'
|
|
10
|
+
require_relative 'plugins/factory'
|
|
11
|
+
require_relative '../rainbow'
|
|
10
12
|
using Rainbow
|
|
11
13
|
|
|
12
14
|
module Aspera
|
|
13
15
|
module Cli
|
|
14
16
|
# The wizard detects applications and generates a config
|
|
15
17
|
class Wizard
|
|
16
|
-
extend OptionDeclarator
|
|
17
|
-
|
|
18
18
|
WIZARD_RESULT_KEYS = %i[preset_ids preset_value test_args].freeze
|
|
19
19
|
DEFAULT_PRIV_KEY_FILENAME = 'my_private_key.pem' # pragma: allowlist secret
|
|
20
20
|
private_constant :WIZARD_RESULT_KEYS, :DEFAULT_PRIV_KEY_FILENAME
|
|
21
21
|
|
|
22
|
-
# Declared by the `config` plugin (`use_options Wizard`)
|
|
23
|
-
option :override, description: 'Wizard: override existing value', allowed: Type::BOOLEAN, default: false
|
|
24
|
-
option :default, description: 'Wizard: set as default configuration for specified plugin (also: update)', allowed: Type::BOOLEAN, default: true
|
|
25
|
-
option :key_path, description: 'Wizard: path to private key for JWT'
|
|
26
|
-
|
|
27
22
|
def initialize(parent, main_folder)
|
|
28
23
|
@parent = parent
|
|
29
24
|
@main_folder = main_folder
|
|
@@ -94,32 +89,37 @@ module Aspera
|
|
|
94
89
|
nil
|
|
95
90
|
end
|
|
96
91
|
|
|
97
|
-
# To be called in public wizard method to get private key
|
|
92
|
+
# To be called in public wizard method to get private key.
|
|
93
|
+
# The key is the value of option `private_key` (e.g. `@file:<path>`): if empty or not provided, the default key is used, or generated.
|
|
98
94
|
# @param user [String] User's email
|
|
99
95
|
# @param url [String] Instance URL
|
|
100
96
|
# @param page [Array<String>] Navigation steps to the page to enter the public key (see `display_navigation`)
|
|
101
|
-
# @return [String]
|
|
97
|
+
# @return [String] Value of `private_key` for the preset: the key as provided, or a reference to the generated file
|
|
102
98
|
def ask_private_key(user:, url:, page:)
|
|
103
|
-
# Lets see if
|
|
104
|
-
|
|
99
|
+
# Lets see if the private key is provided
|
|
100
|
+
private_key_pem = options.get_option(:private_key)
|
|
105
101
|
# Give a chance to provide
|
|
106
|
-
if
|
|
107
|
-
formatter.display_status('
|
|
108
|
-
|
|
102
|
+
if private_key_pem.nil?
|
|
103
|
+
formatter.display_status('Private RSA key, e.g. @file:<path> (leave empty to generate):')
|
|
104
|
+
private_key_pem = options.get_option(:private_key, mandatory: true).to_s
|
|
109
105
|
end
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
106
|
+
if private_key_pem.empty?
|
|
107
|
+
private_key_path = File.join(@main_folder, DEFAULT_PRIV_KEY_FILENAME)
|
|
108
|
+
if File.exist?(File.expand_path(private_key_path))
|
|
109
|
+
formatter.display_status('Using existing key:')
|
|
110
|
+
else
|
|
111
|
+
formatter.display_status("Generating #{OAuth::Jwt::DEFAULT_PRIV_KEY_LENGTH} bit RSA key...")
|
|
112
|
+
OAuth::Jwt.generate_rsa_private_key(path: private_key_path)
|
|
113
|
+
formatter.display_status('Created key:')
|
|
114
|
+
end
|
|
115
|
+
formatter.display_status(private_key_path)
|
|
116
|
+
private_key_pem = File.read(File.expand_path(private_key_path))
|
|
117
|
+
options.set_option(:private_key, private_key_pem)
|
|
118
|
+
private_key_preset_value = "@file:#{private_key_path}"
|
|
114
119
|
else
|
|
115
|
-
|
|
116
|
-
OAuth::Jwt.generate_rsa_private_key(path: private_key_path)
|
|
117
|
-
formatter.display_status('Created key:')
|
|
120
|
+
private_key_preset_value = private_key_pem
|
|
118
121
|
end
|
|
119
|
-
formatter.display_status(private_key_path)
|
|
120
|
-
private_key_pem = File.read(File.expand_path(private_key_path))
|
|
121
122
|
pub_key_pem = OpenSSL::PKey::RSA.new(private_key_pem).public_key.to_s
|
|
122
|
-
options.set_option(:private_key, private_key_pem)
|
|
123
123
|
formatter.display_status("Please Log in as user #{user.red} at: #{url.red}")
|
|
124
124
|
display_navigation(*page)
|
|
125
125
|
formatter.display_status("Check or update the value to (#{'including BEGIN/END lines'.red}):".blink)
|
|
@@ -127,18 +127,22 @@ module Aspera
|
|
|
127
127
|
formatter.display_status('Once updated or validated, press [Enter].')
|
|
128
128
|
Environment.instance.open_uri(url)
|
|
129
129
|
$stdin.gets if required
|
|
130
|
-
|
|
130
|
+
private_key_preset_value
|
|
131
131
|
end
|
|
132
132
|
|
|
133
133
|
# Wizard function, creates configuration
|
|
134
|
-
#
|
|
135
|
-
|
|
134
|
+
# Options of the plugin (e.g. `--username`, `--password`, `--private-key`) are read from the command line, once the plugin has declared them.
|
|
135
|
+
# @param apps [Array] list of detected apps
|
|
136
|
+
# @param preset_name [String] name of the preset to create (default: generated)
|
|
137
|
+
# @param override [Boolean] override the existing default preset of the plugin, if it exists
|
|
138
|
+
# @param default [Boolean] set the preset as default configuration for the plugin
|
|
139
|
+
def find(apps, preset_name: '', override: false, default: true)
|
|
136
140
|
identification = if apps.length.eql?(1)
|
|
137
141
|
Log.log.debug { "Detected: #{identification}" }
|
|
138
142
|
apps.first
|
|
139
143
|
else
|
|
140
144
|
formatter.display_status('Multiple applications detected, please select from:')
|
|
141
|
-
|
|
145
|
+
require_relative 'result'
|
|
142
146
|
formatter.display_results(Result::ObjectList.new(apps, fields: %w[product url version]))
|
|
143
147
|
answer = options.prompt_user_input_in_list('product', apps.map { |a| a[:product] })
|
|
144
148
|
apps.find { |a| a[:product].eql?(answer) }
|
|
@@ -168,11 +172,10 @@ module Aspera
|
|
|
168
172
|
# Write configuration file
|
|
169
173
|
formatter.display_status("Preparing preset: #{wiz_preset_name}")
|
|
170
174
|
# Init defaults if necessary
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
@parent.context.presets.defaults_set(identification[:product], wiz_preset_name, wizard_result[:preset_value].stringify_keys, option_default, option_override)
|
|
175
|
+
preset_value = {PresetManager::Key::COMMENT => "wizard: #{identification[:name]}"}.merge(wizard_result[:preset_value].stringify_keys)
|
|
176
|
+
@parent.context.presets.defaults_set(identification[:product], wiz_preset_name, preset_value, default, override)
|
|
174
177
|
test_args = wizard_result[:test_args]
|
|
175
|
-
test_args = "-P#{wiz_preset_name} #{test_args}" unless
|
|
178
|
+
test_args = "-P#{wiz_preset_name} #{test_args}" unless default
|
|
176
179
|
# TODO: actually test the command
|
|
177
180
|
test_cmd = "#{Info::CMD_NAME} #{identification[:product]} #{test_args}"
|
|
178
181
|
return Result::Status.new("You can test with:\n#{test_cmd.red}")
|
|
@@ -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 'log'
|
|
7
|
+
require_relative 'assert'
|
|
8
|
+
require_relative 'schema/registry'
|
|
9
|
+
require_relative 'exec_spec'
|
|
7
10
|
require 'yaml'
|
|
8
11
|
module Aspera
|
|
9
12
|
# Helper class to build command line from a parameter list (key-value hash)
|
|
@@ -28,6 +31,7 @@ module Aspera
|
|
|
28
31
|
'x-cli-switch', # [Boolean] `true` if option has no arg, else by default option has a value
|
|
29
32
|
'x-cli-special', # [Boolean] `true` if special handling (deferred)
|
|
30
33
|
'x-cli-convert', # [String,Hash] Method name for Convert object or Conversion for enum ts to arg
|
|
34
|
+
'x-cli-complete', # [String] Values proposed by shell completion: `file`, `folder` (see `Cli::Complete::KINDS`)
|
|
31
35
|
'x-agents', # [Array] Supported agents (for doc only), if not specified: all
|
|
32
36
|
'x-ts-name', # [Boolean,String] (async) true if same name in transfer spec, else real name in transfer spec, else ignored
|
|
33
37
|
'x-ts-convert', # [String] (async) Name of methods to convert value from transfer spec to `conf` API.
|
|
@@ -231,7 +235,7 @@ module Aspera
|
|
|
231
235
|
else
|
|
232
236
|
# transform into command line option with value
|
|
233
237
|
# parameter_value=parameter_value.to_s if parameter_value.is_a?(Integer)
|
|
234
|
-
parameter_value =
|
|
238
|
+
parameter_value = Array(parameter_value)
|
|
235
239
|
# if transfer_spec value is an array, applies option many times
|
|
236
240
|
parameter_value.each { |v| add_command_line_options(properties['x-cli-option'], v) }
|
|
237
241
|
end
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
require_relative 'assert'
|
|
4
7
|
module Aspera
|
|
5
8
|
# conversion class for transfer spec values to CLI values (ascp)
|
|
6
9
|
class CommandLineConverter
|
data/lib/aspera/coverage.rb
CHANGED
|
@@ -1,39 +1,109 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
#
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
#
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
3
|
+
# SPDX-FileCopyrightText: IBM Corp.
|
|
4
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
|
|
6
|
+
module Aspera
|
|
7
|
+
# Test coverage with SimpleCov, enabled with env var `ENABLE_COVERAGE`.
|
|
8
|
+
# Each tested process stores only its own result in `parts/<uuid>`: merging all results at each process exit is slow when there are many processes.
|
|
9
|
+
# The report is generated by `report`, which merges all parts (called by the test Rake tasks).
|
|
10
|
+
module Coverage
|
|
11
|
+
# Development top folder, computed from this source location
|
|
12
|
+
ROOT = File.dirname(File.realpath(__FILE__), 3)
|
|
13
|
+
# Report folder, relative to `ROOT`
|
|
14
|
+
DIR = 'tmp/coverage'
|
|
15
|
+
# One sub-folder per process, each with its own `.resultset.json`
|
|
16
|
+
PARTS = File.join(DIR, 'parts')
|
|
17
|
+
# Coverage badge (shields.io endpoint), relative to `ROOT`
|
|
18
|
+
BADGE = 'docs/coverage.json'
|
|
19
|
+
# Badge color: first one whose lower limit is reached
|
|
20
|
+
BADGE_COLORS = {90 => 'brightgreen', 80 => 'green', 70 => 'yellowgreen', 60 => 'yellow', 50 => 'orange'}.freeze
|
|
21
|
+
# Results are kept for 1 day (must be longer than time to run the whole test suite, possibly in several runs)
|
|
22
|
+
MERGE_TIMEOUT = 86_400
|
|
23
|
+
# Lines with those words are ignored from coverage (assertions usually do not trigger)
|
|
24
|
+
NO_COV_FUNCTIONS = %w[error_unreachable_line error_unexpected_value Log.log.trace].freeze
|
|
25
|
+
# No coverage in these files or folders
|
|
26
|
+
NO_COV_PATHS = %w[
|
|
27
|
+
build/
|
|
28
|
+
tmp/
|
|
29
|
+
lib/transferd_pb.rb
|
|
30
|
+
lib/transferd_services_pb.rb
|
|
31
|
+
lib/aspera/secret/store/macos_security.rb
|
|
32
|
+
lib/aspera/assert.rb
|
|
33
|
+
].freeze
|
|
34
|
+
private_constant :BADGE_COLORS, :MERGE_TIMEOUT, :NO_COV_FUNCTIONS, :NO_COV_PATHS
|
|
35
|
+
|
|
36
|
+
class << self
|
|
37
|
+
# Start coverage of current process.
|
|
38
|
+
# Must be called before any library is loaded.
|
|
39
|
+
def start
|
|
40
|
+
require 'simplecov'
|
|
41
|
+
require 'securerandom'
|
|
42
|
+
name = SecureRandom.uuid
|
|
43
|
+
SimpleCov.root(ROOT)
|
|
44
|
+
SimpleCov.coverage_dir(File.join(PARTS, name))
|
|
45
|
+
SimpleCov.command_name(name)
|
|
46
|
+
SimpleCov.merge_subprocesses(true)
|
|
47
|
+
SimpleCov.merge_timeout(MERGE_TIMEOUT)
|
|
48
|
+
# The trend of a single process is meaningless
|
|
49
|
+
SimpleCov.history_limit(0)
|
|
50
|
+
# Only store this process result (in its own folder): no report
|
|
51
|
+
SimpleCov.at_exit { SimpleCov.result }
|
|
52
|
+
SimpleCov.start { Aspera::Coverage.filters(self) }
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Merge the results of all processes and generate the report in `DIR`.
|
|
56
|
+
# Results older than `MERGE_TIMEOUT` are deleted.
|
|
57
|
+
# @return [Float, nil] Percentage of covered lines, or `nil` if there is no result
|
|
58
|
+
def report
|
|
59
|
+
require 'simplecov'
|
|
60
|
+
require 'fileutils'
|
|
61
|
+
require 'etc'
|
|
62
|
+
parts = Dir.glob(File.join(ROOT, PARTS, '*'))
|
|
63
|
+
old, parts = parts.partition { |dir| Time.now - File.mtime(dir) > MERGE_TIMEOUT }
|
|
64
|
+
FileUtils.rm_rf(old)
|
|
65
|
+
results = parts.map { |dir| File.join(dir, '.resultset.json') }.select { |file| File.exist?(file) }
|
|
66
|
+
return if results.empty?
|
|
67
|
+
# Else the merged result would be added to the previous one
|
|
68
|
+
FileUtils.rm_f(File.join(ROOT, DIR, '.resultset.json'))
|
|
69
|
+
SimpleCov.root(ROOT)
|
|
70
|
+
SimpleCov.coverage_dir(DIR)
|
|
71
|
+
percent = nil
|
|
72
|
+
# The merged command name lists all process UUIDs: show their number instead
|
|
73
|
+
SimpleCov.at_exit do
|
|
74
|
+
result = SimpleCov.result
|
|
75
|
+
result.command_name = "#{result.command_names.size} processes"
|
|
76
|
+
result.format!
|
|
77
|
+
percent = result.covered_percent
|
|
78
|
+
end
|
|
79
|
+
SimpleCov.collate(results, processes: Etc.nprocessors) { Aspera::Coverage.filters(self) }
|
|
80
|
+
percent
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# Write the coverage badge: a shields.io endpoint file, shown in the top `README.md`
|
|
84
|
+
# @param percent [Float] Percentage of covered lines
|
|
85
|
+
def write_badge(percent)
|
|
86
|
+
require 'json'
|
|
87
|
+
color = BADGE_COLORS.find { |limit, _| percent >= limit }&.last || 'red'
|
|
88
|
+
File.write(File.join(ROOT, BADGE), "#{JSON.pretty_generate(schemaVersion: 1, label: 'coverage', message: format('%.1f%%', percent), color: color)}\n")
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# Configure coverage criteria and filters (in `SimpleCov.start` or `SimpleCov.collate` block)
|
|
92
|
+
# Branch coverage is measured in addition to line coverage (shown in the report, the badge shows lines).
|
|
93
|
+
# @param config [SimpleCov] Receiver of the configuration block
|
|
94
|
+
def filters(config)
|
|
95
|
+
config.enable_coverage(:branch)
|
|
96
|
+
config.skip do |source_file|
|
|
97
|
+
source_file.lines.each do |line|
|
|
98
|
+
line.skipped! if NO_COV_FUNCTIONS.any? { |i| line.src.include?(i) }
|
|
99
|
+
end
|
|
100
|
+
false
|
|
101
|
+
end
|
|
102
|
+
NO_COV_PATHS.each { |path| config.skip(path) }
|
|
32
103
|
end
|
|
33
|
-
false
|
|
34
104
|
end
|
|
35
|
-
# no coverage in these files
|
|
36
|
-
add_filter 'lib/aspera/keychain/macos_security.rb'
|
|
37
|
-
add_filter 'lib/aspera/assert.rb'
|
|
38
105
|
end
|
|
39
106
|
end
|
|
107
|
+
|
|
108
|
+
# Start coverage when this file is loaded, if enabled: must be required before any other library
|
|
109
|
+
Aspera::Coverage.start if ENV.key?('ENABLE_COVERAGE')
|