Add extra_index parameter to python::pip

Add extra_index parameter to python::pip, corresponding to the pip
command line option --extra-index-url, allowing packages to be
installed from a local repository while dependencies are pulled
from pypi.

Author: ookisan

REFERENCE.md

@@ -685,6 +685,7 @@ The following parameters are available in the `python::pip` defined type:
 * [`owner`](#owner)
 * [`group`](#group)
 * [`index`](#index)
+* [`extra_index`](#extra_index)
 * [`proxy`](#proxy)
 * [`editable`](#editable)
 * [`environment`](#environment)
@@ -766,6 +767,14 @@ Base URL of Python package index.
 
 Default value: ``false``
 
+##### <a name="extra_index"></a>`extra_index`
+
+Data type: `Variant[Boolean,String[1]]`
+
+Base URL of extra Python package index.
+
+Default value: ``false``
+
 ##### <a name="proxy"></a>`proxy`
 
 Data type: `Optional[Stdlib::HTTPUrl]`

manifests/pip.pp

@@ -9,6 +9,7 @@
 # @param owner The owner of the virtualenv being manipulated.
 # @param group The group of the virtualenv being manipulated.
 # @param index Base URL of Python package index.
+# @param extra_index Base URL of extra Python package index.
 # @param proxy Proxy server to use for outbound connections.
 # @param editable If true the package is installed as an editable resource.
 # @param environment Additional environment variables required to install the packages.
@@ -57,6 +58,7 @@
   Optional[String[1]]                               $group          = getvar('python::params::group'),
   Optional[Python::Umask]                           $umask          = undef,
   Variant[Boolean,String[1]]                        $index          = false,
+  Variant[Boolean,String[1]]                        $extra_index    = false,
   Optional[Stdlib::HTTPUrl]                         $proxy          = undef,
   Any                                               $egg            = false,
   Boolean                                           $editable       = false,
@@ -114,6 +116,11 @@
     default => "--index-url=${index}",
   }
 
+  $pypi_extra_index = $extra_index ? {
+    false   => '',
+    default => "--extra-index-url=${extra_index}",
+  }
+
   $proxy_flag = $proxy ? {
     undef    => '',
     default  => "--proxy=${proxy}",
@@ -173,7 +180,7 @@
   }
 
   $pip_install     = "${pip_env} --log ${log}/pip.log install"
-  $pip_common_args = "${pypi_index} ${proxy_flag} ${install_editable} ${source}"
+  $pip_common_args = "${pypi_index} ${pypi_extra_index} ${proxy_flag} ${install_editable} ${source}"
 
   # Explicit version out of VCS when PIP supported URL is provided
   if $source =~ /^'(git\+|hg\+|bzr\+|svn\+)(http|https|ssh|svn|sftp|ftp|lp|git)(:\/\/).+'$/ {
@@ -204,7 +211,8 @@
         # Note: we DO need to repeat ourselves with "from version" in both grep and sed as on some systems pip returns
         # more than one line with paretheses.
         $latest_version = join( [
-            "${pip_install} ${pypi_index} ${proxy_flag} ${install_args} ${install_editable} ${real_pkgname}==notreallyaversion 2>&1",
+            "${pip_install} ${pypi_index} ${pypi_extra_index} ${proxy_flag}",
+            " ${install_args} ${install_editable} ${real_pkgname}==notreallyaversion 2>&1",
             ' | grep -oP "\(from versions: .*\)" | sed -E "s/\(from versions: (.*?, )*(.*)\)/\2/g"',
             ' | tr -d "[:space:]"',
         ])

spec/acceptance/pip_spec.rb

@@ -31,6 +31,7 @@ class { 'python':
   end
 
   # rubocop:disable RSpec/RepeatedExampleGroupDescription
+  # rubocop:disable RSpec/RepeatedExampleGroupBody
   describe command('/opt/test-venv/bin/pip list') do
     its(:exit_status) { is_expected.to eq 0 }
     its(:stdout) { is_expected.to match %r{agent.* 0\.1\.2} }
@@ -74,5 +75,40 @@ class { 'python':
     its(:exit_status) { is_expected.to eq 0 }
     its(:stdout) { is_expected.not_to match %r{agent.* 0\.1\.2} }
   end
+
+  context 'install package via extra_index' do
+    it 'works with no errors' do
+      pp = <<-PUPPET
+      class { 'python':
+        version => '3',
+        dev     => 'present',
+      }
+
+      python::pyvenv { '/opt/test-venv':
+        ensure      => 'present',
+        systempkgs  => false,
+        mode        => '0755',
+        pip_version => '<= 20.3.4',
+      }
+
+      python::pip { 'agent package via extra_index':
+        virtualenv  => '/opt/test-venv',
+        pkgname     => 'agent',
+        index       => 'invalid',
+        extra_index => 'https://pypi.org/simple',
+        ensure      => '0.1.2',
+      }
+      PUPPET
+
+      apply_manifest(pp, catch_failures: true)
+      apply_manifest(pp, catch_changes: true)
+    end
+  end
+
+  describe command('/opt/test-venv/bin/pip list') do
+    its(:exit_status) { is_expected.to eq 0 }
+    its(:stdout) { is_expected.to match %r{agent.* 0\.1\.2} }
+  end
+  # rubocop:enable RSpec/RepeatedExampleGroupBody
   # rubocop:enable RSpec/RepeatedExampleGroupDescription
 end

spec/defines/pip_spec.rb

@@ -76,7 +76,7 @@
       context 'adds proxy to install command if proxy set' do
         let(:params) { { proxy: 'http://my.proxy:3128' } }
 
-        it { is_expected.to contain_exec('pip_install_rpyc').with_command('pip --log /tmp/pip.log install   --proxy=http://my.proxy:3128  rpyc') }
+        it { is_expected.to contain_exec('pip_install_rpyc').with_command('pip --log /tmp/pip.log install    --proxy=http://my.proxy:3128  rpyc') }
       end
     end
 
@@ -90,7 +90,21 @@
       context 'adds index to install command if index set' do
         let(:params) { { index: 'http://www.example.com/simple/' } }
 
-        it { is_expected.to contain_exec('pip_install_rpyc').with_command('pip --log /tmp/pip.log install  --index-url=http://www.example.com/simple/   rpyc') }
+        it { is_expected.to contain_exec('pip_install_rpyc').with_command('pip --log /tmp/pip.log install  --index-url=http://www.example.com/simple/    rpyc') }
+      end
+    end
+
+    describe 'extra_index as' do
+      context 'defaults to empty' do
+        let(:params) { {} }
+
+        it { is_expected.not_to contain_exec('pip_install_rpyc').with_command(%r{--extra-index-url}) }
+      end
+
+      context 'adds extra_index to install command if extra_index set' do
+        let(:params) { { extra_index: 'http://www.example.com/extra/simple/' } }
+
+        it { is_expected.to contain_exec('pip_install_rpyc').with_command('pip --log /tmp/pip.log install   --extra-index-url=http://www.example.com/extra/simple/   rpyc') }
       end
     end
 
@@ -107,7 +121,7 @@
       context 'adds install_args to install command if install_args set' do
         let(:params) { { install_args: '--pre' } }
 
-        it { is_expected.to contain_exec('pip_install_rpyc').with_command('pip --log /tmp/pip.log install --pre    rpyc') }
+        it { is_expected.to contain_exec('pip_install_rpyc').with_command('pip --log /tmp/pip.log install --pre     rpyc') }
       end
     end
 
@@ -171,13 +185,13 @@
       context 'suceeds with no extras' do
         let(:params) { {} }
 
-        it { is_expected.to contain_exec('pip_install_requests').with_command('pip --log /tmp/pip.log install     requests') }
+        it { is_expected.to contain_exec('pip_install_requests').with_command('pip --log /tmp/pip.log install      requests') }
       end
 
       context 'succeeds with extras' do
         let(:params) { { extras: ['security'] } }
 
-        it { is_expected.to contain_exec('pip_install_requests').with_command('pip --log /tmp/pip.log install     requests[security]') }
+        it { is_expected.to contain_exec('pip_install_requests').with_command('pip --log /tmp/pip.log install      requests[security]') }
       end
     end
   end