Class: Chef::Provider::Package

Inherits:
Chef::Provider show all
Extended by:
Mixin::SubclassDirective
Includes:
Mixin::ShellOut
Defined in:
lib/chef/provider/package.rb,
lib/chef/provider/package/apt.rb,
lib/chef/provider/package/bff.rb,
lib/chef/provider/package/cab.rb,
lib/chef/provider/package/deb.rb,
lib/chef/provider/package/dnf.rb,
lib/chef/provider/package/ips.rb,
lib/chef/provider/package/msu.rb,
lib/chef/provider/package/rpm.rb,
lib/chef/provider/package/yum.rb,
lib/chef/provider/package/dpkg.rb,
lib/chef/provider/package/snap.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/powershell.rb,
lib/chef/provider/package/dnf/version.rb,
lib/chef/provider/package/windows/exe.rb,
lib/chef/provider/package/windows/msi.rb,
lib/chef/provider/package/yum/version.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/yum/rpm_utils.rb,
lib/chef/provider/package/yum/yum_cache.rb,
lib/chef/provider/package/dnf/python_helper.rb,
lib/chef/provider/package/yum/python_helper.rb,
lib/chef/provider/package/windows/registry_uninstall_entry.rb

Defined Under Namespace

Modules: Deb, Freebsd Classes: Apt, Bff, Cab, Chocolatey, Dnf, Dpkg, Homebrew, Ips, Macports, Msu, Openbsd, Pacman, Paludis, Portage, Powershell, Rpm, Rubygems, SmartOS, Snap, Solaris, Windows, Yum, Zypper

Instance Attribute Summary collapse

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

Methods included from Mixin::SubclassDirective

subclass_directive

Methods included from Mixin::ShellOut

apply_default_env, maybe_add_timeout, #shell_out, #shell_out!

Methods inherited from Chef::Provider

action, #action_nothing, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #cookbook_name, #description, #events, include_resource_dsl?, include_resource_dsl_module, #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::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

#initialize(new_resource, run_context) ⇒ Package

Returns a new instance of Package.



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

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)

Returns:

  • (Array, String) —

    candidate_version(s) may be a string or array



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

def candidate_version
  @candidate_version
end

Instance Method Details

#action_lock ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/chef/provider/package.rb', line 192

def action_lock
  packages_locked = if respond_to?(:packages_all_locked?, true)
                      packages_all_locked?(Array(new_resource.package_name), Array(new_resource.version))
                    else
                      package_locked(new_resource.package_name, new_resource.version)
                    end
  unless packages_locked
    description = new_resource.version ? "version #{new_resource.version} of " : ""
    converge_by("lock #{description}package #{current_resource.package_name}") do
      multipackage_api_adapter(current_resource.package_name, new_resource.version) do |name, version|
        lock_package(name, version)
        logger.info("#{new_resource} locked")
      end
    end
  else
    logger.trace("#{new_resource} is already locked")
  end
end

#action_unlock ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/chef/provider/package.rb', line 211

def action_unlock
  packages_unlocked = if respond_to?(:packages_all_unlocked?, true)
                        packages_all_unlocked?(Array(new_resource.package_name), Array(new_resource.version))
                      else
                        !package_locked(new_resource.package_name, new_resource.version)
                      end
  unless packages_unlocked
    description = new_resource.version ? "version #{new_resource.version} of " : ""
    converge_by("unlock #{description}package #{current_resource.package_name}") do
      multipackage_api_adapter(current_resource.package_name, new_resource.version) do |name, version|
        unlock_package(name, version)
        logger.info("#{new_resource} unlocked")
      end
    end
  else
    logger.trace("#{new_resource} is already unlocked")
  end
end

#as_array(thing) ⇒ Object

helper method used by subclasses



363
364
365
 
# File 'lib/chef/provider/package.rb', line 363

def as_array(thing)
  [ thing ].flatten
end

#check_resource_semantics! ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/chef/provider/package.rb', line 56

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 



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

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.



281
282
283
284
285
286
287
288
289
 
# File 'lib/chef/provider/package.rb', line 281

def expand_options(options)
  # its deprecated but still work to do to deprecate it fully
  # Chef.deprecated(:package_misc, "expand_options is deprecated, use shell_out instead")
  if options
    " #{options.is_a?(Array) ? Shellwords.join(options) : options}"
  else
    ""
  end
end

#have_any_matching_version? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
162
163
164
165
 
# File 'lib/chef/provider/package.rb', line 159

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:



248
249
250
 
# File 'lib/chef/provider/package.rb', line 248

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

#load_current_resource ⇒ Object 



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

def load_current_resource; end

#lock_package(name, version) ⇒ Object

Raises:



272
273
274
 
# File 'lib/chef/provider/package.rb', line 272

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

#multipackage_api_adapter(name, version) ⇒ Object 



240
241
242
243
244
245
246
 
# File 'lib/chef/provider/package.rb', line 240

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

#options ⇒ Object 



52
53
54
 
# File 'lib/chef/provider/package.rb', line 52

def options
  new_resource.options
end

#package_locked(name, version) ⇒ Object

for multipackage just implement packages_all_locked? properly and omit implementing this API

Raises:



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

def package_locked(name, version)
  raise Chef::Exceptions::UnsupportedAction, "#{self} has no way to detect if package is locked"
end

#prepare_for_installation ⇒ Object

Subclasses will override this to a method and provide a preseed file path



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

def prepare_for_installation; end

#preseed_package(file) ⇒ Object

Raises:



264
265
266
 
# File 'lib/chef/provider/package.rb', line 264

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

#purge_package(name, version) ⇒ Object

Raises:



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

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

#reconfig_package(name) ⇒ Object

Raises:



268
269
270
 
# File 'lib/chef/provider/package.rb', line 268

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

#remove_package(name, version) ⇒ Object

Raises:



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

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

#removing_package? ⇒ Boolean

Returns:

  • (Boolean) 


167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/chef/provider/package.rb', line 167

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, target_version) ⇒ Boolean

This method performs a strict equality check between two strings representing version numbers

This function will eventually be deprecated in favour of the below version_equals function.

Returns:

  • (Boolean) 


315
316
317
 
# File 'lib/chef/provider/package.rb', line 315

def target_version_already_installed?(current_version, target_version)
  version_equals?(current_version, target_version)
end

#unlock_package(name, version) ⇒ Object

Raises:



276
277
278
 
# File 'lib/chef/provider/package.rb', line 276

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

#upgrade_package(name, version) ⇒ Object

Raises:



252
253
254
 
# File 'lib/chef/provider/package.rb', line 252

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

#version_compare(v1, v2) ⇒ Object

This function compares two version numbers and returns ‘spaceship operator’ style results, ie: if v1 < v2 then return -1 if v1 = v2 then return 0 if v1 > v2 then return 1 if v1 and v2 are not comparable then return nil

By default, this function will use Gem::Version comparison. Subclasses can reimplement this method for package-management system specific versions.

(In other words, pull requests to introduce domain specific mangling of versions into this method will be closed – that logic must go into the subclass – we understand that this is far from perfect but it is a better default than outright buggy things like v1.to_f <=> v2.to_f)



343
344
345
346
347
348
 
# File 'lib/chef/provider/package.rb', line 343

def version_compare(v1, v2)
  gem_v1 = Gem::Version.new(v1.gsub(/\A\s*(#{Gem::Version::VERSION_PATTERN}).*/, '\1'))
  gem_v2 = Gem::Version.new(v2.gsub(/\A\s*(#{Gem::Version::VERSION_PATTERN}).*/, '\1'))

  gem_v1 <=> gem_v2
end

#version_equals?(v1, v2) ⇒ Boolean

This method performs a strict equality check between two strings representing version numbers

Returns:

  • (Boolean) 


324
325
326
327
328
 
# File 'lib/chef/provider/package.rb', line 324

def version_equals?(v1, v2)
  return false unless v1 && v2

  v1 == v2
end

#version_requirement_satisfied?(current_version, new_version) ⇒ Boolean

Check the current_version against the new_resource.version, possibly using fuzzy matching criteria.

Subclasses MAY override this to provide fuzzy matching on the resource (‘>=’ and ‘~>’ stuff)

‘version_satisfied_by?(version, constraint)` might be a better name to make this generic.

Returns:

  • (Boolean) 


357
358
359
 
# File 'lib/chef/provider/package.rb', line 357

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