Class: Puppet::Property::KeyValue

Inherits:
Puppet::Property show all
Defined in:
lib/puppet/property/keyvalue.rb

Overview

TODO:

The node with an important message is not very clear.

Note:

IMPORTANT: In order for this property to work there must also be a ‘membership’ parameter The class that inherits from property should override that method with the symbol for the membership

This subclass of Puppet::Property manages string key value pairs. In order to use this property:

  • the should value must be an array of key-value pairs separated by the ‘separator’

  • the retrieve method should return a hash with the keys as symbols

Constant Summary

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Constants included from Util::Logging

Util::Logging::FILE_AND_LINE, Util::Logging::FILE_NO_LINE, Util::Logging::MM, Util::Logging::NO_FILE_LINE, Util::Logging::SUPPRESS_FILE_LINE

Instance Attribute Summary

Attributes inherited from Puppet::Property

#noop, #shouldorig

Attributes inherited from Puppet::Parameter

#name, #parent, #resource, #sensitive

Attributes included from Util::Docs

#doc, #nodoc

Instance Method Summary collapse

Methods inherited from Puppet::Property

#call_provider, #change_to_s, #event, #event_name, idempotent, idempotent=, #idempotent?, #insync_values?, #log, #match_all?, method_added, #name, newvalue, #property_matches?, #safe_insync?, #set, #should=, #sync, #unsafe_validate, #validate_features_per_value, #value, #value=, value_name, value_option

Methods inherited from Puppet::Parameter

aliasvalue, defaultto, desc, doc, #file, #format, format_value_for_display, #initialize, initvars, isnamevar, isnamevar?, #isnamevar?, isrequired, #line, #log, #metaparam?, munge, #munge, newvalues, nodefault, #noop, #path, #pathbuilder, #provider, proxymethods, #remove, #required?, required?, #tags, #to_s, unmunge, #unmunge, #unsafe_munge, #unsafe_validate, validate, #validate, #value, #value=, #version

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, safe_posix_fork, set_env, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::MethodHelper

#requiredopts, #set_options, #symbolize_options

Methods included from Util::Logging

#clear_deprecation_warnings, #debug, #deprecation_warning, #format_exception, #get_deprecation_offender, #log_and_raise, #log_deprecations_to_file, #log_exception, #puppet_deprecation_warning, #send_log, setup_facter_logging!, #warn_once

Methods included from Util::Errors

#adderrorcontext, #devfail, #error_context, #exceptwrap, #fail

Constructor Details

This class inherits a constructor from Puppet::Parameter

Instance Method Details

#delimiter ⇒ String

Returns a default delimiter of “;”

Returns:

  • (String) —

    Returns a default delimiter of “;”



69
70
71
 
# File 'lib/puppet/property/keyvalue.rb', line 69

def delimiter
  ";"
end

#hash_to_key_value_s(hash) ⇒ Object 



16
17
18
 
# File 'lib/puppet/property/keyvalue.rb', line 16

def hash_to_key_value_s(hash)
  hash.select { |k,v| true }.map { |pair| pair.join(separator) }.join(delimiter)
end

#hashify(key_value_array) ⇒ Object 



36
37
38
39
40
41
42
43
 
# File 'lib/puppet/property/keyvalue.rb', line 36

def hashify(key_value_array)
  #turns string array into a hash
  key_value_array.inject({}) do |hash, key_value|
    tmp = key_value.split(separator)
    hash[tmp[0].intern] = tmp[1]
    hash
  end
end

#inclusive? ⇒ Boolean

Returns:



32
33
34
 
# File 'lib/puppet/property/keyvalue.rb', line 32

def inclusive?
  @resource[membership] == :inclusive
end

#insync?(is) ⇒ Boolean

Returns true if there is no is value, else returns if is is equal to should using == as comparison.

Returns:

  • (Boolean) —

    whether the property is in sync or not.



88
89
90
91
92
 
# File 'lib/puppet/property/keyvalue.rb', line 88

def insync?(is)
  return true unless is

  (is == self.should)
end

#is_to_s(current_value) ⇒ Object 



24
25
26
 
# File 'lib/puppet/property/keyvalue.rb', line 24

def is_to_s(current_value)
  hash_to_key_value_s(current_value)
end

#membership ⇒ Object 



28
29
30
 
# File 'lib/puppet/property/keyvalue.rb', line 28

def membership
  :key_value_membership
end

#process_current_hash(current) ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/puppet/property/keyvalue.rb', line 45

def process_current_hash(current)
  return {} if current == :absent

  #inclusive means we are managing everything so if it isn't in should, its gone
  current.each_key { |key| current[key] = nil } if inclusive?
  current
end

#retrieve ⇒ Hash

Retrieves the key-hash from the provider by invoking its method named the same as this property.

Returns:

  • (Hash) —

    the hash from the provider, or ‘:absent`



76
77
78
79
80
81
82
83
 
# File 'lib/puppet/property/keyvalue.rb', line 76

def retrieve
  #ok, some 'convention' if the keyvalue property is named properties, provider should implement a properties method
  if key_hash = provider.send(name) and key_hash != :absent
    return key_hash
  else
    return :absent
  end
end

#separator ⇒ String

Returns a default separator of “=”

Returns:

  • (String) —

    Returns a default separator of “=”



64
65
66
 
# File 'lib/puppet/property/keyvalue.rb', line 64

def separator
  "="
end

#should ⇒ Object 



53
54
55
56
57
58
59
60
61
 
# File 'lib/puppet/property/keyvalue.rb', line 53

def should
  return nil unless @should

  members = hashify(@should)
  current = process_current_hash(retrieve)

  #shared keys will get overwritten by members
  current.merge(members)
end

#should_to_s(should_value) ⇒ Object 



20
21
22
 
# File 'lib/puppet/property/keyvalue.rb', line 20

def should_to_s(should_value)
  hash_to_key_value_s(should_value)
end