← 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, 2010, 2011 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
# This file allows loggerhead to be treated as a plugin for bzr.
 
19
#
 
20
# XXX: Because loggerhead already contains a loggerhead directory, much of the
 
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
# directory to be the module, but when it's used as a library people expect
 
24
# the source directory to contain a directory called loggerhead.  -- mbp
 
25
# 20090123
 
26
 
 
27
"""Loggerhead web viewer for Bazaar branches.
 
28
 
 
29
This provides a new option "--http" to the "bzr serve" command, that
 
30
starts a web server to browse the contents of a branch.
 
31
"""
 
32
 
 
33
from info import (
 
34
    bzr_plugin_version as version_info,
 
35
    bzr_compatible_versions,
 
36
    )
 
37
 
 
38
if __name__ == 'bzrlib.plugins.loggerhead':
 
39
    import bzrlib
 
40
    from bzrlib.api import require_any_api
 
41
    from bzrlib import commands
 
42
 
 
43
    require_any_api(bzrlib, bzr_compatible_versions)
 
44
 
 
45
    from bzrlib.transport import transport_server_registry
 
46
 
 
47
    DEFAULT_HOST = '0.0.0.0'
 
48
    DEFAULT_PORT = 8080
 
49
    HELP = ('Loggerhead, a web-based code viewer and server. (default port: %d)' %
 
50
            (DEFAULT_PORT,))
 
51
 
 
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
        # 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.apps.transport
 
69
        except ImportError:
 
70
            import os.path, sys
 
71
            sys.path.append(os.path.dirname(__file__))
 
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
 
 
79
        from loggerhead.apps.transport import BranchesFromTransportRoot
 
80
        from loggerhead.config import LoggerheadConfig
 
81
 
 
82
        if host is None:
 
83
            host = DEFAULT_HOST
 
84
        if port is None:
 
85
            port = DEFAULT_PORT
 
86
        argv = ['--host', host, '--port', str(port), '--', transport.base]
 
87
        if not transport.is_readonly():
 
88
            argv.insert(0, '--allow-writes')
 
89
        config = LoggerheadConfig(argv)
 
90
        setup_logging(config)
 
91
        app = BranchesFromTransportRoot(transport.base, config)
 
92
        app = HTTPExceptionHandler(app)
 
93
        serve(app, host=host, port=port)
 
94
 
 
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