Initial revision.

modules/circusd.py

@@ -0,0 +1,90 @@
+from __future__ import absolute_import
+import os
+from salt.exceptions import CommandNotFoundError
+
+def __virtual__():
+    return True
+
+def _get_circusctl_bin(bin_env):
+    '''
+    Return circusctl command to call, either from a virtualenv, an argument
+    passed in, or from the global modules options
+    '''
+    cmd = 'circusctl'
+    if not bin_env:
+        which_result = __salt__['cmd.which_bin']([cmd])
+        if which_result is None:
+            raise CommandNotFoundError(
+                'Could not find a `{0}` binary'.format(cmd)
+            )
+        return which_result
+
+    # try to get binary from env
+    if os.path.isdir(bin_env):
+        cmd_bin = os.path.join(bin_env, 'bin', cmd)
+        if os.path.isfile(cmd_bin):
+            return cmd_bin
+        raise CommandNotFoundError('Could not find a `{0}` binary'.format(cmd))
+
+    return bin_env
+
+def _ctl_cmd(cmd, args, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env):
+    '''
+    Return the command list to use
+    '''
+    ret = [_get_circusctl_bin(bin_env)]
+    if endpoint is not None:
+        ret += ['--endpoint', endpoint]
+    if json:
+        ret.append('--json')
+    if prettify:
+        ret.append('--prettify')
+    if ssh is not None:
+        ret += ['--ssh', ssh]
+    if ssh_keyfile is not None:
+        ret += ['--ssh_keyfile', ssh_keyfile]
+    if timeout is not None:
+        ret += ['--timeout', timeout]
+    ret.append(cmd)
+    if args is not None:
+        ret += args
+    return ' ' .join(ret)
+
+def _get_return(ret):
+    if ret['retcode'] == 0:
+        return ret['stdout']
+    else:
+        return ret['stderr']
+
+def _run_ctl_cmd(cmd, args, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env):
+    ret = __salt__['cmd.run_all'](
+        _ctl_cmd(cmd, args, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env),
+        python_shell=False
+    )
+    return _get_return(ret)
+
+def _signal_watcher(signal, name, waiting, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env):
+    args = []
+    if name is not None:
+        args.append(name)
+    if waiting:
+        args.append('--waiting')
+    return _run_ctl_cmd(signal, args, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env)
+
+def start(name=None, waiting=True, endpoint=None, json=False, prettify=False, ssh=None, ssh_keyfile=None, timeout=None, bin_env=None):
+    return _signal_watcher('start', name, waiting, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env)
+
+def stop(name=None, waiting=True, endpoint=None, json=False, prettify=False, ssh=None, ssh_keyfile=None, timeout=None, bin_env=None):
+    return _signal_watcher('stop', name, waiting, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env)
+
+def restart(name=None, waiting=True, endpoint=None, json=False, prettify=False, ssh=None, ssh_keyfile=None, timeout=None, bin_env=None):
+    return _signal_watcher('restart', name, waiting, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env)
+
+def reloadconfig(waiting=True, endpoint=None, json=False, prettify=False, ssh=None, ssh_keyfile=None, timeout=None, bin_env=None):
+    return _signal_watcher('reloadconfig', None, waiting, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env)
+
+def status(name=None, endpoint=None, json=False, prettify=False, ssh=None, ssh_keyfile=None, timeout=None, bin_env=None):
+    return _signal_watcher('status', name, False, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env)
+
+def dstats(endpoint=None, json=False, prettify=False, ssh=None, ssh_keyfile=None, timeout=None, bin_env=None):
+    return _run_ctl_cmd('dstats', None, endpoint, json, prettify, ssh, ssh_keyfile, timeout, bin_env)

states/circusd.py

@@ -0,0 +1,144 @@
+from __future__ import absolute_import
+import os
+import difflib
+import six
+import json
+from salt.exceptions import SaltInvocationError
+
+"""
+Interaction with the circusd daemon
+===================================
+
+.. code-block:: yaml
+
+    my_watcher:
+        circusd.watcher_running:
+          - watch:
+            - file: /etc/circusd/conf.d/my_watcher.ini
+"""
+
+def _parse_output(ouptput):
+    try:
+        result = json.loads(ouptput)
+    except ValueError:
+        return None
+
+    if isinstance(result, dict) and ('status' in result):
+        return result
+    else:
+        return None
+
+def _error(ret, error_msg):
+    ret['result'] = False
+    ret['comment'] = error_msg
+    return ret
+
+def watcher_running(name,
+                    endpoint=None,
+                    ssh=None,
+                    ssh_keyfile=None,
+                    timeout=None,
+                    bin_env=None,
+                    restart=None):
+    """
+    Ensure that a circus watcher is running.
+
+    name
+        The name of the watcher as it appears in 'circusctl status'
+
+    endpoint
+        circusctl connection endpoint
+
+    ssh
+        circusctl SSH connection details in the form user@host:port
+
+    ssh_keyfile
+        circusctl SSH keyfile path
+
+    timeout
+        circusctl timeout
+
+    bin_env
+        path to circusctl binary or path to virtualenv with circusctl
+        installed
+
+    """
+
+    ret = {'name': name, 'changes': {}, 'result': False, 'comment': ''}
+    is_test = True if __opts__['test'] else False
+        
+    output = __salt__['circusd.status'](name, json=True, endpoint=endpoint, ssh=ssh, ssh_keyfile=ssh_keyfile, timeout=timeout, bin_env=bin_env)
+    result = _parse_output(output)
+
+    if result is None:
+        return _error(ret, 'circusctl: {0}'.format(output))
+
+    # Known status values at the time of writing:
+    # - error
+    # - stopping
+    # - stopped
+    # - starting
+    # - active
+    if result['status'] == 'error':
+        return _error(ret, 'circusctl: watcher {0} not found'.format(name))
+
+    is_stopped = result['status'] in ('stopping', 'stopped')
+    start_prefix = '' if is_stopped else 're'
+    verb = 'is set to be' if is_test else 'was'
+
+    if is_stopped:
+        ret['comment'] = 'Watcher {0} {1} started'.format(name, verb)
+        ret['changes'][name] = True
+    elif restart:
+        ret['comment'] = 'Watcher {0} {1} restarted'.format(name, verb)
+        ret['changes'][name] = True
+    else:
+        ret['comment'] = 'Watcher {0} is already running'.format(name)
+        ret['result'] = True
+        return ret
+
+    if is_test:
+        ret['result'] = None
+        return ret
+
+    output = __salt__['circusd.{0}start'.format(start_prefix)](name, json=True, waiting=True, endpoint=endpoint, ssh=ssh, ssh_keyfile=ssh_keyfile, timeout=timeout, bin_env=bin_env)
+    result = _parse_output(output)
+
+    if result is None:
+        return _error(ret, 'circusctl: {0}'.format(output))
+
+    if result['status'] == 'error':
+        return _error(ret, 'circusctl: {0}'.format(result['reason']))
+
+    if result['status'] != 'ok':
+        return _error(ret, 'circusctl: {0}'.format(output))
+
+    if not result['info']['started'] and not result['info']['kept']:
+        return _error(ret, 'Watcher {0} failed to start'.format(name))
+
+    ret['result'] = True
+    return ret
+
+# NOTE: As of Salt version 2016.3.2, mod_watch is not called if both
+# watcher_running and the watched state report changes, even though the
+# documenation states that mod_watch is called whenever the watched state
+# report changes. This means we cannot do a 'circusctl reloadconfig' in
+# mod_watch as it won't be called if the watcher wasn't running and
+# watcher_running has to start it (thereby causing it to return changes).
+# Instead, we get reloadconfig to run before this state using a combination
+# of 'onchanges' requisites and 'test.succeed_with(out)_changes' states.
+def mod_watch(name,
+              endpoint=None,
+              ssh=None,
+              ssh_keyfile=None,
+              timeout=None,
+              bin_env=None,
+              **kwargs):
+    # Always restart the watcher on changes.
+    return watcher_running(name=name,
+                           endpoint=endpoint,
+                           ssh=ssh,
+                           ssh_keyfile=ssh_keyfile,
+                           timeout=timeout,
+                           bin_env=bin_env,
+                           restart=True)