Class: Inspec::InspecCLI
Overview
rubocop:disable Metrics/ClassLength
Instance Method Summary collapse
- #archive(path) ⇒ Object
-
#check(path) ⇒ Object
rubocop:disable Metrics/AbcSize.
- #detect ⇒ Object
- #env(shell = nil) ⇒ Object
- #exec(*targets) ⇒ Object
- #json(target) ⇒ Object
- #schema(name) ⇒ Object
- #shell_func ⇒ Object
- #vendor(path = nil) ⇒ Object
- #version ⇒ Object
Methods inherited from BaseCLI
exec_options, profile_options, target_options
Instance Method Details
#archive(path) ⇒ Object
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/inspec/cli.rb', line 129 def archive(path) diagnose o = opts.dup o[:logger] = Logger.new(STDOUT) o[:logger].level = get_log_level(o.log_level) o[:backend] = Inspec::Backend.create(target: 'mock://') profile = Inspec::Profile.for_target(path, o) result = profile.check if result && !opts[: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(opts) rescue StandardError => e pretty_handle_exception(e) end |
#check(path) ⇒ Object
rubocop:disable Metrics/AbcSize
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 101 102 103 104 105 106 107 |
# File 'lib/inspec/cli.rb', line 61 def check(path) # rubocop:disable Metrics/AbcSize diagnose o = opts.dup o[:ignore_supports] = true # we check for integrity only o[:backend] = Inspec::Backend.create(target: 'mock://') # 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] rescue StandardError => e pretty_handle_exception(e) end |
#detect ⇒ Object
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/inspec/cli.rb', line 167 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 rescue StandardError => e pretty_handle_exception(e) end |
#env(shell = nil) ⇒ Object
218 219 220 221 222 223 |
# File 'lib/inspec/cli.rb', line 218 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
153 154 155 156 157 158 159 160 161 162 |
# File 'lib/inspec/cli.rb', line 153 def exec(*targets) diagnose configure_logger(opts) o = opts.dup # run tests run_tests(targets, o) rescue StandardError => e pretty_handle_exception(e) end |
#json(target) ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/inspec/cli.rb', line 35 def json(target) diagnose o = opts.dup o[:ignore_supports] = true o[:backend] = Inspec::Backend.create(target: 'mock://') 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.(dst) File.write(fdst, JSON.dump(profile.info)) end rescue StandardError => e pretty_handle_exception(e) end |
#schema(name) ⇒ Object
226 227 228 229 230 231 |
# File 'lib/inspec/cli.rb', line 226 def schema(name) puts Inspec::Schema.json(name) rescue StandardError => e puts e puts "Valid schemas are #{Inspec::Schema.names.join(', ')}" end |
#shell_func ⇒ 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 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. rescue StandardError => e pretty_handle_exception(e) end |
#vendor(path = nil) ⇒ Object
112 113 114 115 |
# File 'lib/inspec/cli.rb', line 112 def vendor(path = nil) o = opts.dup vendor_deps(path, o) end |
#version ⇒ Object
234 235 236 237 238 239 240 241 |
# File 'lib/inspec/cli.rb', line 234 def version puts Inspec::VERSION # display outdated version latest = LatestInSpecVersion.new.latest if Gem::Version.new(Inspec::VERSION) < Gem::Version.new(latest) puts "\nYour version of InSpec is out of date! The latest version is #{latest}." end end |