Module: Wisco::Commands::Exec

Defined in:
lib/wisco/commands/exec.rb

Class Method Summary collapse

Class Method Details

.display_output_summary(parsed, pretty, section:, summary:, summary_lines:, batch:) ⇒ Object

── Output summary ─────────────────────────────────────────────────────



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/wisco/commands/exec.rb', line 405

def display_output_summary(parsed, pretty, section:, summary:, summary_lines:, batch:)
  return unless summary

  if section == 'pick_lists'
    if batch
      count = parsed.is_a?(Array) ? parsed.length : '?'
      puts "  Items: #{count}"
    else
      display_pick_list_table(parsed)
    end
    return
  end

  puts pretty if !batch && pretty.lines.length <= (summary_lines || 20)
  puts "  #{format_summary(parsed)}"
end

.display_pick_list_table(data) ⇒ Object 



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/wisco/commands/exec.rb', line 422

def display_pick_list_table(data)
  unless data.is_a?(Array) && !data.empty?
    puts '  (empty)'
    return
  end

  rows = data.select { |item| item.is_a?(Array) && item.length >= 2 }

  if rows.empty?
    puts "  Items: #{data.length} (unexpected format)"
    return
  end

  max_col = 60
  labels  = rows.map { |item| truncate_str(item[0].to_s, max_col) }
  values  = rows.map { |item| truncate_str(item[1].to_s, max_col) }

  col1_w = [labels.map(&:length).max, 'Label'.length].max
  col2_w = [values.map(&:length).max, 'Value'.length].max
  num_w  = rows.length.to_s.length

  puts "  Items: #{rows.length}"
  puts "  | #{'#'.ljust(num_w)} | #{'Label'.ljust(col1_w)} | #{'Value'.ljust(col2_w)} |"
  puts "  |#{'-' * (num_w + 2)}|#{'-' * (col1_w + 2)}|#{'-' * (col2_w + 2)}|"
  rows.each_with_index do |_, i|
    puts "  | #{(i + 1).to_s.ljust(num_w)} | #{labels[i].ljust(col1_w)} | #{values[i].ljust(col2_w)} |"
  end
end

.execute_one(section, key, input_file, fixtures_dir, connector_full_path, connection, pagination: true, verbose: false, debug: false, extended: true, closure: nil, config_fields: nil, continue: nil, extended_input_schema: nil, extended_output_schema: nil, summary: true, summary_lines: 20, batch: false) ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/wisco/commands/exec.rb', line 193

def execute_one(section, key, input_file, fixtures_dir, connector_full_path, connection,
                pagination: true, verbose: false, debug: false,
                extended: true, closure: nil, config_fields: nil, continue: nil,
                extended_input_schema: nil, extended_output_schema: nil,
                summary: true, summary_lines: 20, batch: false)
  stem        = input_file ? File.basename(input_file, '.*') : 'execute'
  output_file = File.join(fixtures_dir, "output_#{stem}.json")
  error_file  = File.join(fixtures_dir, "error_#{stem}.txt")

  use_args  = %w[pick_lists methods].include?(section)
  exec_path = if use_args
                "#{section}.#{key}"
              elsif section == 'triggers'
                pagination ? "#{section}.#{key}.poll" : "#{section}.#{key}.poll_page"
              else
                "#{section}.#{key}.execute"
              end

  options = { connector: connector_full_path, output: output_file }
  options[:connection] = connection if connection
  options[:verbose]    = verbose
  if use_args
    if input_file && section == 'methods'
      options[:args] = normalize_method_args(input_file)
    elsif input_file
      options[:args] = input_file
    end
  else
    options[:input] = input_file
  end

  # ── pass-through workato exec parameters ───────────────────────────
  options[:closure]       = resolve_option_path(closure,       fixtures_dir) if closure
  options[:config_fields] = resolve_option_path(config_fields, fixtures_dir) if config_fields
  options[:continue]      = resolve_option_path(continue,      fixtures_dir) if continue

  # ── extended schema (actions + triggers only) ───────────────────────
  unless use_args
    eis = if extended_input_schema
            resolve_option_path(extended_input_schema, fixtures_dir)
          elsif extended
            f = File.join(fixtures_dir, 'input_fields.json')
            File.exist?(f) ? f : nil
          end
    options[:extended_input_schema] = eis if eis

    eos = if extended_output_schema
            resolve_option_path(extended_output_schema, fixtures_dir)
          elsif extended
            f = File.join(fixtures_dir, 'output_fields.json')
            File.exist?(f) ? f : nil
          end
    options[:extended_output_schema] = eos if eos

    if verbose
      Wisco::TerminalOutput.emit_info("  [INFO] extended_input_schema:  #{options[:extended_input_schema]}")  if options[:extended_input_schema]
      Wisco::TerminalOutput.emit_info("  [INFO] extended_output_schema: #{options[:extended_output_schema]}") if options[:extended_output_schema]
    end
  end

  if debug
    warn "[exec] path:         #{exec_path}"
    warn "[exec] connector:    #{connector_full_path}"
    warn "[exec] connection:   #{connection.inspect}"
    warn "[exec] #{use_args ? 'args' : 'input'}:        #{input_file.inspect}"
    warn "[exec] output:       #{output_file}"
    warn "[exec] closure:      #{options[:closure].inspect}"              if options[:closure]
    warn "[exec] config_fields:#{options[:config_fields].inspect}"        if options[:config_fields]
    warn "[exec] continue:     #{options[:continue].inspect}"             if options[:continue]
    warn "[exec] ext_input:    #{options[:extended_input_schema].inspect}" if options[:extended_input_schema]
    warn "[exec] ext_output:   #{options[:extended_output_schema].inspect}" if options[:extended_output_schema]
  end

  begin
    cmd = Workato::CLI::ExecCommand.new(path: exec_path, options: options)
    cmd.call
  rescue StandardError => e
    FileUtils.rm_f(output_file)
    File.write(error_file, "#{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}\n")
    Wisco::TerminalOutput.emit_error("Error executing #{section}.#{key} with #{input_file ? File.basename(input_file) : 'no input'}: #{e.message}")
    Wisco::TerminalOutput.emit_error("  Details written to: #{error_file}")
    return
  end

  FileUtils.rm_f(error_file)
  return unless File.exist?(output_file)

  parsed = JSON.parse(File.read(output_file))
  pretty = JSON.pretty_generate(parsed)
  File.write(output_file, pretty + "\n")
  puts "  Written: #{output_file}"
  display_output_summary(parsed, pretty, section: section, summary: summary,
                         summary_lines: summary_lines, batch: batch)
end

.execute_ruby_script(section, key, script_path, fixtures_dir, target_dir, connector_full_path, connection, config, pagination: true, verbose: false, debug: false, extended: true, closure: nil, config_fields: nil, continue: nil, extended_input_schema: nil, extended_output_schema: nil, summary: true, summary_lines: 20, batch: false) ⇒ Object

Handles ‘execute_*.rb` scripts: evaluates the script to produce dynamic input, writes it to <subdir>/input.json, runs the connector item via ExecCommand, and writes <subdir>/output.json or <subdir>/error.txt. The subdirectory is named after the script (without .rb), e.g. execute_input.rb -> execute_input/.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/wisco/commands/exec.rb', line 293

def execute_ruby_script(section, key, script_path, fixtures_dir, target_dir,
                        connector_full_path, connection, config,
                        pagination: true, verbose: false, debug: false,
                        extended: true, closure: nil, config_fields: nil, continue: nil,
                        extended_input_schema: nil, extended_output_schema: nil,
                        summary: true, summary_lines: 20, batch: false)
  subdir      = File.join(fixtures_dir, File.basename(script_path, '.rb'))
  FileUtils.mkdir_p(subdir)
  input_file  = File.join(subdir, 'input.json')
  output_file = File.join(subdir, 'output.json')
  error_file  = File.join(subdir, 'error.txt')

  # Step 1: evaluate the script to obtain dynamic input
  connection_name = config['connection'] || 'default'

  begin
    generated = Wisco::ExecScript.evaluate(
      script_path:         script_path,
      connector_full_path: connector_full_path,
      target_dir:          target_dir,
      connection_name:     connection_name
    )
  rescue StandardError => e
    FileUtils.rm_f(input_file)
    FileUtils.rm_f(output_file)
    File.write(error_file, "#{e.class}: #{e.message}\n\n#{Array(e.backtrace).join("\n")}\n")
    Wisco::TerminalOutput.emit_error("Error evaluating #{File.basename(script_path)}: #{e.message}")
    Wisco::TerminalOutput.emit_error("  Details written to: #{error_file}")
    return
  end

  File.write(input_file, JSON.pretty_generate(generated) + "\n")
  puts "  Generated: #{input_file}"

  # Step 2: build ExecCommand options (mirrors execute_one)
  use_args  = %w[pick_lists methods].include?(section)
  exec_path = if use_args
                "#{section}.#{key}"
              elsif section == 'triggers'
                pagination ? "#{section}.#{key}.poll" : "#{section}.#{key}.poll_page"
              else
                "#{section}.#{key}.execute"
              end

  options = { connector: connector_full_path, output: output_file }
  options[:connection] = connection if connection
  options[:verbose]    = verbose
  if use_args
    options[:args] = section == 'methods' ? normalize_ruby_method_args(input_file) : input_file
  else
    options[:input] = input_file
  end

  options[:closure]       = resolve_option_path(closure,       fixtures_dir) if closure
  options[:config_fields] = resolve_option_path(config_fields, fixtures_dir) if config_fields
  options[:continue]      = resolve_option_path(continue,      fixtures_dir) if continue

  # extended schema files still live at the item's fixtures_dir (not the subdir)
  unless use_args
    eis = if extended_input_schema
            resolve_option_path(extended_input_schema, fixtures_dir)
          elsif extended
            f = File.join(fixtures_dir, 'input_fields.json')
            File.exist?(f) ? f : nil
          end
    options[:extended_input_schema] = eis if eis

    eos = if extended_output_schema
            resolve_option_path(extended_output_schema, fixtures_dir)
          elsif extended
            f = File.join(fixtures_dir, 'output_fields.json')
            File.exist?(f) ? f : nil
          end
    options[:extended_output_schema] = eos if eos
  end

  if debug
    warn "[exec.rb] script:      #{script_path}"
    warn "[exec.rb] subdir:      #{subdir}"
    warn "[exec.rb] path:        #{exec_path}"
    warn "[exec.rb] connector:   #{connector_full_path}"
    warn "[exec.rb] connection:  #{connection.inspect}"
    warn "[exec.rb] #{use_args ? 'args' : 'input'}:       #{input_file}"
    warn "[exec.rb] output:      #{output_file}"
  end

  # Step 3: invoke ExecCommand against the generated input
  begin
    cmd = Workato::CLI::ExecCommand.new(path: exec_path, options: options)
    cmd.call
  rescue StandardError => e
    FileUtils.rm_f(input_file)
    FileUtils.rm_f(output_file)
    File.write(error_file, "#{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}\n")
    Wisco::TerminalOutput.emit_error("Error executing #{section}.#{key} with #{File.basename(script_path)}: #{e.message}")
    Wisco::TerminalOutput.emit_error("  Details written to: #{error_file}")
    return
  end

  FileUtils.rm_f(error_file)
  return unless File.exist?(output_file)

  parsed = JSON.parse(File.read(output_file))
  pretty = JSON.pretty_generate(parsed)
  File.write(output_file, pretty + "\n")
  puts "  Written: #{output_file}"
  display_output_summary(parsed, pretty, section: section, summary: summary,
                         summary_lines: summary_lines, batch: batch)
end

.file_has_sentinel?(path) ⇒ Boolean

Returns true if the file should be skipped. Each input format has its own sentinel convention:

.json — first line exactly equals Wisco::Commands::Fixtures::SENTINEL
.rb   — first non-blank line matches `# WISCO_SKIP`

Returns:

  • (Boolean) 


136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/wisco/commands/exec.rb', line 136

def file_has_sentinel?(path)
  if File.extname(path).downcase == '.rb'
    return Wisco::ExecScript.sentinel?(path)
  end

  first_line = begin
    File.open(path, &:readline).chomp
  rescue StandardError
    ''
  end
  first_line == Wisco::Commands::Fixtures::SENTINEL
end

.format_summary(parsed) ⇒ Object 



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/wisco/commands/exec.rb', line 451

def format_summary(parsed)
  case parsed
  when Array
    return 'Array: 0 items' if parsed.empty?
    first_str = parsed.first.inspect
    first_str = "#{first_str[0, 97]}…" if first_str.length > 100
    "Array: #{parsed.length} #{parsed.length == 1 ? 'item' : 'items'} — first: #{first_str}"
  when Hash
    return 'Hash: 0 keys' if parsed.empty?
    keys   = parsed.keys.first(20)
    suffix = parsed.keys.length > 20 ? " (+#{parsed.keys.length - 20} more)" : ''
    "Hash: #{parsed.keys.length} keys — #{keys.join(', ')}#{suffix}"
  when NilClass
    '(nil)'
  else
    "Value: #{parsed.inspect}"
  end
end

.normalize_method_args(input_file) ⇒ Object

For JSON execute_input files (positional-args array format):

[h1,h2]

→ [[[h1,h2]]] so SDK flatten(1) restores [[h1,h2]] → method()



482
483
484
485
486
487
488
489
490
491
 
# File 'lib/wisco/commands/exec.rb', line 482

def normalize_method_args(input_file)
  parsed = JSON.parse(File.read(input_file))
  return input_file unless parsed.is_a?(Array) && parsed.any? { |a| a.is_a?(Array) }

  fixed = parsed.map { |a| a.is_a?(Array) ? [a] : a }
  tmp = Tempfile.new(['wisco_args_', '.json'])
  tmp.write(JSON.generate(fixed))
  tmp.close
  tmp.path
end

.normalize_ruby_method_args(input_file) ⇒ Object

For Ruby-script-generated input files (direct argument value):

h1,h2

→ [[h1,h2]] so SDK flatten(1) restores [h1,h2] → method()



495
496
497
498
499
500
501
502
503
 
# File 'lib/wisco/commands/exec.rb', line 495

def normalize_ruby_method_args(input_file)
  parsed = JSON.parse(File.read(input_file))
  return input_file unless parsed.is_a?(Array)

  tmp = Tempfile.new(['wisco_args_', '.json'])
  tmp.write(JSON.generate([parsed]))
  tmp.close
  tmp.path
end

.resolve_input_files(input, fixtures_dir, debug: false) ⇒ Object

Resolve the list of input files to execute. If an explicit input filename/path is given, use that (relative to fixtures_dir). Otherwise glob execute_*.json,rb in fixtures_dir and exclude files still containing their respective sentinel.

In debug mode, prints which candidate files were found and which were skipped (because they still contain a sentinel comment).



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/wisco/commands/exec.rb', line 110

def resolve_input_files(input, fixtures_dir, debug: false)
  if input
    path = File.absolute_path?(input) ? input : File.join(fixtures_dir, input)
    unless File.exist?(path)
      Wisco::TerminalOutput.emit_error("Error: Input file not found: #{path}")
      exit 1
    end
    [path]
  else
    candidates = Dir.glob(File.join(fixtures_dir, 'execute_*.{json,rb}')).select { |f| File.file?(f) }
    warn "[exec] candidate files: #{candidates.map { |f| File.basename(f) }}" if debug
    candidates.reject do |f|
      if file_has_sentinel?(f)
        warn "[exec]   skipped (sentinel): #{File.basename(f)}" if debug
        true
      else
        false
      end
    end
  end
end

.resolve_option_path(value, fixtures_dir) ⇒ Object

Resolves a user-supplied path option. If the value is a bare filename (no directory component), it is joined to fixtures_dir. Otherwise used as-is.



151
152
153
154
 
# File 'lib/wisco/commands/exec.rb', line 151

def resolve_option_path(value, fixtures_dir)
  return nil if value.nil?
  File.dirname(value) == '.' ? File.join(fixtures_dir, value) : value
end

.run(path_arg, target_dir, input: nil, pagination: true, verbose: false, debug: false, extended: true, closure: nil, config_fields: nil, continue: nil, extended_input_schema: nil, extended_output_schema: nil, summary: true, summary_lines: 20) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/wisco/commands/exec.rb', line 16

def run(path_arg, target_dir, input: nil, pagination: true, verbose: false, debug: false,
        extended: true, closure: nil, config_fields: nil, continue: nil,
        extended_input_schema: nil, extended_output_schema: nil,
        summary: true, summary_lines: 20)
  target_dir = File.expand_path(target_dir)
  config_path = Wisco.config_path(target_dir)

  unless File.exist?(config_path)
    Wisco::TerminalOutput.emit_error("Error: No #{Wisco::WISCO_DIR}/#{Wisco::CONFIG_FILENAME} found in #{target_dir}.")
    Wisco::TerminalOutput.emit_error("       Run '#{Wisco::CLI_NAME} init' first.")
    exit 1
  end

  config = Wisco::Config.load_config(config_path)
  connector_path = config.dig('connector', 'path')
  connector_file = config.dig('connector', 'file')

  if connector_path.nil? || connector_file.nil?
    Wisco::TerminalOutput.emit_error("Error: #{Wisco::WISCO_DIR}/#{Wisco::CONFIG_FILENAME} is missing connector path/file. Run '#{Wisco::CLI_NAME} init' again.")
    exit 1
  end

  connector_full_path = File.join(connector_path, connector_file)
  connection = config['connection']

  # ── connection test short-circuit ──────────────────────────────────
  if path_arg == 'test'
    run_test(target_dir, connector_full_path, connection, verbose: verbose, debug: debug)
    return
  end

  connector = Wisco::Connector.load_connector_from_config(target_dir)
  pairs = Wisco::PathUtils.parse_path(path_arg, connector)

  pairs.each do |section, key|
    puts "Executing #{section}.#{key}"
    fixtures_dir = File.join(target_dir, 'fixtures', section, key)
    fixture_dir_output = fixtures_dir.sub(connector_path, '.')

    unless File.directory?(fixtures_dir)
      puts "  Auto-setup: running fixtures for #{section}.#{key}"
      Wisco::Commands::Fixtures.run("#{section}.#{key}", target_dir, debug: debug)
    end

    input_files = resolve_input_files(input, fixtures_dir, debug: debug)
    batch = pairs.length > 1 || input_files.length > 1

    if input_files.empty?
      if %w[pick_lists methods].include?(section)
        # No-param pick list or method — execute once with no input file
        execute_one(section, key, nil, fixtures_dir, connector_full_path, connection,
                    pagination: pagination, verbose: verbose, extended: extended,
                    closure: closure, config_fields: config_fields, continue: continue,
                    extended_input_schema: extended_input_schema,
                    extended_output_schema: extended_output_schema, debug: debug,
                    summary: summary, summary_lines: summary_lines, batch: batch)
      else
        Wisco::TerminalOutput.emit_warning("  Warning: No ready input files found in #{fixture_dir_output}")
        input_template = File.join(fixtures_dir, 'execute_input.json')
        if File.exist?(input_template)
          Wisco::TerminalOutput.emit_info("           Fill in #{File.join(fixture_dir_output, 'execute_input.json')} and re-run.")
        end
      end
      next
    end

    input_files.each do |input_file|
      if File.extname(input_file).downcase == '.rb'
        execute_ruby_script(section, key, input_file, fixtures_dir, target_dir,
                            connector_full_path, connection, config,
                            pagination: pagination, verbose: verbose,
                            extended: extended, closure: closure, config_fields: config_fields,
                            continue: continue, extended_input_schema: extended_input_schema,
                            extended_output_schema: extended_output_schema, debug: debug,
                            summary: summary, summary_lines: summary_lines, batch: batch)
      else
        execute_one(section, key, input_file, fixtures_dir,
                    connector_full_path, connection, pagination: pagination, verbose: verbose,
                    extended: extended, closure: closure, config_fields: config_fields,
                    continue: continue, extended_input_schema: extended_input_schema,
                    extended_output_schema: extended_output_schema, debug: debug,
                    summary: summary, summary_lines: summary_lines, batch: batch)
      end
    end
  end
end

.run_test(target_dir, connector_full_path, connection, verbose: false, debug: false) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/wisco/commands/exec.rb', line 156

def run_test(target_dir, connector_full_path, connection, verbose: false, debug: false)
  puts "Testing connection"
  fixtures_dir = File.join(target_dir, 'fixtures', 'connection', 'test')
  FileUtils.mkdir_p(fixtures_dir)

  output_file = File.join(fixtures_dir, 'output_test.json')
  error_file  = File.join(fixtures_dir, 'error_test.txt')

  options = { connector: connector_full_path, output: output_file }
  options[:connection] = connection if connection
  options[:verbose]    = verbose

  if debug
    warn "[exec] path:       test"
    warn "[exec] connector:  #{connector_full_path}"
    warn "[exec] connection: #{connection.inspect}"
    warn "[exec] output:     #{output_file}"
  end

  begin
    cmd = Workato::CLI::ExecCommand.new(path: 'test', options: options)
    cmd.call
  rescue StandardError => e
    File.write(error_file, "#{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}\n")
    Wisco::TerminalOutput.emit_error("Error testing connection: #{e.message}")
    Wisco::TerminalOutput.emit_error("  Details written to: #{error_file}")
    return
  end

  FileUtils.rm_f(error_file)
  return unless File.exist?(output_file)

  pretty = JSON.pretty_generate(JSON.parse(File.read(output_file)))
  File.write(output_file, pretty + "\n")
  puts "  Written: #{output_file}"
end

.truncate_str(str, max) ⇒ Object 



470
471
472
 
# File 'lib/wisco/commands/exec.rb', line 470

def truncate_str(str, max)
  str.length > max ? "#{str[0, max - 1]}…" : str
end