/loggerhead/trunk

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/loggerhead/trunk

« back to all changes in this revision

Viewing changes to __init__.py

  • Committer: Tres Seaver
  • Date: 2010-03-23 15:44:51 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100323154451-enjul7pa2crkk18b
Add Sphinx-based documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
__init__.py
1
 
# Copyright 2009, 2010, 2011 Canonical Ltd
 
1
# Copyright 2009 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335  USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
# This file allows loggerhead to be treated as a plugin for bzr.
19
19
#
20
20
# XXX: Because loggerhead already contains a loggerhead directory, much of the
21
 
# code is going to appear loaded at breezy.plugins.loggerhead.loggerhead.
22
 
# This seems like the easiest thing, because breezy wants the top-level plugin
 
21
# code is going to appear loaded at bzrlib.plugins.loggerhead.loggerhead.
 
22
# This seems like the easiest thing, because bzrlib wants the top-level plugin
23
23
# directory to be the module, but when it's used as a library people expect
24
24
# the source directory to contain a directory called loggerhead.  -- mbp
25
25
# 20090123
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
 
try:
34
 
    import importlib.metadata as importlib_metadata
35
 
except ImportError:
36
 
    import importlib_metadata
37
 
 
38
 
import sys
39
 
 
40
 
from packaging.version import Version
41
 
 
42
 
try:
43
 
    version_info = Version(importlib_metadata.version("loggerhead")).release
44
 
except importlib_metadata.PackageNotFoundError:
45
 
    # Support running tests from the build tree without installation.
46
 
    version_info = None
47
 
 
48
 
import breezy
49
 
from breezy import commands
50
 
from breezy.transport import transport_server_registry
51
 
 
52
 
DEFAULT_HOST = '0.0.0.0'
53
 
DEFAULT_PORT = 8080
54
 
HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
55
 
        (DEFAULT_PORT,))
56
 
 
57
 
 
58
 
def serve_http(transport, host=None, port=None, inet=None, client_timeout=None):
59
 
    # TODO: if we supported inet to pass requests in and respond to them,
60
 
    #       then it would be easier to test the full stack, but it probably
61
 
    #       means routing around paste.httpserver.serve which probably
62
 
    #       isn't testing the full stack
63
 
    from paste.httpexceptions import HTTPExceptionHandler
64
 
    from paste.httpserver import serve
 
33
version_info = (1, 17, 0)
 
34
 
 
35
if __name__ == 'bzrlib.plugins.loggerhead':
 
36
    import bzrlib
 
37
    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.
65
50
 
66
51
    try:
67
 
        from .loggerhead.apps.http_head import HeadMiddleware
68
 
        from .loggerhead.apps.transport import BranchesFromTransportRoot
69
 
        from .loggerhead.config import LoggerheadConfig
70
 
        from .loggerhead.__main__ import setup_logging
 
52
        from bzrlib.transport import transport_server_registry
71
53
    except ImportError:
72
 
        from loggerhead.apps.http_head import HeadMiddleware
 
54
        transport_server_registry = None
 
55
 
 
56
    DEFAULT_HOST = '0.0.0.0'
 
57
    DEFAULT_PORT = 8080
 
58
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
 
59
            (DEFAULT_PORT,))
 
60
 
 
61
    def serve_http(transport, host=None, port=None, inet=None):
 
62
        from paste.httpexceptions import HTTPExceptionHandler
 
63
        from paste.httpserver import serve
 
64
 
 
65
        # loggerhead internal code will try to 'import loggerhead', so
 
66
        # let's put it on the path if we can't find it in the existing path
 
67
        try:
 
68
            import loggerhead
 
69
        except ImportError:
 
70
            import os.path, sys
 
71
            sys.path.append(os.path.dirname(__file__))
 
72
 
73
73
        from loggerhead.apps.transport import BranchesFromTransportRoot
74
74
        from loggerhead.config import LoggerheadConfig
75
 
        from loggerhead.__main__ import setup_logging
76
 
 
77
 
    if host is None:
78
 
        host = DEFAULT_HOST
79
 
    if port is None:
80
 
        port = DEFAULT_PORT
81
 
    argv = ['--host', host, '--port', str(port), '--', transport.base]
82
 
    if not transport.is_readonly():
83
 
        argv.insert(0, '--allow-writes')
84
 
    config = LoggerheadConfig(argv)
85
 
    setup_logging(config, init_logging=False, log_file=sys.stderr)
86
 
    app = BranchesFromTransportRoot(transport.base, config)
87
 
    # Bug #758618, HeadMiddleware seems to break HTTPExceptionHandler from
88
 
    # actually sending appropriate return codes to the client. Since nobody
89
 
    # desperately needs HeadMiddleware right now, just ignoring it.
90
 
    # app = HeadMiddleware(app)
91
 
    app = HTTPExceptionHandler(app)
92
 
    serve(app, host=host, port=port)
93
 
 
94
 
transport_server_registry.register('http', serve_http, help=HELP)
95
 
 
96
 
class cmd_load_test_loggerhead(commands.Command):
97
 
    """Run a load test against a live loggerhead instance.
98
 
 
99
 
    Pass in the name of a script file to run. See loggerhead/load_test.py
100
 
    for a description of the file format.
101
 
    """
102
 
 
103
 
    hidden = True
104
 
    takes_args = ["filename"]
105
 
 
106
 
    def run(self, filename):
107
 
        try:
108
 
            from .loggerhead.loggerhead import load_test
109
 
        except ImportError:
110
 
            from loggerhead.loggerhead import load_test
111
 
        script = load_test.run_script(filename)
112
 
        for thread_id in sorted(script._threads):
113
 
            worker = script._threads[thread_id][0]
114
 
            for url, success, time in worker.stats:
115
 
                self.outf.write(' %5.3fs %s %s\n'
116
 
                                % (time, str(success)[0], url))
117
 
 
118
 
commands.register_command(cmd_load_test_loggerhead)
119
 
 
120
 
def load_tests(loader, basic_tests, pattern):
121
 
    try:
122
 
        from .loggerhead.tests import test_suite
123
 
    except ImportError:
124
 
        from breezy.trace import mutter
125
 
        mutter(
126
 
            'loggerhead tests not installed, not registering tests')
 
75
 
 
76
        if host is None:
 
77
            host = DEFAULT_HOST
 
78
        if port is None:
 
79
            port = DEFAULT_PORT
 
80
        argv = ['--host', host, '--port', str(port), '--', transport.base]
 
81
        if not transport.is_readonly():
 
82
            argv.insert(0, '--allow-writes')
 
83
        config = LoggerheadConfig(argv)
 
84
        app = BranchesFromTransportRoot(transport.base, config)
 
85
        app = HTTPExceptionHandler(app)
 
86
        serve(app, host=host, port=port)
 
87
 
 
88
    if transport_server_registry is not None:
 
89
        transport_server_registry.register('http', serve_http, help=HELP)
127
90
    else:
128
 
        basic_tests.addTest(test_suite())
129
 
    return basic_tests
 
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)