#9024 - Introduce class abp::mercurial::extension::hggit

modules/adblockplus/manifests/mercurial/extension/hggit.pp

 # == Class: adblockplus::mercurial::extension::hggit
 #
 # See http://hub.eyeo.com/issues/9024
-# This class should be obsolete when puppet is => 4.1.0

[mathias, 2018/03/15 17:57:04]

... and why is it required now? Without documenting the whole story this comment
is pointless. So please make sure either the ticket linked contains all the info
or the description above.

[f.lopez, 2018/03/16 00:23:59]

Should I include the description here? That's why I included the ticket
reference, in the ticket there is the full explanation, maybe just a few lines
explaining the problem?

+# This class should be obsolete when puppet is => 4.1.0 due `install_options`
+# being included for pip provider.
 #
-class adblockplus::mercurial::extension::hggit {
+# [*ensure*]
+#   General resource policy, i.e. "present" or "absent".
+#
+class adblockplus::mercurial::extension::hggit (
+  $ensure = '0.8.9',
+) {
 
-  ensure_packages([
+  $dependencies = [
+    'python-pip',
     'libffi-dev',
     'libssl-dev',
-  ])
+  ]
 
-  exec { "upgrade setuptools":

[mathias, 2018/03/15 17:57:05]

Please use single quotes and no space after the bracket.

[f.lopez, 2018/03/16 00:23:59]

Acknowledged.

+  ensure_packages($dependencies)
+
+  exec {'upgrade setuptools':
     command => '/usr/bin/pip install --upgrade setuptools',
-    require => Package['python-pip', 'libffi-dev', 'libssl-dev'],

[mathias, 2018/03/15 17:57:05]

This requires Package['python-pip'] being defined upfront, which is a) an
implicit assumption prone to ordering issues and b) a hidden relationship prone
to dependency issues. For now just include it with ensure_packages() above.

[f.lopez, 2018/03/16 00:23:59]

Acknowledged.

+    require => Package[$dependencies],
   }
 
-  exec { "upgrade urllib3":

[mathias, 2018/03/15 17:57:04]

Same as above.

[f.lopez, 2018/03/16 00:23:59]

Acknowledged.

+  exec {'upgrade urllib3':
     command => '/usr/bin/pip install --upgrade urllib3',
-    require => Package['python-pip', 'libffi-dev', 'libssl-dev'],
+    require => Package[$dependencies],
   }
 
   adblockplus::mercurial::extension {'hggit':
     package => {
-      ensure => '0.8.9',

[mathias, 2018/03/15 17:57:05]

This value should be implemented as the default for an $ensure parameter of this
class.

[f.lopez, 2018/03/16 00:23:59]

Acknowledged.

+      ensure => $ensure,
       name => 'hg-git',
       provider => 'pip',
     },
     require => Exec['upgrade urllib3'],
   }
-}
+}
+