Package buildbot :: Package status :: Module tinderbox :: Class TinderboxMailNotifier
[frames | no frames]

Class TinderboxMailNotifier

       ComparableMixin --+        
                         |        
           Service --+   |        
                     |   |        
          MultiService --+        
                         |        
        StatusReceiver --+        
                         |        
StatusReceiverMultiService --+    
                             |    
                  MailNotifier --+
                                 |
                                TinderboxMailNotifier


This is a Tinderbox status notifier. It can send e-mail to a number of different tinderboxes or people. E-mails are sent at the beginning and upon completion of each build. It can be configured to send out e-mails for only certain builds.

The most basic usage is as follows:
   TinderboxMailNotifier(fromaddr="buildbot@localhost",
                         tree="MyTinderboxTree",
                         extraRecipients=["tinderboxdaemon@host.org"])
The builder name (as specified in master.cfg) is used as the "build" tinderbox option.
Method Summary
  __init__(self, fromaddr, tree, extraRecipients, categories, builders, relayhost, subject, binaryURL, logCompression)
  buildMessage(self, name, build, results)
  buildStarted(self, name, build)
    Inherited from MailNotifier
  builderAdded(self, name, builder)
  builderChangedState(self, name, state)
  builderRemoved(self, name)
  buildFinished(self, name, build, results)
  disownServiceParent(self)
  sendMessage(self, m, recipients)
  setServiceParent(self, parent)
  setup(self)
    Inherited from StatusReceiver
  buildETAUpdate(self, build, ETA)
  buildsetSubmitted(self, buildset)
  logChunk(self, build, step, log, channel, text)
  logFinished(self, build, step, log)
  logStarted(self, build, step, log)
  stepETAUpdate(self, build, step, ETA, expectations)
  stepFinished(self, build, step, results)
  stepStarted(self, build, step)
    Inherited from MultiService
  __iter__(self)
  addService(self, service)
  getServiceNamed(self, name)
  privilegedStartService(self)
  removeService(self, service)
  startService(self)
  stopService(self)
    Inherited from Service
  __getstate__(self)
  setName(self, name)
    Inherited from ComparableMixin
  __cmp__(self, them)
  __hash__(self)

Class Variable Summary
Implements __implemented__ = <implementedBy buildbot.status.tinderb...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...
list compare_attrs = ['extraRecipients', 'fromaddr', 'categor...
    Inherited from StatusReceiver
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
    Inherited from Service
NoneType name = None                                                                  
NoneType parent = None                                                                  
int running = 0                                                                     

Method Details

__init__(self, fromaddr, tree, extraRecipients, categories=None, builders=None, relayhost='localhost', subject='buildbot %(result)s in %(builder)s', binaryURL='', logCompression='')
(Constructor)

Parameters:
fromaddr - the email address to be used in the 'From' header.
           (type=string)
tree - The Tinderbox tree to post to.
           (type=string)
extraRecipients - E-mail addresses of recipients. This should at least include the tinderbox daemon.
           (type=tuple of string)
categories - a list of category names to serve status information for. Defaults to None (all categories). Use either builders or categories, but not both.
           (type=list of strings)
builders - a list of builder names for which mail should be sent. Defaults to None (send mail for all builds). Use either builders or categories, but not both.
           (type=list of strings)
relayhost - the host to which the outbound SMTP connection should be made. Defaults to 'localhost'
           (type=string)
subject - a string to be used as the subject line of the message. %(builder)s will be replaced with the name of the %builder which provoked the message. This parameter is not significant for the tinderbox daemon.
           (type=string)
binaryURL - If specified, this should be the location where final binary for a build is located. (ie. http://www.myproject.org/nightly/08-08-2006.tgz) It will be posted to the Tinderbox.
           (type=string)
logCompression - The type of compression to use on the log. Valid options are"bzip2" and "gzip". gzip is only known to work on Python 2.4 and above.
           (type=string)
Overrides:
buildbot.status.mail.MailNotifier.__init__

Class Variable Details

__implemented__

Type:
Implements
Value:
<implementedBy buildbot.status.tinderbox.TinderboxMailNotifier>        

__provides__

Type:
ClassProvides
Value:
<zope.interface.declarations.ClassProvides object at 0x4137988c>       

compare_attrs

Type:
list
Value:
['extraRecipients',
 'fromaddr',
 'categories',
 'builders',
 'addLogs',
 'relayhost',
 'subject',
 'binaryURL',
...                                                                    

Generated by Epydoc 2.1 on Sun Dec 10 22:04:45 2006 http://epydoc.sf.net