From af42367dce6ab1ad18a1a8d10e4d54b5accae449 Mon Sep 17 00:00:00 2001
From: Richard Crowley <r@rcrowley.org>
Date: Tue, 1 Mar 2011 20:44:11 +0000
Subject: (#6527) Added pip package provider.

Python's pip package manager is analogous to RubyGems and should be included in Puppet.

Reviewed-by: Matt Robinson <matt@puppetlabs.com>
---
 spec/unit/provider/package/pip_spec.rb | 190 +++++++++++++++++++++++++++++++++
 1 file changed, 190 insertions(+)
 create mode 100644 spec/unit/provider/package/pip_spec.rb

(limited to 'spec/unit')

diff --git a/spec/unit/provider/package/pip_spec.rb b/spec/unit/provider/package/pip_spec.rb
new file mode 100644
index 000000000..ad8201aa0
--- /dev/null
+++ b/spec/unit/provider/package/pip_spec.rb
@@ -0,0 +1,190 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+provider_class = Puppet::Type.type(:package).provider(:pip)
+
+describe provider_class do
+
+  before do
+    @resource = stub("resource")
+    @provider = provider_class.new
+    @provider.instance_variable_set(:@resource, @resource)
+  end
+
+  describe "parse" do
+
+    it "should return a hash on valid input" do
+      provider_class.parse("Django==1.2.5").should == {
+        :ensure => "1.2.5",
+        :name => "Django",
+        :provider => :pip,
+      }
+    end
+
+    it "should return nil on invalid input" do
+      provider_class.parse("foo").should == nil
+    end
+
+  end
+
+  describe "instances" do
+
+    it "should return an array when pip is present" do
+      provider_class.expects(:command).with(:pip).returns("/fake/bin/pip")
+      p = stub("process")
+      p.expects(:collect).yields("Django==1.2.5")
+      provider_class.expects(:execpipe).with("/fake/bin/pip freeze").yields(p)
+      provider_class.instances
+    end
+
+    it "should return an empty array when pip is missing" do
+      provider_class.expects(:command).with(:pip).raises(
+        Puppet::DevError.new("Pretend pip isn't installed."))
+      provider_class.instances.should == []
+    end
+
+  end
+
+  describe "query" do
+
+    before do
+      @resource.stubs(:[]).with(:name).returns("Django")
+    end
+
+    it "should return a hash when pip and the package are present" do
+      @provider.expects(:command).with(:pip).returns("/fake/bin/pip")
+      p = stub("process")
+      p.expects(:each).yields("Django==1.2.5")
+      @provider.expects(:execpipe).with("/fake/bin/pip freeze").yields(p)
+      @provider.query.should == {
+        :ensure => "1.2.5",
+        :name => "Django",
+        :provider => :pip,
+      }
+    end
+
+    it "should return nil when pip is missing" do
+      @provider.expects(:command).with(:pip).raises(
+        Puppet::DevError.new("Pretend pip isn't installed."))
+      @provider.query.should == nil
+    end
+
+    it "should return nil when the package is missing" do
+      @provider.expects(:command).with(:pip).returns("/fake/bin/pip")
+      p = stub("process")
+      p.expects(:each).yields("sdsfdssdhdfyjymdgfcjdfjxdrssf==0.0.0")
+      @provider.expects(:execpipe).with("/fake/bin/pip freeze").yields(p)
+      @provider.query.should == nil
+    end
+
+  end
+
+  describe "latest" do
+
+    it "should find a version number for Django" do
+      @resource.stubs(:[]).with(:name).returns "Django"
+      @provider.latest.should_not == nil
+    end
+
+    it "should not find a version number for sdsfdssdhdfyjymdgfcjdfjxdrssf" do
+      @resource.stubs(:[]).with(:name).returns "sdsfdssdhdfyjymdgfcjdfjxdrssf"
+      @provider.latest.should == nil
+    end
+
+  end
+
+  describe "install" do
+
+    before do
+      @resource.stubs(:[]).with(:name).returns("sdsfdssdhdfyjymdgfcjdfjxdrssf")
+      @url = "git+https://example.com/sdsfdssdhdfyjymdgfcjdfjxdrssf.git"
+    end
+
+    it "should install" do
+      @resource.stubs(:[]).with(:ensure).returns(:installed)
+      @resource.stubs(:[]).with(:source).returns(nil)
+      @provider.expects(:lazy_pip).with do |*args|
+        "install" == args[0] && "sdsfdssdhdfyjymdgfcjdfjxdrssf" == args[-1]
+      end.returns nil
+      @provider.install
+    end
+
+    it "should install from SCM" do
+      @resource.stubs(:[]).with(:ensure).returns(:installed)
+      @resource.stubs(:[]).with(:source).returns(@url)
+      @provider.expects(:lazy_pip).with do |*args|
+        "#{@url}#egg=sdsfdssdhdfyjymdgfcjdfjxdrssf" == args[-1]
+      end.returns nil
+      @provider.install
+    end
+
+    it "should install a particular revision" do
+      @resource.stubs(:[]).with(:ensure).returns("0123456")
+      @resource.stubs(:[]).with(:source).returns(@url)
+      @provider.expects(:lazy_pip).with do |*args|
+        "#{@url}@0123456#egg=sdsfdssdhdfyjymdgfcjdfjxdrssf" == args[-1]
+      end.returns nil
+      @provider.install
+    end
+
+    it "should install a particular version" do
+      @resource.stubs(:[]).with(:ensure).returns("0.0.0")
+      @resource.stubs(:[]).with(:source).returns(nil)
+      @provider.expects(:lazy_pip).with do |*args|
+        "sdsfdssdhdfyjymdgfcjdfjxdrssf==0.0.0" == args[-1]
+      end.returns nil
+      @provider.install
+    end
+
+    it "should upgrade" do
+      @resource.stubs(:[]).with(:ensure).returns(:latest)
+      @resource.stubs(:[]).with(:source).returns(nil)
+      @provider.expects(:lazy_pip).with do |*args|
+        "--upgrade" == args[-2] && "sdsfdssdhdfyjymdgfcjdfjxdrssf" == args[-1]
+      end.returns nil
+      @provider.install
+    end
+
+  end
+
+  describe "uninstall" do
+
+    it "should uninstall" do
+      @resource.stubs(:[]).with(:name).returns("sdsfdssdhdfyjymdgfcjdfjxdrssf")
+      @provider.expects(:lazy_pip).returns(nil)
+      @provider.uninstall
+    end
+
+  end
+
+  describe "update" do
+
+    it "should just call install" do
+      @provider.expects(:install).returns(nil)
+      @provider.update
+    end
+
+  end
+
+  describe "lazy_pip" do
+
+    it "should succeed if pip is present" do
+      @provider.stubs(:pip).returns(nil)
+      @provider.method(:lazy_pip).call "freeze"
+    end
+
+    it "should retry if pip has not yet been found" do
+      @provider.stubs(:pip).raises(NoMethodError).returns("/fake/bin/pip")
+      @provider.method(:lazy_pip).call "freeze"
+    end
+
+    it "should fail if pip is missing" do
+      @provider.stubs(:pip).twice.raises(NoMethodError)
+      expect { @provider.method(:lazy_pip).call("freeze") }.to \
+        raise_error(NoMethodError)
+    end
+
+  end
+
+end
-- 
cgit 


From 0170cebba039378597fdf9f0086339c2766df408 Mon Sep 17 00:00:00 2001
From: Matt Robinson <matt@puppetlabs.com>
Date: Tue, 22 Mar 2011 15:28:52 -0700
Subject: (#6527) Fix uninstall problem and refactor

Uninstall wasn't working properly because the instances method relied on
the pip command having been defined by calling lazy_pip.  This lazy_pip
pattern is a nice way of getting around Puppet's problem of
disqualifying providers at the beginning of a run because the command
doesn't yet exist even though part way through the run the command might
exist.

Really, we need to fix puppet to lazily evaluate a provider
command for validity only at the time the provider is needed.

The refactoring also pointed out that query could just reuse the logic
from instances.

The tests were also refactored to use real resources instead of stubbed
ones, and they reflect the implementation changes to instances.

Paired-with: Richard Crowley <r@rcrowley.org>
---
 spec/unit/provider/package/pip_spec.rb | 98 +++++++++++++++-------------------
 1 file changed, 42 insertions(+), 56 deletions(-)

(limited to 'spec/unit')

diff --git a/spec/unit/provider/package/pip_spec.rb b/spec/unit/provider/package/pip_spec.rb
index ad8201aa0..6809d3f90 100644
--- a/spec/unit/provider/package/pip_spec.rb
+++ b/spec/unit/provider/package/pip_spec.rb
@@ -7,17 +7,16 @@ provider_class = Puppet::Type.type(:package).provider(:pip)
 describe provider_class do
 
   before do
-    @resource = stub("resource")
-    @provider = provider_class.new
-    @provider.instance_variable_set(:@resource, @resource)
+    @resource = Puppet::Resource.new(:package, "sdsfdssdhdfyjymdgfcjdfjxdrssf")
+    @provider = provider_class.new(@resource)
   end
 
   describe "parse" do
 
     it "should return a hash on valid input" do
       provider_class.parse("Django==1.2.5").should == {
-        :ensure => "1.2.5",
-        :name => "Django",
+        :ensure   => "1.2.5",
+        :name     => "Django",
         :provider => :pip,
       }
     end
@@ -31,7 +30,7 @@ describe provider_class do
   describe "instances" do
 
     it "should return an array when pip is present" do
-      provider_class.expects(:command).with(:pip).returns("/fake/bin/pip")
+      provider_class.expects(:which).with('pip').returns("/fake/bin/pip")
       p = stub("process")
       p.expects(:collect).yields("Django==1.2.5")
       provider_class.expects(:execpipe).with("/fake/bin/pip freeze").yields(p)
@@ -39,8 +38,7 @@ describe provider_class do
     end
 
     it "should return an empty array when pip is missing" do
-      provider_class.expects(:command).with(:pip).raises(
-        Puppet::DevError.new("Pretend pip isn't installed."))
+      provider_class.expects(:which).with('pip').returns nil
       provider_class.instances.should == []
     end
 
@@ -49,32 +47,25 @@ describe provider_class do
   describe "query" do
 
     before do
-      @resource.stubs(:[]).with(:name).returns("Django")
+      @resource[:name] = "Django"
     end
 
     it "should return a hash when pip and the package are present" do
-      @provider.expects(:command).with(:pip).returns("/fake/bin/pip")
-      p = stub("process")
-      p.expects(:each).yields("Django==1.2.5")
-      @provider.expects(:execpipe).with("/fake/bin/pip freeze").yields(p)
+      provider_class.expects(:instances).returns [provider_class.new({
+        :ensure   => "1.2.5",
+        :name     => "Django",
+        :provider => :pip,
+      })]
+
       @provider.query.should == {
-        :ensure => "1.2.5",
-        :name => "Django",
+        :ensure   => "1.2.5",
+        :name     => "Django",
         :provider => :pip,
       }
     end
 
-    it "should return nil when pip is missing" do
-      @provider.expects(:command).with(:pip).raises(
-        Puppet::DevError.new("Pretend pip isn't installed."))
-      @provider.query.should == nil
-    end
-
     it "should return nil when the package is missing" do
-      @provider.expects(:command).with(:pip).returns("/fake/bin/pip")
-      p = stub("process")
-      p.expects(:each).yields("sdsfdssdhdfyjymdgfcjdfjxdrssf==0.0.0")
-      @provider.expects(:execpipe).with("/fake/bin/pip freeze").yields(p)
+      provider_class.expects(:instances).returns []
       @provider.query.should == nil
     end
 
@@ -83,12 +74,12 @@ describe provider_class do
   describe "latest" do
 
     it "should find a version number for Django" do
-      @resource.stubs(:[]).with(:name).returns "Django"
+      @resource[:name] = "Django"
       @provider.latest.should_not == nil
     end
 
     it "should not find a version number for sdsfdssdhdfyjymdgfcjdfjxdrssf" do
-      @resource.stubs(:[]).with(:name).returns "sdsfdssdhdfyjymdgfcjdfjxdrssf"
+      @resource[:name] = "sdsfdssdhdfyjymdgfcjdfjxdrssf"
       @provider.latest.should == nil
     end
 
@@ -97,52 +88,46 @@ describe provider_class do
   describe "install" do
 
     before do
-      @resource.stubs(:[]).with(:name).returns("sdsfdssdhdfyjymdgfcjdfjxdrssf")
+      @resource[:name] = "sdsfdssdhdfyjymdgfcjdfjxdrssf"
       @url = "git+https://example.com/sdsfdssdhdfyjymdgfcjdfjxdrssf.git"
     end
 
     it "should install" do
-      @resource.stubs(:[]).with(:ensure).returns(:installed)
-      @resource.stubs(:[]).with(:source).returns(nil)
-      @provider.expects(:lazy_pip).with do |*args|
-        "install" == args[0] && "sdsfdssdhdfyjymdgfcjdfjxdrssf" == args[-1]
-      end.returns nil
+      @resource[:ensure] = :installed
+      @resource[:source] = nil
+      @provider.expects(:lazy_pip).
+        with("install", '-q', "sdsfdssdhdfyjymdgfcjdfjxdrssf")
       @provider.install
     end
 
     it "should install from SCM" do
-      @resource.stubs(:[]).with(:ensure).returns(:installed)
-      @resource.stubs(:[]).with(:source).returns(@url)
-      @provider.expects(:lazy_pip).with do |*args|
-        "#{@url}#egg=sdsfdssdhdfyjymdgfcjdfjxdrssf" == args[-1]
-      end.returns nil
+      @resource[:ensure] = :installed
+      @resource[:source] = @url
+      @provider.expects(:lazy_pip).
+        with("install", '-q', '-e', "#{@url}#egg=sdsfdssdhdfyjymdgfcjdfjxdrssf")
       @provider.install
     end
 
-    it "should install a particular revision" do
-      @resource.stubs(:[]).with(:ensure).returns("0123456")
-      @resource.stubs(:[]).with(:source).returns(@url)
-      @provider.expects(:lazy_pip).with do |*args|
-        "#{@url}@0123456#egg=sdsfdssdhdfyjymdgfcjdfjxdrssf" == args[-1]
-      end.returns nil
+    it "should install a particular SCM revision" do
+      @resource[:ensure] = "0123456"
+      @resource[:source] = @url
+      @provider.expects(:lazy_pip).
+        with("install", "-q", "-e", "#{@url}@0123456#egg=sdsfdssdhdfyjymdgfcjdfjxdrssf")
       @provider.install
     end
 
     it "should install a particular version" do
-      @resource.stubs(:[]).with(:ensure).returns("0.0.0")
-      @resource.stubs(:[]).with(:source).returns(nil)
-      @provider.expects(:lazy_pip).with do |*args|
-        "sdsfdssdhdfyjymdgfcjdfjxdrssf==0.0.0" == args[-1]
-      end.returns nil
+      @resource[:ensure] = "0.0.0"
+      @resource[:source] = nil
+      @provider.expects(:lazy_pip).with("install", "-q", "sdsfdssdhdfyjymdgfcjdfjxdrssf==0.0.0")
       @provider.install
     end
 
     it "should upgrade" do
-      @resource.stubs(:[]).with(:ensure).returns(:latest)
-      @resource.stubs(:[]).with(:source).returns(nil)
-      @provider.expects(:lazy_pip).with do |*args|
-        "--upgrade" == args[-2] && "sdsfdssdhdfyjymdgfcjdfjxdrssf" == args[-1]
-      end.returns nil
+      @resource[:ensure] = :latest
+      @resource[:source] = nil
+      @provider.expects(:lazy_pip).
+        with("install", "-q", "--upgrade", "sdsfdssdhdfyjymdgfcjdfjxdrssf")
       @provider.install
     end
 
@@ -151,8 +136,9 @@ describe provider_class do
   describe "uninstall" do
 
     it "should uninstall" do
-      @resource.stubs(:[]).with(:name).returns("sdsfdssdhdfyjymdgfcjdfjxdrssf")
-      @provider.expects(:lazy_pip).returns(nil)
+      @resource[:name] = "sdsfdssdhdfyjymdgfcjdfjxdrssf"
+      @provider.expects(:lazy_pip).
+        with('uninstall', '-y', '-q', 'sdsfdssdhdfyjymdgfcjdfjxdrssf')
       @provider.uninstall
     end
 
-- 
cgit