Class: Inspec::InspecCLI

Inherits:
BaseCLI
  • Object
show all
Includes:
LicenseAcceptance::CLIFlags::Thor
Defined in:
lib/inspec/cli.rb

Instance Method Summary collapse

Methods inherited from BaseCLI

check_license!, exec_options, exit_on_failure?, format_platform_info, help, profile_options, start, target_options

Instance Method Details

#archive(path) ⇒ Object 



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
 
# File 'lib/inspec/cli.rb', line 190

def archive(path)
  o = config
  diagnose(o)

  o[:logger] = Logger.new($stdout)
  o[:logger].level = get_log_level(o[:log_level])
  o[:backend] = Inspec::Backend.create(Inspec::Config.mock)

  # Force vendoring with overwrite when archiving
  vendor_options = o.dup
  vendor_options[:overwrite] = true
  vendor_deps(path, vendor_options)

  profile = Inspec::Profile.for_target(path, o)
  result = profile.check

  if result && !o[:ignore_errors] == false
    o[:logger].info "Profile check failed. Please fix the profile before generating an archive."
    return ui.exit Inspec::UI::EXIT_USAGE_ERROR
  end

  # generate archive
  ui.exit Inspec::UI::EXIT_USAGE_ERROR unless profile.archive(o)
rescue StandardError => e
  pretty_handle_exception(e)
end

#check(path) ⇒ Object

rubocop:disable Metrics/AbcSize,Metrics/MethodLength



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/inspec/cli.rb', line 99

def check(path) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
  o = config
  diagnose(o)
  o["log_location"] ||= STDERR if o["format"] == "json"
  o["log_level"] ||= "warn"
  configure_logger(o)

  o[:backend] = Inspec::Backend.create(Inspec::Config.mock)
  o[:check_mode] = true
  o[:vendor_cache] = Inspec::Cache.new(o[:vendor_cache])

  # run check
  profile = Inspec::Profile.for_target(path, o)
  result = profile.check

  if o["format"] == "json"
    puts JSON.generate(result)
  else
    %w{location profile controls timestamp valid}.each do |item|
      prepared_string = format("%-12s %s",
                               "#{item.to_s.capitalize} :",
                               result[:summary][item.to_sym])
      ui.plain_line(prepared_string)
    end
    puts

    enable_offenses = !Inspec.locally_windows? # See 5723
    if result[:errors].empty? && result[:warnings].empty? && result[:offenses].empty?
      if enable_offenses
        ui.plain_line("No errors, warnings, or offenses")
      else
        ui.plain_line("No errors or warnings")
      end
    else
      item_msg = lambda { |item|
        pos = [item[:file], item[:line], item[:column]].compact.join(":")
        pos.empty? ? item[:msg] : pos + ": " + item[:msg]
      }

      result[:errors].each { |item| ui.red " #{Inspec::UI::GLYPHS[:script_x]}  #{item_msg.call(item)}\n" }
      result[:warnings].each { |item| ui.yellow " !  #{item_msg.call(item)}\n" }

      puts

      if enable_offenses && !result[:offenses].empty?
        puts "Offenses:\n"
        result[:offenses].each { |item| ui.cyan(" #{Inspec::UI::GLYPHS[:script_x]} #{item_msg.call(item)}\n\n") }
      end

      offenses = ui.cyan("#{result[:offenses].length} offenses", print: false)
      errors = ui.red("#{result[:errors].length} errors", print: false)
      warnings = ui.yellow("#{result[:warnings].length} warnings", print: false)
      if enable_offenses
        ui.plain_line("Summary:     #{errors}, #{warnings}, #{offenses}")
      else
        ui.plain_line("Summary:     #{errors}, #{warnings}")
      end
    end
  end

  ui.exit Inspec::UI::EXIT_USAGE_ERROR unless result[:summary][:valid]
rescue StandardError => e
  pretty_handle_exception(e)
end

#clear_cache ⇒ Object 



431
432
433
434
435
436
437
438
439
440
 
# File 'lib/inspec/cli.rb', line 431

def clear_cache
  o = config
  configure_logger(o)
  cache_path = o[:vendor_cache] || "~/.inspec/cache"
  FileUtils.rm_r Dir.glob(File.expand_path(cache_path))

  o[:logger] = Logger.new($stdout)
  o[:logger].level = get_log_level(o[:log_level])
  o[:logger].info "== InSpec cache cleared successfully =="
end

#detect ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/inspec/cli.rb', line 315

def detect
  o = config
  o[:command] = "platform.params"

  configure_logger(o)

  (_, res) = run_command(o)

  if o["format"] == "json"
    puts res.to_json
  else
    ui.headline("Platform Details")
    ui.plain Inspec::BaseCLI.format_platform_info(params: res, indent: 0, color: 36, enable_color: ui.color?)
  end
rescue ArgumentError, RuntimeError, Train::UserError => e
  $stderr.puts e.message
  ui.exit Inspec::UI::EXIT_USAGE_ERROR
rescue StandardError => e
  pretty_handle_exception(e)
end

#env(shell = nil) ⇒ Object 



393
394
395
396
397
398
 
# File 'lib/inspec/cli.rb', line 393

def env(shell = nil)
  p = Inspec::EnvPrinter.new(self.class, shell)
  p.print_and_exit!
rescue StandardError => e
  pretty_handle_exception(e)
end

#exec(*targets) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/inspec/cli.rb', line 296

def exec(*targets)
  o = config
  diagnose(o)
  configure_logger(o)

  runner = Inspec::Runner.new(o)
  targets.each { |target| runner.add_target(target) }

  ui.exit runner.run
rescue ArgumentError, RuntimeError, Train::UserError => e
  $stderr.puts e.message
  ui.exit Inspec::UI::EXIT_USAGE_ERROR
rescue StandardError => e
  pretty_handle_exception(e)
end

#json(target) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/inspec/cli.rb', line 71

def json(target)
  require "json" unless defined?(JSON)

  o = config
  diagnose(o)
  o["log_location"] = $stderr
  configure_logger(o)

  o[:backend] = Inspec::Backend.create(Inspec::Config.mock)
  o[:check_mode] = true
  o[:vendor_cache] = Inspec::Cache.new(o[:vendor_cache])

  profile = Inspec::Profile.for_target(target, o)
  dst = o[:output].to_s

  # Write JSON
  Inspec::Utils::JsonProfileSummary.produce_json(
    info: profile.info,
    write_path: dst
  )
rescue StandardError => e
  pretty_handle_exception(e)
end

#run_context ⇒ Object 



411
412
413
414
 
# File 'lib/inspec/cli.rb', line 411

def run_context
  require "inspec/utils/telemetry/run_context_probe"
  puts Inspec::Telemetry::RunContextProbe.guess_run_context
end

#schema(name) ⇒ Object 



401
402
403
404
405
406
407
408
 
# File 'lib/inspec/cli.rb', line 401

def schema(name)
  require "inspec/schema/output_schema"

  puts Inspec::Schema::OutputSchema.json(name)
rescue StandardError => e
  puts e
  puts "Valid schemas are #{Inspec::Schema::OutputSchema.names.join(", ")}"
end

#shell_func ⇒ Object 



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
 
# File 'lib/inspec/cli.rb', line 355

def shell_func
  o = config
  diagnose(o)
  o[:debug_shell] = true

  Inspec::Resource.toggle_inspect unless o[:inspect]

  log_device = suppress_log_output?(o) ? nil : $stdout
  o[:logger] = Logger.new(log_device)
  o[:logger].level = get_log_level(o[:log_level])

  if o[:command].nil?
    runner = Inspec::Runner.new(o)
    return Inspec::Shell.new(runner).start
  end

  run_type, res = run_command(o)
  ui.exit res unless run_type == :ruby_eval

  # No InSpec tests - just print evaluation output.
  reporters = o["reporter"] || {}
  if reporters.keys.include?("json")
    res = if res.respond_to?(:to_json)
            res.to_json
          else
            JSON.dump(res)
          end
  end

  puts res
  ui.exit Inspec::UI::EXIT_NORMAL
rescue RuntimeError, Train::UserError => e
  $stderr.puts e.message
rescue StandardError => e
  pretty_handle_exception(e)
end

#vendor(path = nil) ⇒ Object 



167
168
169
170
171
172
173
174
 
# File 'lib/inspec/cli.rb', line 167

def vendor(path = nil)
  o = config
  configure_logger(o)
  o[:logger] = Logger.new($stdout)
  o[:logger].level = get_log_level(o[:log_level])

  vendor_deps(path, o)
end

#version ⇒ Object 



418
419
420
421
422
423
424
425
 
# File 'lib/inspec/cli.rb', line 418

def version
  if config["format"] == "json"
    v = { version: Inspec::VERSION }
    puts v.to_json
  else
    puts Inspec::VERSION
  end
end