← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_source.py

merge with bzr.dev revno.1860

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_source.py
 
1
# Copyright (C) 2005 by Canonical Ltd
 
2
#   Authors: Robert Collins <robert.collins@canonical.com>
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
"""These tests are tests about the source code of bzrlib itself.
 
19
 
 
20
They are useful for testing code quality, checking coverage metric etc.
 
21
"""
 
22
 
 
23
# import system imports here
 
24
import os
 
25
import sys
 
26
 
 
27
#import bzrlib specific imports here
 
28
from bzrlib.tests import TestCase
 
29
import bzrlib.branch
 
30
 
 
31
 
 
32
class TestApiUsage(TestCase):
 
33
 
 
34
    def find_occurences(self, rule, filename):
 
35
        """Find the number of occurences of rule in a file."""
 
36
        occurences = 0
 
37
        source = file(filename, 'r')
 
38
        for line in source:
 
39
            if line.find(rule) > -1:
 
40
                occurences += 1
 
41
        return occurences
 
42
 
 
43
    def source_file_name(self, package):
 
44
        """Return the path of the .py file for package."""
 
45
        path = package.__file__
 
46
        if path[-1] in 'co':
 
47
            return path[:-1]
 
48
        else:
 
49
            return path
 
50
 
 
51
    def test_branch_working_tree(self):
 
52
        """Test that the number of uses of working_tree in branch is stable."""
 
53
        occurences = self.find_occurences('self.working_tree()',
 
54
                                          self.source_file_name(bzrlib.branch))
 
55
        # do not even think of increasing this number. If you think you need to
 
56
        # increase it, then you almost certainly are doing something wrong as
 
57
        # the relationship from working_tree to branch is one way.
 
58
        # Note that this is an exact equality so that when the number drops, 
 
59
        #it is not given a buffer but rather has this test updated immediately.
 
60
        self.assertEqual(0, occurences)
 
61
 
 
62
    def test_branch_WorkingTree(self):
 
63
        """Test that the number of uses of working_tree in branch is stable."""
 
64
        occurences = self.find_occurences('WorkingTree',
 
65
                                          self.source_file_name(bzrlib.branch))
 
66
        # do not even think of increasing this number. If you think you need to
 
67
        # increase it, then you almost certainly are doing something wrong as
 
68
        # the relationship from working_tree to branch is one way.
 
69
        # This number should be 4 (import NoWorkingTree and WorkingTree, 
 
70
        # raise NoWorkingTree from working_tree(), and construct a working tree
 
71
        # there) but a merge that regressed this was done before this test was
 
72
        # written. Note that this is an exact equality so that when the number
 
73
        # drops, it is not given a buffer but rather this test updated
 
74
        # immediately.
 
75
        self.assertEqual(2, occurences)