Escape text in zephyr messages

[invirt/packages/invirt-dev.git] / build-hooks / post-build

diff --git a/build-hooks/post-build b/build-hooks/post-build
index 277f8f2..8dd8eb4 100755 (executable)
--- a/build-hooks/post-build
+++ b/build-hooks/post-build
@@ -16,12 +16,13 @@ To configure zephyr, add something like the following to your invirt config:
 build:
  hooks:
   post_build:
 build:
  hooks:
   post_build:

-   zephyr: &post_build_zepyhr
+   zephyr: &post_build_zephyr

     class: myclass [required]
     instance: myinstance [optional]
     zsig: myzsig [optional]
   failed_build:
    zephyr: *post_build_zephyr
     class: myclass [required]
     instance: myinstance [optional]
     zsig: myzsig [optional]
   failed_build:
    zephyr: *post_build_zephyr

+  ...

 
 == mail ==
 
 
 == mail ==
 

@@ -36,10 +37,18 @@ build:
     subject: My Subject [optional]
   failed_build:
    mail: *post_build_mail
     subject: My Subject [optional]
   failed_build:
    mail: *post_build_mail

-
-post_build values will be used when this script is invoked as
-post-build, while failed_build values will be used when it is invoked
-as failed-build.
+  ...
+
+The script chooses which configuration option to use based off the
+name it is called with.  This name also determines which command-line
+arguments the script takes, as well as how they are formatted.  When
+called as:
+
+post-build: uses post_build option
+failed-build: uses failed_build option
+post-submit: uses post_submit option
+failed-submit: uses failed_submit option
+post-add-repo: uses post_add_repo option

 """
 
 import optparse
 """
 
 import optparse

@@ -53,40 +62,50 @@ from email.mime import text
 from invirt import common, database, builder
 from invirt.config import structs as config
 
 from invirt import common, database, builder
 from invirt.config import structs as config
 

-def build_completion_msg(succeeded, values, verbose=True, success=lambda x: x, failure=lambda x: x):
+def build_completion_msg(succeeded, values, verbose=True, success=lambda x: x, failure=lambda x: x,
+                         escape=lambda x: x):

     """Format a message reporting the results of a build"""
     values = dict(values)
     if not verbose and values['traceback'] is not None:
     """Format a message reporting the results of a build"""
     values = dict(values)
     if not verbose and values['traceback'] is not None:

-        # TODO: better heuristic
-        values['traceback'] = textwrap.fill('\n'.join(values['traceback'].split('\n')[-2:]))
+        split = values['traceback'].split('\n')
+        # Here, have a hackish heuristic
+        truncated = '(empty)'
+        for i in xrange(2, len(split)):
+            truncated = textwrap.fill('\n'.join(split[-i:]))
+            if len(truncated) >= 10:
+                break
+        values['traceback'] = truncated
+
+    for key in ['package', 'version', 'pocket', 'principal', 'inserted_at', 'short_commit']:
+        values[key] = escape(values[key])

 
     if succeeded:
         values['result'] = success(values['result'])
         msg = """Build of %(package)s %(version)s in %(pocket)s %(result)s.
 
     if succeeded:
         values['result'] = success(values['result'])
         msg = """Build of %(package)s %(version)s in %(pocket)s %(result)s.

-
-Branch %(pocket)s has been advanced to %(short_commit)s.
-
-(Build %(build_id)s was submitted by %(principal)s at %(inserted_at)s.)""" % values
+Job submitted by %(principal)s at %(inserted_at)s.
+Branch %(pocket)s has been advanced to %(short_commit)s.""" % values

     else:
         values['result'] = failure(values['result'])
     else:
         values['result'] = failure(values['result'])

-        msg = """Build of %(package)s %(version)s in %(pocket)s %(result)s while %(failed_stage)s.
-
-%(traceback)s
-
-(Build %(build_id)s was submitted by %(principal)s at %(inserted_at)s.)""" % values
+        msg = """Build of %(package)s version %(version)s in %(pocket)s %(result)s while %(failed_stage)s.
+Job submitted by %(principal)s at %(inserted_at)s.
+Error: %(traceback)s""" % values

     return msg
 
     return msg
 

-def submit_completion_msg(succeeded, values, verbose=True, success=lambda x: x, failure=lambda x: x):
+def submit_completion_msg(succeeded, values, verbose=True, success=lambda x: x, failure=lambda x: x,
+                          escape=lambda x: x):

     values = dict(values)
     if succeeded:
         values['result'] = success(values['result'])
     else:
         values['result'] = failure(values['result'])
     values = dict(values)
     if succeeded:
         values['result'] = success(values['result'])
     else:
         values['result'] = failure(values['result'])

+    for key in ['commit', 'pocket', 'principal']:
+        values[key] = escape(values[key])

     msg = """Submission of %(commit)s to be built in %(pocket)s %(result)s.
 Build submitted by %(principal)s.""" % values
     return msg
 
     msg = """Submission of %(commit)s to be built in %(pocket)s %(result)s.
 Build submitted by %(principal)s.""" % values
     return msg
 

-def repo_creation_msg(succeeded, values, verbose=True, success=lambda x: x, failure=lambda x: x):
+def repo_creation_msg(succeeded, values, verbose=True, success=lambda x: x, failure=lambda x: x,
+                      escape=lambda x: x):

     values = dict(values)
     assert succeeded
     msg = '%(principal)s just created a new repository, %(category)s/%(name)s.git' % values
     values = dict(values)
     assert succeeded
     msg = '%(principal)s just created a new repository, %(category)s/%(name)s.git' % values

@@ -118,6 +137,7 @@ message_generators = {
     }
 
 def zephyr_escape(m):
     }
 
 def zephyr_escape(m):

+    m = str(m)

     m = re.sub('@', '@@', m)
     m = re.sub('}', '@(})', m)
     return m
     m = re.sub('@', '@@', m)
     m = re.sub('}', '@(})', m)
     return m

@@ -169,8 +189,8 @@ def main():
                    'short_commit' : short_commit,
                    'traceback' : build.traceback,
                    'version' : build.version,
                    'short_commit' : short_commit,
                    'traceback' : build.traceback,
                    'version' : build.version,

-                   'default_instance' : 'build_%(build_id)s',
-                   'default_subject' : 'XVM build %(result)s: %(package)s %(version)s in %(pocket)s'}
+                   'default_instance' : 'b%(build_id)s',
+                   'default_subject' : 'Build %(build_id)d %(result)s: %(package)s %(version)s in %(pocket)s'}

         if build.succeeded:
             assert prog == POST_BUILD
             values['result'] = 'succeeded'
         if build.succeeded:
             assert prog == POST_BUILD
             values['result'] = 'succeeded'

@@ -218,7 +238,8 @@ def main():
     else:
         make_msg = message_generators[ZEPHYR][prog]
         msg = '@{%s}' % make_msg(succeeded, values, verbose=False,
     else:
         make_msg = message_generators[ZEPHYR][prog]
         msg = '@{%s}' % make_msg(succeeded, values, verbose=False,

-                                 success=zephyr_success, failure=zephyr_failure)
+                                 success=zephyr_success, failure=zephyr_failure,
+                                 escape=zephyr_escape)

         instance = zephyr_config.get('instance', values['default_instance']) % values
         zsig = zephyr_config.get('zsig', 'XVM Buildbot') % values
         common.captureOutput(['zwrite', '-c', klass, '-i', instance, '-s',
         instance = zephyr_config.get('instance', values['default_instance']) % values
         zsig = zephyr_config.get('zsig', 'XVM Buildbot') % values
         common.captureOutput(['zwrite', '-c', klass, '-i', instance, '-s',