1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

# This file is part of Buildbot.  Buildbot is free software: you can 

# redistribute it and/or modify it under the terms of the GNU General Public 

# License as published by the Free Software Foundation, version 2. 

# 

# This program is distributed in the hope that it will be useful, but WITHOUT 

# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 

# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 

# details. 

# 

# You should have received a copy of the GNU General Public License along with 

# this program; if not, write to the Free Software Foundation, Inc., 51 

# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 

# 

# Copyright Buildbot Team Members 

 

import itertools 

import sqlalchemy as sa 

from twisted.internet import reactor 

from twisted.python import log 

from buildbot.db import base 

from buildbot.util import epoch2datetime, datetime2epoch 

 

class AlreadyClaimedError(Exception): 

    pass 

 

class NotClaimedError(Exception): 

    pass 

 

class BrDict(dict): 

    pass 

 

# private decorator to add a _master_objectid keyword argument, querying from 

# the master 

def with_master_objectid(fn): 

    def wrap(self, *args, **kwargs): 

        d = self.db.master.getObjectId() 

        d.addCallback(lambda master_objectid : 

                fn(self, _master_objectid=master_objectid, *args, **kwargs)) 

        return d 

    wrap.__name__ = fn.__name__ 

    wrap.__doc__ = fn.__doc__ 

    return wrap 

 

class BuildRequestsConnectorComponent(base.DBConnectorComponent): 

    # Documentation is in developer/database.rst 

 

    @with_master_objectid 

    def getBuildRequest(self, brid, _master_objectid=None): 

        def thd(conn): 

            reqs_tbl = self.db.model.buildrequests 

            claims_tbl = self.db.model.buildrequest_claims 

            res = conn.execute(sa.select([ 

                reqs_tbl.outerjoin(claims_tbl, 

                                   (reqs_tbl.c.id == claims_tbl.c.brid)) ], 

                whereclause=(reqs_tbl.c.id == brid))) 

            row = res.fetchone() 

 

            rv = None 

            if row: 

                rv = self._brdictFromRow(row, _master_objectid) 

            res.close() 

            return rv 

        return self.db.pool.do(thd) 

 

    @with_master_objectid 

    def getBuildRequests(self, buildername=None, complete=None, claimed=None, 

            bsid=None, _master_objectid=None): 

        def thd(conn): 

            reqs_tbl = self.db.model.buildrequests 

            claims_tbl = self.db.model.buildrequest_claims 

            q = sa.select([ reqs_tbl.outerjoin(claims_tbl, 

                                    reqs_tbl.c.id == claims_tbl.c.brid) ]) 

            if claimed is not None: 

                if not claimed: 

                    q = q.where( 

                        (claims_tbl.c.claimed_at == None) & 

                        (reqs_tbl.c.complete == 0)) 

                elif claimed == "mine": 

                    q = q.where( 

                        (claims_tbl.c.objectid == _master_objectid)) 

                else: 

                    q = q.where( 

                        (claims_tbl.c.claimed_at != None)) 

            if buildername is not None: 

                q = q.where(reqs_tbl.c.buildername == buildername) 

            if complete is not None: 

                if complete: 

                    q = q.where(reqs_tbl.c.complete != 0) 

                else: 

                    q = q.where(reqs_tbl.c.complete == 0) 

            if bsid is not None: 

                q = q.where(reqs_tbl.c.buildsetid == bsid) 

            res = conn.execute(q) 

 

            return [ self._brdictFromRow(row, _master_objectid) 

                     for row in res.fetchall() ] 

        return self.db.pool.do(thd) 

 

    @with_master_objectid 

    def claimBuildRequests(self, brids, claimed_at=None, _reactor=reactor, 

                            _master_objectid=None): 

        if claimed_at is not None: 

            claimed_at = datetime2epoch(claimed_at) 

        else: 

            claimed_at = _reactor.seconds() 

 

        def thd(conn): 

            transaction = conn.begin() 

            tbl = self.db.model.buildrequest_claims 

 

            try: 

                q = tbl.insert() 

                conn.execute(q, [ dict(brid=id, objectid=_master_objectid, 

                                    claimed_at=claimed_at) 

                                  for id in brids ]) 

            except (sa.exc.IntegrityError, sa.exc.ProgrammingError): 

                transaction.rollback() 

                raise AlreadyClaimedError 

 

            transaction.commit() 

 

        return self.db.pool.do(thd) 

 

    @with_master_objectid 

    def reclaimBuildRequests(self, brids, _reactor=reactor, 

                            _master_objectid=None): 

        def thd(conn): 

            transaction = conn.begin() 

            tbl = self.db.model.buildrequest_claims 

            claimed_at = _reactor.seconds() 

 

            # we'll need to batch the brids into groups of 100, so that the 

            # parameter lists supported by the DBAPI aren't exhausted 

            iterator = iter(brids) 

 

            while 1: 

                batch = list(itertools.islice(iterator, 100)) 

                if not batch: 

                    break # success! 

 

                q = tbl.update(tbl.c.brid.in_(batch) 

                                & (tbl.c.objectid==_master_objectid)) 

                res = conn.execute(q, claimed_at=claimed_at) 

 

                # if fewer rows were updated than expected, then something 

                # went wrong 

                if res.rowcount != len(batch): 

                    transaction.rollback() 

                    raise AlreadyClaimedError 

 

            transaction.commit() 

        return self.db.pool.do(thd) 

 

    @with_master_objectid 

    def unclaimBuildRequests(self, brids, _master_objectid=None): 

        def thd(conn): 

            transaction = conn.begin() 

            claims_tbl = self.db.model.buildrequest_claims 

 

            # we'll need to batch the brids into groups of 100, so that the 

            # parameter lists supported by the DBAPI aren't exhausted 

            iterator = iter(brids) 

 

            while 1: 

                batch = list(itertools.islice(iterator, 100)) 

                if not batch: 

                    break # success! 

 

                try: 

                    q = claims_tbl.delete( 

                            (claims_tbl.c.brid.in_(batch)) 

                            & (claims_tbl.c.objectid == _master_objectid)) 

                    conn.execute(q) 

                except: 

                    transaction.rollback() 

                    raise 

 

            transaction.commit() 

        return self.db.pool.do(thd) 

 

    @with_master_objectid 

    def completeBuildRequests(self, brids, results, complete_at=None, 

                            _reactor=reactor, _master_objectid=None): 

        if complete_at is not None: 

            complete_at = datetime2epoch(complete_at) 

        else: 

            complete_at = _reactor.seconds() 

 

        def thd(conn): 

            transaction = conn.begin() 

 

            # the update here is simple, but a number of conditions are 

            # attached to ensure that we do not update a row inappropriately, 

            # Note that checking that the request is mine would require a 

            # subquery, so for efficiency that is not checed. 

 

            reqs_tbl = self.db.model.buildrequests 

 

            # we'll need to batch the brids into groups of 100, so that the 

            # parameter lists supported by the DBAPI aren't exhausted 

            iterator = iter(brids) 

 

            while 1: 

                batch = list(itertools.islice(iterator, 100)) 

                if not batch: 

                    break # success! 

 

                q = reqs_tbl.update() 

                q = q.where(reqs_tbl.c.id.in_(batch)) 

                q = q.where(reqs_tbl.c.complete != 1) 

                res = conn.execute(q, 

                    complete=1, 

                    results=results, 

                    complete_at=complete_at) 

 

                # if an incorrect number of rows were updated, then we failed. 

                if res.rowcount != len(batch): 

                    log.msg("tried to complete %d buildreqests, " 

                        "but only completed %d" % (len(batch), res.rowcount)) 

                    transaction.rollback() 

                    raise NotClaimedError 

            transaction.commit() 

        return self.db.pool.do(thd) 

 

    def unclaimExpiredRequests(self, old, _reactor=reactor): 

        def thd(conn): 

            reqs_tbl = self.db.model.buildrequests 

            claims_tbl = self.db.model.buildrequest_claims 

            old_epoch = _reactor.seconds() - old 

 

            # select any expired requests, and delete each one individually 

            expired_brids = sa.select([ reqs_tbl.c.id ], 

                        whereclause=(reqs_tbl.c.complete != 1)) 

            res = conn.execute(claims_tbl.delete( 

                        (claims_tbl.c.claimed_at < old_epoch) & 

                        claims_tbl.c.brid.in_(expired_brids))) 

            return res.rowcount 

        d = self.db.pool.do(thd) 

        def log_nonzero_count(count): 

            if count != 0: 

                log.msg("unclaimed %d expired buildrequests (over %d seconds " 

                        "old)" % (count, old)) 

        d.addCallback(log_nonzero_count) 

        return d 

 

    def _brdictFromRow(self, row, master_objectid): 

        claimed = mine = False 

        claimed_at = None 

        if row.claimed_at is not None: 

            claimed_at = row.claimed_at 

            claimed = True 

            mine = row.objectid == master_objectid 

 

        def mkdt(epoch): 

            if epoch: 

                return epoch2datetime(epoch) 

        submitted_at = mkdt(row.submitted_at) 

        complete_at = mkdt(row.complete_at) 

        claimed_at = mkdt(row.claimed_at) 

 

        return BrDict(brid=row.id, buildsetid=row.buildsetid, 

                buildername=row.buildername, priority=row.priority, 

                claimed=claimed, claimed_at=claimed_at, mine=mine, 

                complete=bool(row.complete), results=row.results, 

                submitted_at=submitted_at, complete_at=complete_at)