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, profile_options, start, target_options

Instance Method Details

#archive(path) ⇒ Object 



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

def archive(path)
  require "inspec/resources"

  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 exit 1
  end

  # generate archive
  exit 1 unless profile.archive(o)
rescue StandardError => e
  pretty_handle_exception(e)
end

#check(path) ⇒ Object

rubocop:disable Metrics/AbcSize,Metrics/MethodLength



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

def check(path) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
  require "inspec/resources"

  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|
      puts format("%-12s %s", item.to_s.capitalize + ":",
        mark_text(result[:summary][item.to_sym]))
    end
    puts

    if result[:errors].empty? && result[:warnings].empty?
      puts "No errors or warnings"
    else
      red    = "\033[31m"
      yellow = "\033[33m"
      rst    = "\033[0m"

      item_msg = lambda { |item|
        pos = [item[:file], item[:line], item[:column]].compact.join(":")
        pos.empty? ? item[:msg] : pos + ": " + item[:msg]
      }
      result[:errors].each do |item|
        puts "#{red}  ✖  #{item_msg.call(item)}#{rst}"
      end
      result[:warnings].each do |item|
        puts "#{yellow}  !  #{item_msg.call(item)}#{rst}"
      end

      puts
      puts format("Summary:     %s%d errors%s, %s%d warnings%s",
        red, result[:errors].length, rst,
        yellow, result[:warnings].length, rst)
    end
  end
  exit 1 unless result[:summary][:valid]
rescue StandardError => e
  pretty_handle_exception(e)
end

#detect ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/inspec/cli.rb', line 308

def detect
  o = config
  o[:command] = "platform.params"
  (_, res) = run_command(o)
  if o["format"] == "json"
    puts res.to_json
  else
    headline("Platform Details")
    puts Inspec::BaseCLI.format_platform_info(params: res, indent: 0, color: 36)
  end
rescue ArgumentError, RuntimeError, Train::UserError => e
  $stderr.puts e.message
  exit 1
rescue StandardError => e
  pretty_handle_exception(e)
end

#env(shell = nil) ⇒ Object 



364
365
366
367
368
369
 
# File 'lib/inspec/cli.rb', line 364

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 



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/inspec/cli.rb', line 289

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

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

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

#json(target) ⇒ Object 



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

def json(target)
  require "inspec/resources"
  require "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)
  info = profile.info
  # add in inspec version
  info[:generator] = {
    name: "inspec",
    version: Inspec::VERSION,
  }
  dst = o[:output].to_s
  if dst.empty?
    puts JSON.dump(info)
  else
    if File.exist? dst
      puts "----> updating #{dst}"
    else
      puts "----> creating #{dst}"
    end
    fdst = File.expand_path(dst)
    File.write(fdst, JSON.dump(info))
  end
rescue StandardError => e
  pretty_handle_exception(e)
end

#nothing ⇒ Object 



401
402
403
 
# File 'lib/inspec/cli.rb', line 401

def nothing
  puts "you did nothing"
end

#schema(name) ⇒ Object 



372
373
374
375
376
377
378
379
 
# File 'lib/inspec/cli.rb', line 372

def schema(name)
  require "inspec/schema"

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

#shell_func ⇒ Object 



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

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

  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)
  exit res unless run_type == :ruby_eval

  # No InSpec tests - just print evaluation output.
  res = (res.respond_to?(:to_json) ? res.to_json : JSON.dump(res)) if o["reporter"]&.keys&.include?("json")
  puts res
  exit 0
rescue RuntimeError, Train::UserError => e
  $stderr.puts e.message
rescue StandardError => e
  pretty_handle_exception(e)
end

#vendor(path = nil) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/inspec/cli.rb', line 163

def vendor(path = nil)
  require "inspec/resources"

  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 



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

def version
  if config["format"] == "json"
    v = { version: Inspec::VERSION }
    puts v.to_json
  else
    require "inspec/utils/latest_version"
    puts Inspec::VERSION
    # display outdated version
    # TODO: remove this. Don't notify of update to a gem when they install omnibus
    latest = LatestInSpecVersion.new.latest || Inspec::VERSION
    if Gem::Version.new(Inspec::VERSION) < Gem::Version.new(latest)
      puts "\nYour version of #{Inspec::Dist::PRODUCT_NAME} is out of date! The latest version is #{latest}."
    end
  end
end