#!/usr/bin/env python # -*- coding: utf-8 -*- ''' The setup script for salt ''' # pylint: disable=C0111,E1101,E1103,F0401,W0611 # For Python 2.5. A no-op on 2.6 and above. from __future__ import with_statement import os import sys import glob import urllib2 from datetime import datetime # pylint: disable=E0611 from distutils import log from distutils.cmd import Command from distutils.errors import DistutilsArgError from distutils.command.build import build from distutils.command.clean import clean from distutils.command.sdist import sdist from distutils.command.install_lib import install_lib # pylint: enable=E0611 try: import zmq HAS_ZMQ = True except ImportError: HAS_ZMQ = False # Change to salt source's directory prior to running any command try: SETUP_DIRNAME = os.path.dirname(__file__) except NameError: # We're most likely being frozen and __file__ triggered this NameError # Let's work around that SETUP_DIRNAME = os.path.dirname(sys.argv[0]) if SETUP_DIRNAME != '': os.chdir(SETUP_DIRNAME) SETUP_DIRNAME = os.path.abspath(SETUP_DIRNAME) BOOTSTRAP_SCRIPT_DISTRIBUTED_VERSION = os.environ.get( # The user can provide a different bootstrap-script version. # ATTENTION: A tag for that version MUST exist 'BOOTSTRAP_SCRIPT_VERSION', # If no bootstrap-script version was provided from the environment, let's # provide the one we define. 'v2014.06.21' ) # Store a reference to the executing platform IS_WINDOWS_PLATFORM = sys.platform.startswith('win') # Use setuptools only if the user opts-in by setting the USE_SETUPTOOLS env var # Or if setuptools was previously imported (which is the case when using # 'distribute') # This ensures consistent behavior but allows for advanced usage with # virtualenv, buildout, and others. WITH_SETUPTOOLS = False if 'USE_SETUPTOOLS' in os.environ or 'setuptools' in sys.modules: try: from setuptools import setup from setuptools.command.install import install from setuptools.command.sdist import sdist WITH_SETUPTOOLS = True except ImportError: WITH_SETUPTOOLS = False if WITH_SETUPTOOLS is False: import warnings # pylint: disable=E0611 from distutils.command.install import install from distutils.core import setup # pylint: enable=E0611 warnings.filterwarnings( 'ignore', 'Unknown distribution option: \'(extras_require|tests_require|install_requires|zip_safe)\'', UserWarning, 'distutils.dist' ) try: # Add the esky bdist target if the module is available # may require additional modules depending on platform from esky import bdist_esky # bbfreeze chosen for its tight integration with distutils import bbfreeze HAS_ESKY = True except ImportError: HAS_ESKY = False SALT_VERSION = os.path.join(os.path.abspath(SETUP_DIRNAME), 'salt', 'version.py') SALT_REQS = os.path.join(os.path.abspath(SETUP_DIRNAME), '_requirements.txt') SALT_ZEROMQ_REQS = os.path.join(os.path.abspath(SETUP_DIRNAME), 'zeromq-requirements.txt') SALT_CLOUD_REQS = os.path.join(os.path.abspath(SETUP_DIRNAME), 'cloud-requirements.txt') SALT_RAET_REQS = os.path.join(os.path.abspath(SETUP_DIRNAME), 'raet-requirements.txt') SALT_SYSPATHS = os.path.join(os.path.abspath(SETUP_DIRNAME), 'salt', 'syspaths.py') # pylint: disable=W0122 exec(compile(open(SALT_VERSION).read(), SALT_VERSION, 'exec')) exec(compile(open(SALT_SYSPATHS).read(), SALT_SYSPATHS, 'exec')) # pylint: enable=W0122 # ----- Helper Functions --------------------------------------------------------------------------------------------> def _parse_requirements_file(requirements_file): parsed_requirements = [] with open(requirements_file) as rfh: for line in rfh.readlines(): line = line.strip() if not line or line.startswith(('#', '-r')): continue if IS_WINDOWS_PLATFORM and 'libcloud' in line: continue parsed_requirements.append(line) return parsed_requirements # <---- Helper Functions --------------------------------------------------------------------------------------------- # ----- Custom Distutils/Setuptools Commands ------------------------------------------------------------------------> class CloudSdist(sdist): user_options = sdist.user_options + [ ('download-bootstrap-script', None, 'Download the latest stable bootstrap-salt.sh script. This ' 'can also be triggered by having `DOWNLOAD_BOOTSTRAP_SCRIPT=1` as an ' 'environment variable.') ] boolean_options = sdist.boolean_options + [ 'download-bootstrap-script' ] def initialize_options(self): sdist.initialize_options(self) self.download_bootstrap_script = False def finalize_options(self): sdist.finalize_options(self) if 'DOWNLOAD_BOOTSTRAP_SCRIPT' in os.environ: download_bootstrap_script = os.environ.get( 'DOWNLOAD_BOOTSTRAP_SCRIPT', '0' ) self.download_bootstrap_script = download_bootstrap_script == '1' def run(self): if self.download_bootstrap_script is True: # Let's update the bootstrap-script to the version defined to be # distributed. See BOOTSTRAP_SCRIPT_DISTRIBUTED_VERSION above. url = ( 'https://github.com/saltstack/salt-bootstrap/raw/{0}' '/bootstrap-salt.sh'.format( BOOTSTRAP_SCRIPT_DISTRIBUTED_VERSION ) ) deploy_path = os.path.join( SETUP_DIRNAME, 'salt', 'cloud', 'deploy', 'bootstrap-salt.sh' ) log.info( 'Updating bootstrap-salt.sh.' '\n\tSource: {0}' '\n\tDestination: {1}'.format( url, deploy_path ) ) try: import requests req = requests.get(url) if req.status_code == 200: script_contents = req.text.encode(req.encoding) else: log.error( 'Failed to update the bootstrap-salt.sh script. HTTP ' 'Error code: {0}'.format( req.status_code ) ) except ImportError: req = urllib2.urlopen(url) if req.getcode() == 200: script_contents = req.read() else: log.error( 'Failed to update the bootstrap-salt.sh script. HTTP ' 'Error code: {0}'.format( req.getcode() ) ) try: with open(deploy_path, 'w') as fp_: fp_.write(script_contents) except (OSError, IOError) as err: log.error( 'Failed to write the updated script: {0}'.format(err) ) # Let's the rest of the build command sdist.run(self) def write_manifest(self): if IS_WINDOWS_PLATFORM: # Remove un-necessary scripts grabbed by MANIFEST.in for filename in self.filelist.files[:]: if filename in ('scripts/salt', 'scripts/salt-api', 'scripts/salt-cloud', 'scripts/salt-api', 'scripts/salt-key', 'scripts/salt-master', 'scripts/salt-run', 'scripts/salt-ssh', 'scripts/salt-syndic'): self.filelist.files.pop( self.filelist.files.index(filename) ) return sdist.write_manifest(self) class TestCommand(Command): description = 'Run tests' user_options = [ ('runtests-opts=', 'R', 'Command line options to pass to runtests.py') ] def initialize_options(self): self.runtests_opts = None def finalize_options(self): pass def run(self): from subprocess import Popen self.run_command('build') build_cmd = self.get_finalized_command('build_ext') runner = os.path.abspath('tests/runtests.py') test_cmd = sys.executable + ' {0}'.format(runner) if self.runtests_opts: test_cmd += ' {0}'.format(self.runtests_opts) print('running test') test_process = Popen( test_cmd, shell=True, stdout=sys.stdout, stderr=sys.stderr, cwd=build_cmd.build_lib ) test_process.communicate() sys.exit(test_process.returncode) class Clean(clean): def run(self): clean.run(self) # Let's clean compiled *.py[c,o] remove_extensions = ('.pyc', '.pyo') for subdir in ('salt', 'tests', 'doc'): root = os.path.join(os.path.dirname(__file__), subdir) for dirname, dirnames, filenames in os.walk(root): for to_remove_filename in glob.glob( '{0}/*.py[oc]'.format(dirname)): os.remove(to_remove_filename) INSTALL_VERSION_TEMPLATE = '''\ # This file was auto-generated by salt's setup on \ {date:%A, %d %B %Y @ %H:%m:%S UTC}. from salt.version import SaltStackVersion __saltstack_version__ = SaltStackVersion{full_version_info!r} ''' INSTALL_SYSPATHS_TEMPLATE = '''\ # This file was auto-generated by salt's setup on \ {date:%A, %d %B %Y @ %H:%m:%S UTC}. ROOT_DIR = {root_dir!r} CONFIG_DIR = {config_dir!r} CACHE_DIR = {cache_dir!r} SOCK_DIR = {sock_dir!r} SRV_ROOT_DIR= {srv_root_dir!r} BASE_FILE_ROOTS_DIR = {base_file_roots_dir!r} BASE_PILLAR_ROOTS_DIR = {base_pillar_roots_dir!r} BASE_MASTER_ROOTS_DIR = {base_master_roots_dir!r} LOGS_DIR = {logs_dir!r} PIDFILE_DIR = {pidfile_dir!r} ''' class Build(build): def run(self): # Run build.run function build.run(self) if getattr(self.distribution, 'running_salt_install', False): # If our install attribute is present and set to True, we'll go # ahead and write our install time python modules. # Write the version file version_file_path = os.path.join( self.build_lib, 'salt', '_version.py' ) # pylint: disable=E0602 open(version_file_path, 'w').write( INSTALL_VERSION_TEMPLATE.format( date=datetime.utcnow(), full_version_info=__saltstack_version__.full_info ) ) # pylint: enable=E0602 # Write the system paths file system_paths_file_path = os.path.join( self.build_lib, 'salt', '_syspaths.py' ) open(system_paths_file_path, 'w').write( INSTALL_SYSPATHS_TEMPLATE.format( date=datetime.utcnow(), root_dir=self.distribution.salt_root_dir, config_dir=self.distribution.salt_config_dir, cache_dir=self.distribution.salt_cache_dir, sock_dir=self.distribution.salt_sock_dir, srv_root_dir=self.distribution.salt_srv_root_dir, base_file_roots_dir=self.distribution.salt_base_file_roots_dir, base_pillar_roots_dir=self.distribution.salt_base_pillar_roots_dir, base_master_roots_dir=self.distribution.salt_base_master_roots_dir, logs_dir=self.distribution.salt_logs_dir, pidfile_dir=self.distribution.salt_pidfile_dir, ) ) class Install(install): user_options = install.user_options + [ ('salt-transport=', None, 'The transport to prepare salt for. Choices are \'zeromq\' ' '\'raet\' or \'both\'. Defaults to \'zeromq\''), ('salt-root-dir=', None, 'Salt\'s pre-configured root directory'), ('salt-config-dir=', None, 'Salt\'s pre-configured configuration directory'), ('salt-cache-dir=', None, 'Salt\'s pre-configured cache directory'), ('salt-sock-dir=', None, 'Salt\'s pre-configured socket directory'), ('salt-srv-root-dir=', None, 'Salt\'s pre-configured service directory'), ('salt-base-file-roots-dir=', None, 'Salt\'s pre-configured file roots directory'), ('salt-base-pillar-roots-dir=', None, 'Salt\'s pre-configured pillar roots directory'), ('salt-base-master-roots-dir=', None, 'Salt\'s pre-configured master roots directory'), ('salt-logs-dir=', None, 'Salt\'s pre-configured logs directory'), ('salt-pidfile-dir=', None, 'Salt\'s pre-configured pidfiles directory'), ] def initialize_options(self): install.initialize_options(self) if not hasattr(self.distribution, 'install_requires'): # Non setuptools installation self.distribution.install_requires = _parse_requirements_file(SALT_REQS) # pylint: disable=E0602 self.salt_transport = 'zeromq' self.salt_root_dir = ROOT_DIR self.salt_config_dir = CONFIG_DIR self.salt_cache_dir = CACHE_DIR self.salt_sock_dir = SOCK_DIR self.salt_srv_root_dir = SRV_ROOT_DIR self.salt_base_file_roots_dir = BASE_FILE_ROOTS_DIR self.salt_base_pillar_roots_dir = BASE_PILLAR_ROOTS_DIR self.salt_base_master_roots_dir = BASE_MASTER_ROOTS_DIR self.salt_logs_dir = LOGS_DIR self.salt_pidfile_dir = PIDFILE_DIR # pylint: enable=E0602 def finalize_options(self): install.finalize_options(self) for optname in ('root_dir', 'config_dir', 'cache_dir', 'sock_dir', 'srv_root_dir', 'base_file_roots_dir', 'base_pillar_roots_dir', 'base_master_roots_dir', 'logs_dir', 'pidfile_dir'): optvalue = getattr(self, 'salt_{0}'.format(optname)) if not optvalue: raise DistutilsArgError( 'The value of --salt-{0} needs a proper path value'.format( optname.replace('_', '-') ) ) setattr(self.distribution, 'salt_{0}'.format(optname), optvalue) if self.salt_transport not in ('zeromq', 'raet', 'both', 'none'): raise DistutilsArgError( 'The value of --salt-transport needs be \'zeromq\', ' '\'raet\', \'both\' or \'none\' not {0!r}'.format( self.salt_transport ) ) elif self.salt_transport == 'none': for requirement in _parse_requirements_file(SALT_ZEROMQ_REQS): if requirement not in self.distribution.install_requires: continue self.distribution.install_requires.remove(requirement) elif self.salt_transport in ('raet', 'both'): self.distribution.install_requires.extend( _parse_requirements_file(SALT_RAET_REQS) ) if self.salt_transport == 'raet': for requirement in _parse_requirements_file(SALT_ZEROMQ_REQS): if requirement not in self.distribution.install_requires: continue self.distribution.install_requires.remove(requirement) def run(self): # Let's set the running_salt_install attribute so we can add # _version.py in the build command self.distribution.running_salt_install = True # Run install.run install.run(self) class InstallLib(install_lib): def run(self): executables = [ 'salt/templates/git/ssh-id-wrapper', 'salt/templates/lxc/salt_tarball', ] install_lib.run(self) # input and outputs match 1-1 inp = self.get_inputs() out = self.get_outputs() chmod = [] for idx, inputfile in enumerate(inp): for executeable in executables: if inputfile.endswith(executeable): chmod.append(idx) for idx in chmod: filename = out[idx] os.chmod(filename, 0755) # <---- Custom Distutils/Setuptools Commands ------------------------------------------------------------------------- NAME = 'salt' VER = __version__ # pylint: disable=E0602 DESC = 'Portable, distributed, remote execution and configuration management system' SETUP_KWARGS = {'name': NAME, 'version': VER, 'description': DESC, 'author': 'Thomas S Hatch', 'author_email': 'thatch45@gmail.com', 'url': 'http://saltstack.org', 'cmdclass': { 'test': TestCommand, 'clean': Clean, 'build': Build, 'install': Install }, 'classifiers': ['Programming Language :: Python', 'Programming Language :: Cython', 'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 2.7', 'Development Status :: 5 - Production/Stable', 'Environment :: Console', 'Intended Audience :: Developers', 'Intended Audience :: Information Technology', 'Intended Audience :: System Administrators', ('License :: OSI Approved ::' ' Apache Software License'), 'Operating System :: POSIX :: Linux', 'Topic :: System :: Clustering', 'Topic :: System :: Distributed Computing', ], 'packages': ['salt', 'salt.auth', 'salt.cli', 'salt.client', 'salt.client.raet', 'salt.client.ssh', 'salt.client.ssh.wrapper', 'salt.cloud', 'salt.cloud.clouds', 'salt.daemons', 'salt.daemons.flo', 'salt.ext', 'salt.fileserver', 'salt.grains', 'salt.log', 'salt.log.handlers', 'salt.modules', 'salt.netapi', 'salt.output', 'salt.pillar', 'salt.proxy', 'salt.renderers', 'salt.returners', 'salt.roster', 'salt.runners', 'salt.search', 'salt.states', 'salt.tops', 'salt.templates', 'salt.transport', 'salt.utils', 'salt.utils.decorators', 'salt.utils.openstack', 'salt.utils.validate', 'salt.utils.serializers', 'salt.wheel', ], 'package_data': {'salt.templates': [ 'rh_ip/*.jinja', 'debian_ip/*.jinja', 'virt/*.jinja', 'git/*', 'lxc/*', ], 'salt.daemons.flo': [ '*.flo' ] }, 'data_files': [('share/man/man1', ['doc/man/salt-cp.1', 'doc/man/salt-call.1', 'doc/man/salt-minion.1', ]), ('share/man/man7', ['doc/man/salt.7', ]), ], # Required for esky builds, ZeroMQ or RAET deps will be added # at install time 'install_requires': _parse_requirements_file(SALT_REQS) + _parse_requirements_file(SALT_ZEROMQ_REQS), 'extras_require': { 'RAET': _parse_requirements_file(SALT_RAET_REQS), 'Cloud': _parse_requirements_file(SALT_CLOUD_REQS) }, # The dynamic module loading in salt.modules makes this # package zip unsafe. Required for esky builds 'zip_safe': False } if IS_WINDOWS_PLATFORM is False: SETUP_KWARGS['cmdclass']['sdist'] = CloudSdist SETUP_KWARGS['cmdclass']['install_lib'] = InstallLib # SETUP_KWARGS['packages'].extend(['salt.cloud', # 'salt.cloud.clouds']) SETUP_KWARGS['package_data']['salt.cloud'] = ['deploy/*.sh'] SETUP_KWARGS['data_files'][0][1].extend([ 'doc/man/salt-master.1', 'doc/man/salt-key.1', 'doc/man/salt.1', 'doc/man/salt-api.1', 'doc/man/salt-syndic.1', 'doc/man/salt-run.1', 'doc/man/salt-ssh.1', 'doc/man/salt-cloud.1' ]) # bbfreeze explicit includes # Sometimes the auto module traversal doesn't find everything, so we # explicitly add it. The auto dependency tracking especially does not work for # imports occurring in salt.modules, as they are loaded at salt runtime. # Specifying includes that don't exist doesn't appear to cause a freezing # error. FREEZER_INCLUDES = [ 'zmq.core.*', 'zmq.utils.*', 'ast', 'difflib', 'distutils', 'distutils.version', 'numbers', 'json', 'M2Crypto', 'Cookie', 'asyncore', 'fileinput', 'sqlite3', 'email', 'email.mime.*', 'sqlite3', ] if HAS_ZMQ and hasattr(zmq, 'pyzmq_version_info'): if HAS_ZMQ and zmq.pyzmq_version_info() >= (0, 14): # We're freezing, and when freezing ZMQ needs to be installed, so this # works fine if 'zmq.core.*' in FREEZER_INCLUDES: # For PyZMQ >= 0.14, freezing does not need 'zmq.core.*' FREEZER_INCLUDES.remove('zmq.core.*') if IS_WINDOWS_PLATFORM: FREEZER_INCLUDES.extend([ 'win32api', 'win32file', 'win32con', 'win32com', 'win32net', 'win32netcon', 'win32gui', 'win32security', 'ntsecuritycon', 'pywintypes', 'pythoncom', '_winreg', 'wmi', 'site', 'psutil', ]) SETUP_KWARGS['install_requires'].append('WMI') elif sys.platform.startswith('linux'): FREEZER_INCLUDES.append('spwd') try: import yum FREEZER_INCLUDES.append('yum') except ImportError: pass elif sys.platform.startswith('sunos'): # (The sledgehammer approach) # Just try to include everything # (This may be a better way to generate FREEZER_INCLUDES generally) try: from bbfreeze.modulegraph.modulegraph import ModuleGraph mf = ModuleGraph(sys.path[:]) for arg in glob.glob('salt/modules/*.py'): mf.run_script(arg) for mod in mf.flatten(): if type(mod).__name__ != 'Script' and mod.filename: FREEZER_INCLUDES.append(str(os.path.basename(mod.identifier))) except ImportError: pass if HAS_ESKY: # if the user has the esky / bbfreeze libraries installed, add the # appropriate kwargs to setup OPTIONS = SETUP_KWARGS.get('options', {}) OPTIONS['bdist_esky'] = { 'freezer_module': 'bbfreeze', 'freezer_options': { 'includes': FREEZER_INCLUDES } } SETUP_KWARGS['options'] = OPTIONS if WITH_SETUPTOOLS: SETUP_KWARGS['entry_points'] = { 'console_scripts': ['salt-call = salt.scripts:salt_call', 'salt-cp = salt.scripts:salt_cp', 'salt-minion = salt.scripts:salt_minion', ] } if IS_WINDOWS_PLATFORM is False: SETUP_KWARGS['entry_points']['console_scripts'].extend([ 'salt = salt.scripts:salt_main', 'salt-api = salt.scripts:salt_api', 'salt-cloud = salt.scripts:salt_cloud', 'salt-key = salt.scripts:salt_key', 'salt-master = salt.scripts:salt_master', 'salt-run = salt.scripts:salt_run', 'salt-ssh = salt.scripts:salt_ssh', 'salt-syndic = salt.scripts:salt_syndic', ]) # Required for running the tests suite SETUP_KWARGS['dependency_links'] = [ 'https://github.com/saltstack/salt-testing/tarball/develop#egg=SaltTesting' ] SETUP_KWARGS['tests_require'] = ['SaltTesting'] else: SETUP_KWARGS['scripts'] = ['scripts/salt-call', 'scripts/salt-cp', 'scripts/salt-minion', 'scripts/salt-unity', ] if IS_WINDOWS_PLATFORM is False: SETUP_KWARGS['scripts'].extend([ 'scripts/salt', 'scripts/salt-api', 'scripts/salt-cloud', 'scripts/salt-key', 'scripts/salt-master', 'scripts/salt-run', 'scripts/salt-ssh', 'scripts/salt-syndic', ]) if __name__ == '__main__': setup(**SETUP_KWARGS)