← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: John Arbash Meinel
  • Date: 2011-02-10 23:05:31 UTC
  • mto: This revision was merged to the branch mainline in revision 426.
  • Revision ID: john@arbash-meinel.com-20110210230531-spb87czp526tljp7
Add a NEWS update, and HACKING commentary about the new code.

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
from info import (
 
34
    bzr_plugin_version as version_info,
 
35
    bzr_compatible_versions,
 
36
    )
34
37
 
35
38
if __name__ == 'bzrlib.plugins.loggerhead':
36
39
    import bzrlib
37
40
    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)])
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
 
41
    from bzrlib import commands
 
42
 
 
43
    require_any_api(bzrlib, bzr_compatible_versions)
 
44
 
 
45
    from bzrlib.transport import transport_server_registry
55
46
 
56
47
    DEFAULT_HOST = '0.0.0.0'
57
48
    DEFAULT_PORT = 8080
58
49
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
59
50
            (DEFAULT_PORT,))
60
51
 
61
 
    def serve_http(transport, host=None, port=None, inet=None):
62
 
        from paste.httpexceptions import HTTPExceptionHandler
63
 
        from paste.httpserver import serve
64
 
 
 
52
    def setup_logging(config):
 
53
        import logging
 
54
        import sys
 
55
 
 
56
        logger = logging.getLogger('loggerhead')
 
57
        handler = logging.StreamHandler(sys.stderr)
 
58
        handler.setLevel(logging.DEBUG)
 
59
        logger.addHandler(handler)
 
60
        logging.getLogger('simpleTAL').addHandler(handler)
 
61
        logging.getLogger('simpleTALES').addHandler(handler)
 
62
 
 
63
    def _ensure_loggerhead_path():
 
64
        """Ensure that you can 'import loggerhead' and get the root."""
65
65
        # loggerhead internal code will try to 'import loggerhead', so
66
66
        # let's put it on the path if we can't find it in the existing path
67
67
        try:
68
 
            import loggerhead
 
68
            import loggerhead.apps.transport
69
69
        except ImportError:
70
70
            import os.path, sys
71
71
            sys.path.append(os.path.dirname(__file__))
72
72
 
 
73
    def serve_http(transport, host=None, port=None, inet=None):
 
74
        from paste.httpexceptions import HTTPExceptionHandler
 
75
        from paste.httpserver import serve
 
76
 
 
77
        _ensure_loggerhead_path()
 
78
 
73
79
        from loggerhead.apps.transport import BranchesFromTransportRoot
74
80
        from loggerhead.config import LoggerheadConfig
75
81
 
81
87
        if not transport.is_readonly():
82
88
            argv.insert(0, '--allow-writes')
83
89
        config = LoggerheadConfig(argv)
 
90
        setup_logging(config)
84
91
        app = BranchesFromTransportRoot(transport.base, config)
85
92
        app = HTTPExceptionHandler(app)
86
93
        serve(app, host=host, port=port)
87
94
 
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)
 
95
    transport_server_registry.register('http', serve_http, help=HELP)
 
96
 
 
97
    class cmd_load_test_loggerhead(commands.Command):
 
98
        """Run a load test against a live loggerhead instance.
 
99
 
 
100
        Pass in the name of a script file to run. See loggerhead/load_test.py
 
101
        for a description of the file format.
 
102
        """
 
103
 
 
104
        takes_args = ["filename"]
 
105
 
 
106
        def run(self, filename):
 
107
            from bzrlib.plugins.loggerhead.loggerhead import load_test
 
108
            script = load_test.run_script(filename)
 
109
            for thread_id in sorted(script._threads):
 
110
                worker = script._threads[thread_id][0]
 
111
                for url, success, time in worker.stats:
 
112
                    self.outf.write(' %5.3fs %s %s\n'
 
113
                                    % (time, str(success)[0], url))
 
114
 
 
115
    commands.register_command(cmd_load_test_loggerhead)
 
116
 
 
117
    def load_tests(standard_tests, module, loader):
 
118
        _ensure_loggerhead_path()
 
119
        standard_tests.addTests(loader.loadTestsFromModuleNames(
 
120
            ['bzrlib.plugins.loggerhead.loggerhead.tests']))
 
121
        return standard_tests