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
39
require_any_api(bzrlib, [(1, 13, 0), (1, 15, 0), (1, 16, 0), (1, 17, 0)])
41
# NB: Normally plugins should lazily load almost everything, but this
42
# seems reasonable to have in-line here: bzrlib.commands and options are
43
# normally loaded, and the rest of loggerhead won't be loaded until serve
46
# transport_server_registry was added in bzr 1.16. When we drop support for
47
# older releases, we can remove the code to override cmd_serve.
50
from bzrlib.transport import transport_server_registry
52
transport_server_registry = None
49
54
DEFAULT_HOST = '0.0.0.0'
50
55
DEFAULT_PORT = 8080
51
56
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."""
59
def serve_http(transport, host=None, port=None, inet=None):
56
60
# loggerhead internal code will try to 'import loggerhead', so
57
61
# let's put it on the path if we can't find it in the existing path
59
import loggerhead.apps.transport
60
64
except ImportError:
61
65
import os.path, sys
62
66
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
68
from loggerhead.apps.transport import BranchesFromTransportRoot
69
from loggerhead.config import LoggerheadConfig
69
70
from paste.httpexceptions import HTTPExceptionHandler
70
71
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
80
73
host = DEFAULT_HOST
84
77
if not transport.is_readonly():
85
78
argv.insert(0, '--allow-writes')
86
79
config = LoggerheadConfig(argv)
87
setup_logging(config, init_logging=False, log_file=sys.stderr)
88
app = BranchesFromTransportRoot(transport.base, config)
89
app = HeadMiddleware(app)
80
app = BranchesFromTransportRoot(transport, config)
90
81
app = HTTPExceptionHandler(app)
91
82
serve(app, host=host, port=port)
93
transport_server_registry.register('http', serve_http, help=HELP)
95
class cmd_load_test_loggerhead(commands.Command):
96
"""Run a load test against a live loggerhead instance.
98
Pass in the name of a script file to run. See loggerhead/load_test.py
99
for a description of the file format.
102
takes_args = ["filename"]
104
def run(self, filename):
105
from bzrlib.plugins.loggerhead.loggerhead import load_test
106
script = load_test.run_script(filename)
107
for thread_id in sorted(script._threads):
108
worker = script._threads[thread_id][0]
109
for url, success, time in worker.stats:
110
self.outf.write(' %5.3fs %s %s\n'
111
% (time, str(success)[0], url))
113
commands.register_command(cmd_load_test_loggerhead)
115
def load_tests(standard_tests, module, loader):
116
_ensure_loggerhead_path()
117
standard_tests.addTests(loader.loadTestsFromModuleNames(
118
['bzrlib.plugins.loggerhead.loggerhead.tests']))
119
return standard_tests
84
if transport_server_registry is not None:
85
transport_server_registry.register('http', serve_http, help=HELP)
87
import bzrlib.builtins
88
from bzrlib.commands import get_cmd_object, register_command
89
from bzrlib.option import Option
91
_original_command = get_cmd_object('serve')
93
class cmd_serve(bzrlib.builtins.cmd_serve):
94
__doc__ = _original_command.__doc__
96
takes_options = _original_command.takes_options + [
97
Option('http', help=HELP)]
99
def run(self, *args, **kw):
101
from bzrlib.transport import get_transport
102
allow_writes = kw.get('allow_writes', False)
103
path = kw.get('directory', '.')
104
port = kw.get('port', DEFAULT_PORT)
105
# port might be an int already...
106
if isinstance(port, basestring) and ':' in port:
107
host, port = port.split(':')
111
transport = get_transport(path)
113
transport = get_transport('readonly+' + path)
114
serve_http(transport, host, port)
116
super(cmd_serve, self).run(*args, **kw)
118
register_command(cmd_serve)