poise-python 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c530f8cfe183f6c43252af07d5f49a0d6780879e
-  data.tar.gz: 89a616f770a38b3af82a251c896987e4ee1da41b
+  metadata.gz: a12da22a9f150574726a0269d44cb5eacbdcb924
+  data.tar.gz: 4ece1e0b399f553cf09a115ef1ccdf733454d86d
 SHA512:
-  metadata.gz: 0570397e050997a489b5c2e49d97b089b54db503c8dde5e62cdc2ceda34a7c92d5f0c32c277f94d6f270f2bca7e5508f407a4f8c828e2428c7c07f0540873f7d
-  data.tar.gz: 49f812c7ac151eff01b84a3732537aa1cba5cb4339e9e77af2d171495384429281c30b2f92f2e194cf79ae2dc5cc355571e175cabd05d520a2c77794d206e65f
+  metadata.gz: d45e0538ac533f844e9e8e9d0f8ce88edbb9b88594ecb8a5577fc8e44166aeb2a885e544e8a46aeb1593075a50e386d63c04e349e1ab9bc8b8b660ca903aad7a
+  data.tar.gz: db9ebcab6fb2dc3ebcb28eafc533d9e88223d53003703238d1398079546c2f3946c609292ba26922eb49da6df3f936f02c788f80887c9c22e90c46646f53fc8d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Poise-Python Changelog
 
+## v1.4.0
+
+* Add system package names for Ubuntu 16.04.
+* Add `options` and `cwd` properties to `pip_requirements` resource.
+* Add `install_options` and `list_options` to `python_package` resource.
+
 ## v1.3.0
 
 * Don't re-bootstrap very old pip if that is the configured version.

data/README.md

@@ -224,6 +224,9 @@ The `:purge` and `:reconfigure` actions are not supported.
 * `user` – System user to install the package.
 * `virtualenv` – Name of the `python_virtualenv` resource to use. This is
   mutually exclusive with the `python` property.
+* `options` – Options to pass to `pip`.
+* `install_options` – Options to pass to `pip install` (and similar commands).
+* `list_options` – Options to pass to `pip list` (and similar commands).
 
 For other properties see the [Chef documentation](https://docs.chef.io/resource_package.html#attributes).
 The `response_file`, `response_file_variables`, and `source` properties are not
@@ -283,7 +286,10 @@ notifications will only be triggered if a package is actually installed.
 
 * `path` – Path to the requirements file, or a folder containing the
   requirements file. *(name property)*
+* `cwd` – Directory to run `pip` from. *(default: directory containing the
+  `requirements.txt`)*
 * `group` – System group to install the packages.
+* `options` – Command line options for use with `pip install`.
 * `python` – Name of the `python_runtime` resource to use. If not specified, the
   most recently declared `python_runtime` will be used. Can also be set to the
   full path to a `python` binary.

data/lib/poise_python/python_providers/system.rb

@@ -33,6 +33,7 @@ module PoisePython
           '~> 6.0' => %w{python3.1 python2.6 python2.5},
         },
         ubuntu: {
+          '16.04' => %w{python3.5 python2.7},
           '14.04' => %w{python3.4 python2.7},
           '12.04' => %w{python3.2 python2.7},
           '10.04' => %w{python3.1 python2.6},

data/lib/poise_python/resources/pip_requirements.rb

@@ -14,6 +14,8 @@
 # limitations under the License.
 #
 
+require 'shellwords'
+
 require 'chef/provider'
 require 'chef/resource'
 require 'poise'
@@ -44,14 +46,36 @@ module PoisePython
         #   requirements file.
         #   @return [String]
         attribute(:path, kind_of: String, name_attribute: true)
+        # @!attribute cwd
+        #   Directory to run pip from. Defaults to the folder containing the
+        #   requirements.txt.
+        #   @return [String]
+        attribute(:cwd, kind_of: String, default: lazy { default_cwd })
         # @!attribute group
         #   System group to install the package.
         #   @return [String, Integer, nil]
         attribute(:group, kind_of: [String, Integer, NilClass])
+        # @!attribute options
+        #   Options string to be used with `pip install`.
+        #   @return [String, nil, false]
+        attribute(:options, kind_of: [String, NilClass, FalseClass])
         # @!attribute user
         #   System user to install the package.
         #   @return [String, Integer, nil]
         attribute(:user, kind_of: [String, Integer, NilClass])
+
+        private
+
+        # Default value for the {#cwd} property.
+        #
+        # @return [String]
+        def default_cwd
+          if ::File.directory?(path)
+            path
+          else
+            ::File.dirname(path)
+          end
+        end
       end
 
       # The default provider for `pip_requirements`.
@@ -84,11 +108,20 @@ module PoisePython
         # @param upgrade [Boolean] If we should use the --upgrade flag.
         # @return [void]
         def install_requirements(upgrade: false)
-          cmd = %w{-m pip.__main__ install}
-          cmd << '--upgrade' if upgrade
-          cmd << '--requirement'
-          cmd << requirements_path
-          output = python_shell_out!(cmd, user: new_resource.user, group: new_resource.group).stdout
+          if new_resource.options
+            # Use a string because we have some options.
+            cmd = '-m pip.__main__ install'
+            cmd << ' --upgrade' if upgrade
+            cmd << " #{new_resource.options}"
+            cmd << " --requirement #{Shellwords.escape(requirements_path)}"
+          else
+            # No options, use an array to be slightly faster.
+            cmd = %w{-m pip.__main__ install}
+            cmd << '--upgrade' if upgrade
+            cmd << '--requirement'
+            cmd << requirements_path
+          end
+          output = python_shell_out!(cmd, user: new_resource.user, group: new_resource.group, cwd: new_resource.cwd).stdout
           if output.include?('Successfully installed')
             new_resource.updated_by_last_action(true)
           end

data/lib/poise_python/resources/python_package.rb

@@ -100,6 +100,14 @@ EOH
         #   System group to install the package.
         #   @return [String, Integer, nil]
         attribute(:group, kind_of: [String, Integer, NilClass])
+        # @!attribute install_options
+        #   Options string to be used with `pip install`.
+        #   @return [String, nil, false]
+        attribute(:install_options, kind_of: [String, NilClass, FalseClass], default: nil)
+        # @!attribute list_options
+        #   Options string to be used with `pip list`.
+        #   @return [String, nil, false]
+        attribute(:list_options, kind_of: [String, NilClass, FalseClass], default: nil)
         # @!attribute user
         #   System user to install the package.
         #   @return [String, Integer, nil]
@@ -163,7 +171,7 @@ EOH
         def check_package_versions(resource, version=new_resource.version)
           version_data = Hash.new {|hash, key| hash[key] = {current: nil, candidate: nil} }
           # Get the version for everything currently installed.
-          list = pip_command('list').stdout
+          list = pip_command('list', :list).stdout
           parse_pip_list(list).each do |name, current|
             # Merge current versions in to the data.
             version_data[name][:current] = current
@@ -216,7 +224,7 @@ EOH
         # @param version [String, Array<String>] Version(s) of package(s).
         # @return [void]
         def remove_package(name, version)
-          pip_command('uninstall', %w{--yes} + [name].flatten)
+          pip_command('uninstall', :install, %w{--yes} + [name].flatten)
         end
 
         private
@@ -251,15 +259,18 @@ EOH
         # Run a pip command.
         #
         # @param pip_command [String, nil] The pip subcommand to run (eg. install).
+        # @param options_type [Symbol] Either `:install` to `:list` to select
+        #   which extra options to use.
         # @param pip_options [Array<String>] Options for the pip command.
         # @param opts [Hash] Mixlib::ShellOut options.
         # @return [Mixlib::ShellOut]
-        def pip_command(pip_command, pip_options=[], opts={})
+        def pip_command(pip_command, options_type, pip_options=[], opts={})
           runner = opts.delete(:pip_runner) || %w{-m pip.__main__}
-          full_cmd = if new_resource.options
+          type_specific_options = new_resource.send(:"#{options_type}_options")
+          full_cmd = if new_resource.options || type_specific_options
             # We have to use a string for this case to be safe because the
             # options are a string and I don't want to try and parse that.
-            "#{runner.join(' ')} #{pip_command} #{new_resource.options} #{Shellwords.join(pip_options)}"
+            "#{runner.join(' ')} #{pip_command} #{new_resource.options} #{type_specific_options} #{Shellwords.join(pip_options)}"
           else
             # No special options, use an array to skip the extra /bin/sh.
             runner + (pip_command ? [pip_command] : []) + pip_options
@@ -282,7 +293,7 @@ EOH
           cmd = pip_requirements(name, version)
           # Prepend --upgrade if needed.
           cmd = %w{--upgrade} + cmd if upgrade
-          pip_command('install', cmd)
+          pip_command('install', :install, cmd)
         end
 
         # Run my hacked version of `pip list --outdated` with a specific set of
@@ -292,7 +303,7 @@ EOH
         # @param requirements [Array<String>] Pip-formatted package requirements.
         # @return [Mixlib::ShellOut]
         def pip_outdated(requirements)
-          pip_command(nil, requirements, input: PIP_HACK_SCRIPT, pip_runner: %w{-})
+          pip_command(nil, :list, requirements, input: PIP_HACK_SCRIPT, pip_runner: %w{-})
         end
 
         # Parse the output from `pip list`. Returns a hash of package key to

data/lib/poise_python/version.rb

@@ -16,5 +16,5 @@
 
 
 module PoisePython
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/test/spec/resources/pip_requirements_spec.rb

@@ -21,13 +21,14 @@ describe PoisePython::Resources::PipRequirements do
   let(:pip_output) { '' }
   let(:pip_user) { nil }
   let(:pip_group) { nil }
+  let(:pip_cwd) { '/test' }
   step_into(:pip_requirements)
   before do
     allow(File).to receive(:directory?).and_return(false)
     allow(File).to receive(:directory?).with('/test').and_return(true)
   end
   before do
-    expect_any_instance_of(PoisePython::Resources::PipRequirements::Provider).to receive(:python_shell_out!).with(pip_cmd, {user: pip_user, group: pip_group}).and_return(double(stdout: pip_output))
+    expect_any_instance_of(PoisePython::Resources::PipRequirements::Provider).to receive(:python_shell_out!).with(pip_cmd, {user: pip_user, group: pip_group, cwd: pip_cwd}).and_return(double(stdout: pip_output))
   end
 
   context 'with a directory' do
@@ -88,4 +89,26 @@ describe PoisePython::Resources::PipRequirements do
 
     it { is_expected.to install_pip_requirements('/test').with(updated?: true) }
   end # /context with output
+
+  context 'with a cwd' do
+    let(:pip_cwd) { '/other' }
+    recipe do
+      pip_requirements '/test' do
+        cwd '/other'
+      end
+    end
+
+    it { is_expected.to install_pip_requirements('/test') }
+  end # /context with a cwd
+
+  context 'with options' do
+    let(:pip_cmd) { '-m pip.__main__ install --index-url=http://example --requirement /test/requirements.txt' }
+    recipe do
+      pip_requirements '/test' do
+        options '--index-url=http://example'
+      end
+    end
+
+    it { is_expected.to install_pip_requirements('/test') }
+  end # /context with options
 end

data/test/spec/resources/python_package_spec.rb

@@ -18,6 +18,35 @@ require 'spec_helper'
 
 describe PoisePython::Resources::PythonPackage do
   describe PoisePython::Resources::PythonPackage::Resource do
+    describe '#response_file' do
+      recipe do
+        python_package 'foo' do
+          response_file 'bar'
+        end
+      end
+
+      it { expect { subject }.to raise_error NoMethodError }
+    end # /describe #response_file
+
+    describe '#response_file_variables' do
+      recipe do
+        python_package 'foo' do
+          response_file_variables 'bar'
+        end
+      end
+
+      it { expect { subject }.to raise_error NoMethodError }
+    end # /describe #response_file_variables
+
+    describe '#source' do
+      recipe do
+        python_package 'foo' do
+          source 'bar'
+        end
+      end
+
+      it { expect { subject }.to raise_error NoMethodError }
+    end # /describe #source
   end # /describe PoisePython::Resources::PythonPackage::Resource
 
   describe PoisePython::Resources::PythonPackage::Provider do
@@ -67,6 +96,30 @@ describe PoisePython::Resources::PythonPackage do
         its(:version) { is_expected.to be nil }
         it { expect(candidate_version).to eq '1.0.0' }
       end # /context with a package with extras
+
+      context 'with options' do
+        let(:package_name) { 'foo' }
+        before do
+          test_resource.options('--index-url=http://example')
+          stub_cmd("-m pip.__main__ list --index-url=http://example  ", stdout: '')
+          stub_cmd("-  --index-url=http://example  foo", input: kind_of(String), stdout: '{"foo":"1.0.0"}')
+        end
+
+        its(:version) { is_expected.to be nil }
+        it { expect(candidate_version).to eq '1.0.0' }
+      end # /context with options
+
+      context 'with list options' do
+        let(:package_name) { 'foo' }
+        before do
+          test_resource.list_options('--index-url=http://example')
+          stub_cmd("-m pip.__main__ list  --index-url=http://example ", stdout: '')
+          stub_cmd("-   --index-url=http://example foo", input: kind_of(String), stdout: '{"foo":"1.0.0"}')
+        end
+
+        its(:version) { is_expected.to be nil }
+        it { expect(candidate_version).to eq '1.0.0' }
+      end # /context with list options
     end # /describe #load_current_resource
 
     describe 'actions' do
@@ -113,11 +166,21 @@ describe PoisePython::Resources::PythonPackage do
           let(:candidate_version) { '1.0.0' }
           before { test_resource.options('--editable') }
           it do
-            stub_cmd('-m pip.__main__ install --editable foo\\=\\=1.0.0')
+            stub_cmd('-m pip.__main__ install --editable  foo\\=\\=1.0.0')
             subject
           end
         end # /context with options
 
+        context 'with install options' do
+          let(:package_name) { 'foo' }
+          let(:candidate_version) { '1.0.0' }
+          before { test_resource.install_options('--editable') }
+          it do
+            stub_cmd('-m pip.__main__ install  --editable foo\\=\\=1.0.0')
+            subject
+          end
+        end # /context with install options
+
         context 'with a package with extras' do
           let(:package_name) { 'foo[bar]' }
           let(:candidate_version) { '1.0.0' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poise-python
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Noah Kantrowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: halite