Class: Chef::Provider::OsxProfile

Inherits:
Chef::Provider show all
Defined in:
lib/chef/provider/osx_profile.rb

Instance Attribute Summary

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

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, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #whyrun_mode?, #whyrun_supported?

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

apply_default_env, maybe_add_timeout, #shell_out, #shell_out!

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

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

#action_install ⇒ Object 



98
99
100
101
102
103
104
105
106
 
# File 'lib/chef/provider/osx_profile.rb', line 98

def action_install
  unless profile_installed?
    converge_by("install profile #{@new_profile_identifier}") do
      profile_path = write_profile_to_disk
      install_profile(profile_path)
      get_installed_profiles(true)
    end
  end
end

#action_remove ⇒ Object 



108
109
110
111
112
113
114
115
116
 
# File 'lib/chef/provider/osx_profile.rb', line 108

def action_remove
  # Clean up profile after removing it
  if profile_installed?
    converge_by("remove profile #{@new_profile_identifier}") do
      remove_profile
      get_installed_profiles(true)
    end
  end
end

#cache_cookbook_profile(cookbook_file) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/chef/provider/osx_profile.rb', line 144

def cache_cookbook_profile(cookbook_file)
  Chef::FileCache.create_cache_path(
    ::File.join(
      "profiles",
      new_resource.cookbook_name,
      ::File.dirname(cookbook_file)
    )
  )
  remote_file = Chef::Resource::CookbookFile.new(
    ::File.join(
      get_cache_dir,
      "#{cookbook_file}.remote"
    ),
    run_context
  )
  remote_file.cookbook_name = new_resource.cookbook_name
  remote_file.source(cookbook_file)
  remote_file.backup(false)
  remote_file.run_action(:create)
  remote_file.path
end

#config_uuid(profile) ⇒ Object 



174
175
176
177
178
179
180
 
# File 'lib/chef/provider/osx_profile.rb', line 174

def config_uuid(profile)
  # Make a UUID of the profile contents and return as string
  UUIDTools::UUID.sha1_create(
    UUIDTools::UUID_DNS_NAMESPACE,
    profile.to_s
  ).to_s
end

#cookbook_file_available?(cookbook_file) ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
135
136
 
# File 'lib/chef/provider/osx_profile.rb', line 132

def cookbook_file_available?(cookbook_file)
  run_context.has_cookbook_file_in_cookbook?(
    new_resource.cookbook_name, cookbook_file
  )
end

#define_resource_requirements ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/chef/provider/osx_profile.rb', line 63

def define_resource_requirements
  requirements.assert(:remove) do |a|
    if @new_profile_identifier
      a.assertion do
        !@new_profile_identifier.nil? &&
          !@new_profile_identifier.end_with?(".mobileconfig") &&
          /^\w+(?:(\.| )\w+)+$/.match(@new_profile_identifier)
      end
      a.failure_message RuntimeError, "when removing using the identifier property, it must match the profile identifier"
    else
      new_profile_name = new_resource.profile_name
      a.assertion do
        !new_profile_name.end_with?(".mobileconfig") &&
          /^\w+(?:(\.| )\w+)+$/.match(new_profile_name)
      end
      a.failure_message RuntimeError, "When removing by resource name, it must match the profile identifier "
    end
  end

  requirements.assert(:install) do |a|
    if @new_profile_hash.is_a?(Hash)
      a.assertion do
        @new_profile_hash.include?("PayloadIdentifier")
      end
      a.failure_message RuntimeError, "The specified profile does not seem to be valid"
    end
    if @new_profile_hash.is_a?(String)
      a.assertion do
        @new_profile_hash.end_with?(".mobileconfig")
      end
      a.failure_message RuntimeError, "#{new_profile_hash}' is not a valid profile"
    end
  end
end

#generate_tempfile ⇒ Object 



223
224
225
 
# File 'lib/chef/provider/osx_profile.rb', line 223

def generate_tempfile
  tempfile = ::Dir::Tmpname.create("allprofiles.plist") {}
end

#get_cache_dir ⇒ Object 



138
139
140
141
142
 
# File 'lib/chef/provider/osx_profile.rb', line 138

def get_cache_dir
  cache_dir = Chef::FileCache.create_cache_path(
    "profiles/#{new_resource.cookbook_name}"
  )
end

#get_installed_profiles(update = nil) ⇒ Object 



204
205
206
207
208
209
210
 
# File 'lib/chef/provider/osx_profile.rb', line 204

def get_installed_profiles(update = nil)
  if update
    node.run_state[:config_profiles] = query_installed_profiles
  else
    node.run_state[:config_profiles] ||= query_installed_profiles
  end
end

#get_profile_hash(new_profile) ⇒ Object 



166
167
168
169
170
171
172
 
# File 'lib/chef/provider/osx_profile.rb', line 166

def get_profile_hash(new_profile)
  if new_profile.is_a?(Hash)
    new_profile
  elsif new_profile.is_a?(String)
    load_profile_hash(new_profile)
  end
end

#install_profile(profile_path) ⇒ Object 



190
191
192
193
194
195
 
# File 'lib/chef/provider/osx_profile.rb', line 190

def install_profile(profile_path)
  cmd = [ "/usr/bin/profiles", "-I", "-F", profile_path ]
  logger.trace("cmd: #{cmd.join(" ")}")
  shellout_results = shell_out(*cmd)
  shellout_results.exitstatus
end

#load_current_resource ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/chef/provider/osx_profile.rb', line 31

def load_current_resource
  @current_resource = Chef::Resource::OsxProfile.new(new_resource.name)
  current_resource.profile_name(new_resource.profile_name)

  all_profiles = get_installed_profiles
  new_resource.profile(
    new_resource.profile ||
    new_resource.profile_name
  )

  @new_profile_hash = get_profile_hash(new_resource.profile)
  if @new_profile_hash
    @new_profile_hash["PayloadUUID"] =
      config_uuid(@new_profile_hash)
  end

  if @new_profile_hash
    @new_profile_identifier = @new_profile_hash["PayloadIdentifier"]
  else
    @new_profile_identifier = new_resource.identifier ||
      new_resource.profile_name
  end

  current_profile = nil
  if all_profiles && all_profiles.key?("_computerlevel")
    current_profile = all_profiles["_computerlevel"].find do |item|
      item["ProfileIdentifier"] == @new_profile_identifier
    end
  end
  current_resource.profile(current_profile)
end

#load_profile_hash(new_profile) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/chef/provider/osx_profile.rb', line 118

def load_profile_hash(new_profile)
  # file must exist in cookbook
  if new_profile.end_with?(".mobileconfig")
    unless cookbook_file_available?(new_profile)
      error_string = "#{self}: '#{new_profile}' not found in cookbook"
      raise Chef::Exceptions::FileNotFound, error_string
    end
    cookbook_profile = cache_cookbook_profile(new_profile)
    read_plist(cookbook_profile)
  else
    nil
  end
end

#profile_installed? ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/chef/provider/osx_profile.rb', line 235

def profile_installed?
  # Profile Identifier and UUID must match a currently installed profile
  if current_resource.profile.nil? || current_resource.profile.empty?
    false
  else
    if new_resource.action.include?(:remove)
      true
    else
      current_resource.profile["ProfileUUID"] ==
        @new_profile_hash["PayloadUUID"]
    end
  end
end

#query_installed_profiles ⇒ Object 



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/chef/provider/osx_profile.rb', line 212

def query_installed_profiles
  # Dump all profile metadata to a tempfile
  tempfile = generate_tempfile
  write_installed_profiles(tempfile)
  installed_profiles = read_plist(tempfile)
  logger.trace("Saved profiles to run_state")
  # Clean up the temp file as we do not need it anymore
  ::File.unlink(tempfile)
  installed_profiles
end

#read_plist(xml_file) ⇒ Object 



231
232
233
 
# File 'lib/chef/provider/osx_profile.rb', line 231

def read_plist(xml_file)
  Plist.parse_xml(xml_file)
end

#remove_profile ⇒ Object 



197
198
199
200
201
202
 
# File 'lib/chef/provider/osx_profile.rb', line 197

def remove_profile
  cmd = [ "/usr/bin/profiles", "-R", "-p", @new_profile_identifier ]
  logger.trace("cmd: #{cmd.join(" ")}")
  shellout_results = shell_out(*cmd)
  shellout_results.exitstatus
end

#write_installed_profiles(tempfile) ⇒ Object 



227
228
229
 
# File 'lib/chef/provider/osx_profile.rb', line 227

def write_installed_profiles(tempfile)
  shell_out!( "/usr/bin/profiles", "-P", "-o", tempfile )
end

#write_profile_to_disk ⇒ Object 



182
183
184
185
186
187
188
 
# File 'lib/chef/provider/osx_profile.rb', line 182

def write_profile_to_disk
  new_resource.path(Chef::FileCache.create_cache_path("profiles"))
  tempfile = Chef::FileContentManagement::Tempfile.new(new_resource).tempfile
  tempfile.write(@new_profile_hash.to_plist)
  tempfile.close
  tempfile.path
end