27
27
"""Loggerhead web viewer for Bazaar branches.
29
This provides a new option "--http" to the "bzr serve" command, that
29
This provides a new option "--http" to the "bzr serve" command, that
30
30
starts a web server to browse the contents of a branch.
36
bzr_plugin_version as version_info,
37
bzr_compatible_versions,
33
version_info = (1, 11, 0)
40
35
if __name__ == 'bzrlib.plugins.loggerhead':
42
37
from bzrlib.api import require_any_api
43
from bzrlib import commands
45
require_any_api(bzrlib, bzr_compatible_versions)
47
from bzrlib.transport import transport_server_registry
49
DEFAULT_HOST = '0.0.0.0'
39
require_any_api(bzrlib, [(1, 11, 0), (1, 13, 0)])
41
# TODO: This should provide a new type of server that can be used by bzr
42
# serve, maybe through a registry, rather than overriding the command. Though
43
# maybe we should keep the wrapper to work with older bzr releases, at least
46
# NB: Normally plugins should lazily load almost everything, but this
47
# seems reasonable to have in-line here: bzrlib.commands and options are
48
# normally loaded, and the rest of loggerhead won't be loaded until serve
51
import bzrlib.builtins
52
from bzrlib.commands import get_cmd_object, register_command
53
from bzrlib.option import Option
55
_original_command = get_cmd_object('serve')
50
57
DEFAULT_PORT = 8080
51
HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
54
def _ensure_loggerhead_path():
55
"""Ensure that you can 'import loggerhead' and get the root."""
56
# loggerhead internal code will try to 'import loggerhead', so
57
# let's put it on the path if we can't find it in the existing path
59
import loggerhead.apps.transport
62
sys.path.append(os.path.dirname(__file__))
64
def serve_http(transport, host=None, port=None, inet=None):
65
# TODO: if we supported inet to pass requests in and respond to them,
66
# then it would be easier to test the full stack, but it probably
67
# means routing around paste.httpserver.serve which probably
68
# isn't testing the full stack
69
from paste.httpexceptions import HTTPExceptionHandler
70
from paste.httpserver import serve
72
_ensure_loggerhead_path()
74
from loggerhead.apps.http_head import HeadMiddleware
75
from loggerhead.apps.transport import BranchesFromTransportRoot
76
from loggerhead.config import LoggerheadConfig
77
from loggerhead.main import setup_logging
83
argv = ['--host', host, '--port', str(port), '--', transport.base]
84
if not transport.is_readonly():
85
argv.insert(0, '--allow-writes')
86
config = LoggerheadConfig(argv)
87
setup_logging(config, init_logging=False, log_file=sys.stderr)
88
app = BranchesFromTransportRoot(transport.base, config)
89
# Bug #758618, HeadMiddleware seems to break HTTPExceptionHandler from
90
# actually sending appropriate return codes to the client. Since nobody
91
# desperately needs HeadMiddleware right now, just ignoring it.
92
# app = HeadMiddleware(app)
93
app = HTTPExceptionHandler(app)
94
serve(app, host=host, port=port)
96
transport_server_registry.register('http', serve_http, help=HELP)
98
class cmd_load_test_loggerhead(commands.Command):
99
"""Run a load test against a live loggerhead instance.
101
Pass in the name of a script file to run. See loggerhead/load_test.py
102
for a description of the file format.
105
takes_args = ["filename"]
107
def run(self, filename):
108
from bzrlib.plugins.loggerhead.loggerhead import load_test
109
script = load_test.run_script(filename)
110
for thread_id in sorted(script._threads):
111
worker = script._threads[thread_id][0]
112
for url, success, time in worker.stats:
113
self.outf.write(' %5.3fs %s %s\n'
114
% (time, str(success)[0], url))
116
commands.register_command(cmd_load_test_loggerhead)
118
def load_tests(standard_tests, module, loader):
119
_ensure_loggerhead_path()
120
standard_tests.addTests(loader.loadTestsFromModuleNames(
121
['bzrlib.plugins.loggerhead.loggerhead.tests']))
122
return standard_tests
59
class cmd_serve(bzrlib.builtins.cmd_serve):
60
__doc__ = _original_command.__doc__
62
takes_options = _original_command.takes_options + [
64
help='Run an http (Loggerhead) server to browse code, '
65
'by default on port %s.' % DEFAULT_PORT)]
67
def run(self, *args, **kw):
69
# loggerhead internal code will try to 'import loggerhead', so
70
# let's put it on the path
72
sys.path.append(os.path.dirname(__file__))
74
from loggerhead.apps.filesystem import BranchesFromFileSystemRoot
75
from paste.httpexceptions import HTTPExceptionHandler
76
from paste.httpserver import serve
77
a = HTTPExceptionHandler(BranchesFromFileSystemRoot('.'))
78
port = kw.get('port', DEFAULT_PORT)
79
# port might be an int already...
80
if isinstance(port, basestring) and ':' in port:
81
host, port = port.split(':')
84
serve(a, host=host, port=port)
86
super(cmd_serve, self).run(*args, **kw)
88
register_command(cmd_serve)