forked from rodjek/rspec-puppet
-
Notifications
You must be signed in to change notification settings - Fork 18
/
adapters.rb
349 lines (308 loc) · 11 KB
/
adapters.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
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
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
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
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
require 'rspec-puppet/facter_impl'
module RSpec::Puppet
module Adapters
class Base
# Set up all Puppet settings applicable for this Puppet version as
# application defaults.
#
# Puppet setting values can be taken from the global RSpec configuration, or from the currently
# executing RSpec context. When a setting is specified both in the global configuration and in
# the example group, the setting in the example group is preferred.
#
# @example Configuring a Puppet setting from a global RSpec configuration value
# RSpec.configure do |config|
# config.parser = "future"
# end
# # => Puppet[:parser] will be future
#
# @example Configuring a Puppet setting from within an RSpec example group
# RSpec.describe 'my_module::my_class', :type => :class do
# let(:module_path) { "/Users/luke/modules" }
# #=> Puppet[:modulepath] will be "/Users/luke/modules"
# end
#
# @example Configuring a Puppet setting with both a global RSpec configuration and local context
# RSpec.configure do |config|
# config.confdir = "/etc/puppet"
# end
# RSpec.describe 'my_module', :type => :class do
# # Puppet[:confdir] will be "/etc/puppet"
# end
# RSpec.describe 'my_module::my_class', :type => :class do
# let(:confdir) { "/etc/puppetlabs/puppet" }
# # => Puppet[:confdir] will be "/etc/puppetlabs/puppet" in this example group
# end
# RSpec.describe 'my_module::my_define', :type => :define do
# # Puppet[:confdir] will be "/etc/puppet" again
# end
#
# @param example_group [RSpec::Core::ExampleGroup] The RSpec context to use for local settings
# @return [void]
def setup_puppet(example_group)
settings = settings_map.map do |puppet_setting, rspec_setting|
[puppet_setting, get_setting(example_group, rspec_setting)]
end.flatten
default_hash = {:confdir => '/dev/null', :vardir => '/dev/null' }
if defined?(Puppet::Test::TestHelper) && Puppet::Test::TestHelper.respond_to?(:app_defaults_for_tests, true)
default_hash.merge!(Puppet::Test::TestHelper.send(:app_defaults_for_tests))
end
settings_hash = default_hash.merge(Hash[*settings])
settings_hash.inject(settings_hash) { |h, (k, v)| h[k] = (v == '/dev/null') ? 'c:/nul/' : v; h } if Gem.win_platform?
if Puppet.settings.respond_to?(:initialize_app_defaults)
Puppet.settings.initialize_app_defaults(settings_hash)
# Forcefully apply the environmentpath setting instead of relying on
# the application defaults as Puppet::Test::TestHelper automatically
# sets this value as well, overriding our application default
Puppet.settings[:environmentpath] = settings_hash[:environmentpath] if settings_hash.key?(:environmentpath)
else
# Set settings the old way for Puppet 2.x, because that's how
# they're defaulted in that version of Puppet::Test::TestHelper and
# we won't be able to override them otherwise.
settings_hash.each do |setting, value|
Puppet.settings[setting] = value
end
end
@environment_name = example_group.environment
end
def get_setting(example_group, rspec_setting)
if example_group.respond_to?(rspec_setting)
example_group.send(rspec_setting)
else
RSpec.configuration.send(rspec_setting)
end
end
def catalog(node, exported)
if exported
# Use the compiler directly to skip the filtering done by the indirector
Puppet::Parser::Compiler.compile(node).filter { |r| !r.exported? }
else
Puppet::Resource::Catalog.indirection.find(node.name, :use_node => node)
end
end
def current_environment
Puppet::Node::Environment.new(@environment_name)
end
def settings_map
[
[:modulepath, :module_path],
[:config, :config],
[:confdir, :confdir],
]
end
def modulepath
Puppet[:modulepath].split(File::PATH_SEPARATOR)
end
# @return [String, nil] The path to the Puppet manifest if it is present and set, nil otherwise.
def manifest
Puppet[:manifest]
end
end
class Adapter40 < Base
#
# @api private
#
# Set the FacterImpl constant to the given Facter implementation or noop
# if the constant is already set. If a proc is given, it will only be
# called if FacterImpl is not defined.
#
# @param impl [Object, Proc] An object or a proc that implements the Facter API
def set_facter_impl(impl)
return if defined?(FacterImpl)
impl = impl.call if impl.is_a?(Proc)
Object.send(:const_set, :FacterImpl, impl)
end
def setup_puppet(example_group)
super
if rspec_modulepath = RSpec.configuration.module_path
modulepath = rspec_modulepath.split(File::PATH_SEPARATOR)
else
modulepath = Puppet[:environmentpath].split(File::PATH_SEPARATOR).map do |path|
File.join(path, 'fixtures', 'modules')
end
end
if rspec_manifest = RSpec.configuration.manifest
manifest = rspec_manifest
else
manifest_paths = Puppet[:environmentpath].split(File::PATH_SEPARATOR).map do |path|
File.join(path, 'fixtures', 'manifests')
end
manifest = manifest_paths.find do |path|
File.exist?(path)
end
manifest ||= Puppet::Node::Environment::NO_MANIFEST
end
env = Puppet::Node::Environment.create(@environment_name, modulepath, manifest)
loader = Puppet::Environments::Static.new(env)
Puppet.push_context(
{
:environments => loader,
:current_environment => env,
:loaders => (Puppet::Pops::Loaders.new(env) if Gem::Version.new(Puppet.version) >= Gem::Version.new('6.0.0')),
},
"Setup rspec-puppet environments"
)
end
def settings_map
super.concat([
[:environmentpath, :environmentpath],
[:hiera_config, :hiera_config],
[:strict_variables, :strict_variables],
[:manifest, :manifest],
])
end
def catalog(node, exported)
node.environment = current_environment
# Override $::environment to workaround PUP-5835, where Puppet otherwise
# stores a symbol for the parameter
node.parameters['environment'] = current_environment.name.to_s if node.parameters['environment'] != node.parameters['environment'].to_s
super
end
def current_environment
Puppet.lookup(:current_environment)
end
def modulepath
current_environment.modulepath
end
# Puppet 4.0 specially handles environments that don't have a manifest set, so we check for the no manifest value
# and return nil when it is set.
#
# @return [String, nil] The path to the Puppet manifest if it is present and set, nil otherwise.
def manifest
m = current_environment.manifest
if m == Puppet::Node::Environment::NO_MANIFEST
nil
else
m
end
end
end
class Adapter4X < Adapter40
def setup_puppet(example_group)
super
set_facter_impl(Facter)
end
def settings_map
super.concat([
[:trusted_server_facts, :trusted_server_facts]
])
end
end
class Adapter6X < Adapter40
#
# @api private
#
# Check to see if Facter runtime implementations are supported in the
# current Puppet version
#
# @return [Boolean] true if runtime implementations are supported
def supports_facter_runtime?
unless defined?(@supports_facter_runtime)
begin
Puppet.runtime[:facter]
@supports_facter_runtime = true
rescue
@supports_facter_runtime = false
end
end
@supports_facter_runtime
end
def setup_puppet(example_group)
case RSpec.configuration.facter_implementation.to_sym
when :rspec
if supports_facter_runtime?
# Lazily instantiate FacterTestImpl here to optimize memory
# allocation, as the proc will only be called if FacterImpl is unset
set_facter_impl(proc { RSpec::Puppet::FacterTestImpl.new })
Puppet.runtime[:facter] = FacterImpl
else
warn "Facter runtime implementations are not supported in Puppet #{Puppet.version}, continuing with facter_implementation 'facter'"
RSpec.configuration.facter_implementation = :facter
set_facter_impl(Facter)
end
when :facter
set_facter_impl(Facter)
else
raise "Unsupported facter_implementation '#{RSpec.configuration.facter_implementation}'"
end
super
end
def settings_map
super.concat([
[:basemodulepath, :basemodulepath],
[:vendormoduledir, :vendormoduledir],
])
end
def catalog(node, _exported)
super.tap do |c|
Puppet::Pops::Evaluator::DeferredResolver.resolve_and_replace(node.facts, c)
end
end
end
class Adapter30 < Base
def settings_map
super.concat([
[:manifestdir, :manifest_dir],
[:manifest, :manifest],
[:templatedir, :template_dir],
[:hiera_config, :hiera_config],
])
end
end
class Adapter32 < Adapter30
def settings_map
super.concat([
[:parser, :parser],
])
end
end
class Adapter33 < Adapter32
def settings_map
super.concat([
[:ordering, :ordering],
[:stringify_facts, :stringify_facts],
])
end
end
class Adapter34 < Adapter33
def settings_map
super.concat([
[:trusted_node_data, :trusted_node_data],
])
end
end
class Adapter35 < Adapter34
def settings_map
super.concat([
[:strict_variables, :strict_variables],
])
end
end
class Adapter27 < Base
def settings_map
super.concat([
[:manifestdir, :manifest_dir],
[:manifest, :manifest],
[:templatedir, :template_dir],
])
end
end
def self.get
[
['6.0', Adapter6X],
['4.1', Adapter4X],
['4.0', Adapter40],
['3.5', Adapter35],
['3.4', Adapter34],
['3.3', Adapter33],
['3.2', Adapter32],
['3.0', Adapter30],
['2.7', Adapter27]
].each do |(version, klass)|
if Puppet::Util::Package.versioncmp(Puppet.version, version) >= 0
return klass.new
end
end
raise "Puppet version #{Puppet.version} is not supported."
end
end
end