Class: Chef::Provider::RegistryKey

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

Constant Summary collapse

WORD_TYPES =
%i{dword dword_big_endian qword}.freeze

Instance Attribute Summary

Attributes inherited from Chef::Provider

#action, #after_resource, #current_resource, #logger, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods included from Mixin::Checksum

#checksum, #short_cksum

Methods inherited from Chef::Provider

action, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #cookbook_name, #description, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #introduced, #load_after_resource, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use, use_inline_resources, #validate_required_properties!, #whyrun_mode?, #whyrun_supported?

Methods included from Mixin::LazyModuleInclude

#descendants, #include, #included

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 Mixin::PowershellExec

#powershell_exec, #powershell_exec!

Methods included from DSL::Powershell

#ps_credential

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 DSL::ChefVault

#chef_vault, #chef_vault_item, #chef_vault_item_for_environment

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search, #tagged?

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Methods included from DSL::PlatformIntrospection

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

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 DSL::Recipe

#exec, #have_resource_class_for?, #resource_class_for

Methods included from DSL::Definitions

add_definition, #evaluate_resource_definition, #has_resource_definition?

Methods included from DSL::Resources

add_resource_dsl, remove_resource_dsl

Methods included from DSL::Cheffish

load_cheffish

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::IncludeRecipe

#include_recipe, #load_recipe

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!, #resources, #with_run_context

Constructor Details

This class inherits a constructor from Chef::Provider

Instance Method Details

#define_resource_requirementsObject


78
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
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/chef/provider/registry_key.rb', line 78

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 recursive == 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

Returns:

  • (Boolean)

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

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

#load_current_resourceObject


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

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

#registryObject


59
60
61
# File 'lib/chef/provider/registry_key.rb', line 59

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

#running_on_windows!Object


40
41
42
43
44
# File 'lib/chef/provider/registry_key.rb', line 40

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

#values_to_hash(values) ⇒ Object


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

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