pyinfra 0.11.dev3__py3-none-any.whl → 3.5.1__py3-none-any.whl

pyinfra/modules/gem.py

@@ -1,30 +0,0 @@
-'''
-Mange gem packages.
-'''
-
-from pyinfra.api import operation
-
-from .util.packaging import ensure_packages
-
-
-@operation
-def packages(state, host, packages=None, present=True, latest=False):
-    '''
-    Add/remove/update gem packages.
-
-    + packages: list of packages to ensure
-    + present: whether the packages should be installed
-    + latest: whether to upgrade packages without a specified version
-
-    Versions:
-        Package versions can be pinned like gem: ``<pkg>:<version>``.
-    '''
-
-    yield ensure_packages(
-        packages, host.fact.gem_packages, present,
-        install_command='gem install',
-        uninstall_command='gem uninstall',
-        upgrade_command='gem update',
-        version_join=':',
-        latest=latest,
-    )

pyinfra/modules/git.py

@@ -1,115 +0,0 @@
-'''
-Manage git repositories and configuration.
-'''
-
-import re
-
-from pyinfra.api import operation, OperationError
-
-from . import files, ssh
-from .util.files import chown
-
-
-@operation(pipeline_facts={
-    'git_config': 'repo',
-})
-def config(
-    state, host, key, value,
-    repo=None,
-):
-    '''
-    Manage git config for a repository or globally.
-
-    + key: the key of the config to ensure
-    + value: the value this key should have
-    + repo: specify the git repo path to edit local config (defaults to global)
-    '''
-
-    existing_config = host.fact.git_config(repo)
-
-    if key not in existing_config or existing_config[key] != value:
-        if repo is None:
-            yield 'git config --global {0} "{1}"'.format(key, value)
-        else:
-            yield 'cd {0} && git config --local {1} "{2}"'.format(repo, key, value)
-
-
-@operation(pipeline_facts={
-    'git_branch': 'target',
-})
-def repo(
-    state, host, source, target,
-    branch='master', pull=True, rebase=False,
-    user=None, group=None, ssh_keyscan=False,
-    update_submodules=False, recursive_submodules=False,
-):
-    '''
-    Clone/pull git repositories.
-
-    + source: the git source URL
-    + target: target directory to clone to
-    + branch: branch to pull/checkout
-    + pull: pull any changes for the branch
-    + rebase: when pulling, use ``--rebase``
-    + user: chown files to this user after
-    + group: chown files to this group after
-    + ssh_keyscan: keyscan the remote host if not in known_hosts before clone/pull
-    + update_submodules: update any git submodules
-    + recursive_submodules: update git submodules recursively
-    '''
-
-    # Ensure our target directory exists
-    yield files.directory(state, host, target)
-
-    # Do we need to scan for the remote host key?
-    if ssh_keyscan:
-        # Attempt to parse the domain from the git repository
-        domain = re.match(r'^[a-zA-Z0-9]+@([0-9a-zA-Z\.\-]+)', source)
-
-        if domain:
-            yield ssh.keyscan(state, host, domain.group(1))
-        else:
-            raise OperationError(
-                'Could not parse domain (to SSH keyscan) from: {0}'.format(source),
-            )
-
-    # Store git commands for directory prefix
-    git_commands = []
-    is_repo = host.fact.directory('/'.join((target, '.git')))
-
-    # Cloning new repo?
-    if not is_repo:
-        git_commands.append('clone {0} --branch {1} .'.format(source, branch))
-
-    # Ensuring existing repo
-    else:
-        current_branch = host.fact.git_branch(target)
-        if current_branch != branch:
-            git_commands.append('fetch')  # fetch to ensure we have the branch locally
-            git_commands.append('checkout {0}'.format(branch))
-
-        if pull:
-            if rebase:
-                git_commands.append('pull --rebase')
-            else:
-                git_commands.append('pull')
-
-    if update_submodules:
-        if recursive_submodules:
-            git_commands.append('submodule update --init --recursive')
-        else:
-            git_commands.append('submodule update --init')
-
-    # Attach prefixes for directory
-    command_prefix = 'cd {0} && git'.format(target)
-    git_commands = [
-        '{0} {1}'.format(command_prefix, command)
-        for command in git_commands
-    ]
-
-    for cmd in git_commands:
-        yield cmd
-
-    # Apply any user or group
-    if user or group:
-        yield chown(target, user, group, recursive=True)

pyinfra/modules/init.py

@@ -1,344 +0,0 @@
-'''
-Manages the state and configuration of init services. Support for:
-
-+ SysVinit (/etc/init.d)
-+ BSD init (/etc/rc.d)
-+ Upstart
-+ Systemctl
-'''
-
-from pyinfra.api import operation, OperationError
-
-from . import files
-
-
-def _handle_service_control(
-    name, statuses, formatter, running, restarted, reloaded, command,
-    status_argument='status',
-):
-    statuses = statuses or {}
-    status = statuses.get(name, None)
-
-    # If we don't know the status, we need to check if it's up before starting
-    # and/or restarting/reloading
-    if status is None:
-        yield '''
-            # If the service is running
-            if {status_command}; then
-                {stop_command}
-                {restart_command}
-                {reload_command}
-
-            # If the service is not running, we just start it (no re[start|load])
-            else
-                {start_command}
-            fi
-        '''.format(
-            status_command=formatter.format(name, status_argument),
-            start_command=(
-                formatter.format(name, 'start')
-                if running is True else 'true'
-            ),
-            stop_command=(
-                formatter.format(name, 'stop')
-                if running is False else 'true'
-            ),
-            restart_command=(
-                formatter.format(name, 'restart')
-                if restarted else 'true'
-            ),
-            reload_command=(
-                formatter.format(name, 'reload')
-                if reloaded else 'true'
-            ),
-        )
-
-    else:
-        # Need down but running
-        if running is False and status:
-            yield formatter.format(name, 'stop')
-
-        # Need running but down
-        if running is True and not status:
-            yield formatter.format(name, 'start')
-
-        # Only restart if the service is already running
-        if restarted and status:
-            yield formatter.format(name, 'restart')
-
-        # Only reload if the service is already reloaded
-        if reloaded and status:
-            yield formatter.format(name, 'reload')
-
-    # Always execute arbitrary commands as these may or may not rely on the service
-    # being up or down
-    if command:
-        yield formatter.format(name, command)
-
-
-@operation
-def d(
-    state, host, name,
-    running=True, restarted=False, reloaded=False,
-    enabled=None, command=None,
-):
-    '''
-    Manage the state of SysV Init (/etc/init.d) services.
-
-    + name: name of the service to manage
-    + running: whether the service should be running
-    + restarted: whether the service should be restarted
-    + reloaded: whether the service should be reloaded
-    + enabled: whether this service should be enabled/disabled
-    + command: command (eg. reload) to run like: ``/etc/init.d/<name> <command>``
-
-    Enabled:
-        Because managing /etc/rc.d/X files is a mess, only certain Linux distributions
-        support enabling/disabling services:
-
-        + Ubuntu/Debian (``update-rc.d``)
-        + CentOS/Fedora/RHEL (``chkconfig``)
-        + Gentoo (``rc-update``)
-
-        For other distributions and more granular service control, see the
-        ``init.d_enable`` operation.
-    '''
-
-    yield _handle_service_control(
-        name, host.fact.initd_status,
-        '/etc/init.d/{0} {1}',
-        running, restarted, reloaded, command,
-    )
-
-    if isinstance(enabled, bool):
-        start_links = host.fact.find_links('/etc/rc*.d/S*{0}'.format(name)) or []
-
-        # If no links exist, attempt to enable the service using distro-specific commands
-        if enabled is True and not start_links:
-            distro = host.fact.linux_distribution.get('name')
-
-            if distro in ('Ubuntu', 'Debian'):
-                yield 'update-rc.d {0} defaults'.format(name)
-
-            elif distro in ('CentOS', 'Fedora', 'Red Hat Enterprise Linux'):
-                yield 'chkconfig {0} --add'.format(name)
-                yield 'chkconfig {0} on'.format(name)
-
-            elif distro == 'Gentoo':
-                yield 'rc-update add {0} default'.format(name)
-
-        # Remove any /etc/rcX.d/<name> start links
-        elif enabled is False:
-            # No state checking, just blindly remove any that exist
-            for link in start_links:
-                yield 'rm -f {0}'.format(link)
-
-
-@operation
-def d_enable(
-    state, host, name,
-    start_priority=20, stop_priority=80,
-    start_levels=(2, 3, 4, 5), stop_levels=(0, 1, 6),
-):
-    '''
-    Manually enable /etc/init.d scripts by creating /etc/rcX.d/Y links.
-
-    + name: name of the service to enable
-    + start_priority: priority to start the service
-    + stop_priority: priority to stop the service
-    + start_levels: which runlevels should the service run when enabled
-    + stop_levels: which runlevels should the service stop when enabled
-    '''
-
-    # Build link list
-    links = []
-
-    for level in start_levels:
-        links.append('/etc/rc{0}.d/S{1}{2}'.format(level, start_priority, name))
-
-    for level in stop_levels:
-        links.append('/etc/rc{0}.d/K{1}{2}'.format(level, stop_priority, name))
-
-    # Ensure all the new links exist
-    for link in links:
-        yield files.link(state, host, link, '/etc/init.d/{0}'.format(name))
-
-
-@operation
-def rc(
-    state, host, name,
-    running=True, restarted=False, reloaded=False,
-    command=None, enabled=None,
-):
-    '''
-    Manage the state of BSD init (/etc/rc.d) services.
-
-    + name: name of the service to manage
-    + running: whether the service should be running
-    + restarted: whether the service should be restarted
-    + reloaded: whether the service should be reloaded
-    + command: custom command to pass like: ``/etc/rc.d/<name> <command>``
-    + enabled: whether this service should be enabled/disabled on boot
-    '''
-
-    yield _handle_service_control(
-        name, host.fact.rcd_status,
-        '/etc/rc.d/{0} {1}',
-        running, restarted, reloaded, command,
-        status_argument='check',
-    )
-
-    # BSD init is simple, just add/remove <name>_enabled="YES"
-    if isinstance(enabled, bool):
-        yield files.line(
-            state, host,
-            '/etc/rc.conf.local',
-            '^{0}_enable='.format(name),
-            replace='{0}_enable="YES"'.format(name),
-            present=enabled,
-        )
-
-
-@operation
-def upstart(
-    state, host, name,
-    running=True, restarted=False, reloaded=False,
-    command=None, enabled=None,
-):
-    '''
-    Manage the state of upstart managed services.
-
-    + name: name of the service to manage
-    + running: whether the service should be running
-    + restarted: whether the service should be restarted
-    + reloaded: whether the service should be reloaded
-    + command: custom command to pass like: ``/etc/rc.d/<name> <command>``
-    + enabled: whether this service should be enabled/disabled on boot
-
-    Enabling/disabling services:
-        Upstart jobs define runlevels in their config files - as such there is no way to
-        edit/list these without fiddling with the config. So pyinfra simply manages the
-        existence of a ``/etc/init/<service>.override`` file, and sets its content to
-        "manual" to disable automatic start of services.
-    '''
-
-    yield _handle_service_control(
-        name, host.fact.upstart_status,
-        'initctl {1} {0}',
-        running, restarted, reloaded, command,
-    )
-
-    # Upstart jobs are setup w/runlevels etc in their config files, so here we just check
-    # there's no override file.
-    if enabled is True:
-        yield files.file(
-            state, host,
-            '/etc/init/{0}.override'.format(name),
-            present=False,
-        )
-
-    # Set the override file to "manual" to disable automatic start
-    elif enabled is False:
-        yield 'echo "manual" > /etc/init/{0}.override'.format(name)
-
-
-@operation
-def systemd(
-    state, host, name,
-    running=True, restarted=False, reloaded=False,
-    command=None, enabled=None, daemon_reload=False,
-):
-    '''
-    Manage the state of systemd managed services.
-
-    + name: name of the service to manage
-    + running: whether the service should be running
-    + restarted: whether the service should be restarted
-    + reloaded: whether the service should be reloaded
-    + command: custom command to pass like: ``/etc/rc.d/<name> <command>``
-    + enabled: whether this service should be enabled/disabled on boot
-    + daemon_reload: reload the systemd daemon to read updated unit files
-    '''
-
-    if daemon_reload:
-        yield 'systemctl daemon-reload'
-
-    yield _handle_service_control(
-        name, host.fact.systemd_status,
-        'systemctl {1} {0}.service',
-        running, restarted, reloaded, command,
-    )
-
-    if isinstance(enabled, bool):
-        is_enabled = host.fact.systemd_enabled.get(name, False)
-
-        # Isn't enabled and want enabled?
-        if not is_enabled and enabled is True:
-            yield 'systemctl enable {0}.service'.format(name)
-
-        # Is enabled and want disabled?
-        elif is_enabled and enabled is False:
-            yield 'systemctl disable {0}.service'.format(name)
-
-
-@operation
-def launchd(
-    state, host, name,
-    running=True, restarted=False, command=None,
-):
-    '''
-    Manage the state of systemd managed services.
-
-    + name: name of the service to manage
-    + running: whether the service should be running
-    + restarted: whether the service should be restarted
-    + command: custom command to pass like: ``/etc/rc.d/<name> <command>``
-    + enabled: whether this service should be enabled/disabled on boot
-    + daemon_reload: reload the systemd daemon to read updated unit files
-    '''
-
-    yield _handle_service_control(
-        name, host.fact.launchd_status,
-        'launchctl {1} {0}',
-        # No support for restart/reload/command
-        running, None, None, None,
-    )
-
-    # No restart command, so just stop/start
-    is_running = host.fact.launchd_status.get(name, None)
-    if restarted and is_running:
-        yield 'launchctl stop {0}'.format(name)
-        yield 'launchctl start {0}'.format(name)
-
-
-@operation
-def service(
-    state, host,
-    *args, **kwargs
-):
-    '''
-    Manage the state of services. This command checks for the presence of all the
-    init systems pyinfra can handle and executes the relevant operation. See init
-    system sepcific operation for arguments.
-    '''
-
-    if host.fact.which('systemctl'):
-        yield systemd(state, host, *args, **kwargs)
-        return
-
-    if host.fact.which('initctl'):
-        yield upstart(state, host, *args, **kwargs)
-        return
-
-    if host.fact.directory('/etc/init.d'):
-        yield d(state, host, *args, **kwargs)
-        return
-
-    if host.fact.directory('/etc/rc.d'):
-        yield rc(state, host, *args, **kwargs)
-        return
-
-    raise OperationError((
-        'No init system found '
-        '(no systemctl, initctl, /etc/init.d or /etc/rc.d found)'
-    ))