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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
|
# File 'lib/puppet/resource_api.rb', line 26
def register_type(definition)
type_def = TypeDefinition.new(definition)
unless Puppet::Provider.const_defined?(class_name_from_type_name(definition[:name]), false)
Puppet::Provider.const_set(class_name_from_type_name(definition[:name]), Module.new)
end
Puppet::Type.newtype(definition[:name].to_sym) do
@doc = definition[:desc]
@type_definition = type_def
define_singleton_method(:my_provider) do
@my_provider ||= Hash.new { |hash, key| hash[key] = Puppet::ResourceApi.load_provider(definition[:name]).new }
if Puppet::Util::NetworkDevice.current.is_a? Puppet::ResourceApi::Transport::Wrapper
@my_provider[Puppet::Util::NetworkDevice.current.transport.class]
else
@my_provider[Puppet::Util::NetworkDevice.current.class]
end
end
def my_provider
self.class.my_provider
end
define_singleton_method(:type_definition) do
@type_definition
end
def type_definition
self.class.type_definition
end
if type_definition.feature?('remote_resource')
apply_to_device
end
def initialize(attributes)
if attributes.is_a? Puppet::Resource
@title = attributes.title
@catalog = attributes.catalog
sensitives = attributes.sensitive_parameters
attributes = attributes.to_hash
else
@ral_find_absent = true
sensitives = []
end
sensitives.each do |name|
if attributes.key?(name) && !attributes[name].is_a?(Puppet::Pops::Types::PSensitiveType::Sensitive)
attributes[name] = Puppet::Pops::Types::PSensitiveType::Sensitive.new(attributes[name])
end
end
if type_definition.feature?('canonicalize')
attributes = my_provider.canonicalize(context, [attributes])[0]
end
if type_definition.attributes[:name].nil? && attributes[:title].nil?
attributes[:title] = attributes.delete(:name)
if attributes[:title].nil? && !type_definition.namevars.empty?
attributes[:title] = @title
end
end
super(attributes)
end
def name
title
end
def self.build_title(type_definition, resource_hash)
if type_definition.namevars.size > 1
Puppet::ResourceApi::MonkeyHash[type_definition.namevars.map { |attr| [attr, resource_hash[attr]] }]
else
resource_hash[type_definition.namevars[0]]
end
end
def rsapi_title
@rsapi_title ||= self.class.build_title(type_definition, self)
@rsapi_title
end
def rsapi_canonicalized_target_state
@rsapi_canonicalized_target_state ||= begin
actual_params = @parameters.select { |k, _v| type_definition.attributes.key? k }
target_state = Hash[actual_params.map { |k, v| [k, v.rs_value] }]
target_state = my_provider.canonicalize(context, [target_state]).first if type_definition.feature?('canonicalize')
target_state
end
@rsapi_canonicalized_target_state
end
def generate
return unless type_definition&.feature?('custom_generate')
should_hash = rsapi_canonicalized_target_state
is_hash = rsapi_current_state
title = rsapi_title
raise(Puppet::DevError, 'No generate method found within the types provider') unless my_provider.respond_to?(:generate)
rules_resources = my_provider.generate(context, title, is_hash, should_hash)
rules_resources
end
def rsapi_current_state
refresh_current_state unless @rsapi_current_state
@rsapi_current_state
end
def to_resource
to_resource_shim(super)
end
def to_resource_shim(resource)
resource_hash = Hash[resource.keys.map { |k| [k, resource[k]] }]
resource_hash[:title] = resource.title
ResourceShim.new(resource_hash, type_definition.name, type_definition.namevars, type_definition.attributes, catalog)
end
validate do
@missing_attrs = []
@missing_params = []
return if @ral_find_absent
definition[:attributes].each do |name, options|
type = Puppet::ResourceApi::DataTypeHandling.parse_puppet_type(
:name,
options[:type],
)
next if [:read_only, :namevar].include? options[:behaviour]
next if definition[:attributes][:ensure] &&
value(:ensure) == 'absent' &&
options[:behaviour].nil?
if value(name).nil? && !(type.instance_of? Puppet::Pops::Types::POptionalType)
@missing_attrs << name
@missing_params << name if options[:behaviour] == :parameter
end
end
@missing_attrs -= [:ensure]
raise_missing_params if @missing_params.any?
end
if type_definition.feature?('custom_insync') && type_definition.insyncable_attributes.empty?
custom_insync_trigger_options = {
type: 'Enum[do_not_specify_in_manifest]',
desc: 'A hidden property which enables a type with custom insync to perform an insync check without specifying any insyncable properties',
default: 'do_not_specify_in_manifest',
}
type_definition.create_attribute_in(self, :rsapi_custom_insync_trigger, :newproperty, Puppet::ResourceApi::Property, custom_insync_trigger_options)
end
definition[:attributes].each do |name, options|
if options[:behaviour]
unless [:read_only, :namevar, :parameter, :init_only].include? options[:behaviour]
raise Puppet::ResourceError, "`#{options[:behaviour]}` is not a valid behaviour value"
end
end
if [:parameter, :namevar].include? options[:behaviour]
param_or_property = :newparam
parent = Puppet::ResourceApi::Parameter
elsif options[:behaviour] == :read_only
param_or_property = :newparam
parent = Puppet::ResourceApi::ReadOnlyParameter
else
param_or_property = :newproperty
parent = Puppet::ResourceApi::Property
end
type_definition.create_attribute_in(self, name, param_or_property, parent, options)
end
def self.instances
provider(type_definition.name)
initial_fetch = if type_definition.feature?('simple_get_filter')
my_provider.get(context, [])
else
my_provider.get(context)
end
initial_fetch.map do |resource_hash|
type_definition.check_schema(resource_hash)
result = if resource_hash.key? :title
new(title: resource_hash[:title])
else
new(title: build_title(type_definition, resource_hash))
end
result.cache_current_state(resource_hash)
result
end
end
def refresh_current_state
@rsapi_current_state = if type_definition.feature?('simple_get_filter')
my_provider.get(context, [rsapi_title]).find { |h| namevar_match?(h) }
else
my_provider.get(context).find { |h| namevar_match?(h) }
end
if @rsapi_current_state
type_definition.check_schema(@rsapi_current_state)
strict_check(@rsapi_current_state)
else
@rsapi_current_state = if rsapi_title.is_a? Hash
rsapi_title.dup
else
{ title: rsapi_title }
end
@rsapi_current_state[:ensure] = :absent if type_definition.ensurable?
end
end
def cache_current_state(resource_hash)
@rsapi_current_state = resource_hash
strict_check(@rsapi_current_state)
end
def retrieve
Puppet.debug("Current State: #{rsapi_current_state.inspect}")
result = Puppet::Resource.new(self.class, title, parameters: rsapi_current_state)
result[:ensure] = result[:ensure].to_sym if type_definition.ensurable? && result[:ensure].is_a?(String)
raise_missing_attrs
result
end
def namevar_match?(item)
context.type.namevars.all? do |namevar|
item[namevar] == @parameters[namevar].value if @parameters[namevar].respond_to? :value
end
end
def flush
raise_missing_attrs
target_state = rsapi_canonicalized_target_state
retrieve unless @rsapi_current_state
return if @rsapi_current_state == target_state
Puppet.debug("Target State: #{target_state.inspect}")
if Puppet.settings[:strict] != :off && @rsapi_current_state && (@rsapi_current_state[:ensure] == 'present' && target_state[:ensure] == 'present')
target_state.each do |name, value|
next unless type_definition.attributes[name][:behaviour] == :init_only && value != @rsapi_current_state[name]
message = "Attempting to change `#{name}` init_only attribute value from `#{@rsapi_current_state[name]}` to `#{value}`"
case Puppet.settings[:strict]
when :warning
Puppet.warning(message)
when :error
raise Puppet::ResourceError, message
end
end
end
if type_definition.feature?('supports_noop')
my_provider.set(context, { rsapi_title => { is: @rsapi_current_state, should: target_state } }, noop: noop?)
else
my_provider.set(context, rsapi_title => { is: @rsapi_current_state, should: target_state }) unless noop?
end
if context.failed?
context.reset_failed
raise 'Execution encountered an error'
end
@rsapi_current_state = target_state
end
def raise_missing_attrs
error_msg = "The following mandatory attributes were not provided:\n * " + @missing_attrs.join(", \n * ")
raise Puppet::ResourceError, error_msg if @missing_attrs.any? && (value(:ensure) != :absent && !value(:ensure).nil?)
end
def raise_missing_params
error_msg = "The following mandatory parameters were not provided:\n * " + @missing_params.join(", \n * ")
raise Puppet::ResourceError, error_msg
end
def strict_check(current_state)
return if Puppet.settings[:strict] == :off
strict_check_canonicalize(current_state) if type_definition.feature?('canonicalize')
strict_check_title_parameter(current_state) if type_definition.namevars.size > 1 && !type_definition.title_patterns.empty?
nil
end
def strict_message(message)
case Puppet.settings[:strict]
when :warning
Puppet.warning(message)
when :error
raise Puppet::DevError, message
end
end
def strict_check_canonicalize(current_state)
state_clone = Marshal.load(Marshal.dump(current_state))
state_clone = my_provider.canonicalize(context, [state_clone]).first
return unless state_clone && (current_state != state_clone)
message = <<MESSAGE.strip
#{type_definition.name}[#{@title}]#get has not provided canonicalized values.
Returned values: #{current_state.inspect}
Canonicalized values: #{state_clone.inspect}
MESSAGE
strict_message(message)
end
def strict_check_title_parameter(current_state)
unless current_state.key?(:title)
strict_message("#{type_definition.name}[#{@title}]#get has not provided a title attribute.")
return
end
title_hash = {}
self.class.title_patterns.each do |regexp, symbols|
captures = regexp.match(current_state[:title])
next if captures.nil?
symbols.zip(captures[1..-1]).each do |symbol_and_lambda, capture|
symbol = symbol_and_lambda[0]
title_hash[symbol] = capture
end
break
end
return if title_hash == rsapi_title
namevars = type_definition.namevars.reject { |namevar| title_hash[namevar] == rsapi_title[namevar] }
message = <<MESSAGE.strip
#{type_definition.name}[#{@title}]#get has provided a title attribute which does not match all namevars.
Namevars which do not match: #{namevars.inspect}
Returned parsed title hash: #{title_hash.inspect}
Expected hash: #{rsapi_title.inspect}
MESSAGE
strict_message(message)
end
define_singleton_method(:context) do
@context ||= PuppetContext.new(TypeDefinition.new(definition))
end
def context
self.class.context
end
def self.title_patterns
@title_patterns ||= if type_definition.definition.key? :title_patterns
parse_title_patterns(type_definition.definition[:title_patterns])
else
[[%r{(.*)}m, [[type_definition.namevars.first]]]]
end
end
def self.parse_title_patterns(patterns)
patterns.map do |item|
regex = Regexp.new(item[:pattern])
[item[:pattern], regex.names.map { |x| [x.to_sym] }]
end
end
[:autorequire, :autobefore, :autosubscribe, :autonotify].each do |auto|
next unless definition[auto]
definition[auto].each do |type, values|
Puppet.debug("Registering #{auto} for #{type}: #{values.inspect}")
send(auto, type.downcase.to_sym) do
resolved = [values].flatten.map do |v|
match = %r{\A\$(.*)\Z}.match(v) if v.is_a? String
if match.nil?
v
else
self[match[1].to_sym]
end
end
resolved.flatten.reject { |v| v.nil? }
end
end
end
end
end
|