Class: Chef::Provider::Package::Dpkg

Inherits:
Chef::Provider::Package show all
Includes:
Mixin::GetSourceFromPackage
Defined in:
lib/chef/provider/package/dpkg.rb

Constant Summary collapse

DPKG_INFO =

www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Version

/([a-z\d\-\+\.]+)\t([\w\d.~:-]+)/
DPKG_INSTALLED = 
/^Status: install ok installed/
DPKG_VERSION = 
/^Version: (.+)$/

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary

Attributes inherited from Chef::Provider::Package

#candidate_version

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

Methods included from Mixin::GetSourceFromPackage

#initialize

Methods inherited from Chef::Provider::Package

#action_install, #action_purge, #action_reconfig, #action_remove, #action_upgrade, #as_array, #expand_options, #get_preseed_file, #have_any_matching_version?, #initialize, #preseed_resource, #removing_package?, #target_version_already_installed?, #whyrun_supported?

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

Methods included from Mixin::DescendantsTracker

#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Instance Method Details

#define_resource_requirements ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/chef/provider/package/dpkg.rb', line 37

def define_resource_requirements
  super
  requirements.assert(:install) do |a|
    a.assertion{ not @new_resource.source.nil? }
    a.failure_message Chef::Exceptions::Package, "Source for package #{@new_resource.name} required for action install"
  end

  # TODO this was originally written for any action in which .source is provided
  # but would it make more sense to only look at source if the action is :install?
  requirements.assert(:all_actions) do |a|
    a.assertion { @source_exists }
    a.failure_message Chef::Exceptions::Package, "Package #{@new_resource.name} not found: #{@new_resource.source}"
    a.whyrun "Assuming it would have been previously downloaded."
  end
end

#install_package(name, version) ⇒ Object 



102
103
104
105
106
107
 
# File 'lib/chef/provider/package/dpkg.rb', line 102

def install_package(name, version)
  Chef::Log.info("#{@new_resource} installing #{@new_resource.source}")
  run_noninteractive(
    "dpkg -i#{expand_options(@new_resource.options)} #{@new_resource.source}"
  )
end

#load_current_resource ⇒ Object 



53
54
55
56
57
58
59
60
61
62
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
97
98
99
100
 
# File 'lib/chef/provider/package/dpkg.rb', line 53

def load_current_resource
  @source_exists = true
  @current_resource = Chef::Resource::Package.new(@new_resource.name)
  @current_resource.package_name(@new_resource.package_name)
  @new_resource.version(nil)

  if @new_resource.source
    @source_exists = ::File.exists?(@new_resource.source)
    if @source_exists
      # Get information from the package if supplied
      Chef::Log.debug("#{@new_resource} checking dpkg status")

      shell_out("dpkg-deb -W #{@new_resource.source}").stdout.each_line do |line|
        if pkginfo = DPKG_INFO.match(line)
          @current_resource.package_name(pkginfo[1])
          @new_resource.version(pkginfo[2])
          @candidate_version = pkginfo[2]
        end
      end
    else
      # Source provided but not valid means we can't safely do further processing
      return
    end

  end

  # Check to see if it is installed
  package_installed = nil
  Chef::Log.debug("#{@new_resource} checking install state")
  status = shell_out("dpkg -s #{@current_resource.package_name}")
  status.stdout.each_line do |line|
    case line
    when DPKG_INSTALLED
      package_installed = true
    when DPKG_VERSION
      if package_installed
        Chef::Log.debug("#{@new_resource} current version is #{$1}")
        @current_resource.version($1)
      end
    end
  end

  unless status.exitstatus == 0 || status.exitstatus == 1
    raise Chef::Exceptions::Package, "dpkg failed - #{status.inspect}!"
  end

  @current_resource
end

#preseed_package(preseed_file) ⇒ Object 



127
128
129
130
 
# File 'lib/chef/provider/package/dpkg.rb', line 127

def preseed_package(preseed_file)
  Chef::Log.info("#{@new_resource} pre-seeding package installation instructions")
  run_noninteractive("debconf-set-selections #{preseed_file}")
end

#purge_package(name, version) ⇒ Object 



116
117
118
119
120
121
 
# File 'lib/chef/provider/package/dpkg.rb', line 116

def purge_package(name, version)
  Chef::Log.info("#{@new_resource} purging #{@new_resource.package_name}")
  run_noninteractive(
    "dpkg -P#{expand_options(@new_resource.options)} #{@new_resource.package_name}"
  )
end

#reconfig_package(name, version) ⇒ Object 



132
133
134
135
 
# File 'lib/chef/provider/package/dpkg.rb', line 132

def reconfig_package(name, version)
  Chef::Log.info("#{@new_resource} reconfiguring")
  run_noninteractive("dpkg-reconfigure #{name}")
end

#remove_package(name, version) ⇒ Object 



109
110
111
112
113
114
 
# File 'lib/chef/provider/package/dpkg.rb', line 109

def remove_package(name, version)
  Chef::Log.info("#{@new_resource} removing #{@new_resource.package_name}")
  run_noninteractive(
    "dpkg -r#{expand_options(@new_resource.options)} #{@new_resource.package_name}"
  )
end

#run_noninteractive(command) ⇒ Object

Runs command via shell_out with magic environment to disable interactive prompts. Command is run with default localization rather than forcing locale to “C”, so command output may not be stable.

FIXME: This should be “LC_ALL” => “en_US.UTF-8” in order to stabilize the output and get UTF-8



142
143
144
 
# File 'lib/chef/provider/package/dpkg.rb', line 142

def run_noninteractive(command)
  shell_out!(command, :env => { "DEBIAN_FRONTEND" => "noninteractive", "LC_ALL" => nil })
end

#upgrade_package(name, version) ⇒ Object 



123
124
125
 
# File 'lib/chef/provider/package/dpkg.rb', line 123

def upgrade_package(name, version)
  install_package(name, version)
end