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, supermarket_options, target_options

Instance Method Details

#archive(path, log_level = nil) ⇒ Object 



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

def archive(path, log_level = nil)
  o = config
  diagnose(o)

  o[:logger] = Logger.new($stdout)
  o[:logger].level = get_log_level(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)
  gem_deps = profile.metadata.gem_dependencies + \
    profile.locked_dependencies.list.map { |_k, v| v.profile.metadata.gem_dependencies }.flatten
  unless gem_deps.empty?
    o[:logger].warn "Archiving a profile that contains gem dependencies, but InSpec cannot package gems with the profile! Please archive your ~/.inspec/gems directory separately."
  end

  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



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

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 



495
496
497
498
499
500
501
502
503
504
 
# File 'lib/inspec/cli.rb', line 495

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 



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/inspec/cli.rb', line 377

def detect
  o = config
  deprecate_target_id(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 



457
458
459
460
461
462
 
# File 'lib/inspec/cli.rb', line 457

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 



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/inspec/cli.rb', line 357

def exec(*targets)
  o = config
  diagnose(o)
  deprecate_target_id(config)
  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

#export(target, as_json = false) ⇒ Object 



90
91
92
93
94
95
96
97
98
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
 
# File 'lib/inspec/cli.rb', line 90

def export(target, as_json = false)
  o = config
  diagnose(o)
  o["log_location"] = $stderr
  configure_logger(o)

  # using dup to resolve "can't modify frozen String" error.
  what = o[:what].dup || "profile"
  what.downcase!
  raise Inspec::Error.new("Unrecognized option '#{what}' for --what - expected one of profile, readme, or metadata.") unless %w{profile readme metadata}.include?(what)

  default_format_for_what = {
    "profile" => "yaml",
    "metadata" => "raw",
    "readme" => "raw",
  }
  valid_formats_for_what = {
    "profile" => %w{yaml json},
    "metadata" => %w{yaml raw}, # not going to argue
    "readme" => ["raw"],
  }
  format = o[:format] || default_format_for_what[what]
  # default is json if we were called as old json command
  format = "json" if as_json
  raise Inspec::Error.new("Invalid option '#{format}' for --format and --what combination") unless format && valid_formats_for_what[what].include?(format)

  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

  case what
  when "profile"
    if format == "json"
      require "json" unless defined?(JSON)
      # Write JSON
      Inspec::Utils::JsonProfileSummary.produce_json(
        info: profile.info,
        write_path: dst
      )
    elsif format == "yaml"
      Inspec::Utils::YamlProfileSummary.produce_yaml(
        info: profile.info,
        write_path: dst
      )
    end
  when "readme"
    out = dst.empty? ? $stdout : File.open(dst, "w")
    out.write(profile.readme)
  when "metadata"
    out = dst.empty? ? $stdout : File.open(dst, "w")
    out.write(profile.metadata_src)
  end
rescue StandardError => e
  pretty_handle_exception(e)
end

#json(target) ⇒ Object 



72
73
74
75
76
 
# File 'lib/inspec/cli.rb', line 72

def json(target)
  # This deprecation warning is ignored currently.
  Inspec.deprecate(:renamed_to_inspec_export)
  export(target, true)
end

#run_context ⇒ Object 



475
476
477
478
 
# File 'lib/inspec/cli.rb', line 475

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

#schema(name) ⇒ Object 



465
466
467
468
469
470
471
472
 
# File 'lib/inspec/cli.rb', line 465

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 



418
419
420
421
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
450
451
452
453
454
 
# File 'lib/inspec/cli.rb', line 418

def shell_func
  o = config
  deprecate_target_id(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 



222
223
224
225
226
227
228
229
 
# File 'lib/inspec/cli.rb', line 222

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 



482
483
484
485
486
487
488
489
 
# File 'lib/inspec/cli.rb', line 482

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