Index: statusgrid/buildbot/status/html.py =================================================================== --- statusgrid.orig/buildbot/status/html.py 2007-07-25 09:46:41.280896262 -0500 +++ statusgrid/buildbot/status/html.py 2007-07-25 11:10:46.693375958 -0500 @@ -3,5 +3,13 @@ # compatibility wrapper. This is currently the preferred place for master.cfg # to import from. +# compatibility function from buildbot.status.web.waterfall import Waterfall _hush_pyflakes = [Waterfall] + + +from buildbot.status.web.waterfall import WaterfallStatusResource +_hush_pyflakes = [WaterfallStatusResource] + +from buildbot.status.web.site import WebStatus +_hush_pyflakes = [WebStatus] Index: statusgrid/buildbot/status/web/site.py =================================================================== --- /dev/null 1970-01-01 00:00:00.000000000 +0000 +++ statusgrid/buildbot/status/web/site.py 2007-07-25 11:14:08.258252990 -0500 @@ -0,0 +1,204 @@ +import sys, os.path + +from twisted.web.resource import Resource +from twisted.application import strports +from twisted.web import static, html, server, distrib +from twisted.web.error import NoResource +from twisted.spread import pb + +from buildbot import interfaces +from buildbot.status.base import StatusReceiverMultiService +from buildbot.status.web.base import HtmlResource, IToplevelResource + +if hasattr(sys, "frozen"): + # all 'data' files are in the directory of our executable + here = os.path.dirname(sys.executable) + buildbot_icon = os.path.abspath(os.path.join(here, "buildbot.png")) +else: + # running from source + # the icon is sibpath(__file__, "../buildbot.png") . This is for + # portability. + up = os.path.dirname + buildbot_icon = os.path.abspath(os.path.join(up(up(up(__file__))), + "buildbot.png")) + +class WebStatus(StatusReceiverMultiService): + compare_attrs = ["http_port", "distrib_port", "favicon", "robots_txt"] + + def __init__(self, top_page=None, http_port=None, distrib_port=None, + favicon=None, robots_txt=None, **named_pages): + """To have the buildbot run its own web server, pass a port number to + C{http_port}. To have it run a web.distrib server + + @type top_page: IToplevelResource + @param top_page: an IToplevelResource that should be displayed + as the main resource of this page + + @type http_port: int or L{twisted.application.strports} string + @param http_port: a strports specification describing which port the + buildbot should use for its web server, with the + Waterfall display as the root page. For backwards + compatibility this can also be an int. Use + 'tcp:8000' to listen on that port, or + 'tcp:12345:interface=127.0.0.1' if you only want + local processes to connect to it (perhaps because + you are using an HTTP reverse proxy to make the + buildbot available to the outside world, and do not + want to make the raw port visible). + + @type distrib_port: int or L{twisted.application.strports} string + @param distrib_port: Use this if you want to publish the Waterfall + page using web.distrib instead. The most common + case is to provide a string that is an absolute + pathname to the unix socket on which the + publisher should listen + (C{os.path.expanduser(~/.twistd-web-pb)} will + match the default settings of a standard + twisted.web 'personal web server'). Another + possibility is to pass an integer, which means + the publisher should listen on a TCP socket, + allowing the web server to be on a different + machine entirely. Both forms are provided for + backwards compatibility; the preferred form is a + strports specification like + 'unix:/home/buildbot/.twistd-web-pb'. Providing + a non-absolute pathname will probably confuse + the strports parser. + + @type favicon: string + @param favicon: if set, provide the pathname of an image file that + will be used for the 'favicon.ico' resource. Many + browsers automatically request this file and use it + as an icon in any bookmark generated from this site. + Defaults to the buildbot/buildbot.png image provided + in the distribution. Can be set to None to avoid + using a favicon at all. + + @type robots_txt: string + @param robots_txt: if set, provide the pathname of a robots.txt file. + Many search engines request this file and obey the + rules in it. E.g. to disallow them to crawl the + status page, put the following two lines in + robots.txt:: + User-agent: * + Disallow: / + """ + if favicon is None: favicon = buildbot_icon + + StatusReceiverMultiService.__init__(self) + if type(http_port) is int: + http_port = "tcp:%d" % http_port + self.http_port = http_port + if distrib_port is not None: + if type(distrib_port) is int: + distrib_port = "tcp:%d" % distrib_port + if distrib_port[0] in "/~.": # pathnames + distrib_port = "unix:%s" % distrib_port + self.distrib_port = distrib_port + self.favicon = favicon + self.robots_txt = robots_txt + + self.top_page = top_page + self.named_pages = named_pages + + def __repr__(self): + if self.http_port is None: + return "" % self.distrib_port + if self.distrib_port is None: + return "" % self.http_port + return "" % (self.http_port, + self.distrib_port) + + def setServiceParent(self, parent): + """ + @type parent: L{buildbot.master.BuildMaster} + """ + StatusReceiverMultiService.setServiceParent(self, parent) + self.setup(parent) + + def setup(self, parent): + # first, tell all of the named pages, and the top page, who + # the buildmaster is + if self.top_page: + IToplevelResource(self.top_page).setBuildmaster(parent) + for named_page in self.named_pages.values(): + IToplevelResource(named_page).setBuildmaster(parent) + + wsr = WebStatusResource(self.parent, self.favicon, self.robots_txt, + self.top_page, self.named_pages) + self.site = server.Site(wsr) + + if self.http_port is not None: + s = strports.service(self.http_port, self.site) + s.setServiceParent(self) + if self.distrib_port is not None: + f = pb.PBServerFactory(distrib.ResourcePublisher(self.site)) + s = strports.service(self.distrib_port, f) + s.setServiceParent(self) + +class MenuResource(HtmlResource): + title = "Menu" + def __init__(self, menu_items): + HtmlResource.__init__(self) + self.menu_items = menu_items + + def body(self, request): + data = [ '
    ' ] + data += [ '
  • %s' % (name,name) for name in self.menu_items.keys() ] + data += [ '
' ] + return "\n".join(data) + +class WebStatusResource(Resource): + """ + A generic top-level resource for a site. This resource handles at least + robots.txt and favicon. If supplied with a top_page, then it delegates + all other methods to that resource. Otherwise, it produces a simple HTML + menu of its named_pages. + """ + buildmaster = None + + favicon = None + robots_txt = None + + def __init__(self, buildmaster, favicon, robots_txt, top_page, named_pages): + """ + @type buildmaster: L{buildbot.master.BuildMaster} + @type favicon: string + @type robots_txt: string + @type top_page: Resource or None + @type named_pages: dictionary mapping names to Resources + """ + Resource.__init__(self) + self.buildmaster = buildmaster + self.favicon = favicon + self.robots_txt = robots_txt + self.top_page = top_page + self.named_pages = named_pages + + if self.top_page: + self.putChild("", self.top_page) + else: + self.putChild("", MenuResource(self.named_pages)) + + def render(self, request): + # always add a slash if one isn't present + request.redirect(request.prePathURL() + '/') + request.finish() + + def getChild(self, path, request): + if path == "robots.txt" and self.robots_txt: + return static.File(self.robots_txt) + if path == "favicon.ico": + if self.favicon: + return static.File(self.favicon) + return NoResource("No favicon.ico registered") + + # point to a named page, if present + if self.named_pages.has_key(path): + return self.named_pages[path] + + # delegate anything else to top_page, if present + if self.top_page: + return self.top_page.getChild(path, request) + + return NoResource("No such page '%s'" % path) Index: statusgrid/buildbot/status/web/waterfall.py =================================================================== --- statusgrid.orig/buildbot/status/web/waterfall.py 2007-07-25 09:46:41.280896262 -0500 +++ statusgrid/buildbot/status/web/waterfall.py 2007-07-25 11:12:09.558445232 -0500 @@ -19,9 +19,14 @@ from buildbot import interfaces, util from buildbot import version from buildbot.sourcestamp import SourceStamp -from buildbot.status import builder, base +from buildbot.status import builder +from buildbot.status.base import StatusReceiverMultiService from buildbot.changes import changes from buildbot.process.base import BuildRequest +from buildbot.status.web.site import WebStatus +from buildbot.status.web.base import HtmlResource, StaticHTML, IToplevelResource, IHTMLLog +from buildbot.status.web.changes import StatusResourceChanges +from buildbot.status.web.builder import StatusResourceBuilder class ITopBox(Interface): """I represent a box in the top row of the waterfall display: the one @@ -36,26 +41,6 @@ """I represent a box in the waterfall display.""" pass -class IHTMLLog(Interface): - pass - -ROW_TEMPLATE = ''' -
- %(label)s - %(field)s -
''' - -def make_row(label, field): - """Create a name/value row for the HTML. - - `label` is plain text; it will be HTML-encoded. - - `field` is a bit of HTML structure; it will not be encoded in - any way. - """ - label = html.escape(label) - return ROW_TEMPLATE % {"label": label, "field": field} - colormap = { 'green': '#72ff75', } @@ -140,537 +125,6 @@ return td(text, props, bgcolor=self.color, class_=self.class_) -class HtmlResource(Resource): - css = None - contentType = "text/html; charset=UTF-8" - title = "Dummy" - - def render(self, request): - data = self.content(request) - if isinstance(data, unicode): - data = data.encode("utf-8") - request.setHeader("content-type", self.contentType) - if request.method == "HEAD": - request.setHeader("content-length", len(data)) - return '' - return data - - def content(self, request): - data = ('\n' - '\n') - data += "\n" - data += " " + self.title + "\n" - if self.css: - # TODO: use some sort of relative link up to the root page, so - # this css can be used from child pages too - data += (' \n' - % "buildbot.css") - data += "\n" - data += '\n' - data += self.body(request) - data += "\n" - return data - - def body(self, request): - return "Dummy\n" - -class StaticHTML(HtmlResource): - def __init__(self, body, title): - HtmlResource.__init__(self) - self.bodyHTML = body - self.title = title - def body(self, request): - return self.bodyHTML - -# $builder/builds/NN/stepname -class StatusResourceBuildStep(HtmlResource): - title = "Build Step" - - def __init__(self, status, step): - HtmlResource.__init__(self) - self.status = status - self.step = step - - def body(self, request): - s = self.step - b = s.getBuild() - data = "

BuildStep %s:#%d:%s

\n" % \ - (b.getBuilder().getName(), b.getNumber(), s.getName()) - - if s.isFinished(): - data += ("

Finished

\n" - "

%s

\n" % html.escape("%s" % s.getText())) - else: - data += ("

Not Finished

\n" - "

ETA %s seconds

\n" % s.getETA()) - - exp = s.getExpectations() - if exp: - data += ("

Expectations

\n" - "
    \n") - for e in exp: - data += "
  • %s: current=%s, target=%s
    • \n" % \ - (html.escape(e[0]), e[1], e[2]) - data += "
\n" - logs = s.getLogs() - if logs: - data += ("

Logs

\n" - "
    \n") - for num in range(len(logs)): - if logs[num].hasContents(): - # FIXME: If the step name has a / in it, this is broken - # either way. If we quote it but say '/'s are safe, - # it chops up the step name. If we quote it and '/'s - # are not safe, it escapes the / that separates the - # step name from the log number. - data += '
  • %s
    • \n' % \ - (urllib.quote(request.childLink("%d" % num)), - html.escape(logs[num].getName())) - else: - data += ('
  • %s
    • \n' % - html.escape(logs[num].getName())) - data += "
\n" - - return data - - def getChild(self, path, request): - logname = path - try: - log = self.step.getLogs()[int(logname)] - if log.hasContents(): - return IHTMLLog(interfaces.IStatusLog(log)) - return NoResource("Empty Log '%s'" % logname) - except (IndexError, ValueError): - return NoResource("No such Log '%s'" % logname) - -# $builder/builds/NN/tests/TESTNAME -class StatusResourceTestResult(HtmlResource): - title = "Test Logs" - - def __init__(self, status, name, result): - HtmlResource.__init__(self) - self.status = status - self.name = name - self.result = result - - def body(self, request): - dotname = ".".join(self.name) - logs = self.result.getLogs() - lognames = logs.keys() - lognames.sort() - data = "

%s

\n" % html.escape(dotname) - for name in lognames: - data += "

%s

\n" % html.escape(name) - data += "
" + logs[name] + "
\n\n" - - return data - - -# $builder/builds/NN/tests -class StatusResourceTestResults(HtmlResource): - title = "Test Results" - - def __init__(self, status, results): - HtmlResource.__init__(self) - self.status = status - self.results = results - - def body(self, request): - r = self.results - data = "

Test Results

\n" - data += "
    \n" - testnames = r.keys() - testnames.sort() - for name in testnames: - res = r[name] - dotname = ".".join(name) - data += "
  • %s: " % dotname - # TODO: this could break on weird test names. At the moment, - # test names only come from Trial tests, where the name - # components must be legal python names, but that won't always - # be a restriction. - url = request.childLink(dotname) - data += "%s" % (url, " ".join(res.getText())) - data += "
    • \n" - data += "
\n" - return data - - def getChild(self, path, request): - try: - name = tuple(path.split(".")) - result = self.results[name] - return StatusResourceTestResult(self.status, name, result) - except KeyError: - return NoResource("No such test name '%s'" % path) - - -# $builder/builds/NN -class StatusResourceBuild(HtmlResource): - title = "Build" - - def __init__(self, status, build, builderControl, buildControl): - HtmlResource.__init__(self) - self.status = status - self.build = build - self.builderControl = builderControl - self.control = buildControl - - def body(self, request): - b = self.build - buildbotURL = self.status.getBuildbotURL() - projectName = self.status.getProjectName() - data = '
%s
\n'%(buildbotURL, - projectName) - # the color in the following line gives python-mode trouble - data += ("

Build %s:#%d

\n" - % (self.status.getURLForThing(b.getBuilder()), - b.getBuilder().getName(), b.getNumber())) - data += "

Buildslave:

\n %s\n" % html.escape(b.getSlavename()) - data += "

Reason:

\n%s\n" % html.escape(b.getReason()) - - branch, revision, patch = b.getSourceStamp() - data += "

SourceStamp:

\n" - data += "
    \n" - if branch: - data += "
  • Branch: %s
    • \n" % html.escape(branch) - if revision: - data += "
  • Revision: %s
    • \n" % html.escape(str(revision)) - if patch: - data += "
  • Patch: YES
    • \n" # TODO: provide link to .diff - if b.getChanges(): - data += "
  • Changes: see below
    • \n" - if (branch is None and revision is None and patch is None - and not b.getChanges()): - data += "
  • build of most recent revision
    • \n" - data += "
\n" - if b.isFinished(): - data += "

Results:

\n" - data += " ".join(b.getText()) + "\n" - if b.getTestResults(): - url = request.childLink("tests") - data += "

test results

\n" % url - else: - data += "

Build In Progress

" - if self.control is not None: - stopURL = urllib.quote(request.childLink("stop")) - data += """ -
-

To stop this build, fill out the following fields and - push the 'Stop' button

\n""" % stopURL - data += make_row("Your name:", - "") - data += make_row("Reason for stopping build:", - "") - data += """ -
- """ - - if b.isFinished() and self.builderControl is not None: - data += "

Resubmit Build:

\n" - # can we rebuild it exactly? - exactly = (revision is not None) or b.getChanges() - if exactly: - data += ("

This tree was built from a specific set of \n" - "source files, and can be rebuilt exactly

\n") - else: - data += ("

This tree was built from the most recent " - "revision") - if branch: - data += " (along some branch)" - data += (" and thus it might not be possible to rebuild it \n" - "exactly. Any changes that have been committed \n" - "after this build was started will be \n" - "included in a rebuild.

\n") - rebuildURL = urllib.quote(request.childLink("rebuild")) - data += ('
\n' - % rebuildURL) - data += make_row("Your name:", - "") - data += make_row("Reason for re-running build:", - "") - data += '\n' - data += '
\n' - - data += "

Steps and Logfiles:

\n" - if b.getLogs(): - data += "
    \n" - for s in b.getSteps(): - data += ("
  1. %s [%s]\n" - % (self.status.getURLForThing(s), s.getName(), - " ".join(s.getText()))) - if s.getLogs(): - data += "
      \n" - for logfile in s.getLogs(): - data += ("
    1. %s
      2. \n" % - (self.status.getURLForThing(logfile), - logfile.getName())) - data += "
    \n" - data += "
    2. \n" - data += "
\n" - - data += ("

Blamelist:

\n" - "
    \n") - for who in b.getResponsibleUsers(): - data += "
  1. %s
    2. \n" % html.escape(who) - data += ("
\n" - "

All Changes

\n") - changes = b.getChanges() - if changes: - data += "
    \n" - for c in changes: - data += "
  1. " + c.asHTML() + "
    2. \n" - data += "
\n" - #data += html.PRE(b.changesText()) # TODO - return data - - def stop(self, request): - log.msg("web stopBuild of build %s:%s" % \ - (self.build.getBuilder().getName(), - self.build.getNumber())) - name = request.args.get("username", [""])[0] - comments = request.args.get("comments", [""])[0] - reason = ("The web-page 'stop build' button was pressed by " - "'%s': %s\n" % (name, comments)) - self.control.stopBuild(reason) - # we're at http://localhost:8080/svn-hello/builds/5/stop?[args] and - # we want to go to: http://localhost:8080/svn-hello/builds/5 or - # http://localhost:8080/ - # - #return Redirect("../%d" % self.build.getNumber()) - r = Redirect("../../..") - d = defer.Deferred() - reactor.callLater(1, d.callback, r) - return DeferredResource(d) - - def rebuild(self, request): - log.msg("web rebuild of build %s:%s" % \ - (self.build.getBuilder().getName(), - self.build.getNumber())) - name = request.args.get("username", [""])[0] - comments = request.args.get("comments", [""])[0] - reason = ("The web-page 'rebuild' button was pressed by " - "'%s': %s\n" % (name, comments)) - if not self.builderControl or not self.build.isFinished(): - log.msg("could not rebuild: bc=%s, isFinished=%s" - % (self.builderControl, self.build.isFinished())) - # TODO: indicate an error - else: - self.builderControl.resubmitBuild(self.build, reason) - # we're at http://localhost:8080/svn-hello/builds/5/rebuild?[args] and - # we want to go to the top, at http://localhost:8080/ - r = Redirect("../../..") - d = defer.Deferred() - reactor.callLater(1, d.callback, r) - return DeferredResource(d) - - def getChild(self, path, request): - if path == "tests": - return StatusResourceTestResults(self.status, - self.build.getTestResults()) - if path == "stop": - return self.stop(request) - if path == "rebuild": - return self.rebuild(request) - if path.startswith("step-"): - stepname = path[len("step-"):] - steps = self.build.getSteps() - for s in steps: - if s.getName() == stepname: - return StatusResourceBuildStep(self.status, s) - return NoResource("No such BuildStep '%s'" % stepname) - return NoResource("No such resource '%s'" % path) - -# $builder -class StatusResourceBuilder(HtmlResource): - - def __init__(self, status, builder, control): - HtmlResource.__init__(self) - self.status = status - self.title = builder.getName() + " Builder" - self.builder = builder - self.control = control - - def body(self, request): - b = self.builder - slaves = b.getSlaves() - connected_slaves = [s for s in slaves if s.isConnected()] - - buildbotURL = self.status.getBuildbotURL() - projectName = self.status.getProjectName() - data = "%s\n" % (buildbotURL, projectName) - data += make_row("Builder:", html.escape(b.getName())) - b1 = b.getBuild(-1) - if b1 is not None: - data += make_row("Current/last build:", str(b1.getNumber())) - data += "\n
BUILDSLAVES
\n" - data += "
    \n" - for slave in slaves: - data += "
  1. %s: " % html.escape(slave.getName()) - if slave.isConnected(): - data += "CONNECTED\n" - if slave.getAdmin(): - data += make_row("Admin:", html.escape(slave.getAdmin())) - if slave.getHost(): - data += "Host info:\n" - data += html.PRE(slave.getHost()) - else: - data += ("NOT CONNECTED\n") - data += "
    2. \n" - data += "
\n" - - if self.control is not None and connected_slaves: - forceURL = urllib.quote(request.childLink("force")) - data += ( - """ -
-

To force a build, fill out the following fields and - push the 'Force Build' button

""" - + make_row("Your name:", - "") - + make_row("Reason for build:", - "") - + make_row("Branch to build:", - "") - + make_row("Revision to build:", - "") - + """ - -
- """) % {"forceURL": forceURL} - elif self.control is not None: - data += """ -

All buildslaves appear to be offline, so it's not possible - to force this build to execute at this time.

- """ - - if self.control is not None: - pingURL = urllib.quote(request.childLink("ping")) - data += """ -
-

To ping the buildslave(s), push the 'Ping' button

- - -
- """ % pingURL - - return data - - def force(self, request): - name = request.args.get("username", [""])[0] - reason = request.args.get("comments", [""])[0] - branch = request.args.get("branch", [""])[0] - revision = request.args.get("revision", [""])[0] - - r = "The web-page 'force build' button was pressed by '%s': %s\n" \ - % (name, reason) - log.msg("web forcebuild of builder '%s', branch='%s', revision='%s'" - % (self.builder.name, branch, revision)) - - if not self.control: - # TODO: tell the web user that their request was denied - log.msg("but builder control is disabled") - return Redirect("..") - - # keep weird stuff out of the branch and revision strings. TODO: - # centralize this somewhere. - if not re.match(r'^[\w\.\-\/]*$', branch): - log.msg("bad branch '%s'" % branch) - return Redirect("..") - if not re.match(r'^[\w\.\-\/]*$', revision): - log.msg("bad revision '%s'" % revision) - return Redirect("..") - if branch == "": - branch = None - if revision == "": - revision = None - - # TODO: if we can authenticate that a particular User pushed the - # button, use their name instead of None, so they'll be informed of - # the results. - s = SourceStamp(branch=branch, revision=revision) - req = BuildRequest(r, s, self.builder.getName()) - try: - self.control.requestBuildSoon(req) - except interfaces.NoSlaveError: - # TODO: tell the web user that their request could not be - # honored - pass - return Redirect("..") - - def ping(self, request): - log.msg("web ping of builder '%s'" % self.builder.name) - self.control.ping() # TODO: there ought to be an ISlaveControl - return Redirect("..") - - def getChild(self, path, request): - if path == "force": - return self.force(request) - if path == "ping": - return self.ping(request) - if not path in ("events", "builds"): - return NoResource("Bad URL '%s'" % path) - num = request.postpath.pop(0) - request.prepath.append(num) - num = int(num) - if path == "events": - # TODO: is this dead code? .statusbag doesn't exist,right? - log.msg("getChild['path']: %s" % request.uri) - return NoResource("events are unavailable until code gets fixed") - filename = request.postpath.pop(0) - request.prepath.append(filename) - e = self.builder.statusbag.getEventNumbered(num) - if not e: - return NoResource("No such event '%d'" % num) - file = e.files.get(filename, None) - if file == None: - return NoResource("No such file '%s'" % filename) - if type(file) == type(""): - if file[:6] in ("", ""): - return static.Data(file, "text/html") - return static.Data(file, "text/plain") - return file - if path == "builds": - build = self.builder.getBuild(num) - if build: - control = None - if self.control: - control = self.control.getBuild(num) - return StatusResourceBuild(self.status, build, - self.control, control) - else: - return NoResource("No such build '%d'" % num) - return NoResource("really weird URL %s" % path) - -# $changes/NN -class StatusResourceChanges(HtmlResource): - def __init__(self, status, changemaster): - HtmlResource.__init__(self) - self.status = status - self.changemaster = changemaster - def body(self, request): - data = "" - data += "Change sources:\n" - sources = list(self.changemaster) - if sources: - data += "
    \n" - for s in sources: - data += "
  1. %s
    2. \n" % s.describe() - data += "
\n" - else: - data += "none (push only)\n" - return data - def getChild(self, path, request): - num = int(path) - c = self.changemaster.getChangeNumbered(num) - if not c: - return NoResource("No change number '%d'" % num) - return StaticHTML(c.asHTML(), "Change #%d" % num) - textlog_stylesheet = """