Class: Inspec::Profile

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

Overview

rubocop:disable Metrics/ClassLength

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = nil) ⇒ Profile

rubocop:disable Metrics/AbcSize



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/inspec/profile.rb', line 23

def initialize(options = nil)
  @options = options || {}
  @logger = options[:logger] || Logger.new(nil)
  @path = @options[:path]
  @profile_id = options[:id]

  @runner = Runner.new(
    id: @profile_id,
    backend: :mock,
    test_collector: @options.delete(:test_collector),
  )

  # we're checking a profile, we don't care if it runs on the host machine
  @options[:ignore_supports] = true
  tests, libs, metadata = @runner.add_tests([@path], @options)
  @content = tests + libs + metadata

  # NB if you want to check more than one profile, use one
  # Inspec::Profile#from_file per profile
  @metadata_source = metadata.first
  @metadata = Metadata.from_ref(@metadata_source[:ref], @metadata_source[:content], @profile_id, @logger)
  @params = @metadata.params
  @profile_id ||= params[:name]
  @params[:name] = @profile_id
  @params[:rules] = rules = {}

  @runner.rules.each do |id, rule|
    file = rule.instance_variable_get(:@__file)
    rules[file] ||= {}
    rules[file][id] = {
      title: rule.title,
      desc: rule.desc,
      impact: rule.impact,
      checks: rule.instance_variable_get(:@checks),
      code: rule.instance_variable_get(:@__code),
      source_location: rule.instance_variable_get(:@__source_location),
      group_title: rule.instance_variable_get(:@__group_title),
    }
  end
end

Instance Attribute Details

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



20
21
22
 
# File 'lib/inspec/profile.rb', line 20

def metadata
  @metadata
end

#params ⇒ Object (readonly)

Returns the value of attribute params.



18
19
20
 
# File 'lib/inspec/profile.rb', line 18

def params
  @params
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



19
20
21
 
# File 'lib/inspec/profile.rb', line 19

def path
  @path
end

Class Method Details

.from_path(path, options = nil) ⇒ Object 



11
12
13
14
15
16
 
# File 'lib/inspec/profile.rb', line 11

def self.from_path(path, options = nil)
  opt = {}
  options.each { |k, v| opt[k.to_sym] = v } unless options.nil?
  opt[:path] = path
  Profile.new(opt)
end

Instance Method Details

#archive(opts) ⇒ Object

generates a archive of a folder profile assumes that the profile was checked before



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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/inspec/profile.rb', line 185

def archive(opts) # rubocop:disable Metrics/AbcSize
  profile_name = @params[:name]

  ext = opts[:zip] ? 'zip' : 'tar.gz'

  if opts[:archive]
    archive = Pathname.new(opts[:archive])
  else
    slug = profile_name.downcase.strip.tr(' ', '-').gsub(/[^\w-]/, '_')
    archive = Pathname.new(File.dirname(__FILE__)).join('../..', "#{slug}.#{ext}")
  end

  # check if file exists otherwise overwrite the archive
  if archive.exist? && !opts[:overwrite]
    @logger.info "Archive #{archive} exists already. Use --overwrite."
    return false
  end

  # remove existing archive
  File.delete(archive) if archive.exist?

  @logger.info "Generate archive #{archive}."

  # find all files
  files = Dir.glob("#{path}/**/*")

  # filter files that should not be part of the profile
  # TODO ignore all .files, but add the files to debug output

  # map absolute paths to relative paths
  files = files.collect { |f| Pathname.new(f).relative_path_from(Pathname.new(path)).to_s }

  # display all files that will be part of the archive
  @logger.debug 'Add the following files to archive:'
  files.each { |f|
    @logger.debug '    ' + f
  }

  if opts[:zip]
    # generate zip archive
    require 'inspec/archive/zip'
    zag = Inspec::Archive::ZipArchiveGenerator.new
    zag.archive(path, files, archive)
  else
    # generate tar archive
    require 'inspec/archive/tar'
    tag = Inspec::Archive::TarArchiveGenerator.new
    tag.archive(path, files, archive)
  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.

Returns:

  • (Boolean) —

    true if no errors were found, false otherwise



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
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/inspec/profile.rb', line 92

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: @path,
      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 #{@path}"

  if @content.any? { |h| h[:type] == :metadata && h[:ref] =~ /metadata\.rb$/ }
    warn.call(Pathname.new(path).join('metadata.rb'), 0, 0, nil, 'The use of `metadata.rb` is deprecated. Use `inspec.yml`.')
  end

  # verify metadata
  m_errors, m_warnings = @metadata.valid
  m_errors.each { |msg| error.call(@metadata_source[:ref], 0, 0, nil, msg) }
  m_warnings.each { |msg| warn.call(@metadata_source[:ref], 0, 0, nil, msg) }
  m_unsupported = @metadata.unsupported
  m_unsupported.each { |u| warn.call(@metadata_source[:ref], 0, 0, nil, "doesn't support: #{u}") }
  @logger.info 'Metadata OK.' if m_errors.empty? && m_unsupported.empty?

  # extract profile name
  result[:summary][:profile] = @metadata.params[:name]

  # check if the profile is using the old test directory instead of the
  # new controls directory
  if @content.any? { |h| h[:type] == :test && h[:ref] =~ %r{test/[^/]+$} }
    warn.call(Pathname.new(path).join('test'), 0, 0, nil, 'Profile uses deprecated `test` directory, rename it to `controls`.')
  end

  count = rules_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[:rules].each { |group, controls|
    @logger.info "Verify all controls in #{group}"
    controls.each { |id, control|
      sfile, sline = control[:source_location]
      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

#info ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/inspec/profile.rb', line 64

def info
  res = @params.dup
  rules = {}
  res[:rules].each do |gid, group|
    next if gid.to_s.empty?
    path = gid.sub(File.join(@path, ''), '')
    rules[path] = { title: path, rules: {} }
    group.each 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
      rules[path][:rules][id] = data
      # TODO: temporarily flatten the group down; replace this with
      # proper hierarchy later on
      rules[path][:title] = data[:group_title]
    end
  end
  res[:rules] = rules
  res
end

#rules_count ⇒ Object 



179
180
181
 
# File 'lib/inspec/profile.rb', line 179

def rules_count
  @params[:rules].values.map { |hm| hm.values.length }.inject(:+) || 0
end