Class: Inspec::Rule
- Inherits:
-
Object
- Object
- Inspec::Rule
- Includes:
- RSpec::Matchers
- Defined in:
- lib/inspec/rule.rb
Class Method Summary collapse
- .checks(rule) ⇒ Object
-
.merge(dst, src) ⇒ Object
rubocop:disable Metrics/AbcSize.
- .merge_changes(rule) ⇒ Object
- .merge_count(rule) ⇒ Object
- .prepare_checks(rule) ⇒ Object
- .profile_id(rule) ⇒ Object
-
.resource_dsl ⇒ Object
rubocop:disable Style/TrivialAccessors.
- .rule_id(rule) ⇒ Object
- .set_rule_id(rule, value) ⇒ Object
- .set_skip_rule(rule, value, message = nil) ⇒ Object
- .skip_status(rule) ⇒ Object
-
.with_resource_dsl(resource_dsl) ⇒ Object
Include any resources from the given resource DSL.
Instance Method Summary collapse
- #desc(v = nil, data = nil) ⇒ Object
-
#describe(*values, &block) ⇒ nil|DescribeBase
Describe will add one or more tests to this control.
- #descriptions(description_hash = nil) ⇒ Object
- #expect(value, &block) ⇒ Object
- #id(*_) ⇒ Object
- #impact(v = nil) ⇒ Object
-
#initialize(id, profile_id, opts, &block) ⇒ Rule
constructor
A new instance of Rule.
-
#only_if(message = nil) ⇒ nil
Skip all checks if only_if is false.
- #ref(ref = nil, opts = {}) ⇒ Object
- #source_file ⇒ Object
- #tag(*args) ⇒ Object
- #title(v = nil) ⇒ Object
- #to_s ⇒ Object
Constructor Details
#initialize(id, profile_id, opts, &block) ⇒ Rule
Returns a new instance of Rule.
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 63 64 65 66 67 |
# File 'lib/inspec/rule.rb', line 32 def initialize(id, profile_id, opts, &block) @impact = nil @title = nil @descriptions = {} @refs = [] @tags = {} # not changeable by the user: @__code = nil @__block = block @__source_location = __get_block_source_location(&block) @__rule_id = id @__profile_id = profile_id @__checks = [] @__skip_rule = {} @__merge_count = 0 @__merge_changes = [] @__skip_only_if_eval = opts[:skip_only_if_eval] # evaluate the given definition return unless block_given? begin instance_eval(&block) rescue StandardError => e # We've encountered an exception while trying to eval the code inside the # control block. We need to prevent the exception from bubbling up, and # fail the control. Controls are failed by having a failed resource within # them; but since our control block is unsafe (and opaque) to us, let's # make a dummy and fail that. location = block.source_location.compact.join(':') describe 'Control Source Code Error' do # Rubocop thinks we are raising an exception - we're actually calling RSpec's fail() its(location) { fail e. } # rubocop: disable Style/SignalException end end end |
Class Method Details
.checks(rule) ⇒ Object
185 186 187 |
# File 'lib/inspec/rule.rb', line 185 def self.checks(rule) rule.instance_variable_get(:@__checks) end |
.merge(dst, src) ⇒ Object
rubocop:disable Metrics/AbcSize
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/inspec/rule.rb', line 222 def self.merge(dst, src) # rubocop:disable Metrics/AbcSize if src.id != dst.id # TODO: register an error, this case should not happen return end sp = rule_id(src) dp = rule_id(dst) if sp != dp # TODO: register an error, this case should not happen return end # merge all fields dst.impact(src.impact) unless src.impact.nil? dst.title(src.title) unless src.title.nil? dst.descriptions(src.descriptions) unless src.descriptions.nil? dst.tag(src.tag) unless src.tag.nil? dst.ref(src.ref) unless src.ref.nil? # merge indirect fields # checks defined in the source will completely eliminate # all checks that were defined in the destination sc = checks(src) dst.instance_variable_set(:@__checks, sc) unless sc.empty? skip_check = skip_status(src) sr = skip_check[:result] msg = skip_check[:message] set_skip_rule(dst, sr, msg) unless sr.nil? # Save merge history dst.instance_variable_set(:@__merge_count, merge_count(dst) + 1) dst.instance_variable_set( :@__merge_changes, merge_changes(dst) << src.instance_variable_get(:@__source_location), ) end |
.merge_changes(rule) ⇒ Object
202 203 204 |
# File 'lib/inspec/rule.rb', line 202 def self.merge_changes(rule) rule.instance_variable_get(:@__merge_changes) end |
.merge_count(rule) ⇒ Object
198 199 200 |
# File 'lib/inspec/rule.rb', line 198 def self.merge_count(rule) rule.instance_variable_get(:@__merge_count) end |
.prepare_checks(rule) ⇒ Object
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/inspec/rule.rb', line 206 def self.prepare_checks(rule) skip_check = skip_status(rule) return checks(rule) unless skip_check[:result].eql?(true) if skip_check[:message] msg = "Skipped control due to only_if condition: #{skip_check[:message]}" else msg = 'Skipped control due to only_if condition.' end # TODO: we use os as the carrier here, but should consider # a separate resource to do skipping resource = rule.os resource.skip_resource(msg) [['describe', [resource], nil]] end |
.profile_id(rule) ⇒ Object
181 182 183 |
# File 'lib/inspec/rule.rb', line 181 def self.profile_id(rule) rule.instance_variable_get(:@__profile_id) end |
.resource_dsl ⇒ Object
rubocop:disable Style/TrivialAccessors
28 29 30 |
# File 'lib/inspec/rule.rb', line 28 def self.resource_dsl # rubocop:disable Style/TrivialAccessors @resource_dsl end |
.rule_id(rule) ⇒ Object
173 174 175 |
# File 'lib/inspec/rule.rb', line 173 def self.rule_id(rule) rule.instance_variable_get(:@__rule_id) end |
.set_rule_id(rule, value) ⇒ Object
177 178 179 |
# File 'lib/inspec/rule.rb', line 177 def self.set_rule_id(rule, value) rule.instance_variable_set(:@__rule_id, value) end |
.set_skip_rule(rule, value, message = nil) ⇒ Object
193 194 195 196 |
# File 'lib/inspec/rule.rb', line 193 def self.set_skip_rule(rule, value, = nil) rule.instance_variable_set(:@__skip_rule, { result: value, message: }) end |
.skip_status(rule) ⇒ Object
189 190 191 |
# File 'lib/inspec/rule.rb', line 189 def self.skip_status(rule) rule.instance_variable_get(:@__skip_rule) end |
.with_resource_dsl(resource_dsl) ⇒ Object
Include any resources from the given resource DSL. The passed resource_dsl will also be included in any Inspec::Expect objects we make.
22 23 24 25 26 |
# File 'lib/inspec/rule.rb', line 22 def self.with_resource_dsl(resource_dsl) include resource_dsl @resource_dsl = resource_dsl true end |
Instance Method Details
#desc(v = nil, data = nil) ⇒ Object
93 94 95 96 97 98 99 100 |
# File 'lib/inspec/rule.rb', line 93 def desc(v = nil, data = nil) return @descriptions[:default] if v.nil? if data.nil? @descriptions[:default] = unindent(v) else @descriptions[v.to_sym] = unindent(data) end end |
#describe(*values, &block) ⇒ nil|DescribeBase
Describe will add one or more tests to this control. There is 2 ways of calling it:
describe resource do ... end
or
describe.one do ... end
156 157 158 159 160 161 162 163 164 165 |
# File 'lib/inspec/rule.rb', line 156 def describe(*values, &block) if values.empty? && !block_given? dsl = self.class.ancestors[1] Class.new(DescribeBase) do include dsl end.new(method(:__add_check)) else __add_check('describe', values, with_dsl(block)) end end |
#descriptions(description_hash = nil) ⇒ Object
102 103 104 105 |
# File 'lib/inspec/rule.rb', line 102 def descriptions(description_hash = nil) return @descriptions if description_hash.nil? @descriptions.merge!(description_hash) end |
#expect(value, &block) ⇒ Object
167 168 169 170 171 |
# File 'lib/inspec/rule.rb', line 167 def expect(value, &block) target = Inspec::Expect.new(value, &with_dsl(block)) __add_check('expect', [value], target) target end |
#id(*_) ⇒ Object
73 74 75 76 |
# File 'lib/inspec/rule.rb', line 73 def id(*_) # never overwrite the ID @id end |
#impact(v = nil) ⇒ Object
78 79 80 81 82 83 84 85 86 |
# File 'lib/inspec/rule.rb', line 78 def impact(v = nil) if v.is_a?(String) @impact = Inspec::Impact.impact_from_string(v) elsif !v.nil? @impact = v end @impact end |
#only_if(message = nil) ⇒ nil
Skip all checks if only_if is false
136 137 138 139 140 141 142 |
# File 'lib/inspec/rule.rb', line 136 def only_if( = nil) return unless block_given? return if @__skip_only_if_eval == true @__skip_rule[:result] ||= !yield @__skip_rule[:message] = end |
#ref(ref = nil, opts = {}) ⇒ Object
107 108 109 110 111 112 113 114 115 |
# File 'lib/inspec/rule.rb', line 107 def ref(ref = nil, opts = {}) return @refs if ref.nil? && opts.empty? if opts.empty? && ref.is_a?(Hash) opts = ref else opts[:ref] = ref end @refs.push(opts) end |
#source_file ⇒ Object
128 129 130 |
# File 'lib/inspec/rule.rb', line 128 def source_file @__file end |
#tag(*args) ⇒ Object
117 118 119 120 121 122 123 124 125 126 |
# File 'lib/inspec/rule.rb', line 117 def tag(*args) args.each do |arg| if arg.is_a?(Hash) @tags.merge!(arg) else @tags[arg] ||= nil end end @tags end |
#title(v = nil) ⇒ Object
88 89 90 91 |
# File 'lib/inspec/rule.rb', line 88 def title(v = nil) @title = v unless v.nil? @title end |