Class: Inspec::ProfileContext

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

Overview

rubocop:disable Metrics/ClassLength

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(profile_id, backend, conf) ⇒ ProfileContext

Returns a new instance of ProfileContext.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/inspec/profile_context.rb', line 21

def initialize(profile_id, backend, conf)
  if backend.nil?
    fail 'ProfileContext is initiated with a backend == nil. ' \
         'This is a backend error which must be fixed upstream.'
  end
  @profile_id = profile_id
  @backend = backend
  @conf = conf.dup
  @rules = {}
  @subcontexts = []
  @require_loader = ::Inspec::RequireLoader.new
  @attributes = []
  # A local resource registry that only contains resources defined
  # in the transitive dependency tree of the loaded profile.
  @resource_registry = Inspec::Resource.new_registry
  @library_eval_context = Inspec::LibraryEvalContext.create(@resource_registry, @require_loader)
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



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

def attributes
  @attributes
end

#profile_id ⇒ Object (readonly)

Returns the value of attribute profile_id.



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

def profile_id
  @profile_id
end

#resource_registry ⇒ Object (readonly)

Returns the value of attribute resource_registry.



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

def resource_registry
  @resource_registry
end

#rules ⇒ Object (readonly)

Returns the value of attribute rules.



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

def rules
  @rules
end

Class Method Details

.for_profile(profile, backend, attributes) ⇒ Object 



15
16
17
18
 
# File 'lib/inspec/profile_context.rb', line 15

def self.for_profile(profile, backend, attributes)
  new(profile.name, backend, { 'profile' => profile,
                               'attributes' => attributes })
end

Instance Method Details

#add_resources(context) ⇒ Object 



68
69
70
71
72
 
# File 'lib/inspec/profile_context.rb', line 68

def add_resources(context)
  @resource_registry.merge!(context.resource_registry)
  control_eval_context.add_resources(context)
  reload_dsl
end

#add_subcontext(context) ⇒ Object 



74
75
76
 
# File 'lib/inspec/profile_context.rb', line 74

def add_subcontext(context)
  @subcontexts << context
end

#all_rules ⇒ Object 



62
63
64
65
66
 
# File 'lib/inspec/profile_context.rb', line 62

def all_rules
  ret = @rules.values
  ret += @subcontexts.map(&:all_rules).flatten
  ret
end

#control_eval_context ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/inspec/profile_context.rb', line 51

def control_eval_context
  @control_eval_context ||= begin
                              ctx = Inspec::ControlEvalContext.create(self, to_resources_dsl)
                              ctx.new(@backend, @conf, dependencies, @require_loader)
                            end
end

#dependencies ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/inspec/profile_context.rb', line 39

def dependencies
  if @conf['profile'].nil?
    {}
  else
    @conf['profile'].locked_dependencies
  end
end

#load_control_file(*args) ⇒ Object Also known as: load 



100
101
102
 
# File 'lib/inspec/profile_context.rb', line 100

def load_control_file(*args)
  load_with_context(control_eval_context, *args)
end

#load_libraries(libs) ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/inspec/profile_context.rb', line 78

def load_libraries(libs)
  lib_prefix = 'libraries' + File::SEPARATOR
  autoloads = []

  libs.each do |content, source, line|
    path = source
    if source.start_with?(lib_prefix)
      path = source.sub(lib_prefix, '')
      autoloads.push(path) if File.dirname(path) == '.'
    end

    @require_loader.add(path, content, source, line)
  end

  # load all files directly that are flat inside the libraries folder
  autoloads.each do |path|
    next unless path.end_with?('.rb')
    load_library_file(*@require_loader.load(path)) unless @require_loader.loaded?(path)
  end
  reload_dsl
end

#load_library_file(*args) ⇒ Object 



105
106
107
 
# File 'lib/inspec/profile_context.rb', line 105

def load_library_file(*args)
  load_with_context(@library_eval_context, *args)
end

#load_with_context(context, content, source = nil, line = nil) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/inspec/profile_context.rb', line 109

def load_with_context(context, content, source = nil, line = nil)
  Inspec::Log.debug("Loading #{source || '<anonymous content>'} into #{self}")
  @current_load = { file: source }
  if content.is_a? Proc
    context.instance_eval(&content)
  elsif source.nil? && line.nil?
    context.instance_eval(content)
  else
    context.instance_eval(content, source || 'unknown', line || 1)
  end
end

#register_attribute(name, options = {}) ⇒ Object 



140
141
142
143
144
145
146
147
 
# File 'lib/inspec/profile_context.rb', line 140

def register_attribute(name, options = {})
  # we need to return an attribute object, to allow dermination of default values
  attr = Attribute.new(name, options)
  # read value from given gived values
  attr.value(@conf['attributes'][attr.name]) unless @conf['attributes'].nil?
  @attributes.push(attr)
  attr.value
end

#register_rule(r) ⇒ Object 



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

def register_rule(r)
  # get the full ID
  r.instance_variable_set(:@__file, @current_load[:file])
  r.instance_variable_set(:@__group_title, @current_load[:title])

  # add the rule to the registry
  fid = full_id(Inspec::Rule.profile_id(r), Inspec::Rule.rule_id(r))
  existing = @rules[fid]
  if existing.nil?
    @rules[fid] = r
  else
    Inspec::Rule.merge(existing, r)
  end
end

#reload_dsl ⇒ Object 



58
59
60
 
# File 'lib/inspec/profile_context.rb', line 58

def reload_dsl
  @control_eval_context = nil
end

#set_header(field, val) ⇒ Object 



149
150
151
 
# File 'lib/inspec/profile_context.rb', line 149

def set_header(field, val)
  @current_load[field] = val
end

#to_resources_dsl ⇒ Object 



47
48
49
 
# File 'lib/inspec/profile_context.rb', line 47

def to_resources_dsl
  Inspec::Resource.create_dsl(@backend, @resource_registry)
end

#unregister_rule(id) ⇒ Object 



121
122
123
 
# File 'lib/inspec/profile_context.rb', line 121

def unregister_rule(id)
  @rules.delete(full_id(@profile_id, id))
end