Module: Wisco::Commands::Exec

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

Class Method Summary collapse

Class Method Details

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



183
184
185
186
187
188
189
190
191
192
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
 
# File 'lib/wisco/commands/exec.rb', line 183

def execute_one(section, key, input_file, fixtures_dir, connector_full_path, connection,
                pagination: true, verbose: true, debug: false,
                extended: true, closure: nil, config_fields: nil, continue: nil,
                extended_input_schema: nil, extended_output_schema: nil)
  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
    options[:args] = input_file if input_file
  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)

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

.execute_ruby_script(section, key, script_path, fixtures_dir, target_dir, connector_full_path, connection, config, pagination: true, verbose: true, debug: false, extended: true, closure: nil, config_fields: nil, continue: nil, extended_input_schema: nil, extended_output_schema: nil) ⇒ 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/.



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
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
 
# File 'lib/wisco/commands/exec.rb', line 276

def execute_ruby_script(section, key, script_path, fixtures_dir, target_dir,
                        connector_full_path, connection, config,
                        pagination: true, verbose: true, debug: false,
                        extended: true, closure: nil, config_fields: nil, continue: nil,
                        extended_input_schema: nil, extended_output_schema: nil)
  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] = 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)

  pretty = JSON.pretty_generate(JSON.parse(File.read(output_file)))
  File.write(output_file, pretty + "\n")
  puts "  Written: #{output_file}"
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) 


126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/wisco/commands/exec.rb', line 126

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

.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).



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/wisco/commands/exec.rb', line 100

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.



141
142
143
144
 
# File 'lib/wisco/commands/exec.rb', line 141

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: true, debug: false, extended: true, closure: nil, config_fields: nil, continue: nil, extended_input_schema: nil, extended_output_schema: nil) ⇒ Object 



14
15
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
 
# File 'lib/wisco/commands/exec.rb', line 14

def run(path_arg, target_dir, input: nil, pagination: true, verbose: true, debug: false,
        extended: true, closure: nil, config_fields: nil, continue: nil,
        extended_input_schema: nil, extended_output_schema: nil)
  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)
      Wisco::TerminalOutput.emit_error("Error: fixtures directory not found: #{fixture_dir_output}")
      Wisco::TerminalOutput.emit_error("       Run '#{Wisco::CLI_NAME} fixtures #{section}.#{key}' first.")
      next
    end

    input_files = resolve_input_files(input, fixtures_dir, debug: debug)

    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)
      else
        Wisco::TerminalOutput.emit_warning("  Warning: No ready input files found in #{fixture_dir_output}")
      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)
      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)
      end
    end
  end
end

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



146
147
148
149
150
151
152
153
154
155
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
 
# File 'lib/wisco/commands/exec.rb', line 146

def run_test(target_dir, connector_full_path, connection, verbose: true, 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