1# This file is part of Buildbot.  Buildbot is free software: you can
2# redistribute it and/or modify it under the terms of the GNU General Public
3# License as published by the Free Software Foundation, version 2.
4#
5# This program is distributed in the hope that it will be useful, but WITHOUT
6# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
7# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
8# details.
9#
10# You should have received a copy of the GNU General Public License along with
11# this program; if not, write to the Free Software Foundation, Inc., 51
12# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
13#
14# Copyright Buildbot Team Members
15
16from twisted.internet import defer
17from zope.interface import implementer
18
19from buildbot import interfaces
20from buildbot.process.build import Build
21from buildbot.process.buildrequest import BuildRequest
22from buildbot.process.properties import Properties
23from buildbot.reporters import utils
24from buildbot.reporters.message import MessageFormatterRenderable
25
26from .utils import BuildStatusGeneratorMixin
27
28
29@implementer(interfaces.IReportGenerator)
30class BuildRequestGenerator(BuildStatusGeneratorMixin):
31
32    wanted_event_keys = [
33        ('buildrequests', None, 'new')
34    ]
35
36    compare_attrs = ['formatter']
37
38    def __init__(self, tags=None, builders=None, schedulers=None, branches=None,
39                 add_patch=False, formatter=None):
40
41        super().__init__('all', tags, builders, schedulers, branches, None, False, add_patch)
42        self.formatter = formatter
43        if self.formatter is None:
44            self.formatter = MessageFormatterRenderable('Build pending.')
45
46    @defer.inlineCallbacks
47    def partial_build_dict(self, master, buildrequest):
48        brdict = yield master.db.buildrequests.getBuildRequest(buildrequest['buildrequestid'])
49        bdict = dict()
50
51        props = Properties()
52        buildrequest = yield BuildRequest.fromBrdict(master, brdict)
53        builder = yield master.botmaster.getBuilderById(brdict['builderid'])
54
55        Build.setupPropertiesKnownBeforeBuildStarts(props, [buildrequest], builder)
56        Build.setupBuildProperties(props, [buildrequest])
57
58        bdict['properties'] = props.asDict()
59        yield utils.get_details_for_buildrequest(master, brdict, bdict)
60        return bdict
61
62    @defer.inlineCallbacks
63    def generate(self, master, reporter, key, buildrequest):
64        build = yield self.partial_build_dict(master, buildrequest)
65
66        if not self.is_message_needed_by_props(build):
67            return None
68
69        report = yield self.buildrequest_message(master, build)
70        return report
71
72    @defer.inlineCallbacks
73    def buildrequest_message(self, master, build):
74        patches = self._get_patches_for_build(build)
75        users = []
76        buildmsg = yield self.formatter.format_message_for_build(master, build, mode=self.mode,
77                                                                 users=users)
78
79        return {
80            'body': buildmsg['body'],
81            'subject': buildmsg['subject'],
82            'type': buildmsg['type'],
83            'results': build['results'],
84            'builds': [build],
85            'users': list(users),
86            'patches': patches,
87            'logs': []
88        }
89