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

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

# 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 

 

from __future__ import with_statement 

 

import os, urllib 

from cPickle import load 

from twisted.python import log 

from twisted.persisted import styles 

from twisted.internet import defer 

from twisted.application import service 

from zope.interface import implements 

from buildbot import config, interfaces, util 

from buildbot.util import bbcollections 

from buildbot.util.eventual import eventually 

from buildbot.changes import changes 

from buildbot.status import buildset, builder, buildrequest 

 

class Status(config.ReconfigurableServiceMixin, service.MultiService): 

    implements(interfaces.IStatus) 

 

    def __init__(self, master): 

        service.MultiService.__init__(self) 

        self.master = master 

        self.botmaster = master.botmaster 

        self.basedir = master.basedir 

        self.watchers = [] 

        # No default limit to the log size 

        self.logMaxSize = None 

 

        self._builder_observers = bbcollections.KeyedSets() 

        self._buildreq_observers = bbcollections.KeyedSets() 

        self._buildset_finished_waiters = bbcollections.KeyedSets() 

 

    # service management 

 

    def startService(self): 

        # subscribe to the things we need to know about 

        self._buildset_completion_sub = \ 

            self.master.subscribeToBuildsetCompletions( 

                self._buildsetCompletionCallback) 

        self._buildset_sub = \ 

            self.master.subscribeToBuildsets( 

                self._buildsetCallback) 

        self._build_request_sub = \ 

            self.master.subscribeToBuildRequests( 

                self._buildRequestCallback) 

        self._change_sub = \ 

            self.master.subscribeToChanges( 

                self.changeAdded) 

 

        return service.MultiService.startService(self) 

 

    @defer.inlineCallbacks 

    def reconfigService(self, new_config): 

        # remove the old listeners, then add the new 

        for sr in list(self): 

            yield defer.maybeDeferred(lambda : 

                    sr.disownServiceParent()) 

            sr.master = None 

 

        for sr in new_config.status: 

            sr.master = self.master 

            sr.setServiceParent(self) 

 

        # reconfig any newly-added change sources, as well as existing 

        yield config.ReconfigurableServiceMixin.reconfigService(self, 

                                                            new_config) 

 

    def stopService(self): 

        self._buildset_completion_sub.unsubscribe() 

        self._buildset_sub.unsubscribe() 

        self._build_request_sub.unsubscribe() 

        self._change_sub.unsubscribe() 

 

        return service.MultiService.stopService(self) 

 

    # clean shutdown 

 

    @property 

    def shuttingDown(self): 

        return self.botmaster.shuttingDown 

 

    def cleanShutdown(self): 

        return self.botmaster.cleanShutdown() 

 

    def cancelCleanShutdown(self): 

        return self.botmaster.cancelCleanShutdown() 

 

    # methods called by our clients 

 

    def getTitle(self): 

        return self.master.config.title 

    def getTitleURL(self): 

        return self.master.config.titleURL 

    def getBuildbotURL(self): 

        return self.master.config.buildbotURL 

 

    def getStatus(self): 

        # some listeners expect their .parent to be a BuildMaster object, and 

        # use this method to get the Status object.  This is documented, so for 

        # now keep it working. 

        return self 

 

    def getMetrics(self): 

        return self.master.metrics 

 

    def getURLForBuild(self, builder_name, build_number): 

        prefix = self.getBuildbotURL() 

        return prefix + "builders/%s/builds/%d" % ( 

            urllib.quote(builder_name, safe=''), 

            build_number) 

 

    def getURLForThing(self, thing): 

        prefix = self.getBuildbotURL() 

        if not prefix: 

            return None 

        if interfaces.IStatus.providedBy(thing): 

            return prefix 

        if interfaces.ISchedulerStatus.providedBy(thing): 

            pass 

        if interfaces.IBuilderStatus.providedBy(thing): 

            bldr = thing 

            return prefix + "builders/%s" % ( 

                urllib.quote(bldr.getName(), safe=''), 

                ) 

        if interfaces.IBuildStatus.providedBy(thing): 

            build = thing 

            bldr = build.getBuilder() 

            return self.getURLForBuild(bldr.getName(), build.getNumber()) 

 

        if interfaces.IBuildStepStatus.providedBy(thing): 

            step = thing 

            build = step.getBuild() 

            bldr = build.getBuilder() 

            return prefix + "builders/%s/builds/%d/steps/%s" % ( 

                urllib.quote(bldr.getName(), safe=''), 

                build.getNumber(), 

                urllib.quote(step.getName(), safe='')) 

        # IBuildSetStatus 

        # IBuildRequestStatus 

        # ISlaveStatus 

 

        # IStatusEvent 

        if interfaces.IStatusEvent.providedBy(thing): 

            # TODO: this is goofy, create IChange or something 

            if isinstance(thing, changes.Change): 

                change = thing 

                return "%schanges/%d" % (prefix, change.number) 

 

        if interfaces.IStatusLog.providedBy(thing): 

            loog = thing 

            step = loog.getStep() 

            build = step.getBuild() 

            bldr = build.getBuilder() 

 

            logs = step.getLogs() 

            for i in range(len(logs)): 

                if loog is logs[i]: 

                    break 

            else: 

                return None 

            return prefix + "builders/%s/builds/%d/steps/%s/logs/%s" % ( 

                urllib.quote(bldr.getName(), safe=''), 

                build.getNumber(), 

                urllib.quote(step.getName(), safe=''), 

                urllib.quote(loog.getName(), safe='')) 

 

    def getChangeSources(self): 

        return list(self.master.change_svc) 

 

    def getChange(self, number): 

        """Get a Change object; returns a deferred""" 

        d = self.master.db.changes.getChange(number) 

        def chdict2change(chdict): 

            if not chdict: 

                return None 

            return changes.Change.fromChdict(self.master, chdict) 

        d.addCallback(chdict2change) 

        return d 

 

    def getSchedulers(self): 

        return self.master.allSchedulers() 

 

    def getBuilderNames(self, categories=None): 

        if categories == None: 

            return util.naturalSort(self.botmaster.builderNames) # don't let them break it 

 

        l = [] 

        # respect addition order 

        for name in self.botmaster.builderNames: 

            bldr = self.botmaster.builders[name] 

            if bldr.config.category in categories: 

                l.append(name) 

        return util.naturalSort(l) 

 

    def getBuilder(self, name): 

        """ 

        @rtype: L{BuilderStatus} 

        """ 

        return self.botmaster.builders[name].builder_status 

 

    def getSlaveNames(self): 

        return self.botmaster.slaves.keys() 

 

    def getSlave(self, slavename): 

        return self.botmaster.slaves[slavename].slave_status 

 

    def getBuildSets(self): 

        d = self.master.db.buildsets.getBuildsets(complete=False) 

        def make_status_objects(bsdicts): 

            return [ buildset.BuildSetStatus(bsdict, self) 

                    for bsdict in bsdicts ] 

        d.addCallback(make_status_objects) 

        return d 

 

    def generateFinishedBuilds(self, builders=[], branches=[], 

                               num_builds=None, finished_before=None, 

                               max_search=200): 

 

        def want_builder(bn): 

            if builders: 

                return bn in builders 

            return True 

        builder_names = [bn 

                         for bn in self.getBuilderNames() 

                         if want_builder(bn)] 

 

        # 'sources' is a list of generators, one for each Builder we're 

        # using. When the generator is exhausted, it is replaced in this list 

        # with None. 

        sources = [] 

        for bn in builder_names: 

            b = self.getBuilder(bn) 

            g = b.generateFinishedBuilds(branches, 

                                         finished_before=finished_before, 

                                         max_search=max_search) 

            sources.append(g) 

 

        # next_build the next build from each source 

        next_build = [None] * len(sources) 

 

        def refill(): 

            for i,g in enumerate(sources): 

                if next_build[i]: 

                    # already filled 

                    continue 

                if not g: 

                    # already exhausted 

                    continue 

                try: 

                    next_build[i] = g.next() 

                except StopIteration: 

                    next_build[i] = None 

                    sources[i] = None 

 

        got = 0 

        while True: 

            refill() 

            # find the latest build among all the candidates 

            candidates = [(i, b, b.getTimes()[1]) 

                          for i,b in enumerate(next_build) 

                          if b is not None] 

            candidates.sort(lambda x,y: cmp(x[2], y[2])) 

            if not candidates: 

                return 

 

            # and remove it from the list 

            i, build, finshed_time = candidates[-1] 

            next_build[i] = None 

            got += 1 

            yield build 

            if num_builds is not None: 

                if got >= num_builds: 

                    return 

 

    def subscribe(self, target): 

        self.watchers.append(target) 

        for name in self.botmaster.builderNames: 

            self.announceNewBuilder(target, name, self.getBuilder(name)) 

    def unsubscribe(self, target): 

        self.watchers.remove(target) 

 

 

    # methods called by upstream objects 

 

    def announceNewBuilder(self, target, name, builder_status): 

        t = target.builderAdded(name, builder_status) 

        if t: 

            builder_status.subscribe(t) 

 

    def builderAdded(self, name, basedir, category=None): 

        """ 

        @rtype: L{BuilderStatus} 

        """ 

        filename = os.path.join(self.basedir, basedir, "builder") 

        log.msg("trying to load status pickle from %s" % filename) 

        builder_status = None 

        try: 

            with open(filename, "rb") as f: 

                builder_status = load(f) 

            builder_status.master = self.master 

 

            # (bug #1068) if we need to upgrade, we probably need to rewrite 

            # this pickle, too.  We determine this by looking at the list of 

            # Versioned objects that have been unpickled, and (after doUpgrade) 

            # checking to see if any of them set wasUpgraded.  The Versioneds' 

            # upgradeToVersionNN methods all set this. 

            versioneds = styles.versionedsToUpgrade 

            styles.doUpgrade() 

            if True in [ hasattr(o, 'wasUpgraded') for o in versioneds.values() ]: 

                log.msg("re-writing upgraded builder pickle") 

                builder_status.saveYourself() 

 

        except IOError: 

            log.msg("no saved status pickle, creating a new one") 

        except: 

            log.msg("error while loading status pickle, creating a new one") 

            log.msg("error follows:") 

            log.err() 

        if not builder_status: 

            builder_status = builder.BuilderStatus(name, category, self.master) 

            builder_status.addPointEvent(["builder", "created"]) 

        log.msg("added builder %s in category %s" % (name, category)) 

        # an unpickled object might not have category set from before, 

        # so set it here to make sure 

        builder_status.category = category 

        builder_status.master = self.master 

        builder_status.basedir = os.path.join(self.basedir, basedir) 

        builder_status.name = name # it might have been updated 

        builder_status.status = self 

 

        if not os.path.isdir(builder_status.basedir): 

            os.makedirs(builder_status.basedir) 

        builder_status.determineNextBuildNumber() 

 

        builder_status.setBigState("offline") 

 

        for t in self.watchers: 

            self.announceNewBuilder(t, name, builder_status) 

 

        return builder_status 

 

    def builderRemoved(self, name): 

        for t in self.watchers: 

            if hasattr(t, 'builderRemoved'): 

                t.builderRemoved(name) 

 

    def slaveConnected(self, name): 

        for t in self.watchers: 

            if hasattr(t, 'slaveConnected'): 

                t.slaveConnected(name) 

 

    def slaveDisconnected(self, name): 

        for t in self.watchers: 

            if hasattr(t, 'slaveDisconnected'): 

                t.slaveDisconnected(name) 

 

    def changeAdded(self, change): 

        for t in self.watchers: 

            if hasattr(t, 'changeAdded'): 

                t.changeAdded(change) 

 

    def asDict(self): 

        result = {} 

        # Constant 

        result['title'] = self.getTitle() 

        result['titleURL'] = self.getTitleURL() 

        result['buildbotURL'] = self.getBuildbotURL() 

        # TODO: self.getSchedulers() 

        # self.getChangeSources() 

        return result 

 

    def build_started(self, brid, buildername, build_status): 

        if brid in self._buildreq_observers: 

            for o in self._buildreq_observers[brid]: 

                eventually(o, build_status) 

 

    def _buildrequest_subscribe(self, brid, observer): 

        self._buildreq_observers.add(brid, observer) 

 

    def _buildrequest_unsubscribe(self, brid, observer): 

        self._buildreq_observers.discard(brid, observer) 

 

    def _buildset_waitUntilFinished(self, bsid): 

        d = defer.Deferred() 

        self._buildset_finished_waiters.add(bsid, d) 

        self._maybeBuildsetFinished(bsid) 

        return d 

 

    def _maybeBuildsetFinished(self, bsid): 

        # check bsid to see if it's successful or finished, and notify anyone 

        # who cares 

        if bsid not in self._buildset_finished_waiters: 

            return 

        d = self.master.db.buildsets.getBuildset(bsid) 

        def do_notifies(bsdict): 

            bss = buildset.BuildSetStatus(bsdict, self) 

            if bss.isFinished(): 

                for d in self._buildset_finished_waiters.pop(bsid): 

                    eventually(d.callback, bss) 

        d.addCallback(do_notifies) 

        d.addErrback(log.err, 'while notifying for buildset finishes') 

 

    def _builder_subscribe(self, buildername, watcher): 

        # should get requestSubmitted and requestCancelled 

        self._builder_observers.add(buildername, watcher) 

 

    def _builder_unsubscribe(self, buildername, watcher): 

        self._builder_observers.discard(buildername, watcher) 

 

    def _buildsetCallback(self, **kwargs): 

        bsid = kwargs['bsid'] 

        d = self.master.db.buildsets.getBuildset(bsid) 

        def do_notifies(bsdict): 

            bss = buildset.BuildSetStatus(bsdict, self) 

            for t in self.watchers: 

                if hasattr(t, 'buildsetSubmitted'): 

                    t.buildsetSubmitted(bss) 

        d.addCallback(do_notifies) 

        d.addErrback(log.err, 'while notifying buildsetSubmitted') 

 

    def _buildsetCompletionCallback(self, bsid, result): 

        self._maybeBuildsetFinished(bsid) 

 

    def _buildRequestCallback(self, notif): 

        buildername = notif['buildername'] 

        if buildername in self._builder_observers: 

            brs = buildrequest.BuildRequestStatus(buildername, 

                                                notif['brid'], self) 

            for observer in self._builder_observers[buildername]: 

                if hasattr(observer, 'requestSubmitted'): 

                    eventually(observer.requestSubmitted, brs)