Stop using 'pip search' for ensure => latest

because it does not work properly with devpi
as own repo/PyPi mirror and is being considered
to be deprecated in pip

Author: Greg Dubicki

manifests/pip.pp

@@ -111,11 +111,6 @@
       default => "--index-url=${index}",
     }
 
-  $pypi_search_index = $index ? {
-      false   => '',
-      default => "--index=${index}",
-    }
-
   $proxy_flag = $proxy ? {
     false    => '',
     default  => "--proxy=${proxy}",
@@ -243,10 +238,18 @@
       }
 
       'latest': {
+        # Unfortunately this is the smartest way of getting the latest available package version with pip as of now
+        $latest_version = join(["${pip_env} install ${proxy_flag} ${pkgname}==notreallyaversion 2>&1",
+                                ' | grep -oP "\(.*\)" | sed -E "s/\(from versions: (.*?, )*(.*)\)/\2/g"'])
+
+        # Packages with underscores in their names are listed with dashes in their place by `pip freeze`
+        $pkgname_with_dashes = regsubst($pkgname, '_', '-', 'G')
+        $installed_version = "${pip_env} freeze --all | grep -oP '(?i)(?<=${pkgname_with_dashes}==).*'"
+
         # Latest version.
         exec { "pip_install_${name}":
           command     => "${wheel_check} ; { ${pip_install} --upgrade \$wheel_support_flag ${pip_common_args} || ${pip_install} --upgrade ${pip_common_args} ;}",
-          unless      => "${pip_env} search ${pypi_search_index} ${proxy_flag} ${source} | grep -i INSTALLED.*latest",
+          unless      => "[ `${latest_version}` == `${installed_version}` ]",
           user        => $owner,
           group       => $group,
           umask       => $umask,

spec/acceptance/virtualenv_spec.rb

@@ -55,5 +55,61 @@ class { 'python' :
       apply_manifest(pp, catch_failures: true)
       apply_manifest(pp, catch_changes: true)
     end
+    it 'works with ensure=>latest' do
+      pp = <<-EOS
+      class { 'python' :
+        version    => 'system',
+        pip        => 'present',
+        virtualenv => 'present',
+      }
+      ->
+      python::virtualenv { 'venv' :
+        ensure     => 'present',
+        systempkgs => false,
+        venv_dir   => '/opt/venv3',
+        owner      => 'root',
+        group      => 'root',
+      }
+      ->
+      python::pip { 'rpyc' :
+        ensure     => 'latest',
+        virtualenv => '/opt/venv3',
+      }
+      EOS
+
+      # Run it twice and test for idempotency
+      apply_manifest(pp, catch_failures: true)
+      # Of course this test will fail if between the applies a new version of the package will be released,
+      # but probability of this happening is minimal, so it should be acceptable.
+      apply_manifest(pp, catch_changes: true)
+    end
+    it 'works with ensure=>latest for package with underscore in its name' do
+      pp = <<-EOS
+      class { 'python' :
+        version    => 'system',
+        pip        => 'present',
+        virtualenv => 'present',
+      }
+      ->
+      python::virtualenv { 'venv' :
+        ensure     => 'present',
+        systempkgs => false,
+        venv_dir   => '/opt/venv4',
+        owner      => 'root',
+        group      => 'root',
+      }
+      ->
+      python::pip { 'Randomized_Requests' :
+        ensure     => 'latest',
+        virtualenv => '/opt/venv4',
+      }
+      EOS
+
+      # Run it twice and test for idempotency
+      apply_manifest(pp, catch_failures: true)
+      # Of course this test will fail if between the applies a new version of the package will be released,
+      # but probability of this happening is minimal, so it should be acceptable.
+      apply_manifest(pp, catch_changes: true)
+    end
   end
 end

spec/defines/pip_spec.rb

@@ -79,7 +79,7 @@
         let(:params) { { proxy: 'http://my.proxy:3128', ensure: 'latest' } }
 
         it { is_expected.to contain_exec('pip_install_rpyc').with_command("pip wheel --help > /dev/null 2>&1 && { pip show wheel > /dev/null 2>&1 || wheel_support_flag='--no-binary :all:'; } ; { pip --log /tmp/pip.log install --upgrade $wheel_support_flag  --proxy=http://my.proxy:3128   rpyc || pip --log /tmp/pip.log install --upgrade  --proxy=http://my.proxy:3128   rpyc ;}") }
-        it { is_expected.to contain_exec('pip_install_rpyc').with_unless('pip search  --proxy=http://my.proxy:3128 rpyc | grep -i INSTALLED.*latest') }
+        it { is_expected.to contain_exec('pip_install_rpyc').with_unless('[ `pip install --proxy=http://my.proxy:3128 rpyc==notreallyaversion 2>&1 | grep -oP "\(.*\)" | sed -E "s/\(from versions: (.*?, )*(.*)\)/\2/g"` == `pip freeze --all | grep -oP \'(?i)(?<=rpyc==).*\'` ]') }
       end
     end
 
@@ -109,6 +109,20 @@
         it { is_expected.to contain_exec('pip_install_rpyc').with_path(['/opt/python3/bin', '/usr/local/bin', '/usr/bin', '/bin', '/usr/sbin']) }
       end
     end
+
+    describe 'install latest' do
+      context 'does not use pip search' do
+        let(:params) { { ensure: 'latest' } }
+
+        it { is_expected.not_to contain_exec('pip_install_rpyc').with_unless(%r{search}) }
+      end
+      context 'checks installed version of a package by converting underscores in its name with dashes' do
+        let(:params) { { ensure: 'latest', pkgname: 'wordpress_json' } }
+
+        # yes, the exec title does not change if we use different pgkname
+        it { is_expected.to contain_exec('pip_install_rpyc').with_unless(%r{wordpress-json}) }
+      end
+    end
   end
 end