Class: Chef::Provider::Package::Yum

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

Defined Under Namespace

Classes: RPMDb, RPMDbPackage, RPMDependency, RPMPackage, RPMProvide, RPMRequire, RPMUtils, RPMVersion, YumCache

Constant Summary

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, #current_resource, #new_resource, #run_context

Instance Method Summary collapse

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!

Methods inherited from Chef::Provider::Package

#action_install, #action_purge, #action_reconfig, #action_remove, #define_resource_requirements, #expand_options, #get_preseed_file, #preseed_package, #preseed_resource, #reconfig_package, #removing_package?, #target_version_already_installed?, #whyrun_supported?

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, #cookbook_name, #define_resource_requirements, #events, #node, #process_resource_requirements, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, #whyrun_mode?, #whyrun_supported?

Methods included from DSL::Recipe

#method_missing

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Constructor Details

#initialize(new_resource, run_context) ⇒ Yum

Returns a new instance of Yum.



952
953
954
955
956
 
# File 'lib/chef/provider/package/yum.rb', line 952

def initialize(new_resource, run_context)
  super

  @yum = YumCache.instance
end

Dynamic Method Handling

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

Instance Method Details

#action_upgrade ⇒ Object

Keep upgrades from trying to install an older candidate version. Can happen when a new version is installed then removed from a repository, now the older available version shows up as a viable install candidate.

Can be done in upgrade_package but an upgraded from->to log message slips out

Hacky - better overall solution? Custom compare in Package provider?



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
 
# File 'lib/chef/provider/package/yum.rb', line 1155

def action_upgrade
  # Could be uninstalled or have no candidate
  if @current_resource.version.nil? || candidate_version.nil?
    super
  # Ensure the candidate is newer
  elsif RPMVersion.parse(candidate_version) > RPMVersion.parse(@current_resource.version)
    super
  else
    Chef::Log.debug("#{@new_resource} is at the latest version - nothing to do")
  end
end

#allow_downgrade ⇒ Object 



977
978
979
980
981
982
983
 
# File 'lib/chef/provider/package/yum.rb', line 977

def allow_downgrade
  if @new_resource.respond_to?("allow_downgrade")
    @new_resource.allow_downgrade
  else
    false
  end
end

#arch ⇒ Object

Extra attributes



961
962
963
964
965
966
967
 
# File 'lib/chef/provider/package/yum.rb', line 961

def arch
  if @new_resource.respond_to?("arch")
    @new_resource.arch
  else
    nil
  end
end

#flush_cache ⇒ Object 



969
970
971
972
973
974
975
 
# File 'lib/chef/provider/package/yum.rb', line 969

def flush_cache
  if @new_resource.respond_to?("flush_cache")
    @new_resource.flush_cache
  else
    { :before => false, :after => false }
  end
end

#install_package(name, version) ⇒ Object 



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/chef/provider/package/yum.rb', line 1102

def install_package(name, version)
  if @new_resource.source
    yum_command("yum -d0 -e0 -y#{expand_options(@new_resource.options)} localinstall #{@new_resource.source}")
  else
    # Work around yum not exiting with an error if a package doesn't exist for CHEF-2062
    if @yum.version_available?(name, version, arch)
      method = "install"
      log_method = "installing"

      # More Yum fun:
      #
      # yum install of an old name+version will exit(1)
      # yum install of an old name+version+arch will exit(0) for some reason
      #
      # Some packages can be installed multiple times like the kernel
      unless @yum.allow_multi_install.include?(name)
        if RPMVersion.parse(@current_resource.version) > RPMVersion.parse(version)
          # Unless they want this...
          if allow_downgrade
            method = "downgrade"
            log_method = "downgrading"
          else
            # we bail like yum when the package is older
            raise Chef::Exceptions::Package, "Installed package #{name}-#{@current_resource.version} is newer " +
                                             "than candidate package #{name}-#{version}"
          end
        end
      end

      repo = @yum.package_repository(name, version, arch)
      Chef::Log.info("#{@new_resource} #{log_method} #{name}-#{version}#{yum_arch} from #{repo} repository")

      yum_command("yum -d0 -e0 -y#{expand_options(@new_resource.options)} #{method} #{name}-#{version}#{yum_arch}")
    else
      raise Chef::Exceptions::Package, "Version #{version} of #{name} not found. Did you specify both version " +
                                       "and release? (version-release, e.g. 1.84-10.fc6)"
    end
  end

  if flush_cache[:after]
    @yum.reload
  else
    @yum.reload_installed
  end
end

#load_current_resource ⇒ Object

Standard Provider methods for Parent



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/chef/provider/package/yum.rb', line 1026

def load_current_resource
  if flush_cache[:before]
    @yum.reload
  end

  if @new_resource.options
    repo_control = []
    @new_resource.options.split.each do |opt|
      if opt =~ %r{--(enable|disable)repo=.+}
        repo_control << opt
      end
    end

    if repo_control.size > 0
      @yum.enable_extra_repo_control(repo_control.join(" "))
    else
      @yum.disable_extra_repo_control
    end
  else
    @yum.disable_extra_repo_control
  end

  # At this point package_name could be:
  #
  # 1) a package name, eg: "foo"
  # 2) a package name.arch, eg: "foo.i386"
  # 3) or a dependency, eg: "foo >= 1.1"

  # Check if we have name or name+arch which has a priority over a dependency
  unless @yum.package_available?(@new_resource.package_name)
    # If they aren't in the installed packages they could be a dependency
    parse_dependency
  end

  # Don't overwrite an existing arch
  unless arch
    parse_arch
  end

  @current_resource = Chef::Resource::Package.new(@new_resource.name)
  @current_resource.package_name(@new_resource.package_name)

  if @new_resource.source
    unless ::File.exists?(@new_resource.source)
      raise Chef::Exceptions::Package, "Package #{@new_resource.name} not found: #{@new_resource.source}"
    end

    Chef::Log.debug("#{@new_resource} checking rpm status")
    shell_out!("rpm -qp --queryformat '%{NAME} %{VERSION}-%{RELEASE}\n' #{@new_resource.source}", :timeout => Chef::Config[:yum_timeout]).stdout.each_line do |line|
      case line
      when /([\w\d_.-]+)\s([\w\d_.-]+)/
        @current_resource.package_name($1)
        @new_resource.version($2)
      end
    end
  end

  if @new_resource.version
    new_resource = "#{@new_resource.package_name}-#{@new_resource.version}#{yum_arch}"
  else
    new_resource = "#{@new_resource.package_name}#{yum_arch}"
  end

  Chef::Log.debug("#{@new_resource} checking yum info for #{new_resource}")

  installed_version = @yum.installed_version(@new_resource.package_name, arch)
  @current_resource.version(installed_version)

  @candidate_version = @yum.candidate_version(@new_resource.package_name, arch)

  Chef::Log.debug("#{@new_resource} installed version: #{installed_version || "(none)"} candidate version: " +
                  "#{@candidate_version || "(none)"}")

  @current_resource
end

#purge_package(name, version) ⇒ Object 



1185
1186
1187
 
# File 'lib/chef/provider/package/yum.rb', line 1185

def purge_package(name, version)
  remove_package(name, version)
end

#remove_package(name, version) ⇒ Object 



1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
 
# File 'lib/chef/provider/package/yum.rb', line 1171

def remove_package(name, version)
  if version
    yum_command("yum -d0 -e0 -y#{expand_options(@new_resource.options)} remove #{name}-#{version}#{yum_arch}")
  else
    yum_command("yum -d0 -e0 -y#{expand_options(@new_resource.options)} remove #{name}#{yum_arch}")
  end

  if flush_cache[:after]
    @yum.reload
  else
    @yum.reload_installed
  end
end

#upgrade_package(name, version) ⇒ Object 



1167
1168
1169
 
# File 'lib/chef/provider/package/yum.rb', line 1167

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

#yum_arch ⇒ Object

Helpers



988
989
990
 
# File 'lib/chef/provider/package/yum.rb', line 988

def yum_arch
  arch ? ".#{arch}" : nil
end

#yum_command(command) ⇒ Object 



992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/chef/provider/package/yum.rb', line 992

def yum_command(command)
  status, stdout, stderr = output_of_command(command, {:timeout => Chef::Config[:yum_timeout]})

  # This is fun: rpm can encounter errors in the %post/%postun scripts which aren't
  # considered fatal - meaning the rpm is still successfully installed. These issue
  # cause yum to emit a non fatal warning but still exit(1). As there's currently no
  # way to suppress this behavior and an exit(1) will break a Chef run we make an
  # effort to trap these and re-run the same install command - it will either fail a
  # second time or succeed.
  #
  # A cleaner solution would have to be done in python and better hook into
  # yum/rpm to handle exceptions as we see fit.
  if status.exitstatus == 1
    stdout.each_line do |l|
      # rpm-4.4.2.3 lib/psm.c line 2182
      if l =~ %r{^error: %(post|postun)\(.*\) scriptlet failed, exit status \d+$}
        Chef::Log.warn("#{@new_resource} caught non-fatal scriptlet issue: \"#{l}\". Can't trust yum exit status " +
                       "so running install again to verify.")
        status, stdout, stderr = output_of_command(command, {:timeout => Chef::Config[:yum_timeout]})
        break
      end
    end
  end

  if status.exitstatus > 0
    command_output = "STDOUT: #{stdout}"
    command_output << "STDERR: #{stderr}"
    handle_command_failures(status, command_output, {})
  end
end