Public
Snippet $430 authored by Julien Muchembled
wrapper.py
Raw
##############################################################################
#
# 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 os, shlex
from six.moves import filter
from slapos.recipe.librecipe import GenericBaseRecipe, generateHashFromFiles
from zc.buildout import UserError

class Recipe(GenericBaseRecipe):
    """Recipe to create a script from given command and options.

    :param str command-line: shell command which launches the intended process
    :param str wrapper-path: absolute path to file's destination

    :param lines wait-for-files: list of files to wait for
    :param lines hash-files: list of buildout-generated files to be checked by hash
    :param lines hash-existing-files: list of existing files to be checked by hash
    :param str pidfile: path to pidfile ensure exclusivity for the process
    :param str private-dev-shm: size of private /dev/shm, using user namespaces
    :param bool reserve-cpu: command will ask for an exclusive CPU core
    """
    _existing = ()

    def __init__(self, buildout, name, options):
        self.options = options
        hash_files = options.get('hash-files')
        if hash_files:
          self.hash_files = hash_files.split()
          self._existing = list(filter(os.path.exists, self.hash_files))
        else:
          self.hash_files = []
        hash_files = options.get('hash-existing-files')
        if hash_files:
          hash_files = hash_files.split()
          options['__hash_files__'] = generateHashFromFiles(hash_files)
          self.hash_files += hash_files

    def getWrapperPath(self):
        wrapper_path = self.options['wrapper-path']
        if self.hash_files:
          wrapper_path += '-' + generateHashFromFiles(self.hash_files)
        return wrapper_path

    def install(self):
        if self._existing:
          raise UserError(
            "hash-files must only list files that are generated by buildout:"
            "\n  " + "\n  ".join(self._existing))

        args = shlex.split(self.options['command-line'])
        wait_files = self.options.get('wait-for-files')
        pidfile = self.options.get('pidfile')
        private_dev_shm = self.options.get('private-dev-shm')

        environment = {}
        for line in (self.options.get('environment') or '').splitlines():
          line = line.strip()
          if line:
            k, v = line.split('=', 1)
            environment[k.rstrip()] = v.lstrip()

        kw = {}
        if wait_files:
          kw['wait_list'] = wait_files.split()
        if pidfile:
          kw['pidfile'] = pidfile
        if private_dev_shm:
          kw['private_dev_shm'] = private_dev_shm
        if self.isTrueValue(self.options.get('reserve-cpu')):
          kw['reserve_cpu'] = True
        return self.createWrapper(self.getWrapperPath(),
                                  args, environment, **kw)

    def update(self):
        wrapper_path = self.getWrapperPath()
        if not os.path.isfile(wrapper_path):
          raise UserError("unstable wrapper path (%r)" % wrapper_path)
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!