Document the Google Code Web Hook handler and make the branch returne…

…d an option

- You can now choose the branch returned by the web hook handler with
  the 'branch' option;
- Also, check if a 'branch' field exists in the JSON dictionary sent by
  Google Code (in the hope that they add it one day…);
- Adjust test accordingly.

master/buildbot/status/web/hooks/googlecode.py

@@ -28,9 +28,10 @@ class GoogleCodeAuthFailed(Exception):
     pass
 
 class Payload(object):
-    def __init__(self, headers, body):
+    def __init__(self, headers, body, branch):
         self._auth_code = headers['Google-Code-Project-Hosting-Hook-Hmac']
         self._body = body # we need to save it if we want to authenticate it
+        self._branch = branch
 
         payload = json.loads(body)
         self.project = payload['project_name']
@@ -57,7 +58,8 @@ def changes(self):
                 links=[r['url']],
                 revision=r['revision'],
                 when=r['timestamp'],
-                branch='default', # missing in the body
+                # Let's hope Google add the branch one day:
+                branch=r.get('branch', self._branch),
                 revlink=r['url'],
                 repository=self.repository,
                 project=self.project
@@ -70,7 +72,12 @@ def getChanges(request, options=None):
         headers = request.received_headers
         body = request.content.getvalue()
         #logging.error('headers = {0}, body = {1}'.format(headers, body))
-        payload = Payload(headers, body)
+
+        # Instantiate a Payload object: this will parse the body, get the
+        # authentication code from the headers and remember the branch picked up
+        # by the user (Google Code doesn't send on which branch the changes were
+        # made)
+        payload = Payload(headers, body, options.get('branch', 'default'))
 
         if 'secret_key' in options:
             if not payload.authenticate(options['secret_key']):

master/buildbot/test/unit/test_status_web_change_hooks_googlecode.py

@@ -59,7 +59,12 @@ def setUp(self):
             'Content-Type': 'application/json; charset=UTF-8'
         }
 
-        self.changeHook = change_hook.ChangeHookResource(dialects={'googlecode' : {'secret_key': 'FSP3p-Ghdn4T0oqX'}})
+        self.changeHook = change_hook.ChangeHookResource(dialects={
+                'googlecode': {
+                    'secret_key': 'FSP3p-Ghdn4T0oqX',
+                    'branch': 'test'
+                }
+        })
 
     # Test 'base' hook with attributes. We should get a json string representing
     # a Change object as a dictionary. All values show be set.
@@ -78,7 +83,7 @@ def check_changes(r):
             self.assertEquals(change["who"], "Louis Opter <louis@lse.epitech.net>")
             self.assertEquals(change["revision"], '68e5df283a8e751cdbf95516b20357b2c46f93d4')
             self.assertEquals(change["comments"], "Print a message")
-            self.assertEquals(change["branch"], "default")
+            self.assertEquals(change["branch"], "test")
             self.assertEquals(change["revlink"], "http://webhook-test.googlecode.com/hg-history/68e5df283a8e751cdbf95516b20357b2c46f93d4/")
 
         d.addCallback(check_changes)

master/docs/manual/cfg-changesources.rst

@@ -1125,8 +1125,8 @@ Change Hooks (HTTP Notifications)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Buildbot already provides a web frontend, and that frontend can easily be used
-to receive HTTP push notifications of commits from services like GitHub.  See
-:ref:`Change-Hooks` for more information.
+to receive HTTP push notifications of commits from services like GitHub or
+GoogleCode. See :ref:`Change-Hooks` for more information.
 
 .. bb:chsrc:: GoogleCodeAtomPoller
 

master/docs/manual/cfg-statustargets.rst

@@ -682,6 +682,33 @@ Note that there is a standalone HTTP server available for receiving GitHub
 notifications, as well: :file:`contrib/github_buildbot.py`.  This script may be
 useful in cases where you cannot expose the WebStatus for public consumption.
 
+Google Code hook
+################
+
+The Google Code hook is quite similar to the GitHub Hook. It has one option
+for the "Post-Commit Authentication Key" used to check if the request is
+legitimate::
+
+    c['status'].append(html.WebStatus(
+        …,
+        change_hook_dialects={'googlecode': {'secret_key': 'FSP3p-Ghdn4T0oqX'}}
+    ))
+
+This will add a "Post-Commit URL" for the project in the Google Code
+administrative interface, pointing to ``/change_hook/googlecode`` relative to
+the root of the web status.
+
+Alternatively, you can use the :ref:`GoogleCodeAtomPoller` :class:`ChangeSource`
+that periodically poll the Google Code commit feed for changes.
+
+.. note::
+
+   Google Code doesn't send the branch on which the changes were made. So, the
+   hook always returns ``'default'`` as the branch, you can override it with the
+   ``'branch'`` option::
+
+      change_hook_dialects={'googlecode': {'secret_key': 'FSP3p-Ghdn4T0oqX', 'branch': 'master'}}
+
 .. bb:status:: MailNotifier
 
 .. index:: single: email; MailNotifier