Class: Puppet::Provider::PowerstoreFileInterface::PowerstoreFileInterface

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb

Overview

class Puppet::Provider::PowerstoreFileInterface::PowerstoreFileInterface

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.add_keys_to_request(request, hash) ⇒ Object 



362
363
364
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 362

def self.add_keys_to_request(request, hash)
  hash.each { |x, v| request[x] = v } if hash
end

.authenticate(_path_params, _query_params, _header_params, _body_params) ⇒ Object 



351
352
353
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 351

def self.authenticate(_path_params, _query_params, _header_params, _body_params)
  true
end

.build_key_values ⇒ Object 



121
122
123
124
125
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 121

def self.build_key_values
  key_values = {}
  key_values['api-version'] = 'assets'
  key_values
end

.deep_delete(hash_item, tokens) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 329

def self.deep_delete(hash_item, tokens)
  if tokens.size == 1
    if hash_item.is_a?(Array)
      hash_item.map! { |item| deep_delete(item, tokens) }
    else
      hash_item.delete(tokens[0]) unless hash_item.nil? || hash_item[tokens[0]].nil?
    end
  elsif hash_item.is_a?(Array)
    hash_item.map! { |item| deep_delete(item, tokens[1..-1]) }
  else
    hash_item[tokens.first] = deep_delete(hash_item[tokens.first], tokens[1..-1]) unless hash_item.nil? || hash_item[tokens[0]].nil?
  end
  hash_item
end

.fetch_all(context) ⇒ Object 



344
345
346
347
348
349
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 344

def self.fetch_all(context)
  response = invoke_list_all(context)
  return unless response.is_a? Net::HTTPSuccess
  body = JSON.parse(response.body)
  body # ["value"] if body.is_a? Array # and body.key? "value"
end

.fetch_all_as_hash(context) ⇒ Object 



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
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 301

def self.fetch_all_as_hash(context)
  items = fetch_all(context)
  if items
    items.map { |item|
      hash = {
        gateway: item['gateway'],
        id: item['id'],
        ip_address: item['ip_address'],
        is_disabled: item['is_disabled'],
        name: item['name'],
        nas_server_id: item['nas_server_id'],
        prefix_length: item['prefix_length'],
        role: item['role'],
        role_l10n: item['role_l10n'],
        vlan_id: item['vlan_id'],
        ensure: 'present',
      }
      Puppet.debug("Adding to collection: #{item}")
      hash
    }.compact
  else
    []
  end
rescue StandardError => ex
  Puppet.alert("ex is #{ex} and backtrace is #{ex.backtrace}")
  raise
end

.invoke_create(context, resource = nil, body_params = nil) ⇒ Object 



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
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 168

def self.invoke_create(context, resource = nil, body_params = nil)
  key_values = build_key_values
  Puppet.info('Calling operation file_interface_create')
  path_params = {}
  query_params = {}
  header_params = {}
  header_params['User-Agent'] = ''

  op_params = [
    op_param('gateway', 'body', 'gateway', 'gateway'),
    op_param('ip_address', 'body', 'ip_address', 'ip_address'),
    op_param('is_disabled', 'body', 'is_disabled', 'is_disabled'),
    op_param('nas_server_id', 'body', 'nas_server_id', 'nas_server_id'),
    op_param('prefix_length', 'body', 'prefix_length', 'prefix_length'),
    op_param('role', 'body', 'role', 'role'),
    op_param('vlan_id', 'body', 'vlan_id', 'vlan_id'),
  ]
  op_params.each do |i|
    inquery = i[:inquery]
    name    = i[:name]
    paramalias = i[:paramalias]
    name_snake = i[:namesnake]
    if inquery == 'query'
      query_params[name] = key_values[name] unless key_values[name].nil?
      query_params[name] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      query_params[name] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    else
      path_params[name_snake.to_sym] = key_values[name] unless key_values[name].nil?
      path_params[name_snake.to_sym] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      path_params[name_snake.to_sym] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    end
  end
  context.transport.call_op(path_params, query_params, header_params, body_params, '/file_interface', 'Post', 'application/json')
end

.invoke_delete(context, resource = nil, body_params = nil) ⇒ Object 



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
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 239

def self.invoke_delete(context, resource = nil, body_params = nil)
  key_values = build_key_values
  Puppet.info('Calling operation file_interface_delete')
  path_params = {}
  query_params = {}
  header_params = {}
  header_params['User-Agent'] = ''

  op_params = [
    op_param('id', 'path', 'id', 'id'),
  ]
  op_params.each do |i|
    inquery = i[:inquery]
    name    = i[:name]
    paramalias = i[:paramalias]
    name_snake = i[:namesnake]
    if inquery == 'query'
      query_params[name] = key_values[name] unless key_values[name].nil?
      query_params[name] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      query_params[name] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    else
      path_params[name_snake.to_sym] = key_values[name] unless key_values[name].nil?
      path_params[name_snake.to_sym] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      path_params[name_snake.to_sym] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    end
  end
  context.transport.call_op(path_params, query_params, header_params, body_params, '/file_interface/%{id}', 'Delete', 'application/json')
end

.invoke_get_one(context, resource = nil, body_params = nil) ⇒ Object 



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
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 271

def self.invoke_get_one(context, resource = nil, body_params = nil)
  key_values = build_key_values
  Puppet.info('Calling operation file_interface_instance_query')
  path_params = {}
  query_params = {}
  header_params = {}
  header_params['User-Agent'] = ''

  op_params = [
    op_param('id', 'path', 'id', 'id'),
  ]
  op_params.each do |i|
    inquery = i[:inquery]
    name    = i[:name]
    paramalias = i[:paramalias]
    name_snake = i[:namesnake]
    if inquery == 'query'
      query_params[name] = key_values[name] unless key_values[name].nil?
      query_params[name] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      query_params[name] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    else
      path_params[name_snake.to_sym] = key_values[name] unless key_values[name].nil?
      path_params[name_snake.to_sym] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      path_params[name_snake.to_sym] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    end
  end
  context.transport.call_op(path_params, query_params, header_params, body_params, '/file_interface/%{id}', 'Get', 'application/json')
end

.invoke_list_all(context, resource = nil, body_params = nil) ⇒ Object 



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
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 139

def self.invoke_list_all(context, resource = nil, body_params = nil)
  key_values = build_key_values
  Puppet.info('Calling operation file_interface_collection_query')
  path_params = {}
  query_params = {}
  header_params = {}
  header_params['User-Agent'] = ''

  op_params = [
  ]
  op_params.each do |i|
    inquery = i[:inquery]
    name    = i[:name]
    paramalias = i[:paramalias]
    name_snake = i[:namesnake]
    if inquery == 'query'
      query_params[name] = key_values[name] unless key_values[name].nil?
      query_params[name] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      query_params[name] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    else
      path_params[name_snake.to_sym] = key_values[name] unless key_values[name].nil?
      path_params[name_snake.to_sym] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      path_params[name_snake.to_sym] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    end
  end
  context.transport.call_op(path_params, query_params, header_params, body_params, '/file_interface', 'Get', 'application/json')
end

.invoke_update(context, resource = nil, body_params = nil) ⇒ Object 



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
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 204

def self.invoke_update(context, resource = nil, body_params = nil)
  key_values = build_key_values
  Puppet.info('Calling operation file_interface_modify')
  path_params = {}
  query_params = {}
  header_params = {}
  header_params['User-Agent'] = ''

  op_params = [
    op_param('gateway', 'body', 'gateway', 'gateway'),
    op_param('id', 'path', 'id', 'id'),
    op_param('ip_address', 'body', 'ip_address', 'ip_address'),
    op_param('is_disabled', 'body', 'is_disabled', 'is_disabled'),
    op_param('prefix_length', 'body', 'prefix_length', 'prefix_length'),
    op_param('vlan_id', 'body', 'vlan_id', 'vlan_id'),
  ]
  op_params.each do |i|
    inquery = i[:inquery]
    name    = i[:name]
    paramalias = i[:paramalias]
    name_snake = i[:namesnake]
    if inquery == 'query'
      query_params[name] = key_values[name] unless key_values[name].nil?
      query_params[name] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      query_params[name] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    else
      path_params[name_snake.to_sym] = key_values[name] unless key_values[name].nil?
      path_params[name_snake.to_sym] = ENV["powerstore_#{name_snake}"] unless ENV["powerstore_#{name_snake}"].nil?
      path_params[name_snake.to_sym] = resource[paramalias.to_sym] unless resource.nil? || resource[paramalias.to_sym].nil?
    end
  end
  context.transport.call_op(path_params, query_params, header_params, body_params, '/file_interface/%{id}', 'Patch', 'application/json')
end

.op_param(name, inquery, paramalias, namesnake) ⇒ Object 



374
375
376
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 374

def self.op_param(name, inquery, paramalias, namesnake)
  { name: name, inquery: inquery, paramalias: paramalias, namesnake: namesnake }
end

.to_query(hash) ⇒ Object 



366
367
368
369
370
371
372
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 366

def self.to_query(hash)
  if hash
    return_value = hash.map { |x, v| "#{x}=#{v}" }.reduce { |x, v| "#{x}&#{v}" }
    return return_value unless return_value.nil?
  end
  ''
end

Instance Method Details

#build_create_hash(resource) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 79

def build_create_hash(resource)
  file_interface = {}
  file_interface['gateway'] = resource[:gateway] unless resource[:gateway].nil?
  file_interface['ip_address'] = resource[:ip_address] unless resource[:ip_address].nil?
  file_interface['is_disabled'] = resource[:is_disabled] unless resource[:is_disabled].nil?
  file_interface['nas_server_id'] = resource[:nas_server_id] unless resource[:nas_server_id].nil?
  file_interface['prefix_length'] = resource[:prefix_length] unless resource[:prefix_length].nil?
  file_interface['role'] = resource[:role] unless resource[:role].nil?
  file_interface['vlan_id'] = resource[:vlan_id] unless resource[:vlan_id].nil?
  file_interface
end

#build_delete_hash(resource) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



100
101
102
103
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 100

def build_delete_hash(resource)
  file_interface = {}
  file_interface
end

#build_hash(resource) ⇒ Object

rubocop:enable Lint/UnusedMethodArgument



106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 106

def build_hash(resource)
  file_interface = {}
  file_interface['gateway'] = resource[:gateway] unless resource[:gateway].nil?
  file_interface['id'] = resource[:id] unless resource[:id].nil?
  file_interface['ip_address'] = resource[:ip_address] unless resource[:ip_address].nil?
  file_interface['is_disabled'] = resource[:is_disabled] unless resource[:is_disabled].nil?
  file_interface['name'] = resource[:name] unless resource[:name].nil?
  file_interface['nas_server_id'] = resource[:nas_server_id] unless resource[:nas_server_id].nil?
  file_interface['prefix_length'] = resource[:prefix_length] unless resource[:prefix_length].nil?
  file_interface['role'] = resource[:role] unless resource[:role].nil?
  file_interface['role_l10n'] = resource[:role_l10n] unless resource[:role_l10n].nil?
  file_interface['vlan_id'] = resource[:vlan_id] unless resource[:vlan_id].nil?
  file_interface
end

#build_update_hash(resource) ⇒ Object 



90
91
92
93
94
95
96
97
98
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 90

def build_update_hash(resource)
  file_interface = {}
  file_interface['gateway'] = resource[:gateway] unless resource[:gateway].nil?
  file_interface['ip_address'] = resource[:ip_address] unless resource[:ip_address].nil?
  file_interface['is_disabled'] = resource[:is_disabled] unless resource[:is_disabled].nil?
  file_interface['prefix_length'] = resource[:prefix_length] unless resource[:prefix_length].nil?
  file_interface['vlan_id'] = resource[:vlan_id] unless resource[:vlan_id].nil?
  file_interface
end

#canonicalize(_context, resources) ⇒ Object 



7
8
9
10
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 7

def canonicalize(_context, resources)
  # nout to do here but seems we need to implement it
  resources
end

#create(context, name, should) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 49

def create(context, name, should)
  context.creating(name) do
    new_hash = build_create_hash(should)
    new_hash.delete('id')
    response = self.class.invoke_create(context, should, new_hash)

    raise("Create failed.  Response is #{response} and body is #{response.body}") unless response.is_a? Net::HTTPSuccess
    should[:ensure] = 'present'
    Puppet.info('Added :ensure to property hash')
  end
rescue StandardError => ex
  Puppet.alert("Exception during create. The state of the resource is unknown.  ex is #{ex} and backtrace is #{ex.backtrace}")
  raise
end

#delete(context, should) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 127

def delete(context, should)
  new_hash = build_delete_hash(should)
  response = self.class.invoke_delete(context, should, new_hash)
  raise("Delete failed.  The state of the resource is unknown.  Response is #{response} and body is #{response.body}") unless response.is_a? Net::HTTPSuccess
  should[:ensure] = 'absent'
  Puppet.info "Added 'absent' to property_hash"
rescue StandardError => ex
  Puppet.alert("Exception during destroy. ex is #{ex} and backtrace is #{ex.backtrace}")
  raise
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


356
357
358
359
360
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 356

def exists?
  return_value = @property_hash[:ensure] && @property_hash[:ensure] != 'absent'
  Puppet.info("Checking if resource #{name} of type <no value> exists, returning #{return_value}")
  return_value
end

#get(context) ⇒ Object 



12
13
14
15
16
17
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 12

def get(context)
  context.debug('Entered get')
  hash = self.class.fetch_all_as_hash(context)
  context.debug("Completed get, returning hash #{hash}")
  hash
end

#set(context, changes, noop: false) ⇒ Object 



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
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 19

def set(context, changes, noop: false)
  context.debug('Entered set')

  changes.each do |name, change|
    context.debug("set change with #{name} and #{change}")
    # FIXME: key[:name] below hardwires the unique key of the resource to be :name
    is = change.key?(:is) ? change[:is] : get(context).find { |key| key[:name] == name }
    should = change[:should]

    is = { name: name, ensure: 'absent' } if is.nil?
    should = { name: name, ensure: 'absent' } if should.nil?

    if is[:ensure].to_s == 'absent' && should[:ensure].to_s == 'present'
      create(context, name, should) unless noop
    elsif is[:ensure].to_s == 'present' && should[:ensure].to_s == 'absent'
      context.deleting(name) do
        # FIXME: hardwired
        should[:id] = is[:id]
        delete(context, should) unless noop
      end
    elsif is[:ensure].to_s == 'absent' && should[:ensure].to_s == 'absent'
      context.failed(name, message: 'Unexpected absent to absent change')
    elsif is[:ensure].to_s == 'present' && should[:ensure].to_s == 'present'
      # FIXME: hardwired
      should[:id] = is[:id]
      update(context, name, should)
    end
  end
end

#update(context, name, should) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/puppet/provider/powerstore_file_interface/powerstore_file_interface.rb', line 64

def update(context, name, should)
  context.updating(name) do
    new_hash = build_update_hash(should)
    new_hash.delete('id')
    response = self.class.invoke_update(context, should, new_hash)

    raise("Update failed. The state of the resource is unknown.  Response is #{response} and body is #{response.body}") unless response.is_a? Net::HTTPSuccess
    should[:ensure] = 'present'
    Puppet.info('Added :ensure to property hash')
  end
rescue StandardError => ex
  Puppet.alert("Exception during update. ex is #{ex} and backtrace is #{ex.backtrace}")
  raise
end