Class: Chef::Provider::Package

Inherits:
Chef::Provider show all
Extended by:
Mixin::SubclassDirective
Includes:
Mixin::Command, Mixin::ShellOut
Defined in:
lib/chef/provider/package.rb,
lib/chef/provider/package/aix.rb,
lib/chef/provider/package/apt.rb,
lib/chef/provider/package/ips.rb,
lib/chef/provider/package/rpm.rb,
lib/chef/provider/package/yum.rb,
lib/chef/provider/package/dpkg.rb,
lib/chef/provider/package/pacman.rb,
lib/chef/provider/package/zypper.rb,
lib/chef/provider/package/openbsd.rb,
lib/chef/provider/package/paludis.rb,
lib/chef/provider/package/portage.rb,
lib/chef/provider/package/smartos.rb,
lib/chef/provider/package/solaris.rb,
lib/chef/provider/package/windows.rb,
lib/chef/provider/package/homebrew.rb,
lib/chef/provider/package/macports.rb,
lib/chef/provider/package/rubygems.rb,
lib/chef/provider/package/chocolatey.rb,
lib/chef/provider/package/freebsd/pkg.rb,
lib/chef/provider/package/windows/exe.rb,
lib/chef/provider/package/windows/msi.rb,
lib/chef/provider/package/easy_install.rb,
lib/chef/provider/package/freebsd/base.rb,
lib/chef/provider/package/freebsd/port.rb,
lib/chef/provider/package/freebsd/pkgng.rb,
lib/chef/provider/package/windows/registry_uninstall_entry.rb

Defined Under Namespace

Modules: Freebsd Classes: Aix, Apt, Chocolatey, Dpkg, EasyInstall, Homebrew, Ips, Macports, Openbsd, Pacman, Paludis, Portage, Rpm, Rubygems, SmartOS, Solaris, Windows, Yum, Zypper

Constant Summary

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary collapse

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

Methods included from Mixin::SubclassDirective

subclass_directive

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::Command

#chdir_or_tmpdir, #handle_command_failures, #output_of_command, #run_command, #run_command_and_return_stdout_stderr, #run_command_with_systems_locale

Methods included from Mixin::Command::Windows

#popen4

Methods included from Mixin::Command::Unix

#popen4

Methods inherited from Chef::Provider

#action_nothing, #cleanup_after_converge, #converge_by, #converge_if_changed, #events, include_resource_dsl, include_resource_dsl_module, #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, #register_deprecated_lwrp_class

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

Constructor Details

#initialize(new_resource, run_context) ⇒ Package 



44
45
46
47
 
# File 'lib/chef/provider/package.rb', line 44

def initialize(new_resource, run_context)
  super
  @candidate_version = nil
end

Instance Attribute Details

#candidate_version ⇒ Array, String

Hook that subclasses use to populate the candidate_version(s)



42
43
44
 
# File 'lib/chef/provider/package.rb', line 42

def candidate_version
  @candidate_version
end

Instance Method Details

#action_install ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/chef/provider/package.rb', line 83

def action_install
  unless target_version_array.any?
    Chef::Log.debug("#{@new_resource} is already installed - nothing to do")
    return
  end

  # @todo: move the preseed code out of the base class (and complete the fix for Array of preseeds? ugh...)

  if @new_resource.response_file
    if preseed_file = get_preseed_file(package_names_for_targets, versions_for_targets)
      converge_by("preseed package #{package_names_for_targets}") do
        preseed_package(preseed_file)
      end
    end
  end

  converge_by(install_description) do
    multipackage_api_adapter(package_names_for_targets, versions_for_targets) do |name, version|
      install_package(name, version)
    end
    Chef::Log.info("#{@new_resource} installed #{package_names_for_targets} at #{versions_for_targets}")
  end
end

#action_purge ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/chef/provider/package.rb', line 183

def action_purge
  if removing_package?
    description = @new_resource.version ? "version #{@new_resource.version} of" : ""
    converge_by("purge #{description} package #{@current_resource.package_name}") do
      multipackage_api_adapter(@current_resource.package_name, @new_resource.version) do |name, version|
        purge_package(name, version)
      end
      Chef::Log.info("#{@new_resource} purged")
    end
  end
end

#action_reconfig ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/chef/provider/package.rb', line 195

def action_reconfig
  if @current_resource.version == nil then
    Chef::Log.debug("#{@new_resource} is NOT installed - nothing to do")
    return
  end

  unless @new_resource.response_file then
    Chef::Log.debug("#{@new_resource} no response_file provided - nothing to do")
    return
  end

  if preseed_file = get_preseed_file(@new_resource.package_name, @current_resource.version)
    converge_by("reconfigure package #{@new_resource.package_name}") do
      preseed_package(preseed_file)
      multipackage_api_adapter(@new_resource.package_name, @current_resource.version) do |name, version|
        reconfig_package(name, version)

      end
      Chef::Log.info("#{@new_resource} reconfigured")
    end
  else
    Chef::Log.debug("#{@new_resource} preseeding has not changed - nothing to do")
  end
end

#action_remove ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/chef/provider/package.rb', line 148

def action_remove
  if removing_package?
    description = @new_resource.version ? "version #{@new_resource.version} of " : ""
    converge_by("remove #{description}package #{@current_resource.package_name}") do
      multipackage_api_adapter(@current_resource.package_name, @new_resource.version) do |name, version|
        remove_package(name, version)
      end
      Chef::Log.info("#{@new_resource} removed")
    end
  else
    Chef::Log.debug("#{@new_resource} package does not exist - nothing to do")
  end
end

#action_upgrade ⇒ Object 



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

def action_upgrade
  if !target_version_array.any?
    Chef::Log.debug("#{@new_resource} no versions to upgrade - nothing to do")
    return
  end

  converge_by(upgrade_description) do
    multipackage_api_adapter(package_names_for_targets, versions_for_targets) do |name, version|
      upgrade_package(name, version)
    end
    log_allow_downgrade = allow_downgrade ? "(allow_downgrade)" : ""
    Chef::Log.info("#{@new_resource} upgraded#{log_allow_downgrade} #{package_names_for_targets} to #{versions_for_targets}")
  end
end

#as_array(thing) ⇒ Object

helper method used by subclasses



306
307
308
 
# File 'lib/chef/provider/package.rb', line 306

def as_array(thing)
  [ thing ].flatten
end

#check_resource_semantics! ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/chef/provider/package.rb', line 53

def check_resource_semantics!
  # FIXME: this is not universally true and subclasses are needing to override this and no-ops it.  It should be turned into

  # another "subclass_directive" and the apt and yum providers should declare that they need this behavior.

  if new_resource.package_name.is_a?(Array) && new_resource.source != nil
    raise Chef::Exceptions::InvalidResourceSpecification, "You may not specify both multipackage and source"
  end
end

#define_resource_requirements ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/chef/provider/package.rb', line 64

def define_resource_requirements
  # XXX: upgrade with a specific version doesn't make a whole lot of sense, but why don't we throw this anyway if it happens?

  # if not, shouldn't we raise to tell the user to use install instead of upgrade if they want to pin a version?

  requirements.assert(:install) do |a|
    a.assertion { candidates_exist_for_all_forced_changes? }
    a.failure_message(Chef::Exceptions::Package, "No version specified, and no candidate version available for #{forced_packages_missing_candidates.join(", ")}")
    a.whyrun("Assuming a repository that offers #{forced_packages_missing_candidates.join(", ")} would have been configured")
  end

  # XXX: Does it make sense to pass in a source with :upgrade? Probably

  # not, but as with the above comment, we don't yet enforce such a thing,

  # so we'll just leave things as-is for now.

  requirements.assert(:upgrade, :install) do |a|
    a.assertion { candidates_exist_for_all_uninstalled? || new_resource.source }
    a.failure_message(Chef::Exceptions::Package, "No candidate version available for #{packages_missing_candidates.join(", ")}")
    a.whyrun("Assuming a repository that offers #{packages_missing_candidates.join(", ")} would have been configured")
  end
end

#expand_options(options) ⇒ Object

used by subclasses. deprecated. use #a_to_s instead.



255
256
257
 
# File 'lib/chef/provider/package.rb', line 255

def expand_options(options)
  options ? " #{options}" : ""
end

#get_preseed_file(name, version) ⇒ Object

@todo: extract apt/dpkg specific preseeding to a helper class



265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/chef/provider/package.rb', line 265

def get_preseed_file(name, version)
  resource = preseed_resource(name, version)
  resource.run_action(:create)
  Chef::Log.debug("#{@new_resource} fetched preseed file to #{resource.path}")

  if resource.updated_by_last_action?
    resource.path
  else
    false
  end
end

#have_any_matching_version? ⇒ Boolean 



162
163
164
165
166
167
168
 
# File 'lib/chef/provider/package.rb', line 162

def have_any_matching_version?
  f = []
  new_version_array.each_with_index do |item, index|
    f << (item == current_version_array[index])
  end
  f.any?
end

#install_package(name, version) ⇒ Object

Raises:



230
231
232
 
# File 'lib/chef/provider/package.rb', line 230

def install_package(name, version)
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :install"
end

#load_current_resource ⇒ Object 



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

def load_current_resource
end

#multipackage_api_adapter(name, version) ⇒ Object 



222
223
224
225
226
227
228
 
# File 'lib/chef/provider/package.rb', line 222

def multipackage_api_adapter(name, version)
  if use_multipackage_api?
    yield [name].flatten, [version].flatten
  else
    yield name, version
  end
end

#preseed_package(file) ⇒ Object

Raises:



246
247
248
 
# File 'lib/chef/provider/package.rb', line 246

def preseed_package(file)
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support pre-seeding package install/upgrade instructions"
end

#preseed_resource(name, version) ⇒ Object

@todo: extract apt/dpkg specific preseeding to a helper class



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/chef/provider/package.rb', line 278

def preseed_resource(name, version)
  # A directory in our cache to store this cookbook's preseed files in

  file_cache_dir = Chef::FileCache.create_cache_path("preseed/#{@new_resource.cookbook_name}")
  # The full path where the preseed file will be stored

  cache_seed_to = "#{file_cache_dir}/#{name}-#{version}.seed"

  Chef::Log.debug("#{@new_resource} fetching preseed file to #{cache_seed_to}")

  if template_available?(@new_resource.response_file)
    Chef::Log.debug("#{@new_resource} fetching preseed file via Template")
    remote_file = Chef::Resource::Template.new(cache_seed_to, run_context)
    remote_file.variables(@new_resource.response_file_variables)
  elsif cookbook_file_available?(@new_resource.response_file)
    Chef::Log.debug("#{@new_resource} fetching preseed file via cookbook_file")
    remote_file = Chef::Resource::CookbookFile.new(cache_seed_to, run_context)
  else
    message = "No template or cookbook file found for response file #{@new_resource.response_file}"
    raise Chef::Exceptions::FileNotFound, message
  end

  remote_file.cookbook_name = @new_resource.cookbook_name
  remote_file.source(@new_resource.response_file)
  remote_file.backup(false)
  remote_file
end

#purge_package(name, version) ⇒ Object

Raises:



242
243
244
 
# File 'lib/chef/provider/package.rb', line 242

def purge_package(name, version)
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :purge"
end

#reconfig_package(name, version) ⇒ Object

Raises:



250
251
252
 
# File 'lib/chef/provider/package.rb', line 250

def reconfig_package(name, version)
  raise( Chef::Exceptions::UnsupportedAction, "#{self} does not support :reconfig" )
end

#remove_package(name, version) ⇒ Object

Raises:



238
239
240
 
# File 'lib/chef/provider/package.rb', line 238

def remove_package(name, version)
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :remove"
end

#removing_package? ⇒ Boolean 



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/chef/provider/package.rb', line 170

def removing_package?
  if !current_version_array.any?
    # ! any? means it's all nil's, which means nothing is installed

    false
  elsif !new_version_array.any?
    true # remove any version of all packages

  elsif have_any_matching_version?
    true # remove the version we have

  else
    false # we don't have the version we want to remove

  end
end

#target_version_already_installed?(current_version, new_version) ⇒ Boolean

this is public and overridden by subclasses (rubygems package implements ‘>=’ and ‘~>’ operators)



260
261
262
 
# File 'lib/chef/provider/package.rb', line 260

def target_version_already_installed?(current_version, new_version)
  new_version == current_version
end

#upgrade_package(name, version) ⇒ Object

Raises:



234
235
236
 
# File 'lib/chef/provider/package.rb', line 234

def upgrade_package(name, version)
  raise Chef::Exceptions::UnsupportedAction, "#{self} does not support :upgrade"
end

#whyrun_supported? ⇒ Boolean 



49
50
51
 
# File 'lib/chef/provider/package.rb', line 49

def whyrun_supported?
  true
end