Class: Inspec::Profile
- Inherits:
-
Object
- Object
- Inspec::Profile
- Extended by:
- Forwardable
- Defined in:
- lib/inspec/profile.rb
Overview
rubocop:disable Metrics/ClassLength
Instance Attribute Summary collapse
-
#runner_context ⇒ Object
Returns the value of attribute runner_context.
-
#source_reader ⇒ Object
readonly
Returns the value of attribute source_reader.
Class Method Summary collapse
Instance Method Summary collapse
-
#archive(opts) ⇒ Object
generates a archive of a folder profile assumes that the profile was checked before.
-
#check ⇒ Boolean
Check if the profile is internall well-structured.
- #controls_count ⇒ Object
- #info ⇒ Object
-
#initialize(source_reader, options = nil) ⇒ Profile
constructor
rubocop:disable Metrics/AbcSize.
- #params ⇒ Object
Constructor Details
#initialize(source_reader, options = nil) ⇒ Profile
rubocop:disable Metrics/AbcSize
44 45 46 47 48 49 50 51 52 |
# File 'lib/inspec/profile.rb', line 44 def initialize(source_reader, = nil) @options = || {} @target = @options.delete(:target) @logger = @options[:logger] || Logger.new(nil) @source_reader = source_reader @profile_id = @options[:id] @runner_context = nil Metadata.finalize(@source_reader., @profile_id) end |
Instance Attribute Details
#runner_context ⇒ Object
Returns the value of attribute runner_context.
38 39 40 |
# File 'lib/inspec/profile.rb', line 38 def runner_context @runner_context end |
#source_reader ⇒ Object (readonly)
Returns the value of attribute source_reader.
37 38 39 |
# File 'lib/inspec/profile.rb', line 37 def source_reader @source_reader end |
Class Method Details
.for_target(target, opts) ⇒ Object
33 34 35 |
# File 'lib/inspec/profile.rb', line 33 def self.for_target(target, opts) new(resolve_target(target, opts), opts) end |
.resolve_target(target, opts) ⇒ Object
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# File 'lib/inspec/profile.rb', line 16 def self.resolve_target(target, opts) # Fetchers retrieve file contents opts[:target] = target fetcher = Inspec::Fetcher.resolve(target) if fetcher.nil? fail("Could not fetch inspec profile in #{target.inspect}.") end # Source readers understand the target's structure and provide # access to tests, libraries, and metadata reader = Inspec::SourceReader.resolve(fetcher.relative_target) if reader.nil? fail("Don't understand inspec profile in #{target.inspect}, it "\ "doesn't look like a supported profile structure.") end reader end |
Instance Method Details
#archive(opts) ⇒ Object
generates a archive of a folder profile assumes that the profile was checked before
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 |
# File 'lib/inspec/profile.rb', line 172 def archive(opts) # check if file exists otherwise overwrite the archive dst = archive_name(opts) if dst.exist? && !opts[:overwrite] @logger.info "Archive #{dst} exists already. Use --overwrite." return false end # remove existing archive File.delete(dst) if dst.exist? @logger.info "Generate archive #{dst}." # filter files that should not be part of the profile # TODO ignore all .files, but add the files to debug output # display all files that will be part of the archive @logger.debug 'Add the following files to archive:' root_path = @source_reader.target.prefix files = @source_reader.target.files files.each { |f| @logger.debug ' ' + f } if opts[:zip] # generate zip archive require 'inspec/archive/zip' zag = Inspec::Archive::ZipArchiveGenerator.new zag.archive(root_path, files, dst) else # generate tar archive require 'inspec/archive/tar' tag = Inspec::Archive::TarArchiveGenerator.new tag.archive(root_path, files, dst) end @logger.info 'Finished archive generation.' true end |
#check ⇒ Boolean
Check if the profile is internall well-structured. The logger will be used to print information on errors and warnings which are found.
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 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 163 164 |
# File 'lib/inspec/profile.rb', line 81 def check # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength # initial values for response object result = { summary: { valid: false, timestamp: Time.now.iso8601, location: @target, profile: nil, controls: 0, }, errors: [], warnings: [], } entry = lambda { |file, line, column, control, msg| { file: file, line: line, column: column, control_id: control, msg: msg, } } warn = lambda { |file, line, column, control, msg| @logger.warn(msg) result[:warnings].push(entry.call(file, line, column, control, msg)) } error = lambda { |file, line, column, control, msg| @logger.error(msg) result[:errors].push(entry.call(file, line, column, control, msg)) } @logger.info "Checking profile in #{@target}" = @source_reader.target.abs_path(@source_reader..ref) if =~ /metadata\.rb$/ warn.call(@target, 0, 0, nil, 'The use of `metadata.rb` is deprecated. Use `inspec.yml`.') end # verify metadata m_errors, m_warnings = .valid m_errors.each { |msg| error.call(, 0, 0, nil, msg) } m_warnings.each { |msg| warn.call(, 0, 0, nil, msg) } m_unsupported = .unsupported m_unsupported.each { |u| warn.call(, 0, 0, nil, "doesn't support: #{u}") } @logger.info 'Metadata OK.' if m_errors.empty? && m_unsupported.empty? # extract profile name result[:summary][:profile] = .params[:name] # check if the profile is using the old test directory instead of the # new controls directory if @source_reader.tests.keys.any? { |x| x =~ %r{^test/$} } warn.call(@target, 0, 0, nil, 'Profile uses deprecated `test` directory, rename it to `controls`.') end count = controls_count result[:summary][:controls] = count if count == 0 warn.call(nil, nil, nil, nil, 'No controls or tests were defined.') else @logger.info("Found #{count} controls.") end # iterate over hash of groups params[:controls].each { |id, control| sfile = control[:source_location][:ref] sline = control[:source_location][:line] error.call(sfile, sline, nil, id, 'Avoid controls with empty IDs') if id.nil? or id.empty? next if id.start_with? '(generated ' warn.call(sfile, sline, nil, id, "Control #{id} has no title") if control[:title].to_s.empty? warn.call(sfile, sline, nil, id, "Control #{id} has no description") if control[:desc].to_s.empty? warn.call(sfile, sline, nil, id, "Control #{id} has impact > 1.0") if control[:impact].to_f > 1.0 warn.call(sfile, sline, nil, id, "Control #{id} has impact < 0.0") if control[:impact].to_f < 0.0 warn.call(sfile, sline, nil, id, "Control #{id} has no tests defined") if control[:checks].nil? or control[:checks].empty? } # profile is valid if we could not find any error result[:summary][:valid] = result[:errors].empty? @logger.info 'Control definitions OK.' if result[:warnings].empty? result end |
#controls_count ⇒ Object
166 167 168 |
# File 'lib/inspec/profile.rb', line 166 def controls_count params[:controls].values.length end |
#info ⇒ Object
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/inspec/profile.rb', line 58 def info res = params.dup # add information about the controls controls = res[:controls].map do |id, rule| next if id.to_s.empty? data = rule.dup data.delete(:checks) data[:impact] ||= 0.5 data[:impact] = 1.0 if data[:impact] > 1.0 data[:impact] = 0.0 if data[:impact] < 0.0 [id, data] end res[:controls] = Hash[controls.compact] # add information about the required attributes res[:attributes] = res[:attributes].map(&:to_hash) unless res[:attributes].nil? || res[:attributes].empty? res end |
#params ⇒ Object
54 55 56 |
# File 'lib/inspec/profile.rb', line 54 def params @params ||= load_params end |