2.5.13.5. MessageFormatterMissingWorkers¶

This formatter is used to format messages in WorkerMissingGenerator.

It formats a message using the Jinja2 templating language and picks the template either from a string or from a file.

The constructor to that class takes the same arguments as MessageFormatter, minus wantLogs, wantProperties, wantSteps.

template_dir

The directory that is used to look for the various templates.

template_filename

This is the name of the file in the template_dir directory that will be used to generate the body of the mail. It defaults to default_mail.txt.

template

If this parameter is set, this parameter indicates the content of the template used to generate the body of the mail as string.

template_type

This indicates the type of the generated template. Use either ‘plain’ (the default) or ‘html’.

subject_filename

This is the name of the file in the template_dir directory that contains the content of the subject of the mail.

subject

Alternatively, this is the content of the subject of the mail as string.

ctx

This is an extension of the standard context that will be given to the templates. Use this to add content to the templates that is otherwise not available.

Alternatively, you can subclass MessageFormatter and override the buildAdditionalContext in order to grab more context from the data API.

buildbot.reporters.message.buildAdditionalContext(master, ctx)

Parameters

master – the master object
ctx – the context dictionary to enhance

Returns

optionally deferred

default implementation will add self.ctx into the current template context

The default ctx for the missing worker email is made of:

buildbot_title

The Buildbot title as per c['title'] from the master.cfg

buildbot_url

The Buildbot title as per c['title'] from the master.cfg

worker

The worker object as defined in the REST api plus two attributes:

notify: List of emails to be notified for this worker.
last_connection: String describing the approximate the time of last connection for this worker.