Class: Puppet::ResourceApi::BaseTypeDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/resource_api/type_definition.rb,
lib/puppet/resource_api/type_definition.rb

Overview

Base RSAPI schema Object

Direct Known Subclasses

TransportSchemaDef, TypeDefinition

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(definition, attr_key) ⇒ BaseTypeDefinition

Returns a new instance of BaseTypeDefinition.



122
123
124
125
126
127
 
# File 'lib/puppet/resource_api/type_definition.rb', line 122

def initialize(definition, attr_key)
  @data_type_cache = {}
  validate_schema(definition, attr_key)
  # store the validated definition
  @definition = definition
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



120
121
122
 
# File 'lib/puppet/resource_api/type_definition.rb', line 120

def attributes
  @attributes
end

#definition ⇒ Object (readonly)

Returns the value of attribute definition.



120
121
122
 
# File 'lib/puppet/resource_api/type_definition.rb', line 120

def definition
  @definition
end

Instance Method Details

#check_schema(resource, message_prefix = nil) ⇒ Object

validates a resource hash against its type schema



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
 
# File 'lib/puppet/resource_api/type_definition.rb', line 191

def check_schema(resource, message_prefix = nil)
  namevars.each do |namevar|
    if resource[namevar].nil?
      raise Puppet::ResourceError, "`#{name}.get` did not return a value for the `#{namevar}` namevar attribute"
    end
  end

  message_prefix = 'Provider returned data that does not match the Type Schema' if message_prefix.nil?
  message = "#{message_prefix} for `#{name}[#{resource[namevars.first]}]`"

  rejected_keys = check_schema_keys(resource)
  bad_values = check_schema_values(resource)

  unless rejected_keys.empty?
    message += "\n Unknown attribute:\n"
    rejected_keys.each { |key, _value| message += "    * #{key}\n" }
  end
  unless bad_values.empty?
    message += "\n Value type mismatch:\n"
    bad_values.each { |key, value| message += "    * #{key}: #{value}\n" }
  end

  return if rejected_keys.empty? && bad_values.empty?

  notify_schema_errors(message)
end

#check_schema_keys(resource) ⇒ Object

Returns an array of keys that where not found in the type schema No longer modifies the resource passed in



231
232
233
234
235
 
# File 'lib/puppet/resource_api/type_definition.rb', line 231

def check_schema_keys(resource)
  rejected = []
  resource.reject { |key| rejected << key if key != :title && attributes.key?(key) == false }
  rejected
end

#check_schema_values(resource) ⇒ Object

Returns a hash of keys and values that are not valid does not modify the resource passed in



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/puppet/resource_api/type_definition.rb', line 239

def check_schema_values(resource)
  bad_vals = {}
  resource.each do |key, value|
    next unless attributes[key]
    type = @data_type_cache[attributes[key][:type]]
    is_sensitive = (attributes[key].key?(:sensitive) && (attributes[key][:sensitive] == true))
    error_message = Puppet::ResourceApi::DataTypeHandling.try_validate(
      type,
      value,
      '',
    )
    if is_sensitive
      bad_vals[key] = '<< redacted value >> ' + error_message unless error_message.nil?
    else
      bad_vals[key] = "#{value} (#{error_message})" unless error_message.nil?
    end
  end
  bad_vals
end

#insyncable_attributes ⇒ Object 



139
140
141
142
143
144
 
# File 'lib/puppet/resource_api/type_definition.rb', line 139

def insyncable_attributes
  @insyncable_attributes ||= attributes.reject { |_name, options|
    # Only attributes without any behavior are normal Puppet Properties and get insynced
    options.key?(:behaviour)
  }.keys
end

#name ⇒ Object 



129
130
131
 
# File 'lib/puppet/resource_api/type_definition.rb', line 129

def name
  definition[:name]
end

#namevars ⇒ Object 



133
134
135
136
137
 
# File 'lib/puppet/resource_api/type_definition.rb', line 133

def namevars
  @namevars ||= attributes.select { |_name, options|
    options.key?(:behaviour) && options[:behaviour] == :namevar
  }.keys
end

#notify_schema_errors(message) ⇒ Object 



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/puppet/resource_api/type_definition.rb', line 218

def notify_schema_errors(message)
  if Puppet.settings[:strict] == :off
    Puppet.debug(message)
  elsif Puppet.settings[:strict] == :warning
    Puppet::ResourceApi.warning_count += 1
    Puppet.warning(message) if Puppet::ResourceApi.warning_count <= 100 # maximum number of schema warnings to display in a run
  elsif Puppet.settings[:strict] == :error
    raise Puppet::DevError, message
  end
end

#validate_schema(definition, attr_key) ⇒ Object

Raises:

  • (Puppet::DevError) 


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
 
# File 'lib/puppet/resource_api/type_definition.rb', line 146

def validate_schema(definition, attr_key)
  raise Puppet::DevError, '%{type_class} must be a Hash, not `%{other_type}`' % { type_class: self.class.name, other_type: definition.class } unless definition.is_a?(Hash)
  @attributes = definition[attr_key]
  raise Puppet::DevError, '%{type_class} must have a name' % { type_class: self.class.name } unless definition.key? :name
  raise Puppet::DevError, '%{type_class} must have `%{attr_key}`' % { type_class: self.class.name, attrs: attr_key } unless definition.key? attr_key
  unless attributes.is_a?(Hash)
    raise Puppet::DevError, '`%{name}.%{attrs}` must be a hash, not `%{other_type}`' % {
      name: definition[:name], attrs: attr_key, other_type: attributes.class
    }
  end

  # fixup desc/docs backwards compatibility
  if definition.key? :docs
    if definition[:desc]
      raise Puppet::DevError, '`%{name}` has both `desc` and `docs`, prefer using `desc`' % { name: definition[:name] }
    end
    definition[:desc] = definition[:docs]
    definition.delete(:docs)
  end
  Puppet.warning('`%{name}` has no documentation, add it using a `desc` key' % { name: definition[:name] }) unless definition.key? :desc

  attributes.each do |key, attr|
    raise Puppet::DevError, '`rsapi_custom_insync_trigger` cannot be specified as an attribute; it is reserved for propertyless types with the custom_insync feature' if key == :rsapi_custom_insync_trigger # rubocop:disable Metrics/LineLength
    raise Puppet::DevError, "`#{definition[:name]}.#{key}` must be a Hash, not a #{attr.class}" unless attr.is_a? Hash
    raise Puppet::DevError, "`#{definition[:name]}.#{key}` has no type" unless attr.key? :type
    Puppet.warning('`%{name}.%{key}` has no documentation, add it using a `desc` key' % { name: definition[:name], key: key }) unless attr.key? :desc

    # validate the type by attempting to parse into a puppet type
    @data_type_cache[attributes[key][:type]] ||=
      Puppet::ResourceApi::DataTypeHandling.parse_puppet_type(
        key,
        attributes[key][:type],
      )

    # fixup any weird behavior  ;-)
    next unless attr[:behavior]
    if attr[:behaviour]
      raise Puppet::DevError, "the '#{key}' attribute has both a `behavior` and a `behaviour`, only use one"
    end
    attr[:behaviour] = attr[:behavior]
    attr.delete(:behavior)
  end
end