Class: Inspec::InspecCLI

Inherits:
BaseCLI
  • Object
show all
Defined in:
lib/inspec/cli.rb

Overview

rubocop:disable Metrics/ClassLength

Instance Method Summary collapse

Methods inherited from BaseCLI

exec_options, profile_options, target_options

Instance Method Details

#archive(path) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/inspec/cli.rb', line 122

def archive(path)
  diagnose

  o = opts.dup
  o[:logger] = Logger.new(STDOUT)
  o[:logger].level = get_log_level(o.log_level)

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

  if result && !opts[:ignore_errors] == false
    @logger.info 'Profile check failed. Please fix the profile before generating an archive.'
    return exit 1
  end

  # generate archive
  exit 1 unless profile.archive(opts)
end

#check(path) ⇒ Object

rubocop:disable Metrics/AbcSize



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

def check(path) # rubocop:disable Metrics/AbcSize
  diagnose
  o = opts.dup
  # configure_logger(o) # we do not need a logger for check yet
  o[:ignore_supports] = true # we check for integrity only

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

  if opts['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? and 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]
end

#detect ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/inspec/cli.rb', line 155

def detect
  o = opts.dup
  o[:command] = 'os.params'
  (_, res) = run_command(o)
  if opts['format'] == 'json'
    puts res.to_json
  else
    headline('Operating System Details')
    %w{name family release arch}.each { |item|
      puts format('%-10s %s', item.to_s.capitalize + ':',
                  mark_text(res[item.to_sym]))
    }
  end
end

#env(shell = nil) ⇒ Object 



202
203
204
205
 
# File 'lib/inspec/cli.rb', line 202

def env(shell = nil)
  p = Inspec::EnvPrinter.new(self.class, shell)
  p.print_and_exit!
end

#exec(*targets) ⇒ Object 



143
144
145
146
147
148
149
150
 
# File 'lib/inspec/cli.rb', line 143

def exec(*targets)
  diagnose
  configure_logger(opts)
  o = opts.dup

  # run tests
  run_tests(targets, o)
end

#json(target) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/inspec/cli.rb', line 33

def json(target)
  diagnose
  o = opts.dup
  o[:ignore_supports] = true

  profile = Inspec::Profile.for_target(target, o)
  dst = o[:output].to_s
  if dst.empty?
    puts JSON.dump(profile.info)
  else
    if File.exist? dst
      puts "----> updating #{dst}"
    else
      puts "----> creating #{dst}"
    end
    fdst = File.expand_path(dst)
    File.write(fdst, JSON.dump(profile.info))
  end
end

#shell_func ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/inspec/cli.rb', line 176

def shell_func
  diagnose
  o = opts.dup

  json_output = ['json', 'json-min'].include?(opts['format'])
  log_device = json_output ? 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 json_output
  puts res
  exit 0
rescue RuntimeError, Train::UserError => e
  $stderr.puts e.message
end

#vendor(path = nil) ⇒ Object 



103
104
105
106
107
108
 
# File 'lib/inspec/cli.rb', line 103

def vendor(path = nil)
  configure_logger(opts)
  profile = Inspec::Profile.for_target('./', opts)
  lockfile = profile.generate_lockfile(path)
  File.write('inspec.lock', lockfile.to_yaml)
end

#version ⇒ Object 



208
209
210
 
# File 'lib/inspec/cli.rb', line 208

def version
  puts Inspec::VERSION
end