Class: Chef::Provider::RegistryKey

Inherits:
Chef::Provider show all
Includes:
Mixin::Checksum
Defined in:
lib/chef/provider/registry_key.rb

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods included from Mixin::Checksum

#checksum, #short_cksum

Methods inherited from Chef::Provider

#action_nothing, #check_resource_semantics!, #cleanup_after_converge, #converge_by, #converge_if_changed, #events, include_resource_dsl, include_resource_dsl_module, #initialize, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #whyrun_mode?

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

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 DeprecatedLWRPClass

#const_missing, #deprecated_constants, #register_deprecated_lwrp_class

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

Methods included from Mixin::NotifyingBlock

#notifying_block, #subcontext_block

Methods included from DSL::DeclareResource

#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #with_run_context

Methods included from Mixin::ShellOut

#a_to_s, #clean_array, #run_command_compatible_options, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::PlatformIntrospection

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

Constructor Details

This class inherits a constructor from Chef::Provider

Instance Method Details

#action_create ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/chef/provider/registry_key.rb', line 120

def action_create
  unless registry.key_exists?(@current_resource.key)
    converge_by("create key #{@new_resource.key}") do
      registry.create_key(@new_resource.key, @new_resource.recursive)
    end
  end
  @new_resource.unscrubbed_values.each do |value|
    if @name_hash.has_key?(value[:name].downcase)
      current_value = @name_hash[value[:name].downcase]
      if [:dword, :dword_big_endian, :qword].include? value[:type]
        value[:data] = value[:data].to_i
      end
      unless current_value[:type] == value[:type] && current_value[:data] == value[:data]
        converge_by("set value #{value}") do
          registry.set_value(@new_resource.key, value)
        end
      end
    else
      converge_by("set value #{value}") do
        registry.set_value(@new_resource.key, value)
      end
    end
  end
end

#action_create_if_missing ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/chef/provider/registry_key.rb', line 145

def action_create_if_missing
  unless registry.key_exists?(@new_resource.key)
    converge_by("create key #{@new_resource.key}") do
      registry.create_key(@new_resource.key, @new_resource.recursive)
    end
  end
  @new_resource.unscrubbed_values.each do |value|
    unless @name_hash.has_key?(value[:name].downcase)
      converge_by("create value #{value}") do
        registry.set_value(@new_resource.key, value)
      end
    end
  end
end

#action_delete ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/chef/provider/registry_key.rb', line 160

def action_delete
  if registry.key_exists?(@new_resource.key)
    @new_resource.unscrubbed_values.each do |value|
      if @name_hash.has_key?(value[:name].downcase)
        converge_by("delete value #{value}") do
          registry.delete_value(@new_resource.key, value)
        end
      end
    end
  end
end

#action_delete_key ⇒ Object 



172
173
174
175
176
177
178
 
# File 'lib/chef/provider/registry_key.rb', line 172

def action_delete_key
  if registry.key_exists?(@new_resource.key)
    converge_by("delete key #{@new_resource.key}") do
      registry.delete_key(@new_resource.key, @new_resource.recursive)
    end
  end
end

#define_resource_requirements ⇒ Object 



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

def define_resource_requirements
  requirements.assert(:create, :create_if_missing, :delete, :delete_key) do |a|
    a.assertion { registry.hive_exists?(@new_resource.key) }
    a.failure_message(Chef::Exceptions::Win32RegHiveMissing, "Hive #{@new_resource.key.split("\\").shift} does not exist")
  end

  requirements.assert(:create) do |a|
    a.assertion { registry.key_exists?(@new_resource.key) }
    a.whyrun("Key #{@new_resource.key} does not exist. Unless it would have been created before, attempt to modify its values would fail.")
  end

  requirements.assert(:create, :create_if_missing) do |a|
    # If keys missing in the path and recursive == false
    a.assertion { !registry.keys_missing?(@current_resource.key) || @new_resource.recursive }
    a.failure_message(Chef::Exceptions::Win32RegNoRecursive, "Intermediate keys missing but recursive is set to false")
    a.whyrun("Intermediate keys in #{@new_resource.key} do not exist. Unless they would have been created earlier, attempt to modify them would fail.")
  end

  requirements.assert(:delete_key) do |a|
    # If key to be deleted has subkeys but recurssive == false
    a.assertion { !registry.key_exists?(@new_resource.key) || !registry.has_subkeys?(@new_resource.key) || @new_resource.recursive }
    a.failure_message(Chef::Exceptions::Win32RegNoRecursive, "#{@new_resource.key} has subkeys but recursive is set to false.")
    a.whyrun("#{@current_resource.key} has subkeys, but recursive is set to false. attempt to delete would fails unless subkeys were deleted prior to this action.")
  end

  requirements.assert(:create, :create_if_missing) do |a|
    # If type key missing in the RegistryKey values hash
    a.assertion { !key_missing?(@new_resource.values, :type) }
    a.failure_message(Chef::Exceptions::RegKeyValuesTypeMissing, "Missing type key in RegistryKey values hash")
    a.whyrun("Type key does not exist. Attempt would fail unless the complete values hash containing all the keys does not exist for registry_key resource's create action.")
  end

  requirements.assert(:create, :create_if_missing) do |a|
    # If data key missing in the RegistryKey values hash
    a.assertion { !key_missing?(@new_resource.values, :data) }
    a.failure_message(Chef::Exceptions::RegKeyValuesDataMissing, "Missing data key in RegistryKey values hash")
    a.whyrun("Data key does not exist. Attempt would fail unless the complete values hash containing all the keys does not exist for registry_key resource's create action.")
  end
end

#key_missing?(values, name) ⇒ Boolean 



73
74
75
76
77
78
 
# File 'lib/chef/provider/registry_key.rb', line 73

def key_missing?(values, name)
  values.each do |v|
    return true unless v.has_key?(name)
  end
  false
end

#load_current_resource ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/chef/provider/registry_key.rb', line 48

def load_current_resource
  running_on_windows!
  @current_resource ||= Chef::Resource::RegistryKey.new(@new_resource.key, run_context)
  @current_resource.key(@new_resource.key)
  @current_resource.architecture(@new_resource.architecture)
  @current_resource.recursive(@new_resource.recursive)
  if registry.key_exists?(@new_resource.key)
    @current_resource.values(registry.get_values(@new_resource.key))
  end
  values_to_hash(@current_resource.unscrubbed_values)
  @current_resource
end

#registry ⇒ Object 



61
62
63
 
# File 'lib/chef/provider/registry_key.rb', line 61

def registry
  @registry ||= Chef::Win32::Registry.new(@run_context, @new_resource.architecture)
end

#running_on_windows! ⇒ Object 



42
43
44
45
46
 
# File 'lib/chef/provider/registry_key.rb', line 42

def running_on_windows!
  unless Chef::Platform.windows?
    raise Chef::Exceptions::Win32NotWindows, "Attempt to manipulate the windows registry on a non-windows node"
  end
end

#values_to_hash(values) ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/chef/provider/registry_key.rb', line 65

def values_to_hash(values)
  if values
    @name_hash = Hash[values.map { |val| [val[:name].downcase, val] }]
  else
    @name_hash = {}
  end
end

#whyrun_supported? ⇒ Boolean 



38
39
40
 
# File 'lib/chef/provider/registry_key.rb', line 38

def whyrun_supported?
  true
end