poreted log_plays, syslog_json and osx_say callbacks to v2

renamed plugins to contrib (they are not really plugins)
rewrote README.md to reflect new usage
added new dir to setup.py so it gets copied with installation, in views
of making using inventory scripts easier in teh future

contrib/README.md

@@ -0,0 +1,17 @@
+inventory
+=========
+
+Inventory scripts allow you to store your hosts, groups, and variables in any way
+you like.  Examples include discovering inventory from EC2 or pulling it from
+Cobbler.  These could also be used to interface with LDAP or database.
+
+chmod +x an inventory plugin and either name it /etc/ansible/hosts or use ansible
+with -i to designate the path to the script. You might also need to copy a configuration
+file with the same name and/or set environment variables, the scripts or configuration
+files have more details.
+
+contributions welcome
+=====================
+
+Send in pull requests to add plugins of your own.  The sky is the limit!
+

lib/ansible/plugins/callback/log_plays.py

@@ -0,0 +1,85 @@
+# (C) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
+
+# This file is part of Ansible
+#
+# Ansible 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.
+#
+# Ansible 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 Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import time
+import json
+
+from ansible.plugins.callback import CallbackBase
+
+# NOTE: in Ansible 1.2 or later general logging is available without
+# this plugin, just set ANSIBLE_LOG_PATH as an environment variable
+# or log_path in the DEFAULTS section of your ansible configuration
+# file.  This callback is an example of per hosts logging for those
+# that want it.
+
+
+class CallbackModule(CallbackBase):
+    """
+    logs playbook results, per host, in /var/log/ansible/hosts
+    """
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = 'notification'
+
+    TIME_FORMAT="%b %d %Y %H:%M:%S"
+    MSG_FORMAT="%(now)s - %(category)s - %(data)s\n\n"
+
+    def __init__(self, display):
+
+        super(CallbackModule, self).__init__(display)
+
+        if not os.path.exists("/var/log/ansible/hosts"):
+            os.makedirs("/var/log/ansible/hosts")
+
+    def log(self, host, category, data):
+        if type(data) == dict:
+            if 'verbose_override' in data:
+                # avoid logging extraneous data from facts
+                data = 'omitted'
+            else:
+                data = data.copy()
+                invocation = data.pop('invocation', None)
+                data = json.dumps(data)
+                if invocation is not None:
+                    data = json.dumps(invocation) + " => %s " % data
+
+        path = os.path.join("/var/log/ansible/hosts", host)
+        now = time.strftime(self.TIME_FORMAT, time.localtime())
+        fd = open(path, "a")
+        fd.write(self.MSG_FORMAT % dict(now=now, category=category, data=data))
+        fd.close()
+
+    def runner_on_failed(self, host, res, ignore_errors=False):
+        self.log(host, 'FAILED', res)
+
+    def runner_on_ok(self, host, res):
+        self.log(host, 'OK', res)
+
+    def runner_on_skipped(self, host, item=None):
+        self.log(host, 'SKIPPED', '...')
+
+    def runner_on_unreachable(self, host, res):
+        self.log(host, 'UNREACHABLE', res)
+
+    def runner_on_async_failed(self, host, res, jid):
+        self.log(host, 'ASYNC_FAILED', res)
+
+    def playbook_on_import_for_host(self, host, imported_file):
+        self.log(host, 'IMPORTED', imported_file)
+
+    def playbook_on_not_import_for_host(self, host, missing_file):
+        self.log(host, 'NOTIMPORTED', missing_file)

lib/ansible/plugins/callback/osx_say.py

@@ -19,87 +19,69 @@
 import subprocess
 import os
 
+from ansible.plugins.callback import CallbackBase
+
 FAILED_VOICE="Zarvox"
 REGULAR_VOICE="Trinoids"
 HAPPY_VOICE="Cellos"
 LASER_VOICE="Princess"
 SAY_CMD="/usr/bin/say"
 
-def say(msg, voice):
+class CallbackModule(CallbackBase):
-    subprocess.call([SAY_CMD, msg, "--voice=%s" % (voice)])
-
-class CallbackModule(object):
     """
     makes Ansible much more exciting on OS X.
     """
-    def __init__(self):
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = 'notification'
+
+    def __init__(self, display):
+
+        super(CallbackModule, self).__init__(display)
+
         # plugin disable itself if say is not present
         # ansible will not call any callback if disabled is set to True
         if not os.path.exists(SAY_CMD):
             self.disabled = True
-            print "%s does not exist, plugin %s disabled" % \
+            self._display.warning("%s does not exist, plugin %s disabled" % (SAY_CMD, os.path.basename(__file__)) )
-                    (SAY_CMD, os.path.basename(__file__))
 
-    def on_any(self, *args, **kwargs):
+    def say(self, msg, voice):
-        pass
+        subprocess.call([SAY_CMD, msg, "--voice=%s" % (voice)])
 
     def runner_on_failed(self, host, res, ignore_errors=False):
-        say("Failure on host %s" % host, FAILED_VOICE)
+        self.say("Failure on host %s" % host, FAILED_VOICE)
 
     def runner_on_ok(self, host, res):
-        say("pew", LASER_VOICE)
+        self.say("pew", LASER_VOICE)
 
     def runner_on_skipped(self, host, item=None):
-        say("pew", LASER_VOICE)
+        self.say("pew", LASER_VOICE)
 
     def runner_on_unreachable(self, host, res):
-        say("Failure on host %s" % host, FAILED_VOICE)
+        self.say("Failure on host %s" % host, FAILED_VOICE)
-
-    def runner_on_no_hosts(self):
-        pass
-
-    def runner_on_async_poll(self, host, res, jid, clock):
-        pass
 
     def runner_on_async_ok(self, host, res, jid):
-        say("pew", LASER_VOICE)
+        self.say("pew", LASER_VOICE)
 
     def runner_on_async_failed(self, host, res, jid):
-        say("Failure on host %s" % host, FAILED_VOICE)
+        self.say("Failure on host %s" % host, FAILED_VOICE)
 
     def playbook_on_start(self):
-        say("Running Playbook", REGULAR_VOICE)
+        self.say("Running Playbook", REGULAR_VOICE)
 
     def playbook_on_notify(self, host, handler):
-        say("pew", LASER_VOICE)
+        self.say("pew", LASER_VOICE)
-
-    def playbook_on_no_hosts_matched(self):
-        pass
-
-    def playbook_on_no_hosts_remaining(self):
-        pass
 
     def playbook_on_task_start(self, name, is_conditional):
         if not is_conditional:
-            say("Starting task: %s" % name, REGULAR_VOICE)
+            self.say("Starting task: %s" % name, REGULAR_VOICE)
         else:
-            say("Notifying task: %s" % name, REGULAR_VOICE)
+            self.say("Notifying task: %s" % name, REGULAR_VOICE)
-
-    def playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None):
-        pass
 
     def playbook_on_setup(self):
-        say("Gathering facts", REGULAR_VOICE)
+        self.say("Gathering facts", REGULAR_VOICE)
-
-    def playbook_on_import_for_host(self, host, imported_file):
-        pass
-
-    def playbook_on_not_import_for_host(self, host, missing_file):
-        pass
 
     def playbook_on_play_start(self, name):
-        say("Starting play: %s" % name, HAPPY_VOICE)
+        self.say("Starting play: %s" % name, HAPPY_VOICE)
 
     def playbook_on_stats(self, stats):
-        say("Play complete", HAPPY_VOICE)
+        self.say("Play complete", HAPPY_VOICE)
-

lib/ansible/plugins/callback/syslog_json.py

@@ -6,7 +6,9 @@ import logging.handlers
 
 import socket
 
-class CallbackModule(object):
+from ansible.plugins.callback import CallbackBase
+
+class CallbackModule(CallbackBase):
     """
     logs ansible-playbook and ansible runs to a syslog server in json format
     make sure you have in ansible.cfg:
@@ -17,8 +19,13 @@ class CallbackModule(object):
         SYSLOG_SERVER   (optional): defaults to localhost
         SYSLOG_PORT     (optional): defaults to 514
     """
+    CALLBACK_VERSION = 2.0
+    CALLBACK_TYPE = 'aggregate'
+
+    def __init__(self, display):
+
+        super(CallbackModule, self).__init__(display)
 
-    def __init__(self):
         self.logger =  logging.getLogger('ansible logger')
         self.logger.setLevel(logging.DEBUG)
 
@@ -30,8 +37,6 @@ class CallbackModule(object):
         self.logger.addHandler(self.handler)
         self.hostname = socket.gethostname()
 
-    def on_any(self, *args, **kwargs):
-        pass
 
     def runner_on_failed(self, host, res, ignore_errors=False):
         self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
@@ -45,47 +50,11 @@ class CallbackModule(object):
     def runner_on_unreachable(self, host, res):
         self.logger.error('%s ansible-command: task execution UNREACHABLE; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
 
-    def runner_on_no_hosts(self):
-        pass
-
-    def runner_on_async_poll(self, host, res):
-        pass
-
-    def runner_on_async_ok(self, host, res):
-        pass
-
     def runner_on_async_failed(self, host, res):
         self.logger.error('%s ansible-command: task execution FAILED; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
 
-    def playbook_on_start(self):
-        pass
-
-    def playbook_on_notify(self, host, handler):
-        pass
-
-    def playbook_on_no_hosts_matched(self):
-        pass
-
-    def playbook_on_no_hosts_remaining(self):
-        pass
-
-    def playbook_on_task_start(self, name, is_conditional):
-        pass
-
-    def playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None):
-        pass
-
-    def playbook_on_setup(self):
-        pass
-
     def playbook_on_import_for_host(self, host, imported_file):
         self.logger.info('%s ansible-command: playbook IMPORTED; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
 
     def playbook_on_not_import_for_host(self, host, missing_file):
         self.logger.info('%s ansible-command: playbook NOT IMPORTED; host: %s; message: %s' % (self.hostname,host,json.dumps(res, sort_keys=True)))
-
-    def playbook_on_play_start(self, name):
-        pass
-
-    def playbook_on_stats(self, stats):
-        pass

plugins/README.md

@@ -1,35 +0,0 @@
-ansible-plugins
-===============
-
-You can extend ansible with optional callback and connection plugins.
-
-callbacks
-=========
-
-Callbacks can be used to add logging or monitoring capability, or just make
-interesting sound effects.
-
-Drop callback plugins in your ansible/lib/callback_plugins/ directory.
-
-connections
-===========
-
-Connection plugins allow ansible to talk over different protocols.
-
-Drop connection plugins in your ansible/lib/runner/connection_plugins/ directory.
-
-inventory
-=========
-
-Inventory plugins allow you to store your hosts, groups, and variables in any way
-you like.  Examples include discovering inventory from EC2 or pulling it from
-Cobbler.  These could also be used to interface with LDAP or database.
-
-chmod +x an inventory plugin and either name it /etc/ansible/hosts or use ansible
-with -i to designate the path to the plugin.
-
-contributions welcome
-=====================
-
-Send in pull requests to add plugins of your own.  The sky is the limit!
-

plugins/callbacks/log_plays.py

@@ -1,116 +0,0 @@
-# (C) 2012, Michael DeHaan, <michael.dehaan@gmail.com>
-
-# This file is part of Ansible
-#
-# Ansible 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.
-#
-# Ansible 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 Ansible.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-import time
-import json
-
-# NOTE: in Ansible 1.2 or later general logging is available without
-# this plugin, just set ANSIBLE_LOG_PATH as an environment variable
-# or log_path in the DEFAULTS section of your ansible configuration
-# file.  This callback is an example of per hosts logging for those
-# that want it.
-
-TIME_FORMAT="%b %d %Y %H:%M:%S"
-MSG_FORMAT="%(now)s - %(category)s - %(data)s\n\n"
-
-if not os.path.exists("/var/log/ansible/hosts"):
-    os.makedirs("/var/log/ansible/hosts")
-
-def log(host, category, data):
-    if type(data) == dict:
-        if 'verbose_override' in data:
-            # avoid logging extraneous data from facts
-            data = 'omitted'
-        else:
-            data = data.copy()
-            invocation = data.pop('invocation', None)
-            data = json.dumps(data)
-            if invocation is not None:
-                data = json.dumps(invocation) + " => %s " % data
-
-    path = os.path.join("/var/log/ansible/hosts", host)
-    now = time.strftime(TIME_FORMAT, time.localtime())
-    fd = open(path, "a")
-    fd.write(MSG_FORMAT % dict(now=now, category=category, data=data))
-    fd.close()
-
-class CallbackModule(object):
-    """
-    logs playbook results, per host, in /var/log/ansible/hosts
-    """
-
-    def on_any(self, *args, **kwargs):
-        pass
-
-    def runner_on_failed(self, host, res, ignore_errors=False):
-        log(host, 'FAILED', res)
-
-    def runner_on_ok(self, host, res):
-        log(host, 'OK', res)
-
-    def runner_on_skipped(self, host, item=None):
-        log(host, 'SKIPPED', '...')
-
-    def runner_on_unreachable(self, host, res):
-        log(host, 'UNREACHABLE', res)
-
-    def runner_on_no_hosts(self):
-        pass
-
-    def runner_on_async_poll(self, host, res, jid, clock):
-        pass
-
-    def runner_on_async_ok(self, host, res, jid):
-        pass
-
-    def runner_on_async_failed(self, host, res, jid):
-        log(host, 'ASYNC_FAILED', res)
-
-    def playbook_on_start(self):
-        pass
-
-    def playbook_on_notify(self, host, handler):
-        pass
-
-    def playbook_on_no_hosts_matched(self):
-        pass
-
-    def playbook_on_no_hosts_remaining(self):
-        pass
-
-    def playbook_on_task_start(self, name, is_conditional):
-        pass
-
-    def playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None):
-        pass
-
-    def playbook_on_setup(self):
-        pass
-
-    def playbook_on_import_for_host(self, host, imported_file):
-        log(host, 'IMPORTED', imported_file)
-
-    def playbook_on_not_import_for_host(self, host, missing_file):
-        log(host, 'NOTIMPORTED', missing_file)
-
-    def playbook_on_play_start(self, name):
-        pass
-
-    def playbook_on_stats(self, stats):
-        pass
-

setup.py

@@ -25,7 +25,7 @@ setup(name='ansible',
       package_dir={ '': 'lib' },
       packages=find_packages('lib'),
       package_data={
-         '': ['module_utils/*.ps1', 'modules/core/windows/*.ps1', 'modules/extras/windows/*.ps1'],
+         '': ['module_utils/*.ps1', 'modules/core/windows/*.ps1', 'modules/extras/windows/*.ps1', 'contrib/README.md', 'contrib/inventory/*'],
       },
       scripts=[
          'bin/ansible',