[COOK-1715] Upgrade pip resource with user & group

dexterous · jtimberman · commit 7a7beb7db46e · 2012-11-22T00:33:23.000-07:00
- pass user &amp; group to shellout
- refactor provider to remove lots of duplication
- also set HOME to specified user's home to prevent permission errors
  when pip attemts to write ~/.pip/pip.log
diff --git a/providers/pip.rb b/providers/pip.rb
@@ -39,52 +39,40 @@ def whyrun_supported?
     install_version = candidate_version
   end
 
-  # Set the timeout (units in seconds)
-  timeout = 900
-  if @new_resource.timeout
-    timeout = @new_resource.timeout
-  end
-
   if install_version
     description = "install package #{@new_resource} version #{install_version}"
     converge_by(description) do
-       Chef::Log.info("Installing #{@new_resource} version #{install_version}")
-       status = install_package(@new_resource.package_name, install_version, timeout)
+      Chef::Log.info("Installing #{@new_resource} version #{install_version}")
+      status = install_package(install_version)
+      if status
+        @new_resource.updated_by_last_action(true)
+      end
     end
   end
 end
 
 action :upgrade do
-  # Set the timeout (units in seconds)
-  timeout = 900
-  if @new_resource.timeout
-    timeout = @new_resource.timeout
-  end
-
   if @current_resource.version != candidate_version
     orig_version = @current_resource.version || "uninstalled"
     description = "upgrade #{@current_resource} version from #{@current_resource.version} to #{candidate_version}"
     converge_by(description) do
-       Chef::Log.info("Upgrading #{@new_resource} version from #{orig_version} to #{candidate_version}")
-       status = upgrade_package(@new_resource.package_name, candidate_version, timeout)
+      Chef::Log.info("Upgrading #{@new_resource} version from #{orig_version} to #{candidate_version}")
+      status = upgrade_package(candidate_version)
+      if status
+        @new_resource.updated_by_last_action(true)
+      end
     end
   end
 end
 
 action :remove do
-  # Set the timeout (units in seconds)
-  timeout = 900
-  if @new_resource.timeout
-    timeout = @new_resource.timeout
-  end
-
   if removing_package?
     description = "remove package #{@new_resource}"
     converge_by(description) do
-       Chef::Log.info("Removing #{@new_resource}")
-       remove_package(@current_resource.package_name, @new_resource.version, timeout)
+      Chef::Log.info("Removing #{@new_resource}")
+      remove_package(@new_resource.version)
+      @new_resource.updated_by_last_action(true)
     end
-  else
   end
 end
 
@@ -100,10 +88,6 @@ def removing_package?
   end
 end
 
-def expand_options(options)
-  options ? " #{options}" : ""
-end
-
 # these methods are the required overrides of
 # a provider that extends from Chef::Provider::Package
 # so refactoring into core Chef should be easy
@@ -124,7 +108,7 @@ def current_installed_version
   @current_installed_version ||= begin
     delimeter = /==/
 
-    version_check_cmd = "#{pip_cmd(@new_resource)} freeze | grep -i '^#{@new_resource.package_name}=='"
+    version_check_cmd = "#{which_pip(@new_resource)} freeze | grep -i '^#{@new_resource.package_name}=='"
     # incase you upgrade pip with pip!
     if @new_resource.package_name.eql?('pip')
       delimeter = /\s/
@@ -146,23 +130,29 @@ def candidate_version
   end
 end
 
-def install_package(name, version, timeout)
-  v = "==#{version}" unless version.eql?('latest')
-  shell_out!("#{pip_cmd(@new_resource)} install#{expand_options(@new_resource.options)} #{name}#{v}", :timeout => timeout)
+def install_package(version)
+  pip_cmd('install', version == 'latest' ? '' : "==#{version}")
+end
+
+def upgrade_package(version)
+  @new_resource.options "#{@new_resource.options} --upgrade"
+  install_package(version)
 end
 
-def upgrade_package(name, version, timeout)
-  v = "==#{version}" unless version.eql?('latest')
-  shell_out!("#{pip_cmd(@new_resource)} install --upgrade#{expand_options(@new_resource.options)} #{@new_resource.name}#{v}", :timeout => timeout)
+def remove_package(version)
+  @new_resource.options "#{@new_resource.options} --yes"
+  pip_cmd('uninstall')
 end
 
-def remove_package(name, version, timeout)
-  shell_out!("#{pip_cmd(@new_resource)} uninstall -y#{expand_options(@new_resource.options)} #{@new_resource.name}", :timeout => timeout)
+def pip_cmd(subcommand, version='')
+  options = { :timeout => @new_resource.timeout, :user => @new_resource.user, :group => @new_resource.group }
+  options[:environment] = { 'HOME' => ::File.expand_path("~#{@new_resource.user}") } if @new_resource.user
+  shell_out!("#{which_pip(@new_resource)} #{subcommand} #{@new_resource.options} #{@new_resource.name}#{version}", options)
 end
 
 # TODO remove when provider is moved into Chef core
 # this allows PythonPip to work with Chef::Resource::Package
-def pip_cmd(nr)
+def which_pip(nr)
   if (nr.respond_to?("virtualenv") && nr.virtualenv)
     ::File.join(nr.virtualenv,'/bin/pip')
   elsif "#{node['python']['install_method']}".eql?("source")
diff --git a/resources/pip.rb b/resources/pip.rb
@@ -22,6 +22,8 @@
 
 attribute :package_name, :kind_of => String, :name_attribute => true
 attribute :version, :default => nil
-attribute :timeout, :default => nil
+attribute :timeout, :default => 900
 attribute :virtualenv, :kind_of => String
-attribute :options, :kind_of => String
+attribute :user, :regex => Chef::Config[:user_valid_regex]
+attribute :group, :regex => Chef::Config[:group_valid_regex]
+attribute :options, :kind_of => String, :default => ''
