← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Andrew Bennetts
  • Date: 2011-06-28 16:51:55 UTC
  • mto: This revision was merged to the branch mainline in revision 452.
  • Revision ID: andrew.bennetts@canonical.com-20110628165155-4a4h387hq7br0e5f
Allow /diff/1 to work, and so show the 'download diff' link on the revision page for revision 1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
__init__.py
1
 
# Copyright 2009 Canonical Ltd
 
1
# Copyright 2009, 2010, 2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
26
26
 
27
27
"""Loggerhead web viewer for Bazaar branches.
28
28
 
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.
31
31
"""
32
32
 
33
 
version_info = (1, 17, 0)
 
33
import sys
 
34
 
 
35
from info import (
 
36
    bzr_plugin_version as version_info,
 
37
    bzr_compatible_versions,
 
38
    )
34
39
 
35
40
if __name__ == 'bzrlib.plugins.loggerhead':
36
41
    import bzrlib
37
42
    from bzrlib.api import require_any_api
38
 
 
39
 
    require_any_api(bzrlib, [
40
 
        (1, 13, 0), (1, 15, 0), (1, 16, 0), (1, 17, 0), (1, 18, 0),
41
 
        (2, 0, 0), (2, 1, 0), (2, 2, 0)])
42
 
 
43
 
    # NB: Normally plugins should lazily load almost everything, but this
44
 
    # seems reasonable to have in-line here: bzrlib.commands and options are
45
 
    # normally loaded, and the rest of loggerhead won't be loaded until serve
46
 
    # --http is run.
47
 
 
48
 
    # transport_server_registry was added in bzr 1.16. When we drop support for
49
 
    # older releases, we can remove the code to override cmd_serve.
50
 
 
51
 
    try:
52
 
        from bzrlib.transport import transport_server_registry
53
 
    except ImportError:
54
 
        transport_server_registry = None
 
43
    from bzrlib import commands
 
44
 
 
45
    require_any_api(bzrlib, bzr_compatible_versions)
 
46
 
 
47
    from bzrlib.transport import transport_server_registry
55
48
 
56
49
    DEFAULT_HOST = '0.0.0.0'
57
50
    DEFAULT_PORT = 8080
58
51
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
59
52
            (DEFAULT_PORT,))
60
53
 
61
 
    def serve_http(transport, host=None, port=None, inet=None):
62
 
        from paste.httpexceptions import HTTPExceptionHandler
63
 
        from paste.httpserver import serve
64
 
 
 
54
    def _ensure_loggerhead_path():
 
55
        """Ensure that you can 'import loggerhead' and get the root."""
65
56
        # loggerhead internal code will try to 'import loggerhead', so
66
57
        # let's put it on the path if we can't find it in the existing path
67
58
        try:
68
 
            import loggerhead
 
59
            import loggerhead.apps.transport
69
60
        except ImportError:
70
61
            import os.path, sys
71
62
            sys.path.append(os.path.dirname(__file__))
72
63
 
 
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
 
71
 
 
72
        _ensure_loggerhead_path()
 
73
 
 
74
        from loggerhead.apps.http_head import HeadMiddleware
73
75
        from loggerhead.apps.transport import BranchesFromTransportRoot
74
76
        from loggerhead.config import LoggerheadConfig
 
77
        from loggerhead.main import setup_logging
75
78
 
76
79
        if host is None:
77
80
            host = DEFAULT_HOST
81
84
        if not transport.is_readonly():
82
85
            argv.insert(0, '--allow-writes')
83
86
        config = LoggerheadConfig(argv)
 
87
        setup_logging(config, init_logging=False, log_file=sys.stderr)
84
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)
85
93
        app = HTTPExceptionHandler(app)
86
94
        serve(app, host=host, port=port)
87
95
 
88
 
    if transport_server_registry is not None:
89
 
        transport_server_registry.register('http', serve_http, help=HELP)
90
 
    else:
91
 
        import bzrlib.builtins
92
 
        from bzrlib.commands import get_cmd_object, register_command
93
 
        from bzrlib.option import Option
94
 
 
95
 
        _original_command = get_cmd_object('serve')
96
 
 
97
 
        class cmd_serve(bzrlib.builtins.cmd_serve):
98
 
            __doc__ = _original_command.__doc__
99
 
 
100
 
            takes_options = _original_command.takes_options + [
101
 
                Option('http', help=HELP)]
102
 
 
103
 
            def run(self, *args, **kw):
104
 
                if 'http' in kw:
105
 
                    from bzrlib.transport import get_transport
106
 
                    allow_writes = kw.get('allow_writes', False)
107
 
                    path = kw.get('directory', '.')
108
 
                    port = kw.get('port', DEFAULT_PORT)
109
 
                    # port might be an int already...
110
 
                    if isinstance(port, basestring) and ':' in port:
111
 
                        host, port = port.split(':')
112
 
                    else:
113
 
                        host = DEFAULT_HOST
114
 
                    if allow_writes:
115
 
                        transport = get_transport(path)
116
 
                    else:
117
 
                        transport = get_transport('readonly+' + path)
118
 
                    serve_http(transport, host, port)
119
 
                else:
120
 
                    super(cmd_serve, self).run(*args, **kw)
121
 
 
122
 
        register_command(cmd_serve)
 
96
    transport_server_registry.register('http', serve_http, help=HELP)
 
97
 
 
98
    class cmd_load_test_loggerhead(commands.Command):
 
99
        """Run a load test against a live loggerhead instance.
 
100
 
 
101
        Pass in the name of a script file to run. See loggerhead/load_test.py
 
102
        for a description of the file format.
 
103
        """
 
104
 
 
105
        takes_args = ["filename"]
 
106
 
 
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))
 
115
 
 
116
    commands.register_command(cmd_load_test_loggerhead)
 
117
 
 
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