allow setting an index URL when creating the venv

voxpupuli · May 17, 2023 · b85d62a · b85d62a
1 parent 175ac42
commit b85d62a
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -904,6 +904,7 @@ The following parameters are available in the `python::pyvenv` defined type:
 * [`path`](#-python--pyvenv--path)
 * [`environment`](#-python--pyvenv--environment)
 * [`prompt`](#-python--pyvenv--prompt)
+* [`index`](#-python--pyvenv--index)
 * [`pip_version`](#-python--pyvenv--pip_version)
 
 ##### <a name="-python--pyvenv--ensure"></a>`ensure`
@@ -986,6 +987,14 @@ Optionally specify the virtualenv prompt (python >= 3.6)
 
 Default value: `undef`
 
+##### <a name="-python--pyvenv--index"></a>`index`
+
+Data type: `Optional[String[1]]`
+
+Optionally specify an index location from where pip and setuptools should be installed
+
+Default value: `undef`
+
 ##### <a name="-python--pyvenv--pip_version"></a>`pip_version`
 
 Data type: `Python::Venv::PipVersion`

diff --git a/manifests/pyvenv.pp b/manifests/pyvenv.pp
@@ -11,6 +11,7 @@
 # @param path Specifies the PATH variable.
 # @param environment Optionally specify environment variables for pyvenv
 # @param prompt Optionally specify the virtualenv prompt (python >= 3.6)
+# @param index Optionally specify an index location from where pip and setuptools should be installed
 #
 # @example
 #   python::pyvenv { '/var/www/project1' :
@@ -34,6 +35,7 @@
   Array                       $environment = [],
   Optional[String[1]]         $prompt      = undef,
   Python::Venv::PipVersion    $pip_version = 'latest',
+  Optional[String[1]]         $index       = undef,
 ) {
   include python
 
@@ -80,13 +82,18 @@
 
     $pip_cmd = "${python::exec_prefix}${venv_dir}/bin/pip"
 
+    $index_config = $index ? {
+      undef   => '',
+      default => "-i ${index}"
+    }
+
     $pip_upgrade = ($pip_version != 'latest') ? {
       true  => "--upgrade 'pip ${pip_version}'",
       false => '--upgrade pip',
     }
 
     exec { "python_virtualenv_${venv_dir}":
-      command     => "${virtualenv_cmd} --clear ${system_pkgs_flag} ${prompt_arg} ${venv_dir} && ${pip_cmd} --log ${venv_dir}/pip.log install ${pip_upgrade} && ${pip_cmd} --log ${venv_dir}/pip.log install --upgrade setuptools",
+      command     => "${virtualenv_cmd} --clear ${system_pkgs_flag} ${prompt_arg} ${venv_dir} && ${pip_cmd} --log ${venv_dir}/pip.log install ${index_config} ${pip_upgrade} && ${pip_cmd} --log ${venv_dir}/pip.log install ${index_config} --upgrade setuptools",
       user        => $owner,
       creates     => "${venv_dir}/bin/activate",
       path        => $_path,

diff --git a/spec/classes/python_spec.rb b/spec/classes/python_spec.rb
@@ -155,7 +155,7 @@
               it {
                 expect(subject).to contain_exec('python_virtualenv_/opt/env1').
                   with(
-                    command: 'python3.8 -m venv --clear   /opt/env1 && /opt/env1/bin/pip --log /opt/env1/pip.log install --upgrade pip && /opt/env1/bin/pip --log /opt/env1/pip.log install --upgrade setuptools',
+                    command: 'python3.8 -m venv --clear   /opt/env1 && /opt/env1/bin/pip --log /opt/env1/pip.log install  --upgrade pip && /opt/env1/bin/pip --log /opt/env1/pip.log install  --upgrade setuptools',
                     user: 'root',
                     creates: '/opt/env1/bin/activate',
                     path: [
@@ -175,7 +175,7 @@
               it {
                 expect(subject).to contain_exec('python_virtualenv_/opt/env2').
                   with(
-                    command: 'python3.8 -m venv --clear   /opt/env2 && /opt/env2/bin/pip --log /opt/env2/pip.log install --upgrade \'pip <= 20.3.4\' && /opt/env2/bin/pip --log /opt/env2/pip.log install --upgrade setuptools',
+                    command: 'python3.8 -m venv --clear   /opt/env2 && /opt/env2/bin/pip --log /opt/env2/pip.log install  --upgrade \'pip <= 20.3.4\' && /opt/env2/bin/pip --log /opt/env2/pip.log install  --upgrade setuptools',
                     user: 'root',
                     creates: '/opt/env2/bin/activate',
                     path: [