~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/benchmarks/bench_log.py

  • Committer: Martin Pool
  • Date: 2008-10-20 08:09:33 UTC
  • mto: This revision was merged to the branch mainline in revision 3787.
  • Revision ID: mbp@sourcefrog.net-20081020080933-xba7zw9ffozm6brl
Build zip file from 'make dist' and document this; also tweak standard announcement mail

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006 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
"""Tests for tree transform performance"""
 
18
 
 
19
import os
 
20
import sys
 
21
 
 
22
from bzrlib.benchmarks import Benchmark
 
23
from bzrlib.log import log_formatter, show_log
 
24
from bzrlib.osutils import pathjoin
 
25
from cStringIO import StringIO
 
26
from bzrlib.transform import TreeTransform
 
27
from bzrlib.workingtree import WorkingTree
 
28
 
 
29
 
 
30
class LinesDone(Exception):
 
31
    """Raised when `LineConsumer` reaches the required number of lines."""
 
32
    pass
 
33
 
 
34
 
 
35
class LineConsumer(object):
 
36
    """Count lines that are produced.
 
37
 
 
38
    When the required number of lines have been reached, raise `LinesDone`.
 
39
    """
 
40
 
 
41
    def __init__(self, required_lines):
 
42
        """Create a new consumer.
 
43
 
 
44
        :param required_lines: How many lines must be produced.
 
45
        :type required_lines: integer
 
46
        """
 
47
        self.required_lines = required_lines
 
48
 
 
49
    def write(self, text):
 
50
        """Write some text to the black hole.
 
51
 
 
52
        But count how many lines have been written.
 
53
 
 
54
        :param text: A string that would be written.
 
55
        :raise LinesDone: when the required number of lines has been reached.
 
56
        :return: None
 
57
        """
 
58
        self.required_lines -= text.count('\n')
 
59
        if self.required_lines < 0:
 
60
            raise LinesDone()
 
61
 
 
62
 
 
63
class LogBenchmark(Benchmark):
 
64
    """Benchmarks for ``'bzr log'`` performance."""
 
65
 
 
66
    def test_log(self):
 
67
        """Run log in a many-commit tree."""
 
68
        tree = self.make_many_commit_tree(hardlink=True)
 
69
        lf = log_formatter('long', to_file=StringIO())
 
70
        self.time(show_log, tree.branch, lf, direction='reverse')
 
71
 
 
72
    def test_merge_log(self):
 
73
        """Run log in a tree with many merges"""
 
74
        tree = self.make_heavily_merged_tree(hardlink=True)
 
75
        lf = log_formatter('short', to_file=StringIO())
 
76
        self.time(show_log, tree.branch, lf, direction='reverse')
 
77
 
 
78
    def test_log_screenful(self):
 
79
        """Simulate log --long|less"""
 
80
        self.screenful_tester('long')
 
81
 
 
82
    def test_log_screenful_line(self):
 
83
        """Simulate log --line|less"""
 
84
        self.screenful_tester('line')
 
85
 
 
86
    def test_log_screenful_short(self):
 
87
        """Simulate log --short|less"""
 
88
        self.screenful_tester('short')
 
89
 
 
90
    def screenful_tester(self, formatter):
 
91
        """Run show_log, but stop after 25 lines are generated"""
 
92
        tree = self.make_many_commit_tree(hardlink=True)
 
93
        def log_screenful():
 
94
            lf = log_formatter(formatter, to_file=LineConsumer(25))
 
95
            try:
 
96
                show_log(tree.branch, lf, direction='reverse')
 
97
            except LinesDone:
 
98
                pass
 
99
            else:
 
100
                raise Exception, "LinesDone not raised"
 
101
        self.time(log_screenful)
 
102
 
 
103
    def test_cmd_log(self):
 
104
        """Test execution of the log command.""" 
 
105
        tree = self.make_many_commit_tree(hardlink=True)
 
106
        self.time(self.run_bzr, ['log', '-r', '-4..'])
 
107
 
 
108
    def test_cmd_log_subprocess(self):
 
109
        """Text startup and execution of the log command.""" 
 
110
        tree = self.make_many_commit_tree(hardlink=True)
 
111
        self.time(self.run_bzr_subprocess, 'log', '-r', '-4..')
 
112
 
 
113
    def test_log_verbose(self):
 
114
        """'verbose' log -- shows file changes"""
 
115
        tree = self.make_many_commit_tree(hardlink=True)
 
116
        lf = log_formatter('long', to_file=StringIO())
 
117
        self.time(show_log, tree.branch, lf, direction='reverse', verbose=True)