output structured comments for build events

Author: pietroalbini

homu/comments.py

@@ -0,0 +1,83 @@
+import json
+
+
+class Comment:
+    def __init__(self, **args):
+        if len(args) != len(self.params):
+            raise KeyError("different number of params")
+        for key, value in args.items():
+            if key in self.params:
+                setattr(self, key, value)
+            else:
+                raise KeyError("unknown attribute: %s" % key)
+
+    def jsonify(self):
+        out = {"type": self.__class__.__name__}
+        for param in self.params:
+            out[param] = getattr(self, param)
+        return json.dumps(out, separators=(',', ':'))
+
+
+class BuildStarted(Comment):
+    params = ["head_sha", "merge_sha"]
+
+    def render(self):
+        return ":hourglass: Testing commit %s with merge %s..." % (
+            self.head_sha, self.merge_sha,
+        )
+
+
+class TryBuildStarted(Comment):
+    params = ["head_sha", "merge_sha"]
+
+    def render(self):
+        return ":hourglass: Trying commit %s with merge %s..." % (
+            self.head_sha, self.merge_sha,
+        )
+
+
+class BuildCompleted(Comment):
+    params = ["approved_by", "base_ref", "builders", "merge_sha"]
+
+    def render(self):
+        urls = ", ".join(
+            "[%s](%s)" % kv for kv in sorted(self.builders.items())
+        )
+        return (
+            ":sunny: Test successful - %s\n"
+            "Approved by: %s\n"
+            "Pushing %s to %s..."
+            % (
+                urls, self.approved_by, self.merge_sha, self.base_ref,
+            )
+        )
+
+
+class TryBuildCompleted(Comment):
+    params = ["builders", "merge_sha"]
+
+    def render(self):
+        urls = ", ".join(
+            "[%s](%s)" % kv for kv in sorted(self.builders.items())
+        )
+        return ":sunny: Try build successful - %s\nBuild commit: %s" % (
+            urls, self.merge_sha,
+        )
+
+
+class BuildFailed(Comment):
+    params = ["builder_url", "builder_name"]
+
+    def render(self):
+        return ":broken_heart: Test failed - [%s](%s)" % (
+            self.builder_name, self.builder_url
+        )
+
+
+class TryBuildFailed(Comment):
+    params = ["builder_url", "builder_name"]
+
+    def render(self):
+        return ":broken_heart: Test failed - [%s](%s)" % (
+            self.builder_name, self.builder_url
+        )

homu/main.py

@@ -4,6 +4,7 @@
 import json
 import re
 import functools
+from . import comments
 from . import utils
 from .utils import lazy_debug
 import logging
@@ -177,8 +178,12 @@ def get_issue(self):
             issue = self.issue = self.get_repo().issue(self.num)
         return issue
 
-    def add_comment(self, text):
-        self.get_issue().create_comment(text)
+    def add_comment(self, comment):
+        if issubclass(comment.__class__, comments.Comment):
+            comment = "%s\n<!-- homu: %s -->" % (
+                comment.render(), comment.jsonify(),
+            )
+        self.get_issue().create_comment(comment)
 
     def change_labels(self, event):
         event = self.label_events.get(event.value, {})
@@ -1289,7 +1294,16 @@ def start_build(state, repo_cfgs, buildbot_slots, logger, db, git_cfg):
         desc,
         context='homu')
 
-    state.add_comment(':hourglass: ' + desc)
+    if state.try_:
+        state.add_comment(comments.TryBuildStarted(
+            head_sha=state.head_sha,
+            merge_sha=state.merge_sha,
+        ))
+    else:
+        state.add_comment(comments.BuildStarted(
+            head_sha=state.head_sha,
+            merge_sha=state.merge_sha,
+        ))
 
     return True
 

homu/server.py

@@ -9,6 +9,7 @@
     synchronize,
     LabelEvent,
 )
+from . import comments
 from . import utils
 from .utils import lazy_debug
 import github3
@@ -558,19 +559,20 @@ def report_build_res(succ, url, builder, state, logger, repo_cfg):
     if succ:
         if all(x['res'] for x in state.build_res.values()):
             state.set_status('success')
-            desc = 'Test successful'
-            utils.github_create_status(state.get_repo(), state.head_sha,
-                                       'success', url, desc, context='homu')
-
-            urls = ', '.join('[{}]({})'.format(builder, x['url']) for builder, x in sorted(state.build_res.items()))  # noqa
-            test_comment = ':sunny: {} - {}'.format(desc, urls)
+            utils.github_create_status(
+                state.get_repo(), state.head_sha,
+                'success', url, "Test successful", context='homu'
+            )
 
             if state.approved_by and not state.try_:
-                comment = (test_comment + '\n' +
-                           'Approved by: {}\nPushing {} to {}...'
-                           ).format(state.approved_by, state.merge_sha,
-                                    state.base_ref)
-                state.add_comment(comment)
+                state.add_comment(comments.BuildCompleted(
+                    approved_by=state.approved_by,
+                    base_ref=state.base_ref,
+                    builders=dict(
+                        (k, v["url"]) for k, v in state.build_res.items()
+                    ),
+                    merge_sha=state.merge_sha,
+                ))
                 state.change_labels(LabelEvent.SUCCEED)
                 try:
                     try:
@@ -598,24 +600,34 @@ def report_build_res(succ, url, builder, state, logger, repo_cfg):
 
                     state.add_comment(':eyes: ' + desc)
             else:
-                comment = (test_comment + '\n' +
-                           'State: approved={} try={}'
-                           ).format(state.approved_by, state.try_)
-                state.add_comment(comment)
+                state.add_comment(comments.TryBuildCompleted(
+                    builders=dict(
+                        (k, v["url"]) for k, v in state.build_res.items()
+                    ),
+                    merge_sha=state.merge_sha,
+                ))
                 state.change_labels(LabelEvent.TRY_SUCCEED)
 
     else:
         if state.status == 'pending':
             state.set_status('failure')
-            desc = 'Test failed'
-            utils.github_create_status(state.get_repo(), state.head_sha,
-                                       'failure', url, desc, context='homu')
-
-            state.add_comment(':broken_heart: {} - [{}]({})'.format(desc,
-                                                                    builder,
-                                                                    url))
-            event = LabelEvent.TRY_FAILED if state.try_ else LabelEvent.FAILED
-            state.change_labels(event)
+            utils.github_create_status(
+                state.get_repo(), state.head_sha,
+                'failure', url, "Test failed", context='homu'
+            )
+
+            if state.try_:
+                state.add_comment(comments.TryBuildFailed(
+                    builder_url=url,
+                    builder_name=builder,
+                ))
+                state.change_labels(LabelEvent.TRY_FAILED)
+            else:
+                state.add_comment(comments.BuildFailed(
+                    builder_url=url,
+                    builder_name=builder,
+                ))
+                state.change_labels(LabelEvent.FAILED)
 
     g.queue_handler()