Class: Chef::Resource::RegistryKey

Inherits:
Chef::Resource show all
Defined in:
lib/chef/resource/registry_key.rb

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary collapse

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #custom_exception_message, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #guard_interpreter, #identity, identity_attr, #ignore_failure, #immediate_notifications, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, node_map, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resources, #run_action, #sensitive, #should_skip?, #state, state_attrs, strict_const_defined?, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action, #validate_resource_spec!

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::DescendantsTracker

#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::PlatformIntrospection

#platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Constructor Details

#initialize(name, run_context = nil) ⇒ RegistryKey

Returns a new instance of RegistryKey.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/chef/resource/registry_key.rb', line 60

def initialize(name, run_context=nil)
  super
  @resource_name = :registry_key
  @action = :create
  @architecture = :machine
  @recursive = false
  @key = name
  @values, @unscrubbed_values = [], []
  @allowed_actions.push(:create, :create_if_missing, :delete, :delete_key)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Attribute Details

#unscrubbed_values ⇒ Object (readonly)

Some registry key data types may not be safely reported as json. Example (CHEF-5323):

registry_key ‘HKEY_CURRENT_USER\ChefTest2014’ do

values [{
  :name => "ValueWithBadData",
  :type => :binary,
  :data => 255.chr * 1
}]
action :create

end

will raise Encoding::UndefinedConversionError: “xFF” from ASCII-8BIT to UTF-8.

To avoid sending data that cannot be nicely converted for json, we have the values method return “safe” data if the data type is “unsafe”. Known “unsafe” data types are :binary, :dword, :dword-big-endian, and :qword. If other criteria generate data that cannot reliably be sent as json, add that criteria to the needs_checksum? method. When unsafe data is detected, the values method returns an md5 checksum of the listed data.

:unscrubbed_values returns the values exactly as provided in the resource (i.e., data is not checksummed, regardless of the data type/“unsafe” criteria).

Future: If we have conflicts with other resources reporting json incompatible state, we may want to extend the state_attrs API with the ability to rename POST’d attrs.

See lib/chef/resource_reporter.rb for more information.



58
59
60
 
# File 'lib/chef/resource/registry_key.rb', line 58

def unscrubbed_values
  @unscrubbed_values
end

Instance Method Details

#architecture(arg = nil) ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/chef/resource/registry_key.rb', line 113

def architecture(arg=nil)
  set_or_return(
    :architecture,
    arg,
    :kind_of => Symbol
  )
end

#key(arg = nil) ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/chef/resource/registry_key.rb', line 71

def key(arg=nil)
  set_or_return(
    :key,
    arg,
    :kind_of => String
  )
end

#recursive(arg = nil) ⇒ Object 



105
106
107
108
109
110
111
 
# File 'lib/chef/resource/registry_key.rb', line 105

def recursive(arg=nil)
  set_or_return(
    :recursive,
    arg,
    :kind_of => [TrueClass, FalseClass]
  )
end

#values(arg = nil) ⇒ Object 



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
 
# File 'lib/chef/resource/registry_key.rb', line 79

def values(arg=nil)
  if not arg.nil?
    if arg.is_a?(Hash)
      @values = [ arg ]
    elsif arg.is_a?(Array)
      @values = arg
    else
      raise ArgumentError, "Bad type for RegistryKey resource, use Hash or Array"
    end

    @values.each do |v|
      raise ArgumentError, "Missing name key in RegistryKey values hash" unless v.has_key?(:name)
      raise ArgumentError, "Missing type key in RegistryKey values hash" unless v.has_key?(:type)
      raise ArgumentError, "Missing data key in RegistryKey values hash" unless v.has_key?(:data)
      v.each_key do |key|
        raise ArgumentError, "Bad key #{key} in RegistryKey values hash" unless [:name,:type,:data].include?(key)
      end
      raise ArgumentError, "Type of name => #{v[:name]} should be string" unless v[:name].is_a?(String)
      raise Argument Error "Type of type => #{v[:name]} should be symbol" unless v[:type].is_a?(Symbol)
    end
    @unscrubbed_values = @values
  elsif self.instance_variable_defined?(:@values)
    scrub_values(@values)
  end
end