drop :cpan

This recipe alters a system perl ( or perl installed by another buildout
recipe ), which is not consistent with the independence of parts we are
trying to achieve in order to be able to cache and share parts.

SlapOS comonents now expose a `perl-CPAN-package` macro that should be
used for consistency. See slapos!341

/reviewed-on !4

CHANGELOG.rst

@@ -2,6 +2,12 @@
  Changes
 =========
 
+0.37 (unreleased)
+-----------------
+
+* Drop slapos.recipe.build:cpan, use ``perl-CPAN-package`` macro instead.
+
+
 0.36 (2017-06-29)
 -----------------
 

README.rst

@@ -480,54 +480,6 @@ Full example
   git-command = ${git-binary:location}/bin/git
   revision = 0123456789abcdef
 
-==========================
- slapos.recipe.build:cpan
-==========================
-
-Downloads and installs perl modules using Comprehensive Perl Archive Network (cpan).
-
-Examples
---------
-
-Basic example
-~~~~~~~~~~~~~
-
-Here is example to install one or several modules::
-
-  [buildout]
-  parts = perl-modules
-
-  [perl-modules]
-  recipe = slapos.recipe.build:cpan
-  modules =
-    Class::Date
-    Other::Module
-  # Optional argument specifying perl buildout part, if existing.
-  # If specified, recipe will use the perl installed by buildout.
-  # If not specified, will take the globally available perl executable.
-  perl = perl
-
-Specific version
-~~~~~~~~~~~~~~~~
-
-Note that cpan won't allow you to specify version and will always take latest
-version available. To choose a specific version, you will need to specify
-the full path in cpan like in ::
-
-  [buildout]
-  parts = perl-modules
-
-  [perl-modules]
-  recipe = slapos.recipe.build:cpan
-  modules =
-    D/DL/DLUX/Class-Date-1.1.10.tar.gz
-  perl = perl
-
-Notes
------
-
-Currently, the modules will be installed in site-perl directory. Location of this
-directory changes depending on the perl installation.
 
 =========================
  slapos.recipe.build:npm

setup.py

@@ -34,7 +34,6 @@ setup(name=name,
       entry_points={
         'zc.buildout': [
           'default = slapos.recipe.build:Script',
-          'cpan = slapos.recipe.cpan:Cpan',
           'download = slapos.recipe.download:Recipe',
           'download-unpacked = slapos.recipe.downloadunpacked:Recipe',
           'gitclone = slapos.recipe.gitclone:Recipe',

slapos/recipe/cpan.py

-##############################################################################
-#
-# Copyright (c) 2010 Vifib SARL and Contributors. All Rights Reserved.
-#
-# WARNING: This program as such is intended to be used by professional
-# programmers who take the whole responsibility of assessing all potential
-# consequences resulting from its eventual inadequacies and bugs
-# End users who are looking for a ready-to-use solution with commercial
-# guarantees and support are strongly adviced to contract a Free Software
-# Service Company
-#
-# This program is Free Software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation; either version 3
-# of the License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-#
-##############################################################################
-import logging
-import os
-import subprocess
-import zc.buildout
-
-def createExecutable(name, content, mode=0o755):
-  """Create an executable with content
-
-  The parent directory should exists, else it would raise IOError"""
-  with open(name, 'w') as fileobject:
-    fileobject.write(content)
-    os.chmod(fileobject.name, mode)
-  return os.path.abspath(name)
-
-def createWrapper(node, package):
-  """Creates a node package wrapper"""
-
-class Cpan(object):
-  """Download and install locally node packages using cpan"""
-
-  def __init__(self, buildout, name, options):
-    self.cleanup_dir_list = []
-    self.buildout = buildout
-    self.name = name
-    self.logger = logging.getLogger(self.name)
-    self.options = {}
-
-    # Check for mandatory fields
-    if not options.get('modules'):
-       raise zc.buildout.UserError('No package specified in \'modules\' '
-           'parameter')
-
-    # Get variables
-    for k in ['location', 'modules', 'environment-section']:
-      self.options[k] = options.get(k, '').strip()
-
-    # Expose ${:location}
-    if self.options['location'] == '':
-      self.options['location'] = os.path.join(
-          buildout['buildout']['parts-directory'], self.name)
-
-    # Get perl binary. Mimic zc.recipe.egg behavior.
-    perl = options.get('perl')
-    if perl:
-      _cpan_executable = buildout[perl].get('perl_executable',
-          os.path.join(buildout[perl]['location'], 'bin', 'cpan'))
-    else:
-      self.logger.warn('Using system perl.')
-      _cpan_executable = 'cpan'
-
-    # Get list of packages to install
-    package_list = [
-        "%s" % s.strip()
-        for r in self.options['modules'].splitlines()
-        for s in r.split(' ')
-        if r.strip()]
-    self.popen_arguments = [_cpan_executable, 'install']
-    self.popen_arguments.extend(package_list)
-
-  def install(self):
-    # Create part directory
-    location = self.options.get('location')
-    if not os.path.isdir(location):
-      os.makedirs(location)
-    os.chdir(location)
-
-    environ = {}
-    # Set minimal working environment
-    environ['PATH'] = os.environ['PATH']
-    # Create cpan config directory in part directory
-    environ['HOME'] = self.options['location']
-
-    # Apply variables from defined environment (code from h.r.cmmi)
-    environment_section = self.options['environment-section']
-    if environment_section and environment_section in self.buildout:
-      # Use environment variables from the designated config section.
-      environ.update(self.buildout[environment_section])
-    for variable in self.options.get('environment', '').splitlines():
-      if variable.strip():
-        try:
-          key, value = variable.split('=', 1)
-          environ[key.strip()] = value
-        except ValueError:
-          raise zc.buildout.UserError('Invalid environment variable '
-              'definition: %s', variable)
-    # Extrapolate the environment variables using values from the current
-    # environment.
-    for key in environ:
-      environ[key] = environ[key] % os.environ
-
-    # Install packages
-    cpan_process = subprocess.Popen(self.popen_arguments, env=environ)
-    cpan_process.communicate()
-    
-    if cpan_process.returncode is not 0:
-      raise zc.buildout.UserError('Failed to install perl modules.')
-
-    # Create wrappers
-    #for package in self.package_list:
-    #  createExecutable()
-    #  NODE_PATH=${:destination}/node_modules ${nodejs:node_location} ${:cloud9_js_location}
-    
-    return [self.options['location']]
-
-  def update(self):
-    return None