Class: Chef::Resource::PlistResource

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

Overview

we name this PlistResource to avoid confusion with Plist from the plist gem

Constant Summary collapse

PLISTBUDDY_EXECUTABLE = 
"/usr/libexec/PlistBuddy".freeze
DEFAULTS_EXECUTABLE = 
"/usr/bin/defaults".freeze
PLUTIL_EXECUTABLE = 
"/usr/bin/plutil".freeze
PLUTIL_FORMAT_MAP = 
{ "us-ascii" => "xml1",
"text/xml" => "xml1",
"utf-8" => "xml1",
"binary" => "binary1" }.freeze

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #declared_type, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #executed_by_runner, #logger, #params, #recipe_name, #resource_initializing, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods inherited from Chef::Resource

#action, action, #action=, action_class, #action_description, #after_created, allowed_actions, allowed_actions=, #as_json, #before_notifications, chef_version_for_provides, #compile_time, #cookbook_version, #current_value, #current_value_does_not_exist!, #custom_exception_message, custom_resource?, #customize_exception, declare_action_class, #declared_key, default_action, default_action=, default_description, #defined_at, #delayed_action, #delayed_notifications, deprecated, description, #events, examples, from_hash, from_json, #guard_interpreter, #identity, identity_attr, identity_property, #ignore_failure, #immediate_notifications, inherited, #initialize, #inspect, introduced, is_custom_resource!, json_create, load_current_value, #load_from, #lookup_provider_constant, #method_missing, #name, #node, #not_if, #notifies, #notifies_before, #notifies_delayed, #notifies_immediately, #only_if, preview_resource, #provider, #provider=, #provider_for_action, provides, provides?, #resolve_notification_references, resource_for_node, resource_matching_short_name, resource_name, #resource_name, resource_name=, #retries, #retry_delay, #run_action, #sensitive, #should_skip?, skip_docs, sorted_descendants, #source_line_file, #source_line_number, state_attrs, #state_for_resource_reporter, #subscribes, #suppress_up_to_date_messages?, target_mode, #to_h, #to_json, #to_s, #to_text, #umask, unified_mode, #updated?, #updated_by_last_action, #updated_by_last_action?, use, #validate_action, #validate_resource_spec!, #value_to_text, #with_umask

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

#default_secret_config, #default_secret_service, #secret, #with_secret_config, #with_secret_service

Methods included from DSL::RenderHelpers

#render_json, #render_toml, #render_yaml

Methods included from DSL::ReaderHelpers

#parse_file, #parse_json, #parse_toml, #parse_yaml

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::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #normalize_snake_case_name, #snake_case_basename

Methods included from Mixin::Deprecation

#deprecated_attr, #deprecated_attr_reader, #deprecated_attr_writer, #deprecated_ivar

Methods included from Mixin::Properties

#copy_properties_from, included, #property_description, #property_is_set?, #reset_property

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::RebootPending

#reboot_pending?

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::Resource

Dynamic Method Handling

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

Instance Method Details

#convert_to_data_type_from_string(type, value) ⇒ Object

Question: Should I refactor these methods into an action_class? Answer: NO Why: We need them in both the action and in load_current_value. If you put them in the action class then they're only in the Provider class and are not available to load_current_value



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/chef/resource/plist.rb', line 142

def convert_to_data_type_from_string(type, value)
  case type
  when "boolean"
    # Since we've determined this is a boolean data type, we can assume that:
    # If the value as an int is 1, return true
    # If the value as an int is 0 (not 1), return false
    value.to_i == 1
  when "integer"
    value.to_i
  when "float"
    value.to_f
  when "string", "dictionary"
    value
  when nil
    ""
  else
    raise "Unknown or unsupported data type: #{type.class}"
  end
end

#entry_in_plist?(entry, path) ⇒ Boolean

Returns:

  • (Boolean) 


181
182
183
184
185
 
# File 'lib/chef/resource/plist.rb', line 181

def entry_in_plist?(entry, path)
  print_entry = plistbuddy_command :print, entry, path
  cmd = shell_out print_entry
  cmd.exitstatus == 0
end

#plistbuddy_command(subcommand, entry, path, value = nil) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/chef/resource/plist.rb', line 187

def plistbuddy_command(subcommand, entry, path, value = nil)
  sep = " "
  arg = case subcommand.to_s
        when "add"
          if value.is_a?(Hash)
            sep = ":"
            value.map { |k, v| "#{k} #{type_to_commandline_string(v)}" }
          else
            type_to_commandline_string(value)
          end
        when "set"
          if value.is_a?(Hash)
            sep = ":"
            value.map { |k, v| "#{k} #{v}" }
          else
            value
          end
        else
          ""
        end
  entry_with_arg = ["\"#{entry}\"", arg].join(sep).strip
  subcommand = "#{subcommand.capitalize} :#{entry_with_arg}"
  [PLISTBUDDY_EXECUTABLE, "-c", "\'#{subcommand}\'", "\"#{path}\""].join(" ")
end

#setting_from_plist(entry, path) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/chef/resource/plist.rb', line 212

def setting_from_plist(entry, path)
  defaults_read_type_output = shell_out(DEFAULTS_EXECUTABLE, "read-type", path, entry).stdout
  data_type = defaults_read_type_output.split.last

  if value.class == Hash
    plutil_output = shell_out(PLUTIL_EXECUTABLE, "-extract", entry, "xml1", "-o", "-", path).stdout.chomp
    { key_type: data_type, key_value: ::Plist.parse_xml(plutil_output) }
  else
    defaults_read_output = shell_out(DEFAULTS_EXECUTABLE, "read", path, entry).stdout
    { key_type: data_type, key_value: defaults_read_output.strip }
  end
end

#type_to_commandline_string(value) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/chef/resource/plist.rb', line 162

def type_to_commandline_string(value)
  case value
  when Array
    "array"
  when Integer
    "integer"
  when FalseClass, TrueClass
    "bool"
  when Hash
    "dict"
  when String
    "string"
  when Float
    "float"
  else
    raise "Unknown or unsupported data type: #{value} of #{value.class}"
  end
end