← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_source.py

  • Committer: John Arbash Meinel
  • Date: 2006-10-05 05:37:25 UTC
  • mto: This revision was merged to the branch mainline in revision 2080.
  • Revision ID: john@arbash-meinel.com-20061005053725-3d2e757dab45eb94
Add tests to cleanup the copyright of all source files

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_source.py
22
22
 
23
23
# import system imports here
24
24
import os
 
25
import re
25
26
import sys
26
27
 
27
28
#import bzrlib specific imports here
28
 
from bzrlib.tests import TestCase
 
29
from bzrlib import (
 
30
    osutils,
 
31
    )
29
32
import bzrlib.branch
30
 
 
31
 
 
32
 
class TestApiUsage(TestCase):
 
33
from bzrlib.tests import TestCase, TestSkipped
 
34
 
 
35
 
 
36
class TestSourceHelper(TestCase):
 
37
 
 
38
    def source_file_name(self, package):
 
39
        """Return the path of the .py file for package."""
 
40
        path = package.__file__
 
41
        if path[-1] in 'co':
 
42
            return path[:-1]
 
43
        else:
 
44
            return path
 
45
 
 
46
 
 
47
class TestApiUsage(TestSourceHelper):
33
48
 
34
49
    def find_occurences(self, rule, filename):
35
50
        """Find the number of occurences of rule in a file."""
40
55
                occurences += 1
41
56
        return occurences
42
57
 
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
58
    def test_branch_working_tree(self):
52
59
        """Test that the number of uses of working_tree in branch is stable."""
53
60
        occurences = self.find_occurences('self.working_tree()',
73
80
        # drops, it is not given a buffer but rather this test updated
74
81
        # immediately.
75
82
        self.assertEqual(2, occurences)
 
83
 
 
84
 
 
85
class TestSource(TestSourceHelper):
 
86
 
 
87
    def get_bzrlib_dir(self):
 
88
        """Get the path to the root of bzrlib"""
 
89
        source = self.source_file_name(bzrlib)
 
90
        source_dir = os.path.dirname(source)
 
91
 
 
92
        # Avoid the case when bzrlib is packaged in a zip file
 
93
        if not os.path.isdir(source_dir):
 
94
            raise TestSkipped('Cannot find bzrlib source directory. Expected %s'
 
95
                              % source_dir)
 
96
        return source_dir
 
97
 
 
98
    def get_source_files(self):
 
99
        """yield all source files for bzr and bzrlib"""
 
100
        bzrlib_dir = self.get_bzrlib_dir()
 
101
 
 
102
        # This is the front-end 'bzr' script
 
103
        bzr_path = self.get_bzr_path()
 
104
        yield bzr_path
 
105
 
 
106
        for root, dirs, files in os.walk(bzrlib_dir):
 
107
            for f in files:
 
108
                if not f.endswith('.py'):
 
109
                    continue
 
110
                yield osutils.pathjoin(root, f)
 
111
 
 
112
    def get_source_file_contents(self):
 
113
        for fname in self.get_source_files():
 
114
            f = open(fname, 'rb')
 
115
            try:
 
116
                text = f.read()
 
117
            finally:
 
118
                f.close()
 
119
            yield fname, text
 
120
 
 
121
    def is_exception(self, fname):
 
122
        """Certain files are allowed to be different"""
 
123
        if '/util/' in fname:
 
124
            # We don't require external utilities to be (C) Canonical Ltd
 
125
            return True
 
126
 
 
127
        exceptions = ['bzrlib/lsprof.py',
 
128
                      'bzrlib/conflicts.py',
 
129
                      'bzrlib/iterablefile.py',
 
130
                      'bzrlib/patches.py',
 
131
                      'bzrlib/tests/test_patches.py',
 
132
                     ]
 
133
        for exc in exceptions:
 
134
            if fname.endswith(exc):
 
135
                return True
 
136
 
 
137
        return False
 
138
 
 
139
    def test_copyright(self):
 
140
        """Test that all .py files have a valid copyright statement"""
 
141
        # These are files which contain a different copyright statement
 
142
        # and that is okay.
 
143
        incorrect = []
 
144
 
 
145
        copyright_re = re.compile('#\\s*copyright.*\n', re.I)
 
146
        copyright_canonical_re = re.compile(
 
147
            r'# Copyright \(C\) ' # Opening "# Copyright (C)"
 
148
            r'(\d+)(, \d+)*' # Followed by a series of dates
 
149
            r'.*Canonical Ltd' # And containing 'Canonical Ltd'
 
150
            )
 
151
 
 
152
        for fname, text in self.get_source_file_contents():
 
153
            if self.is_exception(fname):
 
154
                continue
 
155
            if not copyright_canonical_re.search(text):
 
156
                m = copyright_re.search(text)
 
157
                if m:
 
158
                    incorrect.append((fname, 'found: %s' % (m.group(),)))
 
159
                else:
 
160
                    incorrect.append((fname, 'no copyright line found\n'))
 
161
 
 
162
        if incorrect:
 
163
            help_text = ["Some files have missing or incorrect copyright"
 
164
                         " statements.",
 
165
                         "Please add '# Copyright (C) 2006 Canonical Ltd'"
 
166
                         " to these files:",
 
167
                         "",
 
168
                        ]
 
169
            for fname, comment in incorrect:
 
170
                help_text.append(fname)
 
171
                help_text.append((' '*4) + comment)
 
172
 
 
173
            self.fail('\n'.join(help_text))
 
174
 
 
175
    def test_gpl(self):
 
176
        """Test that all .py files have a GPL disclaimer"""
 
177
        incorrect = []
 
178
 
 
179
        gpl_txt = """
 
180
# This program is free software; you can redistribute it and/or modify
 
181
# it under the terms of the GNU General Public License as published by
 
182
# the Free Software Foundation; either version 2 of the License, or
 
183
# (at your option) any later version.
 
184
#
 
185
# This program is distributed in the hope that it will be useful,
 
186
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
187
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
188
# GNU General Public License for more details.
 
189
#
 
190
# You should have received a copy of the GNU General Public License
 
191
# along with this program; if not, write to the Free Software
 
192
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
193
"""
 
194
        gpl_re = re.compile(re.escape(gpl_txt), re.MULTILINE)
 
195
 
 
196
        for fname, text in self.get_source_file_contents():
 
197
            if self.is_exception(fname):
 
198
                continue
 
199
            if not gpl_re.search(text):
 
200
                incorrect.append(fname)
 
201
 
 
202
        if incorrect:
 
203
            help_text = ['Some files have missing or incomplete GPL statement',
 
204
                         'Please fix the following files to have text:',
 
205
                         gpl_txt
 
206
                        ]
 
207
            for fname in incorrect:
 
208
                help_text.append((' '*4) + fname)
 
209
 
 
210
            self.fail('\n'.join(help_text))