/
runner.py
1180 lines (1012 loc) · 40.7 KB
/
runner.py
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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- test-case-name: buildbot.test.test_runner -*-
# N.B.: don't import anything that might pull in a reactor yet. Some of our
# subcommands want to load modules that need the gtk reactor.
#
# Also don't forget to mirror your changes on command-line options in manual
# pages and texinfo documentation.
import os, sys, stat, re, time
import traceback
from twisted.python import usage, util, runtime
from buildbot.interfaces import BuildbotNotRunningError
def isBuildmasterDir(dir):
buildbot_tac = os.path.join(dir, "buildbot.tac")
if not os.path.isfile(buildbot_tac):
print "no buildbot.tac"
return False
contents = open(buildbot_tac, "r").read()
return "Application('buildmaster')" in contents
# the create/start/stop commands should all be run as the same user,
# preferably a separate 'buildbot' account.
# Note that the terms 'options' and 'config' are used intechangeably here - in
# fact, they are intercanged several times. Caveat legator.
class OptionsWithOptionsFile(usage.Options):
# subclasses should set this to a list-of-lists in order to source the
# .buildbot/options file.
# buildbotOptions = [ [ 'optfile-name', 'option-name' ], .. ]
buildbotOptions = None
def __init__(self, *args):
# for options in self.buildbotOptions, optParameters, and the options
# file, change the default in optParameters *before* calling through
# to the parent constructor
if self.buildbotOptions:
optfile = loadOptionsFile()
for optfile_name, option_name in self.buildbotOptions:
for i in range(len(self.optParameters)):
if self.optParameters[i][0] == option_name and optfile_name in optfile:
self.optParameters[i][2] = optfile[optfile_name]
usage.Options.__init__(self, *args)
def loadOptionsFile(filename="options", here=None, home=None):
"""Find the .buildbot/FILENAME file. Crawl from the current directory up
towards the root, and also look in ~/.buildbot . The first directory
that's owned by the user and has the file we're looking for wins. Windows
skips the owned-by-user test.
@rtype: dict
@return: a dictionary of names defined in the options file. If no options
file was found, return an empty dict.
"""
if here is None:
here = os.getcwd()
here = os.path.abspath(here)
if home is None:
if runtime.platformType == 'win32':
# never trust env-vars, use the proper API
from win32com.shell import shellcon, shell
appdata = shell.SHGetFolderPath(0, shellcon.CSIDL_APPDATA, 0, 0)
home = os.path.join(appdata, "buildbot")
else:
home = os.path.expanduser("~/.buildbot")
searchpath = []
toomany = 20
while True:
searchpath.append(os.path.join(here, ".buildbot"))
next = os.path.dirname(here)
if next == here:
break # we've hit the root
here = next
toomany -= 1 # just in case
if toomany == 0:
raise ValueError("Hey, I seem to have wandered up into the "
"infinite glories of the heavens. Oops.")
searchpath.append(home)
localDict = {}
for d in searchpath:
if os.path.isdir(d):
if runtime.platformType != 'win32':
if os.stat(d)[stat.ST_UID] != os.getuid():
print "skipping %s because you don't own it" % d
continue # security, skip other people's directories
optfile = os.path.join(d, filename)
if os.path.exists(optfile):
try:
f = open(optfile, "r")
options = f.read()
exec options in localDict
except:
print "error while reading %s" % optfile
raise
break
for k in localDict.keys():
if k.startswith("__"):
del localDict[k]
return localDict
class MakerBase(OptionsWithOptionsFile):
optFlags = [
['help', 'h', "Display this message"],
["quiet", "q", "Do not emit the commands being run"],
]
longdesc = """
Operates upon the specified <basedir> (or the current directory, if not
specified).
"""
opt_h = usage.Options.opt_help
def parseArgs(self, *args):
if len(args) > 0:
self['basedir'] = args[0]
else:
# Use the current directory if no basedir was specified.
self['basedir'] = os.getcwd()
if len(args) > 1:
raise usage.UsageError("I wasn't expecting so many arguments")
def postOptions(self):
self['basedir'] = os.path.abspath(self['basedir'])
makefile_sample = """# -*- makefile -*-
# This is a simple makefile which lives in a buildmaster
# directory (next to the buildbot.tac file). It allows you to start/stop the
# master by doing 'make start' or 'make stop'.
# The 'reconfig' target will tell a buildmaster to reload its config file.
start:
twistd --no_save -y buildbot.tac
stop:
if [ -e twistd.pid ]; \\
then kill `cat twistd.pid`; \\
else echo "Nothing to stop."; \\
fi
reconfig:
if [ -e twistd.pid ]; \\
then kill -HUP `cat twistd.pid`; \\
else echo "Nothing to reconfig."; \\
fi
log:
if [ -e twistd.log ]; \\
then tail -f twistd.log; \\
else echo "Nothing to tail."; \\
fi
"""
class Maker:
def __init__(self, config):
self.config = config
self.basedir = config['basedir']
self.force = config.get('force', False)
self.quiet = config['quiet']
def mkdir(self):
if os.path.exists(self.basedir):
if not self.quiet:
print "updating existing installation"
return
if not self.quiet: print "mkdir", self.basedir
os.mkdir(self.basedir)
def mkinfo(self):
path = os.path.join(self.basedir, "info")
if not os.path.exists(path):
if not self.quiet: print "mkdir", path
os.mkdir(path)
created = False
admin = os.path.join(path, "admin")
if not os.path.exists(admin):
if not self.quiet:
print "Creating info/admin, you need to edit it appropriately"
f = open(admin, "wt")
f.write("Your Name Here <admin@youraddress.invalid>\n")
f.close()
created = True
host = os.path.join(path, "host")
if not os.path.exists(host):
if not self.quiet:
print "Creating info/host, you need to edit it appropriately"
f = open(host, "wt")
f.write("Please put a description of this build host here\n")
f.close()
created = True
access_uri = os.path.join(path, "access_uri")
if not os.path.exists(access_uri):
if not self.quiet:
print "Not creating info/access_uri - add it if you wish"
if created and not self.quiet:
print "Please edit the files in %s appropriately." % path
def chdir(self):
if not self.quiet: print "chdir", self.basedir
os.chdir(self.basedir)
def makeTAC(self, contents, secret=False):
tacfile = "buildbot.tac"
if os.path.exists(tacfile):
oldcontents = open(tacfile, "rt").read()
if oldcontents == contents:
if not self.quiet:
print "buildbot.tac already exists and is correct"
return
if not self.quiet:
print "not touching existing buildbot.tac"
print "creating buildbot.tac.new instead"
tacfile = "buildbot.tac.new"
f = open(tacfile, "wt")
f.write(contents)
f.close()
if secret:
os.chmod(tacfile, 0600)
def makefile(self):
target = "Makefile.sample"
if os.path.exists(target):
oldcontents = open(target, "rt").read()
if oldcontents == makefile_sample:
if not self.quiet:
print "Makefile.sample already exists and is correct"
return
if not self.quiet:
print "replacing Makefile.sample"
else:
if not self.quiet:
print "creating Makefile.sample"
f = open(target, "wt")
f.write(makefile_sample)
f.close()
def sampleconfig(self, source):
target = "master.cfg.sample"
config_sample = open(source, "rt").read()
if os.path.exists(target):
oldcontents = open(target, "rt").read()
if oldcontents == config_sample:
if not self.quiet:
print "master.cfg.sample already exists and is up-to-date"
return
if not self.quiet:
print "replacing master.cfg.sample"
else:
if not self.quiet:
print "creating master.cfg.sample"
f = open(target, "wt")
f.write(config_sample)
f.close()
os.chmod(target, 0600)
def public_html(self, files):
webdir = os.path.join(self.basedir, "public_html")
if os.path.exists(webdir):
if not self.quiet:
print "public_html/ already exists: not replacing"
return
else:
os.mkdir(webdir)
if not self.quiet:
print "populating public_html/"
for target, source in files.iteritems():
target = os.path.join(webdir, target)
f = open(target, "wt")
f.write(open(source, "rt").read())
f.close()
def create_db(self):
from buildbot.db import dbspec, exceptions
spec = dbspec.DBSpec.from_url(self.config["db"], self.basedir)
if not self.config['quiet']: print "creating database"
# upgrade from "nothing"
from buildbot.db.schema import manager
sm = manager.DBSchemaManager(spec, self.basedir)
if sm.get_db_version() != 0:
raise exceptions.DBAlreadyExistsError
sm.upgrade()
def populate_if_missing(self, target, source, overwrite=False):
new_contents = open(source, "rt").read()
if os.path.exists(target):
old_contents = open(target, "rt").read()
if old_contents != new_contents:
if overwrite:
if not self.quiet:
print "%s has old/modified contents" % target
print " overwriting it with new contents"
open(target, "wt").write(new_contents)
else:
if not self.quiet:
print "%s has old/modified contents" % target
print " writing new contents to %s.new" % target
open(target + ".new", "wt").write(new_contents)
# otherwise, it's up to date
else:
if not self.quiet:
print "populating %s" % target
open(target, "wt").write(new_contents)
def move_if_present(self, source, dest):
if os.path.exists(source):
if os.path.exists(dest):
print "Notice: %s now overrides %s" % (dest, source)
print " as the latter is not used by buildbot anymore."
print " Decide which one you want to keep."
else:
try:
print "Notice: Moving %s to %s." % (source, dest)
print " You can (and probably want to) remove it if you haven't modified this file."
os.renames(source, dest)
except Exception, e:
print "Error moving %s to %s: %s" % (source, dest, str(e))
def upgrade_public_html(self, files):
webdir = os.path.join(self.basedir, "public_html")
if not os.path.exists(webdir):
if not self.quiet:
print "populating public_html/"
os.mkdir(webdir)
for target, source in files.iteritems():
self.populate_if_missing(os.path.join(webdir, target),
source)
def check_master_cfg(self):
from buildbot.master import BuildMaster
from twisted.python import log, failure
master_cfg = os.path.join(self.basedir, "master.cfg")
if not os.path.exists(master_cfg):
if not self.quiet:
print "No master.cfg found"
return 1
# side-effects of loading the config file:
# for each Builder defined in c['builders'], if the status directory
# didn't already exist, it will be created, and the
# $BUILDERNAME/builder pickle might be created (with a single
# "builder created" event).
# we put basedir in front of sys.path, because that's how the
# buildmaster itself will run, and it is quite common to have the
# buildmaster import helper classes from other .py files in its
# basedir.
if sys.path[0] != self.basedir:
sys.path.insert(0, self.basedir)
m = BuildMaster(self.basedir)
# we need to route log.msg to stdout, so any problems can be seen
# there. But if everything goes well, I'd rather not clutter stdout
# with log messages. So instead we add a logObserver which gathers
# messages and only displays them if something goes wrong.
messages = []
log.addObserver(messages.append)
try:
# this will raise an exception if there's something wrong with
# the config file. Note that this BuildMaster instance is never
# started, so it won't actually do anything with the
# configuration.
m.loadConfig(open(master_cfg, "r"), check_synchronously_only=True)
except:
f = failure.Failure()
if not self.quiet:
print
for m in messages:
print "".join(m['message'])
print f
print
print "An error was detected in the master.cfg file."
print "Please correct the problem and run 'buildbot upgrade-master' again."
print
return 1
return 0
DB_HELP = """
The --db string is evaluated to build the DB object, which specifies
which database the buildmaster should use to hold scheduler state and
status information. The default (which creates an SQLite database in
BASEDIR/state.sqlite) is equivalent to:
--db='DBSpec("sqlite3", basedir+"/state.sqlite"))'
--db='sqlite:///state.sqlite'
To use a remote MySQL database instead, use something like:
--db='mysql://bbuser:bbpasswd@dbhost/bbdb'
"""
class UpgradeMasterOptions(MakerBase):
optFlags = [
["replace", "r", "Replace any modified files without confirmation."],
]
optParameters = [
["db", None, "sqlite:///state.sqlite",
"which DB to use for scheduler/status state. See below for syntax."],
]
def getSynopsis(self):
return "Usage: buildbot upgrade-master [options] [<basedir>]"
longdesc = """
This command takes an existing buildmaster working directory and
adds/modifies the files there to work with the current version of
buildbot. When this command is finished, the buildmaster directory should
look much like a brand-new one created by the 'create-master' command.
Use this after you've upgraded your buildbot installation and before you
restart the buildmaster to use the new version.
If you have modified the files in your working directory, this command
will leave them untouched, but will put the new recommended contents in a
.new file (for example, if index.html has been modified, this command
will create index.html.new). You can then look at the new version and
decide how to merge its contents into your modified file.
"""+DB_HELP+"""
When upgrading from a pre-0.8.0 release (which did not use a database),
this command will create the given database and migrate data from the old
pickle files into it, then move the pickle files out of the way (e.g. to
changes.pck.old). To revert to an older release, rename the pickle files
back. When you are satisfied with the new version, you can delete the old
pickle files.
"""
def upgradeMaster(config):
basedir = os.path.expanduser(config['basedir'])
m = Maker(config)
# TODO: check Makefile
# TODO: check TAC file
# check web files: index.html, default.css, robots.txt
m.upgrade_public_html({
'bg_gradient.jpg' : util.sibpath(__file__, "../status/web/files/bg_gradient.jpg"),
'default.css' : util.sibpath(__file__, "../status/web/files/default.css"),
'robots.txt' : util.sibpath(__file__, "../status/web/files/robots.txt"),
'favicon.ico' : util.sibpath(__file__, "../status/web/files/favicon.ico"),
})
m.populate_if_missing(os.path.join(basedir, "master.cfg.sample"),
util.sibpath(__file__, "sample.cfg"),
overwrite=True)
# if index.html exists, use it to override the root page tempalte
m.move_if_present(os.path.join(basedir, "public_html/index.html"),
os.path.join(basedir, "templates/root.html"))
from buildbot.db import dbspec
spec = dbspec.DBSpec.from_url(config["db"], basedir)
# TODO: check that TAC file specifies the right spec
# upgrade the db
from buildbot.db.schema import manager
sm = manager.DBSchemaManager(spec, basedir)
sm.upgrade()
# check the configuration
rc = m.check_master_cfg()
if rc:
return rc
if not config['quiet']: print "upgrade complete"
return 0
class MasterOptions(MakerBase):
optFlags = [
["force", "f",
"Re-use an existing directory (will not overwrite master.cfg file)"],
["relocatable", "r",
"Create a relocatable buildbot.tac"],
["no-logrotate", "n",
"Do not permit buildmaster rotate logs by itself"]
]
optParameters = [
["config", "c", "master.cfg", "name of the buildmaster config file"],
["log-size", "s", "10000000",
"size at which to rotate twisted log files"],
["log-count", "l", "10",
"limit the number of kept old twisted log files"],
["db", None, "sqlite:///state.sqlite",
"which DB to use for scheduler/status state. See below for syntax."],
]
def getSynopsis(self):
return "Usage: buildbot create-master [options] [<basedir>]"
longdesc = """
This command creates a buildmaster working directory and buildbot.tac file.
The master will live in <dir> and create various files there. If
--relocatable is given, then the resulting buildbot.tac file will be
written such that its containing directory is assumed to be the basedir.
This is generally a good idea.
At runtime, the master will read a configuration file (named
'master.cfg' by default) in its basedir. This file should contain python
code which eventually defines a dictionary named 'BuildmasterConfig'.
The elements of this dictionary are used to configure the Buildmaster.
See doc/config.xhtml for details about what can be controlled through
this interface.
""" + DB_HELP + """
The --db string is stored verbatim in the buildbot.tac file, and
evaluated as 'buildbot start' time to pass a DBConnector instance into
the newly-created BuildMaster object.
"""
def postOptions(self):
MakerBase.postOptions(self)
if not re.match('^\d+$', self['log-size']):
raise usage.UsageError("log-size parameter needs to be an int")
if not re.match('^\d+$', self['log-count']) and \
self['log-count'] != 'None':
raise usage.UsageError("log-count parameter needs to be an int "+
" or None")
masterTACTemplate = ["""
import os
from twisted.application import service
from buildbot.master import BuildMaster
basedir = r'%(basedir)s'
rotateLength = %(log-size)s
maxRotatedFiles = %(log-count)s
# if this is a relocatable tac file, get the directory containing the TAC
if basedir == '.':
import os.path
basedir = os.path.abspath(os.path.dirname(__file__))
# note: this line is matched against to check that this is a buildmaster
# directory; do not edit it.
application = service.Application('buildmaster')
""",
"""
try:
from twisted.python.logfile import LogFile
from twisted.python.log import ILogObserver, FileLogObserver
logfile = LogFile.fromFullPath(os.path.join(basedir, "twistd.log"), rotateLength=rotateLength,
maxRotatedFiles=maxRotatedFiles)
application.setComponent(ILogObserver, FileLogObserver(logfile).emit)
except ImportError:
# probably not yet twisted 8.2.0 and beyond, can't set log yet
pass
""",
"""
configfile = r'%(config)s'
m = BuildMaster(basedir, configfile)
m.setServiceParent(application)
m.log_rotation.rotateLength = rotateLength
m.log_rotation.maxRotatedFiles = maxRotatedFiles
"""]
def createMaster(config):
m = Maker(config)
m.mkdir()
m.chdir()
if config['relocatable']:
config['basedir'] = '.'
if config['no-logrotate']:
masterTAC = "".join([masterTACTemplate[0]] + masterTACTemplate[2:])
else:
masterTAC = "".join(masterTACTemplate)
contents = masterTAC % config
m.makeTAC(contents)
m.sampleconfig(util.sibpath(__file__, "sample.cfg"))
m.public_html({
'bg_gradient.jpg' : util.sibpath(__file__, "../status/web/files/bg_gradient.jpg"),
'default.css' : util.sibpath(__file__, "../status/web/files/default.css"),
'robots.txt' : util.sibpath(__file__, "../status/web/files/robots.txt"),
'favicon.ico' : util.sibpath(__file__, "../status/web/files/favicon.ico"),
})
m.makefile()
m.create_db()
if not m.quiet: print "buildmaster configured in %s" % m.basedir
def stop(config, signame="TERM", wait=False):
import signal
basedir = config['basedir']
quiet = config['quiet']
if not isBuildmasterDir(config['basedir']):
print "not a buildmaster directory"
sys.exit(1)
os.chdir(basedir)
try:
f = open("twistd.pid", "rt")
except:
raise BuildbotNotRunningError
pid = int(f.read().strip())
signum = getattr(signal, "SIG"+signame)
timer = 0
try:
os.kill(pid, signum)
except OSError, e:
if e.errno != 3:
raise
if not wait:
if not quiet:
print "sent SIG%s to process" % signame
return
time.sleep(0.1)
while timer < 10:
# poll once per second until twistd.pid goes away, up to 10 seconds
try:
os.kill(pid, 0)
except OSError:
if not quiet:
print "buildbot process %d is dead" % pid
return
timer += 1
time.sleep(1)
if not quiet:
print "never saw process go away"
def restart(config):
basedir = config['basedir']
quiet = config['quiet']
if not isBuildmasterDir(basedir):
print "not a buildmaster directory"
sys.exit(1)
from buildbot.scripts.startup import start
try:
stop(config, wait=True)
except BuildbotNotRunningError:
pass
if not quiet:
print "now restarting buildbot process.."
start(config)
class StartOptions(MakerBase):
optFlags = [
['quiet', 'q', "Don't display startup log messages"],
]
def getSynopsis(self):
return "Usage: buildbot start [<basedir>]"
class StopOptions(MakerBase):
def getSynopsis(self):
return "Usage: buildbot stop [<basedir>]"
class ReconfigOptions(MakerBase):
optFlags = [
['quiet', 'q', "Don't display log messages about reconfiguration"],
]
def getSynopsis(self):
return "Usage: buildbot reconfig [<basedir>]"
class RestartOptions(MakerBase):
optFlags = [
['quiet', 'q', "Don't display startup log messages"],
]
def getSynopsis(self):
return "Usage: buildbot restart [<basedir>]"
class DebugClientOptions(OptionsWithOptionsFile):
optFlags = [
['help', 'h', "Display this message"],
]
optParameters = [
["master", "m", None,
"Location of the buildmaster's slaveport (host:port)"],
["passwd", "p", None, "Debug password to use"],
]
buildbotOptions = [
[ 'debugMaster', 'passwd' ],
[ 'master', 'master' ],
]
def getSynopsis(self):
return "Usage: buildbot debugclient [options]"
def parseArgs(self, *args):
if len(args) > 0:
self['master'] = args[0]
if len(args) > 1:
self['passwd'] = args[1]
if len(args) > 2:
raise usage.UsageError("I wasn't expecting so many arguments")
def debugclient(config):
from buildbot.clients import debug
master = config.get('master')
if master is None:
raise usage.UsageError("master must be specified: on the command "
"line or in ~/.buildbot/options")
passwd = config.get('passwd')
if passwd is None:
raise usage.UsageError("passwd must be specified: on the command "
"line or in ~/.buildbot/options")
d = debug.DebugWidget(master, passwd)
d.run()
class StatusClientOptions(OptionsWithOptionsFile):
optFlags = [
['help', 'h', "Display this message"],
]
optParameters = [
["master", "m", None,
"Location of the buildmaster's status port (host:port)"],
["username", "u", "statusClient", "Username performing the trial build"],
["passwd", None, "clientpw", "password for PB authentication"],
]
buildbotOptions = [
[ 'masterstatus', 'master' ],
]
def parseArgs(self, *args):
if len(args) > 0:
self['master'] = args[0]
if len(args) > 1:
raise usage.UsageError("I wasn't expecting so many arguments")
class StatusLogOptions(StatusClientOptions):
def getSynopsis(self):
return "Usage: buildbot statuslog [options]"
class StatusGuiOptions(StatusClientOptions):
def getSynopsis(self):
return "Usage: buildbot statusgui [options]"
def statuslog(config):
from buildbot.clients import base
master = config.get('master')
if master is None:
raise usage.UsageError("master must be specified: on the command "
"line or in ~/.buildbot/options")
passwd = config.get('passwd')
username = config.get('username')
c = base.TextClient(master, username=username, passwd=passwd)
c.run()
def statusgui(config):
from buildbot.clients import gtkPanes
master = config.get('master')
if master is None:
raise usage.UsageError("master must be specified: on the command "
"line or in ~/.buildbot/options")
c = gtkPanes.GtkClient(master)
c.run()
class SendChangeOptions(OptionsWithOptionsFile):
def __init__(self):
OptionsWithOptionsFile.__init__(self)
self['properties'] = {}
optParameters = [
("master", "m", None,
"Location of the buildmaster's PBListener (host:port)"),
# deprecated in 0.8.3; remove in 0.8.5 (bug #1711)
("username", "u", None, "deprecated name for --who"),
("auth", "a", None, "Authentication token - username:password, or prompt for password"),
("who", "W", None, "Author of the commit"),
("repository", "R", '', "Repository specifier"),
("project", "P", '', "Project specifier"),
("branch", "b", None, "Branch specifier"),
("category", "C", None, "Category of repository"),
("revision", "r", None, "Revision specifier"),
("revision_file", None, None, "Filename containing revision spec"),
("property", "p", None,
"A property for the change, in the format: name:value"),
("comments", "c", None, "log message"),
("logfile", "F", None,
"Read the log messages from this file (- for stdin)"),
("when", "w", None, "timestamp to use as the change time"),
("revlink", "l", '', "Revision link (revlink)"),
]
buildbotOptions = [
[ 'master', 'master' ],
[ 'who', 'who' ],
[ 'username', 'username' ],
[ 'branch', 'branch' ],
[ 'category', 'category' ],
]
def getSynopsis(self):
return "Usage: buildbot sendchange [options] filenames.."
def parseArgs(self, *args):
self['files'] = args
def opt_property(self, property):
name,value = property.split(':')
self['properties'][name] = value
def sendchange(config, runReactor=False):
"""Send a single change to the buildmaster's PBChangeSource. The
connection will be drpoped as soon as the Change has been sent."""
from buildbot.clients.sendchange import Sender
who = config.get('who')
if not who and config.get('username'):
print "NOTE: --username/-u is deprecated: use --who/-W'"
who = config.get('username')
auth = config.get('auth')
master = config.get('master')
branch = config.get('branch')
category = config.get('category')
revision = config.get('revision')
properties = config.get('properties', {})
repository = config.get('repository', '')
project = config.get('project', '')
revlink = config.get('revlink', '')
if config.get('when'):
when = float(config.get('when'))
else:
when = None
if config.get("revision_file"):
revision = open(config["revision_file"],"r").read()
comments = config.get('comments')
if not comments and config.get('logfile'):
if config['logfile'] == "-":
f = sys.stdin
else:
f = open(config['logfile'], "rt")
comments = f.read()
if comments is None:
comments = ""
files = config.get('files', [])
# fix up the auth with a password if none was given
if not auth:
auth = 'change:changepw'
if ':' not in auth:
import getpass
pw = getpass.getpass("Enter password for '%s': " % auth)
auth = "%s:%s" % (auth, pw)
auth = auth.split(':', 1)
assert who, "you must provide a committer (--who)"
assert master, "you must provide the master location"
s = Sender(master, auth)
d = s.send(branch, revision, comments, files, who=who, category=category, when=when,
properties=properties, repository=repository, project=project,
revlink=revlink)
if runReactor:
status = [True]
def failed(res):
status[0] = False
s.printFailure(res)
d.addCallbacks(s.printSuccess, failed)
d.addBoth(s.stop)
s.run()
return status[0]
return d
class ForceOptions(OptionsWithOptionsFile):
optParameters = [
["builder", None, None, "which Builder to start"],
["branch", None, None, "which branch to build"],
["revision", None, None, "which revision to build"],
["reason", None, None, "the reason for starting the build"],
]
def parseArgs(self, *args):
args = list(args)
if len(args) > 0:
if self['builder'] is not None:
raise usage.UsageError("--builder provided in two ways")
self['builder'] = args.pop(0)
if len(args) > 0:
if self['reason'] is not None:
raise usage.UsageError("--reason provided in two ways")
self['reason'] = " ".join(args)
class TryOptions(OptionsWithOptionsFile):
optParameters = [
["connect", "c", None,
"how to reach the buildmaster, either 'ssh' or 'pb'"],
# for ssh, use --tryhost, --username, and --trydir
["tryhost", None, None,
"the hostname (used by ssh) for the buildmaster"],
["trydir", None, None,
"the directory (on the tryhost) where tryjobs are deposited"],
["username", "u", None, "Username performing the trial build"],
# for PB, use --master, --username, and --passwd
["master", "m", None,
"Location of the buildmaster's PBListener (host:port)"],
["passwd", None, None, "password for PB authentication"],
["diff", None, None,
"Filename of a patch to use instead of scanning a local tree. Use '-' for stdin."],
["patchlevel", "p", 0,
"Number of slashes to remove from patch pathnames, like the -p option to 'patch'"],
["baserev", None, None,
"Base revision to use instead of scanning a local tree."],
["vc", None, None,
"The VC system in use, one of: cvs,svn,bzr,darcs,p4"],
["branch", None, None,
"The branch in use, for VC systems that can't figure it out"
" themselves"],
["builder", "b", None,
"Run the trial build on this Builder. Can be used multiple times."],
["properties", None, None,
"A set of properties made available in the build environment, format:prop1=value1,prop2=value2..."],
["try-topfile", None, None,
"Name of a file at the top of the tree, used to find the top. Only needed for SVN and CVS."],
["try-topdir", None, None,
"Path to the top of the working copy. Only needed for SVN and CVS."],
]
optFlags = [
["wait", None, "wait until the builds have finished"],
["dryrun", 'n', "Gather info, but don't actually submit."],
["get-builder-names", None, "Get the names of available builders. Doesn't submit anything. Only supported for 'pb' connections."],
]
# here it is, the definitive, quirky mapping of .buildbot/options names to
# command-line options. Design by committee, anyone?
buildbotOptions = [
[ 'try_connect', 'connect' ],
#[ 'try_builders', 'builders' ], <-- handled in postOptions
[ 'try_vc', 'vc' ],
[ 'try_branch', 'branch' ],
[ 'try_topdir', 'try-topdir' ],
[ 'try_topfile', 'try-topfile' ],
[ 'try_host', 'tryhost' ],
[ 'try_username', 'username' ],
[ 'try_dir', 'trydir' ],
[ 'try_password', 'passwd' ],
[ 'try_master', 'master' ],
#[ 'try_wait', 'wait' ], <-- handled in postOptions
[ 'masterstatus', 'master' ],
]
def __init__(self):
OptionsWithOptionsFile.__init__(self)
self['builders'] = []
self['properties'] = {}
def opt_builder(self, option):
self['builders'].append(option)
def opt_properties(self, option):
# We need to split the value of this option into a dictionary of properties
properties = {}
propertylist = option.split(",")
for i in range(0,len(propertylist)):
print propertylist[i]
splitproperty = propertylist[i].split("=")
properties[splitproperty[0]] = splitproperty[1]
self['properties'] = properties
def opt_patchlevel(self, option):
self['patchlevel'] = int(option)
def getSynopsis(self):
return "Usage: buildbot try [options]"
def postOptions(self):
opts = loadOptionsFile()
if not self['builders']:
self['builders'] = opts.get('try_builders', [])
if opts.get('try_wait', False):
self['wait'] = True
def doTry(config):
from buildbot.clients import tryclient
t = tryclient.Try(config)
t.run()
class TryServerOptions(OptionsWithOptionsFile):
optParameters = [
["jobdir", None, None, "the jobdir (maildir) for submitting jobs"],
]
def getSynopsis(self):