zcommit.py

   1 #!/usr/bin/python
   2
   3 import cherrypy
   4 from flup.server.fcgi import WSGIServer
   5 import logging
   6 import json
   7 import os
   8 import subprocess
   9 import sys
  10 import traceback
  11
  12 HERE = os.path.abspath(os.path.dirname(__file__))
  13 ZWRITE = os.path.join(HERE, 'bin', 'zsend')
  14 LOG_FILENAME = 'logs/zcommit.log'
  15
  16 # Set up a specific logger with our desired output level
  17 logger = logging.getLogger(__name__)
  18 logger.setLevel(logging.DEBUG)
  19
  20 # Add the log message handler to the logger
  21 handler = logging.FileHandler(LOG_FILENAME)
  22 logger.addHandler(handler)
  23
  24 def zephyr(sender, klass, instance, zsig, msg):
  25     # TODO: spoof the sender
  26     logger.info("""About to send zephyr:
  27 sender: %(sender)s
  28 class: %(klass)s
  29 instance: %(instance)s
  30 zsig: %(zsig)s
  31 msg: %(msg)s""" % {'sender' : sender,
  32                    'klass' : klass,
  33                    'instance' : instance,
  34                    'zsig' : zsig,
  35                    'msg' : msg})
  36     cmd = [ZWRITE, '-S', sender, '-c', klass, '-i', instance,
  37            '-s', zsig, '-d', '-m', msg]
  38     subprocess.check_call(cmd)
  39
  40 class Application(object):
  41     @cherrypy.expose
  42     def index(self):
  43         logger.debug('Hello world app reached')
  44         return """
  45 <p> <i>Welcome to zcommit.</i> </p>
  46
  47 <p> zcommit allows you to send zephyr notifications by sending an HTTP
  48 POST request to a URL.  Currently zcommit supports POST-backs from
  49 github.  If you would like it to support another form of POST-back,
  50 please let us know (zcommit@mit.edu). </p>
  51
  52 <h1> URL structure </h1>
  53
  54 The URL you post to is structured as follows:
  55 <tt>http://zcommit.mit.edu/$type/$key1/$value1/$key2/$value2/...</tt>.
  56 So for example, the URL
  57 <tt>http://zcommit.mit.edu/github/class/zcommit/instance/commit</tt>
  58 is parsed as having type <tt>github</tt>, class <tt>zcommit</tt>, and
  59 instance <tt>commit</tt>.  Using this information, zcommit figures out
  60 how to form a useful message which is then sends as a zephyr.
  61
  62 <h1> Types </h1>
  63
  64 <h2> Github </h2>
  65
  66 Set your POST-back URL to
  67 <tt>http://zcommit.mit.edu/github/class/$classname</tt>, followed by
  68 any of the following optional key/value parameters:
  69
  70 <ul>
  71 <li> <tt>/instance/$instance</tt> </li>
  72 <li> <tt>/zsig/$zsig</tt> </li>
  73 <li> <tt>/sender/$sender</tt> </li>
  74 </ul>
  75 """
  76
  77     class Github(object):
  78         @cherrypy.expose
  79         def default(self, *args, **query):
  80             try:
  81                 return self._default(*args, **query)
  82             except Exception, e:
  83                 logger.error('Caught exception %s:\n%s' % (e, traceback.format_exc()))
  84                 raise
  85
  86         def _default(self, *args, **query):
  87             logger.info('A %s request with args: %r and query: %r' %
  88                         (cherrypy.request.method, args, query))
  89             opts = {}
  90             if len(args) % 2:
  91                 raise cherrypy.HTTPError(400, 'Invalid submission URL')
  92             logger.debug('Passed validation')
  93             for i in xrange(0, len(args), 2):
  94                 opts[args[i]] = args[i + 1]
  95             logger.debug('Set opts')
  96             if 'class' not in opts:
  97                 raise cherrypy.HTTPError(400, 'Must specify a zephyr class name')
  98             logger.debug('Specified a class')
  99             if cherrypy.request.method == 'POST':
 100                 logger.debug('About to load data')
 101                 payload = json.loads(query['payload'])
 102                 logger.debug('Loaded payload data')
 103                 zsig = payload['ref']
 104                 if 'zsig' in opts:
 105                     zsig = '%s: %s' % (opts['zsig'], zsig)
 106                 sender = opts.get('sender', 'daemon.zcommit')
 107                 logger.debug('Set zsig')
 108                 for c in reversed(payload['commits']):
 109                     inst = opts.get('instance', c['id'][:8])
 110                     actions = []
 111                     if c.get('added'):
 112                         actions.append('Added: %s\n' % '\n  '.join(c['added']))
 113                     if c.get('removed'):
 114                         actions.append('Removed: %s\n' % '\n  '.join(c['removed']))
 115                     if c.get('modified'):
 116                         actions.append('Modified: %s\n' % '\n  '.join(c['modified']))
 117                     if not actions:
 118                         actions.append('Did not add/remove/modify any nonempty files.')
 119                     info = {'name' : c['author']['name'],
 120                             'email' : c['author']['email'],
 121                             'message' : c['message'],
 122                             'timestamp' : c['timestamp'],
 123                             'actions' : '--\n'.join(actions)}
 124
 125                     msg = """%(name)s <%(email)s> (%(timestamp)s)
 126 > %(message)s
 127 --
 128 %(actions)s""" % info
 129                     zephyr(sender, opts['class'], inst, zsig, msg)
 130                 msg = 'Thanks for posting!'
 131             else:
 132                 msg = ('If you had sent a POST request to this URL, would have sent'
 133                        ' a zepyhr to -c %s' % opts['class'])
 134             return msg
 135
 136     github = Github()
 137
 138 def main():
 139     app = cherrypy.tree.mount(Application(), '/zcommit')
 140     cherrypy.server.unsubscribe()
 141     cherrypy.engine.start()
 142     try:
 143         WSGIServer(app, environ={'SCRIPT_NAME' : '/zcommit'}).run()
 144     finally:
 145         cherrypy.engine.stop()
 146
 147 if __name__ == '__main__':
 148     sys.exit(main())