~bzr-pqm/bzr/bzr.dev

4934.1.12 by John Arbash Meinel
Revert all of the extension code.
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
16
1685.1.45 by John Arbash Meinel
Moved url functions into bzrlib.urlutils
17
"""Tests for the osutils wrapper."""
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
18
3504.4.12 by John Arbash Meinel
A couple small cleanups, make test_osutils more correct
19
from cStringIO import StringIO
1732.1.28 by John Arbash Meinel
Add tests for fancy file types.
20
import errno
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
21
import os
4183.6.4 by Martin Pool
Separate out re_compile_checked
22
import re
1732.1.28 by John Arbash Meinel
Add tests for fancy file types.
23
import socket
24
import stat
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
25
import sys
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
26
import time
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
27
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
28
from bzrlib import (
29
    errors,
30
    osutils,
3504.4.1 by John Arbash Meinel
Write an alternative 'walkdirs' implementation that uses win32 apis.
31
    tests,
4695.4.1 by Martin Pool
Give a shorter/cleaner message for missing extensions
32
    trace,
2279.4.1 by Alexander Belchenko
Reimplementation of ntpath.abspath in Python for Windows98: unicode safe, UNC path safe
33
    win32utils,
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
34
    )
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
35
from bzrlib.tests import (
36
    file_utils,
37
    test__walkdirs_win32,
38
    )
4297.1.1 by Vincent Ladeuil
Trivial cleanups.
39
40
4241.14.3 by Vincent Ladeuil
Cleanup imports.
41
class _UTF8DirReaderFeature(tests.Feature):
1739.2.12 by Robert Collins
Add ReadDirFeature as per John's review.
42
43
    def _probe(self):
44
        try:
45
            from bzrlib import _readdir_pyx
3696.3.5 by Robert Collins
Streamline _walkdirs_utf8 for utf8 file systems, reducing time to traverse a mozilla tree from 1s to .6 seconds. (Robert Collins)
46
            self.reader = _readdir_pyx.UTF8DirReader
1739.2.12 by Robert Collins
Add ReadDirFeature as per John's review.
47
            return True
48
        except ImportError:
49
            return False
50
51
    def feature_name(self):
1739.2.13 by Robert Collins
Fix typo in ReadDirFeature.
52
        return 'bzrlib._readdir_pyx'
1739.2.12 by Robert Collins
Add ReadDirFeature as per John's review.
53
3696.3.5 by Robert Collins
Streamline _walkdirs_utf8 for utf8 file systems, reducing time to traverse a mozilla tree from 1s to .6 seconds. (Robert Collins)
54
UTF8DirReaderFeature = _UTF8DirReaderFeature()
1739.2.12 by Robert Collins
Add ReadDirFeature as per John's review.
55
4913.2.20 by John Arbash Meinel
Change all of the compiled_foo to compiled_foo_feature
56
term_ios_feature = tests.ModuleAvailableFeature('termios')
4873.2.2 by John Arbash Meinel
Change the TIOCGWINSZ test to use a _ModuleFeature. (fixes bug #492561)
57
4241.14.24 by Vincent Ladeuil
Fixed as per John's review.
58
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
59
def _already_unicode(s):
60
    return s
61
4241.14.24 by Vincent Ladeuil
Fixed as per John's review.
62
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
63
def _utf8_to_unicode(s):
64
    return s.decode('UTF-8')
65
4241.14.24 by Vincent Ladeuil
Fixed as per John's review.
66
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
67
def dir_reader_scenarios():
68
    # For each dir reader we define:
69
70
    # - native_to_unicode: a function converting the native_abspath as returned
71
    #   by DirReader.read_dir to its unicode representation
72
73
    # UnicodeDirReader is the fallback, it should be tested on all platforms.
4241.14.24 by Vincent Ladeuil
Fixed as per John's review.
74
    scenarios = [('unicode',
75
                  dict(_dir_reader_class=osutils.UnicodeDirReader,
76
                       _native_to_unicode=_already_unicode))]
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
77
    # Some DirReaders are platform specific and even there they may not be
78
    # available.
79
    if UTF8DirReaderFeature.available():
80
        from bzrlib import _readdir_pyx
4241.14.24 by Vincent Ladeuil
Fixed as per John's review.
81
        scenarios.append(('utf8',
82
                          dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
83
                               _native_to_unicode=_utf8_to_unicode)))
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
84
4913.2.24 by John Arbash Meinel
Track down a few more import typos.
85
    if test__walkdirs_win32.win32_readdir_feature.available():
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
86
        try:
87
            from bzrlib import _walkdirs_win32
4241.14.24 by Vincent Ladeuil
Fixed as per John's review.
88
            scenarios.append(
89
                ('win32',
90
                 dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
4789.25.3 by John Arbash Meinel
For DirReader tests, the 'fs path' on win32 is a Unicode string, no need to decode/encode.
91
                      _native_to_unicode=_already_unicode)))
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
92
        except ImportError:
93
            pass
94
    return scenarios
95
96
97
def load_tests(basic_tests, module, loader):
98
    suite = loader.suiteClass()
99
    dir_reader_tests, remaining_tests = tests.split_suite_by_condition(
100
        basic_tests, tests.condition_isinstance(TestDirReader))
101
    tests.multiply_tests(dir_reader_tests, dir_reader_scenarios(), suite)
102
    suite.addTest(remaining_tests)
103
    return suite
104
1739.2.12 by Robert Collins
Add ReadDirFeature as per John's review.
105
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
106
class TestContainsWhitespace(tests.TestCase):
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
107
2249.2.1 by John Arbash Meinel
(John Arbash Meinel) hard-code the whitespace chars to avoid problems in some locales.
108
    def test_contains_whitespace(self):
109
        self.failUnless(osutils.contains_whitespace(u' '))
110
        self.failUnless(osutils.contains_whitespace(u'hello there'))
111
        self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
112
        self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
113
        self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
114
        self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
115
116
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
117
        # is whitespace, but we do not.
118
        self.failIf(osutils.contains_whitespace(u''))
119
        self.failIf(osutils.contains_whitespace(u'hellothere'))
120
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
121
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
122
123
class TestRename(tests.TestCaseInTempDir):
124
4789.17.1 by John Arbash Meinel
Change fancy_rename slightly.
125
    def create_file(self, filename, content):
126
        f = open(filename, 'wb')
127
        try:
128
            f.write(content)
129
        finally:
130
            f.close()
131
4789.17.2 by John Arbash Meinel
Also handle the case when source *and* target does not exist.
132
    def _fancy_rename(self, a, b):
133
        osutils.fancy_rename(a, b, rename_func=os.rename,
134
                             unlink_func=os.unlink)
135
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
136
    def test_fancy_rename(self):
137
        # This should work everywhere
4789.17.1 by John Arbash Meinel
Change fancy_rename slightly.
138
        self.create_file('a', 'something in a\n')
4789.17.2 by John Arbash Meinel
Also handle the case when source *and* target does not exist.
139
        self._fancy_rename('a', 'b')
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
140
        self.failIfExists('a')
141
        self.failUnlessExists('b')
142
        self.check_file_contents('b', 'something in a\n')
143
4789.17.1 by John Arbash Meinel
Change fancy_rename slightly.
144
        self.create_file('a', 'new something in a\n')
4789.17.2 by John Arbash Meinel
Also handle the case when source *and* target does not exist.
145
        self._fancy_rename('b', 'a')
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
146
147
        self.check_file_contents('a', 'something in a\n')
148
4789.17.1 by John Arbash Meinel
Change fancy_rename slightly.
149
    def test_fancy_rename_fails_source_missing(self):
150
        # An exception should be raised, and the target should be left in place
151
        self.create_file('target', 'data in target\n')
4789.17.2 by John Arbash Meinel
Also handle the case when source *and* target does not exist.
152
        self.assertRaises((IOError, OSError), self._fancy_rename,
4789.17.1 by John Arbash Meinel
Change fancy_rename slightly.
153
                          'missingsource', 'target')
154
        self.failUnlessExists('target')
155
        self.check_file_contents('target', 'data in target\n')
156
4789.17.2 by John Arbash Meinel
Also handle the case when source *and* target does not exist.
157
    def test_fancy_rename_fails_if_source_and_target_missing(self):
158
        self.assertRaises((IOError, OSError), self._fancy_rename,
159
                          'missingsource', 'missingtarget')
160
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
161
    def test_rename(self):
162
        # Rename should be semi-atomic on all platforms
4789.17.1 by John Arbash Meinel
Change fancy_rename slightly.
163
        self.create_file('a', 'something in a\n')
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
164
        osutils.rename('a', 'b')
165
        self.failIfExists('a')
166
        self.failUnlessExists('b')
167
        self.check_file_contents('b', 'something in a\n')
168
4789.17.1 by John Arbash Meinel
Change fancy_rename slightly.
169
        self.create_file('a', 'new something in a\n')
1185.31.47 by John Arbash Meinel
Added a fancy footwork rename to osutils, made SftpTransport use it.
170
        osutils.rename('b', 'a')
171
172
        self.check_file_contents('a', 'something in a\n')
173
174
    # TODO: test fancy_rename using a MemoryTransport
175
2978.8.2 by Alexander Belchenko
teach fancy_rename to handle change case renames in possible case-insensitive filesystem
176
    def test_rename_change_case(self):
177
        # on Windows we should be able to change filename case by rename
2978.8.1 by Alexander Belchenko
Rename on Windows is able to change filename case. (#77740)
178
        self.build_tree(['a', 'b/'])
179
        osutils.rename('a', 'A')
180
        osutils.rename('b', 'B')
2978.8.2 by Alexander Belchenko
teach fancy_rename to handle change case renames in possible case-insensitive filesystem
181
        # we can't use failUnlessExists on case-insensitive filesystem
182
        # so try to check shape of the tree
2978.8.1 by Alexander Belchenko
Rename on Windows is able to change filename case. (#77740)
183
        shape = sorted(os.listdir('.'))
184
        self.assertEquals(['A', 'B'], shape)
185
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
186
187
class TestRandChars(tests.TestCase):
188
1553.5.5 by Martin Pool
New utility routine rand_chars
189
    def test_01_rand_chars_empty(self):
190
        result = osutils.rand_chars(0)
191
        self.assertEqual(result, '')
192
193
    def test_02_rand_chars_100(self):
194
        result = osutils.rand_chars(100)
195
        self.assertEqual(len(result), 100)
196
        self.assertEqual(type(result), str)
197
        self.assertContainsRe(result, r'^[a-z0-9]{100}$')
198
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
199
200
class TestIsInside(tests.TestCase):
201
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
202
    def test_is_inside(self):
203
        is_inside = osutils.is_inside
204
        self.assertTrue(is_inside('src', 'src/foo.c'))
205
        self.assertFalse(is_inside('src', 'srccontrol'))
206
        self.assertTrue(is_inside('src', 'src/a/a/a/foo.c'))
207
        self.assertTrue(is_inside('foo.c', 'foo.c'))
208
        self.assertFalse(is_inside('foo.c', ''))
209
        self.assertTrue(is_inside('', 'foo.c'))
1534.3.1 by Robert Collins
* bzrlib.osutils.safe_unicode now exists to provide parameter coercion
210
2729.2.4 by Martin Pool
move some osutils-related tests from test_inv to test_osutils
211
    def test_is_inside_any(self):
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
212
        SRC_FOO_C = osutils.pathjoin('src', 'foo.c')
2729.2.4 by Martin Pool
move some osutils-related tests from test_inv to test_osutils
213
        for dirs, fn in [(['src', 'doc'], SRC_FOO_C),
214
                         (['src'], SRC_FOO_C),
215
                         (['src'], 'src'),
216
                         ]:
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
217
            self.assert_(osutils.is_inside_any(dirs, fn))
2729.2.4 by Martin Pool
move some osutils-related tests from test_inv to test_osutils
218
        for dirs, fn in [(['src'], 'srccontrol'),
219
                         (['src'], 'srccontrol/foo')]:
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
220
            self.assertFalse(osutils.is_inside_any(dirs, fn))
2729.2.4 by Martin Pool
move some osutils-related tests from test_inv to test_osutils
221
222
    def test_is_inside_or_parent_of_any(self):
223
        for dirs, fn in [(['src', 'doc'], 'src/foo.c'),
224
                         (['src'], 'src/foo.c'),
225
                         (['src/bar.c'], 'src'),
226
                         (['src/bar.c', 'bla/foo.c'], 'src'),
227
                         (['src'], 'src'),
228
                         ]:
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
229
            self.assert_(osutils.is_inside_or_parent_of_any(dirs, fn))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
230
2729.2.4 by Martin Pool
move some osutils-related tests from test_inv to test_osutils
231
        for dirs, fn in [(['src'], 'srccontrol'),
232
                         (['srccontrol/foo.c'], 'src'),
233
                         (['src'], 'srccontrol/foo')]:
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
234
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
2729.2.4 by Martin Pool
move some osutils-related tests from test_inv to test_osutils
235
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
236
237
class TestRmTree(tests.TestCaseInTempDir):
238
1692.7.6 by Martin Pool
[patch] force deletion of trees containing readonly files (alexander)
239
    def test_rmtree(self):
240
        # Check to remove tree with read-only files/dirs
241
        os.mkdir('dir')
242
        f = file('dir/file', 'w')
243
        f.write('spam')
244
        f.close()
245
        # would like to also try making the directory readonly, but at the
246
        # moment python shutil.rmtree doesn't handle that properly - it would
247
        # need to chmod the directory before removing things inside it - deferred
248
        # for now -- mbp 20060505
249
        # osutils.make_readonly('dir')
250
        osutils.make_readonly('dir/file')
251
252
        osutils.rmtree('dir')
253
254
        self.failIfExists('dir/file')
255
        self.failIfExists('dir')
256
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
257
4490.1.2 by Martin Pool
test and news for forcing readonly deletion
258
class TestDeleteAny(tests.TestCaseInTempDir):
259
260
    def test_delete_any_readonly(self):
261
        # from <https://bugs.launchpad.net/bzr/+bug/218206>
262
        self.build_tree(['d/', 'f'])
263
        osutils.make_readonly('d')
264
        osutils.make_readonly('f')
265
266
        osutils.delete_any('f')
267
        osutils.delete_any('d')
268
269
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
270
class TestKind(tests.TestCaseInTempDir):
271
1732.1.10 by John Arbash Meinel
Updated version of file_kind. Rather than multiple function calls, one mask + dictionary lookup
272
    def test_file_kind(self):
273
        self.build_tree(['file', 'dir/'])
274
        self.assertEquals('file', osutils.file_kind('file'))
275
        self.assertEquals('directory', osutils.file_kind('dir/'))
276
        if osutils.has_symlinks():
277
            os.symlink('symlink', 'symlink')
278
            self.assertEquals('symlink', osutils.file_kind('symlink'))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
279
1732.1.28 by John Arbash Meinel
Add tests for fancy file types.
280
        # TODO: jam 20060529 Test a block device
281
        try:
282
            os.lstat('/dev/null')
283
        except OSError, e:
284
            if e.errno not in (errno.ENOENT,):
285
                raise
286
        else:
287
            self.assertEquals('chardev', osutils.file_kind('/dev/null'))
288
289
        mkfifo = getattr(os, 'mkfifo', None)
290
        if mkfifo:
291
            mkfifo('fifo')
292
            try:
293
                self.assertEquals('fifo', osutils.file_kind('fifo'))
294
            finally:
295
                os.remove('fifo')
296
297
        AF_UNIX = getattr(socket, 'AF_UNIX', None)
298
        if AF_UNIX:
299
            s = socket.socket(AF_UNIX)
300
            s.bind('socket')
301
            try:
302
                self.assertEquals('socket', osutils.file_kind('socket'))
303
            finally:
304
                os.remove('socket')
1732.1.10 by John Arbash Meinel
Updated version of file_kind. Rather than multiple function calls, one mask + dictionary lookup
305
1551.10.27 by Aaron Bentley
Add a kind marker for subtrees
306
    def test_kind_marker(self):
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
307
        self.assertEqual("", osutils.kind_marker("file"))
308
        self.assertEqual("/", osutils.kind_marker('directory'))
309
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
310
        self.assertEqual("@", osutils.kind_marker("symlink"))
311
        self.assertEqual("+", osutils.kind_marker("tree-reference"))
312
        self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
313
314
315
class TestUmask(tests.TestCaseInTempDir):
1551.10.27 by Aaron Bentley
Add a kind marker for subtrees
316
1755.3.7 by John Arbash Meinel
Clean up and write tests for permissions. Now we use fstat which should be cheap, and lets us check the permissions and the file size
317
    def test_get_umask(self):
318
        if sys.platform == 'win32':
319
            # umask always returns '0', no way to set it
320
            self.assertEqual(0, osutils.get_umask())
321
            return
322
4985.2.1 by Vincent Ladeuil
Deploy addAttrCleanup on the whole test suite.
323
        self.addAttrCleanup(os, 'umask')
4241.14.5 by Vincent Ladeuil
Some more cleanup (without typo).
324
        os.umask(0222)
325
        self.assertEqual(0222, osutils.get_umask())
326
        os.umask(0022)
327
        self.assertEqual(0022, osutils.get_umask())
328
        os.umask(0002)
329
        self.assertEqual(0002, osutils.get_umask())
330
        os.umask(0027)
331
        self.assertEqual(0027, osutils.get_umask())
1755.3.7 by John Arbash Meinel
Clean up and write tests for permissions. Now we use fstat which should be cheap, and lets us check the permissions and the file size
332
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
333
334
class TestDateTime(tests.TestCase):
335
1957.1.15 by John Arbash Meinel
Review feedback from Robert
336
    def assertFormatedDelta(self, expected, seconds):
337
        """Assert osutils.format_delta formats as expected"""
338
        actual = osutils.format_delta(seconds)
339
        self.assertEqual(expected, actual)
340
1957.1.4 by John Arbash Meinel
create a helper for formatting a time delta
341
    def test_format_delta(self):
1957.1.15 by John Arbash Meinel
Review feedback from Robert
342
        self.assertFormatedDelta('0 seconds ago', 0)
343
        self.assertFormatedDelta('1 second ago', 1)
344
        self.assertFormatedDelta('10 seconds ago', 10)
345
        self.assertFormatedDelta('59 seconds ago', 59)
346
        self.assertFormatedDelta('89 seconds ago', 89)
347
        self.assertFormatedDelta('1 minute, 30 seconds ago', 90)
348
        self.assertFormatedDelta('3 minutes, 0 seconds ago', 180)
349
        self.assertFormatedDelta('3 minutes, 1 second ago', 181)
350
        self.assertFormatedDelta('10 minutes, 15 seconds ago', 615)
351
        self.assertFormatedDelta('30 minutes, 59 seconds ago', 1859)
352
        self.assertFormatedDelta('31 minutes, 0 seconds ago', 1860)
353
        self.assertFormatedDelta('60 minutes, 0 seconds ago', 3600)
354
        self.assertFormatedDelta('89 minutes, 59 seconds ago', 5399)
355
        self.assertFormatedDelta('1 hour, 30 minutes ago', 5400)
356
        self.assertFormatedDelta('2 hours, 30 minutes ago', 9017)
357
        self.assertFormatedDelta('10 hours, 0 minutes ago', 36000)
358
        self.assertFormatedDelta('24 hours, 0 minutes ago', 86400)
359
        self.assertFormatedDelta('35 hours, 59 minutes ago', 129599)
360
        self.assertFormatedDelta('36 hours, 0 minutes ago', 129600)
361
        self.assertFormatedDelta('36 hours, 0 minutes ago', 129601)
362
        self.assertFormatedDelta('36 hours, 1 minute ago', 129660)
363
        self.assertFormatedDelta('36 hours, 1 minute ago', 129661)
364
        self.assertFormatedDelta('84 hours, 10 minutes ago', 303002)
1957.1.4 by John Arbash Meinel
create a helper for formatting a time delta
365
366
        # We handle when time steps the wrong direction because computers
367
        # don't have synchronized clocks.
1957.1.15 by John Arbash Meinel
Review feedback from Robert
368
        self.assertFormatedDelta('84 hours, 10 minutes in the future', -303002)
369
        self.assertFormatedDelta('1 second in the future', -1)
370
        self.assertFormatedDelta('2 seconds in the future', -2)
1957.1.4 by John Arbash Meinel
create a helper for formatting a time delta
371
3144.1.1 by Lukáš Lalinský
Fixed error reporting of unsupported timezone format.
372
    def test_format_date(self):
373
        self.assertRaises(errors.UnsupportedTimezoneFormat,
374
            osutils.format_date, 0, timezone='foo')
3526.5.4 by Martin von Gagern
Use separate function format_local_date for local weekday formats in unicode.
375
        self.assertIsInstance(osutils.format_date(0), str)
376
        self.assertIsInstance(osutils.format_local_date(0), unicode)
377
        # Testing for the actual value of the local weekday without
3526.5.2 by Martin von Gagern
Check output type of format_date
378
        # duplicating the code from format_date is difficult.
379
        # Instead blackbox.test_locale should check for localized
380
        # dates once they do occur in output strings.
3144.1.1 by Lukáš Lalinský
Fixed error reporting of unsupported timezone format.
381
4379.4.2 by Ian Clatworthy
add NEWS item and tests for new date formatting API
382
    def test_format_date_with_offset_in_original_timezone(self):
383
        self.assertEqual("Thu 1970-01-01 00:00:00 +0000",
384
            osutils.format_date_with_offset_in_original_timezone(0))
385
        self.assertEqual("Fri 1970-01-02 03:46:40 +0000",
386
            osutils.format_date_with_offset_in_original_timezone(100000))
387
        self.assertEqual("Fri 1970-01-02 05:46:40 +0200",
388
            osutils.format_date_with_offset_in_original_timezone(100000, 7200))
389
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
390
    def test_local_time_offset(self):
391
        """Test that local_time_offset() returns a sane value."""
392
        offset = osutils.local_time_offset()
393
        self.assertTrue(isinstance(offset, int))
394
        # Test that the offset is no more than a eighteen hours in
395
        # either direction.
396
        # Time zone handling is system specific, so it is difficult to
397
        # do more specific tests, but a value outside of this range is
398
        # probably wrong.
399
        eighteen_hours = 18 * 3600
400
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
401
402
    def test_local_time_offset_with_timestamp(self):
403
        """Test that local_time_offset() works with a timestamp."""
404
        offset = osutils.local_time_offset(1000000000.1234567)
405
        self.assertTrue(isinstance(offset, int))
406
        eighteen_hours = 18 * 3600
407
        self.assertTrue(-eighteen_hours < offset < eighteen_hours)
408
409
410
class TestLinks(tests.TestCaseInTempDir):
411
2091.3.7 by Aaron Bentley
Rename real_parent to dereferenced_path
412
    def test_dereference_path(self):
4241.14.3 by Vincent Ladeuil
Cleanup imports.
413
        self.requireFeature(tests.SymlinkFeature)
2091.3.5 by Aaron Bentley
Move realpath functionality into osutils
414
        cwd = osutils.realpath('.')
415
        os.mkdir('bar')
416
        bar_path = osutils.pathjoin(cwd, 'bar')
417
        # Using './' to avoid bug #1213894 (first path component not
418
        # dereferenced) in Python 2.4.1 and earlier
419
        self.assertEqual(bar_path, osutils.realpath('./bar'))
420
        os.symlink('bar', 'foo')
421
        self.assertEqual(bar_path, osutils.realpath('./foo'))
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
422
2091.3.5 by Aaron Bentley
Move realpath functionality into osutils
423
        # Does not dereference terminal symlinks
424
        foo_path = osutils.pathjoin(cwd, 'foo')
2091.3.7 by Aaron Bentley
Rename real_parent to dereferenced_path
425
        self.assertEqual(foo_path, osutils.dereference_path('./foo'))
2091.3.5 by Aaron Bentley
Move realpath functionality into osutils
426
427
        # Dereferences parent symlinks
428
        os.mkdir('bar/baz')
429
        baz_path = osutils.pathjoin(bar_path, 'baz')
2091.3.7 by Aaron Bentley
Rename real_parent to dereferenced_path
430
        self.assertEqual(baz_path, osutils.dereference_path('./foo/baz'))
2091.3.5 by Aaron Bentley
Move realpath functionality into osutils
431
432
        # Dereferences parent symlinks that are the first path element
2091.3.7 by Aaron Bentley
Rename real_parent to dereferenced_path
433
        self.assertEqual(baz_path, osutils.dereference_path('foo/baz'))
2091.3.5 by Aaron Bentley
Move realpath functionality into osutils
434
435
        # Dereferences parent symlinks in absolute paths
436
        foo_baz_path = osutils.pathjoin(foo_path, 'baz')
2091.3.7 by Aaron Bentley
Rename real_parent to dereferenced_path
437
        self.assertEqual(baz_path, osutils.dereference_path(foo_baz_path))
2091.3.5 by Aaron Bentley
Move realpath functionality into osutils
438
2568.1.1 by John Arbash Meinel
(Elliot Murphy) Use os.lstat rather than os.stat for osutils.make_readonly/make_writeable
439
    def test_changing_access(self):
440
        f = file('file', 'w')
441
        f.write('monkey')
442
        f.close()
443
444
        # Make a file readonly
445
        osutils.make_readonly('file')
2949.6.2 by Alexander Belchenko
more changes osutils.lstat -> os.lstat
446
        mode = os.lstat('file').st_mode
2568.1.1 by John Arbash Meinel
(Elliot Murphy) Use os.lstat rather than os.stat for osutils.make_readonly/make_writeable
447
        self.assertEqual(mode, mode & 0777555)
448
449
        # Make a file writable
450
        osutils.make_writable('file')
2949.6.2 by Alexander Belchenko
more changes osutils.lstat -> os.lstat
451
        mode = os.lstat('file').st_mode
2568.1.1 by John Arbash Meinel
(Elliot Murphy) Use os.lstat rather than os.stat for osutils.make_readonly/make_writeable
452
        self.assertEqual(mode, mode | 0200)
453
454
        if osutils.has_symlinks():
455
            # should not error when handed a symlink
456
            os.symlink('nonexistent', 'dangling')
457
            osutils.make_readonly('dangling')
458
            osutils.make_writable('dangling')
459
3287.18.26 by Matt McClure
Addresses concerns raised in
460
    def test_host_os_dereferences_symlinks(self):
461
        osutils.host_os_dereferences_symlinks()
462
2324.2.1 by Dmitry Vasiliev
kind_marker() optimization
463
4241.14.3 by Vincent Ladeuil
Cleanup imports.
464
class TestCanonicalRelPath(tests.TestCaseInTempDir):
3794.5.36 by Mark Hammond
test for, and fix problem with canonical_relpath when the tail does not exist.
465
4241.14.3 by Vincent Ladeuil
Cleanup imports.
466
    _test_needs_features = [tests.CaseInsCasePresFilenameFeature]
3794.5.36 by Mark Hammond
test for, and fix problem with canonical_relpath when the tail does not exist.
467
468
    def test_canonical_relpath_simple(self):
469
        f = file('MixedCaseName', 'w')
470
        f.close()
4707.1.1 by Vincent Ladeuil
Fix OSX and FreeBSD failures.
471
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
472
        self.failUnlessEqual('work/MixedCaseName', actual)
3794.5.36 by Mark Hammond
test for, and fix problem with canonical_relpath when the tail does not exist.
473
474
    def test_canonical_relpath_missing_tail(self):
475
        os.mkdir('MixedCaseParent')
4707.1.1 by Vincent Ladeuil
Fix OSX and FreeBSD failures.
476
        actual = osutils.canonical_relpath(self.test_base_dir,
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
477
                                           'mixedcaseparent/nochild')
478
        self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
3794.5.36 by Mark Hammond
test for, and fix problem with canonical_relpath when the tail does not exist.
479
480
4634.70.2 by John Arbash Meinel
Fix bug #322807, teach cicp_canonical_relpath how to handle
481
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
482
483
    def assertRelpath(self, expected, base, path):
484
        actual = osutils._cicp_canonical_relpath(base, path)
485
        self.assertEqual(expected, actual)
486
487
    def test_simple(self):
488
        self.build_tree(['MixedCaseName'])
489
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
490
        self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
491
492
    def test_subdir_missing_tail(self):
493
        self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
494
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
495
        self.assertRelpath('MixedCaseParent/a_child', base,
496
                           'MixedCaseParent/a_child')
497
        self.assertRelpath('MixedCaseParent/a_child', base,
498
                           'MixedCaseParent/A_Child')
499
        self.assertRelpath('MixedCaseParent/not_child', base,
500
                           'MixedCaseParent/not_child')
501
4634.70.6 by John Arbash Meinel
Mix up the test a bit. On Windows we don't run the '/' test
502
    def test_at_root_slash(self):
4634.70.2 by John Arbash Meinel
Fix bug #322807, teach cicp_canonical_relpath how to handle
503
        # We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
504
        # check...
4634.70.4 by John Arbash Meinel
Take spiv's suggestion and move the '/' test to another test case.
505
        if osutils.MIN_ABS_PATHLENGTH > 1:
4634.70.6 by John Arbash Meinel
Mix up the test a bit. On Windows we don't run the '/' test
506
            raise tests.TestSkipped('relpath requires %d chars'
507
                                    % osutils.MIN_ABS_PATHLENGTH)
4634.70.4 by John Arbash Meinel
Take spiv's suggestion and move the '/' test to another test case.
508
        self.assertRelpath('foo', '/', '/foo')
4634.70.2 by John Arbash Meinel
Fix bug #322807, teach cicp_canonical_relpath how to handle
509
4634.70.6 by John Arbash Meinel
Mix up the test a bit. On Windows we don't run the '/' test
510
    def test_at_root_drive(self):
511
        if sys.platform != 'win32':
512
            raise tests.TestNotApplicable('we can only test drive-letter relative'
513
                                          ' paths on Windows where we have drive'
514
                                          ' letters.')
4634.70.2 by John Arbash Meinel
Fix bug #322807, teach cicp_canonical_relpath how to handle
515
        # see bug #322807
516
        # The specific issue is that when at the root of a drive, 'abspath'
517
        # returns "C:/" or just "/". However, the code assumes that abspath
518
        # always returns something like "C:/foo" or "/foo" (no trailing slash).
519
        self.assertRelpath('foo', 'C:/', 'C:/foo')
520
        self.assertRelpath('foo', 'X:/', 'X:/foo')
521
        self.assertRelpath('foo', 'X:/', 'X://foo')
522
523
4241.14.3 by Vincent Ladeuil
Cleanup imports.
524
class TestPumpFile(tests.TestCase):
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
525
    """Test pumpfile method."""
4241.14.3 by Vincent Ladeuil
Cleanup imports.
526
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
527
    def setUp(self):
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
528
        tests.TestCase.setUp(self)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
529
        # create a test datablock
530
        self.block_size = 512
531
        pattern = '0123456789ABCDEF'
532
        self.test_data = pattern * (3 * self.block_size / len(pattern))
533
        self.test_data_len = len(self.test_data)
534
535
    def test_bracket_block_size(self):
536
        """Read data in blocks with the requested read size bracketing the
537
        block size."""
538
        # make sure test data is larger than max read size
539
        self.assertTrue(self.test_data_len > self.block_size)
540
4241.14.3 by Vincent Ladeuil
Cleanup imports.
541
        from_file = file_utils.FakeReadFile(self.test_data)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
542
        to_file = StringIO()
543
544
        # read (max / 2) bytes and verify read size wasn't affected
545
        num_bytes_to_read = self.block_size / 2
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
546
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
547
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
548
        self.assertEqual(from_file.get_read_count(), 1)
549
550
        # read (max) bytes and verify read size wasn't affected
551
        num_bytes_to_read = self.block_size
552
        from_file.reset_read_count()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
553
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
554
        self.assertEqual(from_file.get_max_read_size(), num_bytes_to_read)
555
        self.assertEqual(from_file.get_read_count(), 1)
556
557
        # read (max + 1) bytes and verify read size was limited
558
        num_bytes_to_read = self.block_size + 1
559
        from_file.reset_read_count()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
560
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
561
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
562
        self.assertEqual(from_file.get_read_count(), 2)
563
564
        # finish reading the rest of the data
565
        num_bytes_to_read = self.test_data_len - to_file.tell()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
566
        osutils.pumpfile(from_file, to_file, num_bytes_to_read, self.block_size)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
567
568
        # report error if the data wasn't equal (we only report the size due
569
        # to the length of the data)
570
        response_data = to_file.getvalue()
571
        if response_data != self.test_data:
572
            message = "Data not equal.  Expected %d bytes, received %d."
573
            self.fail(message % (len(response_data), self.test_data_len))
574
575
    def test_specified_size(self):
576
        """Request a transfer larger than the maximum block size and verify
577
        that the maximum read doesn't exceed the block_size."""
578
        # make sure test data is larger than max read size
579
        self.assertTrue(self.test_data_len > self.block_size)
580
581
        # retrieve data in blocks
4241.14.3 by Vincent Ladeuil
Cleanup imports.
582
        from_file = file_utils.FakeReadFile(self.test_data)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
583
        to_file = StringIO()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
584
        osutils.pumpfile(from_file, to_file, self.test_data_len,
585
                         self.block_size)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
586
587
        # verify read size was equal to the maximum read size
588
        self.assertTrue(from_file.get_max_read_size() > 0)
589
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
590
        self.assertEqual(from_file.get_read_count(), 3)
591
592
        # report error if the data wasn't equal (we only report the size due
593
        # to the length of the data)
594
        response_data = to_file.getvalue()
595
        if response_data != self.test_data:
596
            message = "Data not equal.  Expected %d bytes, received %d."
597
            self.fail(message % (len(response_data), self.test_data_len))
598
599
    def test_to_eof(self):
600
        """Read to end-of-file and verify that the reads are not larger than
601
        the maximum read size."""
602
        # make sure test data is larger than max read size
603
        self.assertTrue(self.test_data_len > self.block_size)
604
605
        # retrieve data to EOF
4241.14.3 by Vincent Ladeuil
Cleanup imports.
606
        from_file = file_utils.FakeReadFile(self.test_data)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
607
        to_file = StringIO()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
608
        osutils.pumpfile(from_file, to_file, -1, self.block_size)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
609
610
        # verify read size was equal to the maximum read size
611
        self.assertEqual(from_file.get_max_read_size(), self.block_size)
612
        self.assertEqual(from_file.get_read_count(), 4)
613
614
        # report error if the data wasn't equal (we only report the size due
615
        # to the length of the data)
616
        response_data = to_file.getvalue()
617
        if response_data != self.test_data:
618
            message = "Data not equal.  Expected %d bytes, received %d."
619
            self.fail(message % (len(response_data), self.test_data_len))
620
621
    def test_defaults(self):
622
        """Verifies that the default arguments will read to EOF -- this
623
        test verifies that any existing usages of pumpfile will not be broken
624
        with this new version."""
625
        # retrieve data using default (old) pumpfile method
4241.14.3 by Vincent Ladeuil
Cleanup imports.
626
        from_file = file_utils.FakeReadFile(self.test_data)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
627
        to_file = StringIO()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
628
        osutils.pumpfile(from_file, to_file)
3408.6.1 by Eric Holmberg
Fix for Bug #215426 in which bzr can cause a MemoryError in socket.recv while
629
630
        # report error if the data wasn't equal (we only report the size due
631
        # to the length of the data)
632
        response_data = to_file.getvalue()
633
        if response_data != self.test_data:
634
            message = "Data not equal.  Expected %d bytes, received %d."
635
            self.fail(message % (len(response_data), self.test_data_len))
636
3956.2.1 by John Arbash Meinel
Add report_activity to osutils.pumpfile
637
    def test_report_activity(self):
638
        activity = []
639
        def log_activity(length, direction):
640
            activity.append((length, direction))
641
        from_file = StringIO(self.test_data)
642
        to_file = StringIO()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
643
        osutils.pumpfile(from_file, to_file, buff_size=500,
644
                         report_activity=log_activity, direction='read')
3956.2.1 by John Arbash Meinel
Add report_activity to osutils.pumpfile
645
        self.assertEqual([(500, 'read'), (500, 'read'), (500, 'read'),
646
                          (36, 'read')], activity)
647
648
        from_file = StringIO(self.test_data)
649
        to_file = StringIO()
650
        del activity[:]
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
651
        osutils.pumpfile(from_file, to_file, buff_size=500,
652
                         report_activity=log_activity, direction='write')
3956.2.1 by John Arbash Meinel
Add report_activity to osutils.pumpfile
653
        self.assertEqual([(500, 'write'), (500, 'write'), (500, 'write'),
654
                          (36, 'write')], activity)
655
656
        # And with a limited amount of data
657
        from_file = StringIO(self.test_data)
658
        to_file = StringIO()
659
        del activity[:]
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
660
        osutils.pumpfile(from_file, to_file, buff_size=500, read_length=1028,
661
                         report_activity=log_activity, direction='read')
3956.2.1 by John Arbash Meinel
Add report_activity to osutils.pumpfile
662
        self.assertEqual([(500, 'read'), (500, 'read'), (28, 'read')], activity)
663
664
3635.1.2 by Robert Collins
Add osutils.pump_string_file helper function.
665
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
666
class TestPumpStringFile(tests.TestCase):
3635.1.2 by Robert Collins
Add osutils.pump_string_file helper function.
667
668
    def test_empty(self):
669
        output = StringIO()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
670
        osutils.pump_string_file("", output)
3635.1.2 by Robert Collins
Add osutils.pump_string_file helper function.
671
        self.assertEqual("", output.getvalue())
672
673
    def test_more_than_segment_size(self):
674
        output = StringIO()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
675
        osutils.pump_string_file("123456789", output, 2)
3635.1.2 by Robert Collins
Add osutils.pump_string_file helper function.
676
        self.assertEqual("123456789", output.getvalue())
677
678
    def test_segment_size(self):
679
        output = StringIO()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
680
        osutils.pump_string_file("12", output, 2)
3635.1.2 by Robert Collins
Add osutils.pump_string_file helper function.
681
        self.assertEqual("12", output.getvalue())
682
683
    def test_segment_size_multiple(self):
684
        output = StringIO()
4241.9.3 by Vincent Ladeuil
Fix two more test failures specific to OSX.
685
        osutils.pump_string_file("1234", output, 2)
3635.1.2 by Robert Collins
Add osutils.pump_string_file helper function.
686
        self.assertEqual("1234", output.getvalue())
687
688
4555.2.1 by John Arbash Meinel
Fix bug #394227, osutils.relpath() could get into an infinite loop.
689
class TestRelpath(tests.TestCase):
690
691
    def test_simple_relpath(self):
692
        cwd = osutils.getcwd()
693
        subdir = cwd + '/subdir'
694
        self.assertEqual('subdir', osutils.relpath(cwd, subdir))
695
4555.2.3 by John Arbash Meinel
Fix a trivial bug that should have been caught earlier. :)
696
    def test_deep_relpath(self):
697
        cwd = osutils.getcwd()
698
        subdir = cwd + '/sub/subsubdir'
699
        self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
700
4555.2.1 by John Arbash Meinel
Fix bug #394227, osutils.relpath() could get into an infinite loop.
701
    def test_not_relative(self):
702
        self.assertRaises(errors.PathNotChild,
703
                          osutils.relpath, 'C:/path', 'H:/path')
704
        self.assertRaises(errors.PathNotChild,
705
                          osutils.relpath, 'C:/', 'H:/path')
706
707
4241.14.3 by Vincent Ladeuil
Cleanup imports.
708
class TestSafeUnicode(tests.TestCase):
1534.3.1 by Robert Collins
* bzrlib.osutils.safe_unicode now exists to provide parameter coercion
709
710
    def test_from_ascii_string(self):
711
        self.assertEqual(u'foobar', osutils.safe_unicode('foobar'))
712
1534.3.2 by Robert Collins
An extra test for John.
713
    def test_from_unicode_string_ascii_contents(self):
1534.3.1 by Robert Collins
* bzrlib.osutils.safe_unicode now exists to provide parameter coercion
714
        self.assertEqual(u'bargam', osutils.safe_unicode(u'bargam'))
715
1534.3.2 by Robert Collins
An extra test for John.
716
    def test_from_unicode_string_unicode_contents(self):
717
        self.assertEqual(u'bargam\xae', osutils.safe_unicode(u'bargam\xae'))
718
1534.3.1 by Robert Collins
* bzrlib.osutils.safe_unicode now exists to provide parameter coercion
719
    def test_from_utf8_string(self):
720
        self.assertEqual(u'foo\xae', osutils.safe_unicode('foo\xc2\xae'))
721
722
    def test_bad_utf8_string(self):
4241.14.3 by Vincent Ladeuil
Cleanup imports.
723
        self.assertRaises(errors.BzrBadParameterNotUnicode,
1185.65.29 by Robert Collins
Implement final review suggestions.
724
                          osutils.safe_unicode,
725
                          '\xbb\xbb')
1666.1.6 by Robert Collins
Make knit the default format.
726
727
4241.14.3 by Vincent Ladeuil
Cleanup imports.
728
class TestSafeUtf8(tests.TestCase):
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
729
730
    def test_from_ascii_string(self):
731
        f = 'foobar'
732
        self.assertEqual('foobar', osutils.safe_utf8(f))
733
734
    def test_from_unicode_string_ascii_contents(self):
735
        self.assertEqual('bargam', osutils.safe_utf8(u'bargam'))
736
737
    def test_from_unicode_string_unicode_contents(self):
738
        self.assertEqual('bargam\xc2\xae', osutils.safe_utf8(u'bargam\xae'))
739
740
    def test_from_utf8_string(self):
741
        self.assertEqual('foo\xc2\xae', osutils.safe_utf8('foo\xc2\xae'))
742
743
    def test_bad_utf8_string(self):
4241.14.3 by Vincent Ladeuil
Cleanup imports.
744
        self.assertRaises(errors.BzrBadParameterNotUnicode,
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
745
                          osutils.safe_utf8, '\xbb\xbb')
746
747
4241.14.3 by Vincent Ladeuil
Cleanup imports.
748
class TestSafeRevisionId(tests.TestCase):
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
749
750
    def test_from_ascii_string(self):
2858.2.1 by Martin Pool
Remove most calls to safe_file_id and safe_revision_id.
751
        # this shouldn't give a warning because it's getting an ascii string
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
752
        self.assertEqual('foobar', osutils.safe_revision_id('foobar'))
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
753
754
    def test_from_unicode_string_ascii_contents(self):
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
755
        self.assertEqual('bargam',
756
                         osutils.safe_revision_id(u'bargam', warn=False))
757
758
    def test_from_unicode_deprecated(self):
759
        self.assertEqual('bargam',
760
            self.callDeprecated([osutils._revision_id_warning],
761
                                osutils.safe_revision_id, u'bargam'))
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
762
763
    def test_from_unicode_string_unicode_contents(self):
764
        self.assertEqual('bargam\xc2\xae',
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
765
                         osutils.safe_revision_id(u'bargam\xae', warn=False))
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
766
767
    def test_from_utf8_string(self):
768
        self.assertEqual('foo\xc2\xae',
769
                         osutils.safe_revision_id('foo\xc2\xae'))
770
2249.5.9 by John Arbash Meinel
Update WorkingTree to use safe_revision_id when appropriate
771
    def test_none(self):
772
        """Currently, None is a valid revision_id"""
773
        self.assertEqual(None, osutils.safe_revision_id(None))
774
2249.5.8 by John Arbash Meinel
Add osutils.safe_utf8 and safe_revision_id for the new revision_id work.
775
4241.14.3 by Vincent Ladeuil
Cleanup imports.
776
class TestSafeFileId(tests.TestCase):
2294.1.4 by John Arbash Meinel
Add safe_file_id as a helper in osutils.
777
778
    def test_from_ascii_string(self):
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
779
        self.assertEqual('foobar', osutils.safe_file_id('foobar'))
2294.1.4 by John Arbash Meinel
Add safe_file_id as a helper in osutils.
780
781
    def test_from_unicode_string_ascii_contents(self):
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
782
        self.assertEqual('bargam', osutils.safe_file_id(u'bargam', warn=False))
783
784
    def test_from_unicode_deprecated(self):
785
        self.assertEqual('bargam',
786
            self.callDeprecated([osutils._file_id_warning],
787
                                osutils.safe_file_id, u'bargam'))
2294.1.4 by John Arbash Meinel
Add safe_file_id as a helper in osutils.
788
789
    def test_from_unicode_string_unicode_contents(self):
790
        self.assertEqual('bargam\xc2\xae',
2309.4.4 by John Arbash Meinel
Change what warnings are raised, and add tests that they are used.
791
                         osutils.safe_file_id(u'bargam\xae', warn=False))
2294.1.4 by John Arbash Meinel
Add safe_file_id as a helper in osutils.
792
793
    def test_from_utf8_string(self):
794
        self.assertEqual('foo\xc2\xae',
795
                         osutils.safe_file_id('foo\xc2\xae'))
796
797
    def test_none(self):
798
        """Currently, None is a valid revision_id"""
799
        self.assertEqual(None, osutils.safe_file_id(None))
800
801
4241.14.3 by Vincent Ladeuil
Cleanup imports.
802
class TestWin32Funcs(tests.TestCase):
803
    """Test that _win32 versions of os utilities return appropriate paths."""
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
804
805
    def test_abspath(self):
806
        self.assertEqual('C:/foo', osutils._win32_abspath('C:\\foo'))
807
        self.assertEqual('C:/foo', osutils._win32_abspath('C:/foo'))
2279.4.1 by Alexander Belchenko
Reimplementation of ntpath.abspath in Python for Windows98: unicode safe, UNC path safe
808
        self.assertEqual('//HOST/path', osutils._win32_abspath(r'\\HOST\path'))
809
        self.assertEqual('//HOST/path', osutils._win32_abspath('//HOST/path'))
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
810
811
    def test_realpath(self):
812
        self.assertEqual('C:/foo', osutils._win32_realpath('C:\\foo'))
813
        self.assertEqual('C:/foo', osutils._win32_realpath('C:/foo'))
814
815
    def test_pathjoin(self):
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
816
        self.assertEqual('path/to/foo',
817
                         osutils._win32_pathjoin('path', 'to', 'foo'))
818
        self.assertEqual('C:/foo',
819
                         osutils._win32_pathjoin('path\\to', 'C:\\foo'))
820
        self.assertEqual('C:/foo',
821
                         osutils._win32_pathjoin('path/to', 'C:/foo'))
822
        self.assertEqual('path/to/foo',
823
                         osutils._win32_pathjoin('path/to/', 'foo'))
824
        self.assertEqual('/foo',
825
                         osutils._win32_pathjoin('C:/path/to/', '/foo'))
826
        self.assertEqual('/foo',
827
                         osutils._win32_pathjoin('C:\\path\\to\\', '\\foo'))
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
828
829
    def test_normpath(self):
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
830
        self.assertEqual('path/to/foo',
831
                         osutils._win32_normpath(r'path\\from\..\to\.\foo'))
832
        self.assertEqual('path/to/foo',
833
                         osutils._win32_normpath('path//from/../to/./foo'))
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
834
835
    def test_getcwd(self):
1711.5.2 by John Arbash Meinel
win32 likes to return lowercase drive letters sometimes, and uppercase at other times. normalize this
836
        cwd = osutils._win32_getcwd()
837
        os_cwd = os.getcwdu()
838
        self.assertEqual(os_cwd[1:].replace('\\', '/'), cwd[1:])
839
        # win32 is inconsistent whether it returns lower or upper case
840
        # and even if it was consistent the user might type the other
841
        # so we force it to uppercase
842
        # running python.exe under cmd.exe return capital C:\\
843
        # running win32 python inside a cygwin shell returns lowercase
844
        self.assertEqual(os_cwd[0].upper(), cwd[0])
845
846
    def test_fixdrive(self):
847
        self.assertEqual('H:/foo', osutils._win32_fixdrive('h:/foo'))
848
        self.assertEqual('H:/foo', osutils._win32_fixdrive('H:/foo'))
849
        self.assertEqual('C:\\foo', osutils._win32_fixdrive('c:\\foo'))
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
850
2279.4.1 by Alexander Belchenko
Reimplementation of ntpath.abspath in Python for Windows98: unicode safe, UNC path safe
851
    def test_win98_abspath(self):
852
        # absolute path
853
        self.assertEqual('C:/foo', osutils._win98_abspath('C:\\foo'))
854
        self.assertEqual('C:/foo', osutils._win98_abspath('C:/foo'))
855
        # UNC path
856
        self.assertEqual('//HOST/path', osutils._win98_abspath(r'\\HOST\path'))
857
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
858
        # relative path
859
        cwd = osutils.getcwd().rstrip('/')
860
        drive = osutils._nt_splitdrive(cwd)[0]
861
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
862
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
863
        # unicode path
864
        u = u'\u1234'
865
        self.assertEqual(cwd+'/'+u, osutils._win98_abspath(u))
866
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
867
4241.14.3 by Vincent Ladeuil
Cleanup imports.
868
class TestWin32FuncsDirs(tests.TestCaseInTempDir):
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
869
    """Test win32 functions that create files."""
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
870
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
871
    def test_getcwd(self):
4241.14.5 by Vincent Ladeuil
Some more cleanup (without typo).
872
        self.requireFeature(tests.UnicodeFilenameFeature)
873
        os.mkdir(u'mu-\xb5')
1830.3.9 by John Arbash Meinel
Use a directory name that doesn't get messed up on Mac for getcwd() test.
874
        os.chdir(u'mu-\xb5')
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
875
        # TODO: jam 20060427 This will probably fail on Mac OSX because
876
        #       it will change the normalization of B\xe5gfors
877
        #       Consider using a different unicode character, or make
878
        #       osutils.getcwd() renormalize the path.
1830.3.9 by John Arbash Meinel
Use a directory name that doesn't get messed up on Mac for getcwd() test.
879
        self.assertEndsWith(osutils._win32_getcwd(), u'mu-\xb5')
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
880
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
881
    def test_minimum_path_selection(self):
882
        self.assertEqual(set(),
883
            osutils.minimum_path_selection([]))
4325.3.7 by Johan Walles
Style fixes for minimum_path_selection().
884
        self.assertEqual(set(['a']),
885
            osutils.minimum_path_selection(['a']))
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
886
        self.assertEqual(set(['a', 'b']),
887
            osutils.minimum_path_selection(['a', 'b']))
888
        self.assertEqual(set(['a/', 'b']),
889
            osutils.minimum_path_selection(['a/', 'b']))
890
        self.assertEqual(set(['a/', 'b']),
891
            osutils.minimum_path_selection(['a/c', 'a/', 'b']))
4325.3.3 by Johan Walles
Add unit test and fix for minimum_path_selection() vs directory names with
892
        self.assertEqual(set(['a-b', 'a', 'a0b']),
893
            osutils.minimum_path_selection(['a-b', 'a/b', 'a0b', 'a']))
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
894
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
895
    def test_mkdtemp(self):
896
        tmpdir = osutils._win32_mkdtemp(dir='.')
897
        self.assertFalse('\\' in tmpdir)
898
899
    def test_rename(self):
900
        a = open('a', 'wb')
901
        a.write('foo\n')
902
        a.close()
903
        b = open('b', 'wb')
904
        b.write('baz\n')
905
        b.close()
906
907
        osutils._win32_rename('b', 'a')
908
        self.failUnlessExists('a')
909
        self.failIfExists('b')
910
        self.assertFileEqual('baz\n', 'a')
911
1711.7.6 by John Arbash Meinel
Change _win32_rename() so that it raises ENOENT *before* it tries any renaming.
912
    def test_rename_missing_file(self):
913
        a = open('a', 'wb')
914
        a.write('foo\n')
915
        a.close()
916
917
        try:
918
            osutils._win32_rename('b', 'a')
919
        except (IOError, OSError), e:
920
            self.assertEqual(errno.ENOENT, e.errno)
921
        self.assertFileEqual('foo\n', 'a')
922
923
    def test_rename_missing_dir(self):
924
        os.mkdir('a')
925
        try:
926
            osutils._win32_rename('b', 'a')
927
        except (IOError, OSError), e:
928
            self.assertEqual(errno.ENOENT, e.errno)
929
930
    def test_rename_current_dir(self):
931
        os.mkdir('a')
932
        os.chdir('a')
933
        # You can't rename the working directory
934
        # doing rename non-existant . usually
935
        # just raises ENOENT, since non-existant
936
        # doesn't exist.
937
        try:
938
            osutils._win32_rename('b', '.')
939
        except (IOError, OSError), e:
940
            self.assertEqual(errno.ENOENT, e.errno)
941
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
942
    def test_splitpath(self):
943
        def check(expected, path):
944
            self.assertEqual(expected, osutils.splitpath(path))
945
946
        check(['a'], 'a')
947
        check(['a', 'b'], 'a/b')
948
        check(['a', 'b'], 'a/./b')
949
        check(['a', '.b'], 'a/.b')
950
        check(['a', '.b'], 'a\\.b')
951
952
        self.assertRaises(errors.BzrError, osutils.splitpath, 'a/../b')
953
1685.1.31 by John Arbash Meinel
Adding tests for the rest of the _win32 functions.
954
4370.1.1 by Ian Clatworthy
add osutils.parent_directories() API
955
class TestParentDirectories(tests.TestCaseInTempDir):
956
    """Test osutils.parent_directories()"""
957
958
    def test_parent_directories(self):
959
        self.assertEqual([], osutils.parent_directories('a'))
960
        self.assertEqual(['a'], osutils.parent_directories('a/b'))
961
        self.assertEqual(['a/b', 'a'], osutils.parent_directories('a/b/c'))
962
963
4241.14.3 by Vincent Ladeuil
Cleanup imports.
964
class TestMacFuncsDirs(tests.TestCaseInTempDir):
1830.3.11 by John Arbash Meinel
Create a mac version of 'getcwd()' which normalizes the path.
965
    """Test mac special functions that require directories."""
966
967
    def test_getcwd(self):
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
968
        self.requireFeature(tests.UnicodeFilenameFeature)
969
        os.mkdir(u'B\xe5gfors')
1830.3.11 by John Arbash Meinel
Create a mac version of 'getcwd()' which normalizes the path.
970
        os.chdir(u'B\xe5gfors')
971
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
972
973
    def test_getcwd_nonnorm(self):
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
974
        self.requireFeature(tests.UnicodeFilenameFeature)
1830.3.11 by John Arbash Meinel
Create a mac version of 'getcwd()' which normalizes the path.
975
        # Test that _mac_getcwd() will normalize this path
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
976
        os.mkdir(u'Ba\u030agfors')
1830.3.11 by John Arbash Meinel
Create a mac version of 'getcwd()' which normalizes the path.
977
        os.chdir(u'Ba\u030agfors')
978
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
979
1996.3.14 by John Arbash Meinel
lazy_import osutils and sign_my_commits
980
4241.14.3 by Vincent Ladeuil
Cleanup imports.
981
class TestChunksToLines(tests.TestCase):
3890.2.4 by John Arbash Meinel
Add a new function that can convert 'chunks' format to a 'lines' format.
982
3890.2.8 by John Arbash Meinel
Move everything into properly parameterized tests.
983
    def test_smoketest(self):
984
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
985
                         osutils.chunks_to_lines(['foo\nbar', '\nbaz\n']))
986
        self.assertEqual(['foo\n', 'bar\n', 'baz\n'],
987
                         osutils.chunks_to_lines(['foo\n', 'bar\n', 'baz\n']))
988
3734.2.21 by Vincent Ladeuil
Give test a better name.
989
    def test_osutils_binding(self):
3734.2.20 by Vincent Ladeuil
Fix failing test when CompiledChunksToLines is not available.
990
        from bzrlib.tests import test__chunks_to_lines
4913.2.26 by John Arbash Meinel
A bunch of osutils tests depended on features being available.
991
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
3890.2.8 by John Arbash Meinel
Move everything into properly parameterized tests.
992
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
993
        else:
994
            from bzrlib._chunks_to_lines_py import chunks_to_lines
995
        self.assertIs(chunks_to_lines, osutils.chunks_to_lines)
3890.2.5 by John Arbash Meinel
More tests for edge cases.
996
3890.2.4 by John Arbash Meinel
Add a new function that can convert 'chunks' format to a 'lines' format.
997
4241.14.3 by Vincent Ladeuil
Cleanup imports.
998
class TestSplitLines(tests.TestCase):
1666.1.6 by Robert Collins
Make knit the default format.
999
1000
    def test_split_unicode(self):
1001
        self.assertEqual([u'foo\n', u'bar\xae'],
1002
                         osutils.split_lines(u'foo\nbar\xae'))
1003
        self.assertEqual([u'foo\n', u'bar\xae\n'],
1004
                         osutils.split_lines(u'foo\nbar\xae\n'))
1005
1006
    def test_split_with_carriage_returns(self):
1007
        self.assertEqual(['foo\rbar\n'],
1008
                         osutils.split_lines('foo\rbar\n'))
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1009
1010
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1011
class TestWalkDirs(tests.TestCaseInTempDir):
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1012
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1013
    def assertExpectedBlocks(self, expected, result):
1014
        self.assertEqual(expected,
1015
                         [(dirinfo, [line[0:3] for line in block])
1016
                          for dirinfo, block in result])
1017
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1018
    def test_walkdirs(self):
1019
        tree = [
1020
            '.bzr',
1021
            '0file',
1022
            '1dir/',
1023
            '1dir/0file',
1024
            '1dir/1dir/',
1025
            '2file'
1026
            ]
1027
        self.build_tree(tree)
1028
        expected_dirblocks = [
1897.1.1 by Robert Collins
Add some useful summary data to osutils.walkdirs output.
1029
                (('', '.'),
1030
                 [('0file', '0file', 'file'),
1031
                  ('1dir', '1dir', 'directory'),
1032
                  ('2file', '2file', 'file'),
1033
                 ]
1034
                ),
1035
                (('1dir', './1dir'),
1036
                 [('1dir/0file', '0file', 'file'),
1037
                  ('1dir/1dir', '1dir', 'directory'),
1038
                 ]
1039
                ),
1040
                (('1dir/1dir', './1dir/1dir'),
1041
                 [
1042
                 ]
1043
                ),
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1044
            ]
1045
        result = []
1046
        found_bzrdir = False
1897.1.1 by Robert Collins
Add some useful summary data to osutils.walkdirs output.
1047
        for dirdetail, dirblock in osutils.walkdirs('.'):
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1048
            if len(dirblock) and dirblock[0][1] == '.bzr':
1049
                # this tests the filtering of selected paths
1050
                found_bzrdir = True
1051
                del dirblock[0]
1897.1.1 by Robert Collins
Add some useful summary data to osutils.walkdirs output.
1052
            result.append((dirdetail, dirblock))
1753.1.1 by Robert Collins
(rbc, jam, mbp)Add bzrlib.osutils.walkdirs, an optimised walk-and-stat routine.
1053
1054
        self.assertTrue(found_bzrdir)
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1055
        self.assertExpectedBlocks(expected_dirblocks, result)
1757.2.8 by Robert Collins
Teach walkdirs to walk a subdir of a tree.
1056
        # you can search a subdir only, with a supplied prefix.
1057
        result = []
1897.1.1 by Robert Collins
Add some useful summary data to osutils.walkdirs output.
1058
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
1757.2.8 by Robert Collins
Teach walkdirs to walk a subdir of a tree.
1059
            result.append(dirblock)
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1060
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
1757.2.8 by Robert Collins
Teach walkdirs to walk a subdir of a tree.
1061
4095.1.3 by Martin Pool
Add test for failures inside pyrex readdir
1062
    def test_walkdirs_os_error(self):
1063
        # <https://bugs.edge.launchpad.net/bzr/+bug/338653>
1064
        # Pyrex readdir didn't raise useful messages if it had an error
1065
        # reading the directory
1066
        if sys.platform == 'win32':
1067
            raise tests.TestNotApplicable(
1068
                "readdir IOError not tested on win32")
1069
        os.mkdir("test-unreadable")
1070
        os.chmod("test-unreadable", 0000)
1071
        # must chmod it back so that it can be removed
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
1072
        self.addCleanup(os.chmod, "test-unreadable", 0700)
4095.1.3 by Martin Pool
Add test for failures inside pyrex readdir
1073
        # The error is not raised until the generator is actually evaluated.
1074
        # (It would be ok if it happened earlier but at the moment it
1075
        # doesn't.)
4133.1.1 by Vincent Ladeuil
Fix bzrlib.tests.test_osutils.TestWalkDirs.test_walkdirs_os_error
1076
        e = self.assertRaises(OSError, list, osutils._walkdirs_utf8("."))
1077
        self.assertEquals('./test-unreadable', e.filename)
1078
        self.assertEquals(errno.EACCES, e.errno)
4133.1.2 by Vincent Ladeuil
Fixed as per Martin's remark about the intent of the test :-}
1079
        # Ensure the message contains the file name
1080
        self.assertContainsRe(str(e), "\./test-unreadable")
4095.1.3 by Martin Pool
Add test for failures inside pyrex readdir
1081
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1082
    def test__walkdirs_utf8(self):
1083
        tree = [
1084
            '.bzr',
1085
            '0file',
1086
            '1dir/',
1087
            '1dir/0file',
1088
            '1dir/1dir/',
1089
            '2file'
1090
            ]
1091
        self.build_tree(tree)
1092
        expected_dirblocks = [
1093
                (('', '.'),
1094
                 [('0file', '0file', 'file'),
1095
                  ('1dir', '1dir', 'directory'),
1096
                  ('2file', '2file', 'file'),
1097
                 ]
1098
                ),
1099
                (('1dir', './1dir'),
1100
                 [('1dir/0file', '0file', 'file'),
1101
                  ('1dir/1dir', '1dir', 'directory'),
1102
                 ]
1103
                ),
1104
                (('1dir/1dir', './1dir/1dir'),
1105
                 [
1106
                 ]
1107
                ),
1108
            ]
1109
        result = []
1110
        found_bzrdir = False
1111
        for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
1112
            if len(dirblock) and dirblock[0][1] == '.bzr':
1113
                # this tests the filtering of selected paths
1114
                found_bzrdir = True
1115
                del dirblock[0]
1116
            result.append((dirdetail, dirblock))
1117
1118
        self.assertTrue(found_bzrdir)
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1119
        self.assertExpectedBlocks(expected_dirblocks, result)
1120
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1121
        # you can search a subdir only, with a supplied prefix.
1122
        result = []
1123
        for dirblock in osutils.walkdirs('./1dir', '1dir'):
1124
            result.append(dirblock)
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1125
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
2255.7.27 by John Arbash Meinel
Add a _walkdirs_utf8 which returns utf8 paths instead of Unicode. Approx 20% faster in walking utf8 filesystems
1126
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1127
    def _filter_out_stat(self, result):
1128
        """Filter out the stat value from the walkdirs result"""
1129
        for dirdetail, dirblock in result:
1130
            new_dirblock = []
1131
            for info in dirblock:
1132
                # Ignore info[3] which is the stat
1133
                new_dirblock.append((info[0], info[1], info[2], info[4]))
1134
            dirblock[:] = new_dirblock
1135
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1136
    def _save_platform_info(self):
4985.2.1 by Vincent Ladeuil
Deploy addAttrCleanup on the whole test suite.
1137
        self.addAttrCleanup(win32utils, 'winver')
1138
        self.addAttrCleanup(osutils, '_fs_enc')
1139
        self.addAttrCleanup(osutils, '_selected_dir_reader')
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1140
4241.14.5 by Vincent Ladeuil
Some more cleanup (without typo).
1141
    def assertDirReaderIs(self, expected):
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1142
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
1143
        # Force it to redetect
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1144
        osutils._selected_dir_reader = None
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1145
        # Nothing to list, but should still trigger the selection logic
3557.2.5 by John Arbash Meinel
Test that the empty-directory logic for all _walkdirs implementations is correct.
1146
        self.assertEqual([(('', '.'), [])], list(osutils._walkdirs_utf8('.')))
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1147
        self.assertIsInstance(osutils._selected_dir_reader, expected)
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1148
1149
    def test_force_walkdirs_utf8_fs_utf8(self):
3696.3.5 by Robert Collins
Streamline _walkdirs_utf8 for utf8 file systems, reducing time to traverse a mozilla tree from 1s to .6 seconds. (Robert Collins)
1150
        self.requireFeature(UTF8DirReaderFeature)
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1151
        self._save_platform_info()
3557.2.6 by John Arbash Meinel
Switch from os.name to bzrlib.win32utils.winver.
1152
        win32utils.winver = None # Avoid the win32 detection code
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1153
        osutils._fs_enc = 'UTF-8'
4241.14.5 by Vincent Ladeuil
Some more cleanup (without typo).
1154
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1155
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1156
    def test_force_walkdirs_utf8_fs_ascii(self):
3696.3.5 by Robert Collins
Streamline _walkdirs_utf8 for utf8 file systems, reducing time to traverse a mozilla tree from 1s to .6 seconds. (Robert Collins)
1157
        self.requireFeature(UTF8DirReaderFeature)
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1158
        self._save_platform_info()
3557.2.6 by John Arbash Meinel
Switch from os.name to bzrlib.win32utils.winver.
1159
        win32utils.winver = None # Avoid the win32 detection code
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1160
        osutils._fs_enc = 'US-ASCII'
4241.14.5 by Vincent Ladeuil
Some more cleanup (without typo).
1161
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1162
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1163
    def test_force_walkdirs_utf8_fs_ANSI(self):
3696.3.5 by Robert Collins
Streamline _walkdirs_utf8 for utf8 file systems, reducing time to traverse a mozilla tree from 1s to .6 seconds. (Robert Collins)
1164
        self.requireFeature(UTF8DirReaderFeature)
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1165
        self._save_platform_info()
3557.2.6 by John Arbash Meinel
Switch from os.name to bzrlib.win32utils.winver.
1166
        win32utils.winver = None # Avoid the win32 detection code
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1167
        osutils._fs_enc = 'ANSI_X3.4-1968'
4241.14.5 by Vincent Ladeuil
Some more cleanup (without typo).
1168
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1169
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1170
    def test_force_walkdirs_utf8_fs_latin1(self):
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1171
        self._save_platform_info()
3557.2.6 by John Arbash Meinel
Switch from os.name to bzrlib.win32utils.winver.
1172
        win32utils.winver = None # Avoid the win32 detection code
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1173
        osutils._fs_enc = 'latin1'
4241.14.5 by Vincent Ladeuil
Some more cleanup (without typo).
1174
        self.assertDirReaderIs(osutils.UnicodeDirReader)
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1175
1176
    def test_force_walkdirs_utf8_nt(self):
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1177
        # Disabled because the thunk of the whole walkdirs api is disabled.
4913.2.26 by John Arbash Meinel
A bunch of osutils tests depended on features being available.
1178
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1179
        self._save_platform_info()
3557.2.6 by John Arbash Meinel
Switch from os.name to bzrlib.win32utils.winver.
1180
        win32utils.winver = 'Windows NT'
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1181
        from bzrlib._walkdirs_win32 import Win32ReadDir
4241.14.5 by Vincent Ladeuil
Some more cleanup (without typo).
1182
        self.assertDirReaderIs(Win32ReadDir)
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1183
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1184
    def test_force_walkdirs_utf8_98(self):
4913.2.26 by John Arbash Meinel
A bunch of osutils tests depended on features being available.
1185
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
3557.2.4 by John Arbash Meinel
Cleanup the tests a bit, and add a test that we downgrade if os.name isn't 'nt'
1186
        self._save_platform_info()
3557.2.6 by John Arbash Meinel
Switch from os.name to bzrlib.win32utils.winver.
1187
        win32utils.winver = 'Windows 98'
4241.14.5 by Vincent Ladeuil
Some more cleanup (without typo).
1188
        self.assertDirReaderIs(osutils.UnicodeDirReader)
3557.2.3 by John Arbash Meinel
Change the logic for selecting a real _walkdirs_utf8 implementation,
1189
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1190
    def test_unicode_walkdirs(self):
1191
        """Walkdirs should always return unicode paths."""
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1192
        self.requireFeature(tests.UnicodeFilenameFeature)
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1193
        name0 = u'0file-\xb6'
1194
        name1 = u'1dir-\u062c\u0648'
1195
        name2 = u'2file-\u0633'
1196
        tree = [
1197
            name0,
1198
            name1 + '/',
1199
            name1 + '/' + name0,
1200
            name1 + '/' + name1 + '/',
1201
            name2,
1202
            ]
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1203
        self.build_tree(tree)
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1204
        expected_dirblocks = [
1205
                ((u'', u'.'),
1206
                 [(name0, name0, 'file', './' + name0),
1207
                  (name1, name1, 'directory', './' + name1),
1208
                  (name2, name2, 'file', './' + name2),
1209
                 ]
1210
                ),
1211
                ((name1, './' + name1),
1212
                 [(name1 + '/' + name0, name0, 'file', './' + name1
1213
                                                        + '/' + name0),
1214
                  (name1 + '/' + name1, name1, 'directory', './' + name1
1215
                                                            + '/' + name1),
1216
                 ]
1217
                ),
1218
                ((name1 + '/' + name1, './' + name1 + '/' + name1),
1219
                 [
1220
                 ]
1221
                ),
1222
            ]
1223
        result = list(osutils.walkdirs('.'))
1224
        self._filter_out_stat(result)
1225
        self.assertEqual(expected_dirblocks, result)
1226
        result = list(osutils.walkdirs(u'./'+name1, name1))
1227
        self._filter_out_stat(result)
1228
        self.assertEqual(expected_dirblocks[1:], result)
1229
1230
    def test_unicode__walkdirs_utf8(self):
1231
        """Walkdirs_utf8 should always return utf8 paths.
1232
1233
        The abspath portion might be in unicode or utf-8
1234
        """
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1235
        self.requireFeature(tests.UnicodeFilenameFeature)
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1236
        name0 = u'0file-\xb6'
1237
        name1 = u'1dir-\u062c\u0648'
1238
        name2 = u'2file-\u0633'
1239
        tree = [
1240
            name0,
1241
            name1 + '/',
1242
            name1 + '/' + name0,
1243
            name1 + '/' + name1 + '/',
1244
            name2,
1245
            ]
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1246
        self.build_tree(tree)
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1247
        name0 = name0.encode('utf8')
1248
        name1 = name1.encode('utf8')
1249
        name2 = name2.encode('utf8')
1250
1251
        expected_dirblocks = [
1252
                (('', '.'),
1253
                 [(name0, name0, 'file', './' + name0),
1254
                  (name1, name1, 'directory', './' + name1),
1255
                  (name2, name2, 'file', './' + name2),
1256
                 ]
1257
                ),
1258
                ((name1, './' + name1),
1259
                 [(name1 + '/' + name0, name0, 'file', './' + name1
1260
                                                        + '/' + name0),
1261
                  (name1 + '/' + name1, name1, 'directory', './' + name1
1262
                                                            + '/' + name1),
1263
                 ]
1264
                ),
1265
                ((name1 + '/' + name1, './' + name1 + '/' + name1),
1266
                 [
1267
                 ]
1268
                ),
1269
            ]
1270
        result = []
1271
        # For ease in testing, if walkdirs_utf8 returns Unicode, assert that
1272
        # all abspaths are Unicode, and encode them back into utf8.
1273
        for dirdetail, dirblock in osutils._walkdirs_utf8('.'):
1274
            self.assertIsInstance(dirdetail[0], str)
1275
            if isinstance(dirdetail[1], unicode):
2324.2.4 by Dmitry Vasiliev
Fixed test_unicode__walkdirs_utf8 test
1276
                dirdetail = (dirdetail[0], dirdetail[1].encode('utf8'))
1277
                dirblock = [list(info) for info in dirblock]
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1278
                for info in dirblock:
1279
                    self.assertIsInstance(info[4], unicode)
1280
                    info[4] = info[4].encode('utf8')
1281
            new_dirblock = []
1282
            for info in dirblock:
1283
                self.assertIsInstance(info[0], str)
1284
                self.assertIsInstance(info[1], str)
1285
                self.assertIsInstance(info[4], str)
1286
                # Remove the stat information
1287
                new_dirblock.append((info[0], info[1], info[2], info[4]))
1288
            result.append((dirdetail, new_dirblock))
1289
        self.assertEqual(expected_dirblocks, result)
1290
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1291
    def test__walkdirs_utf8_with_unicode_fs(self):
1292
        """UnicodeDirReader should be a safe fallback everywhere
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1293
1294
        The abspath portion should be in unicode
1295
        """
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1296
        self.requireFeature(tests.UnicodeFilenameFeature)
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1297
        # Use the unicode reader. TODO: split into driver-and-driven unit
1298
        # tests.
1299
        self._save_platform_info()
1300
        osutils._selected_dir_reader = osutils.UnicodeDirReader()
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1301
        name0u = u'0file-\xb6'
1302
        name1u = u'1dir-\u062c\u0648'
1303
        name2u = u'2file-\u0633'
1304
        tree = [
1305
            name0u,
1306
            name1u + '/',
1307
            name1u + '/' + name0u,
1308
            name1u + '/' + name1u + '/',
1309
            name2u,
1310
            ]
4241.14.4 by Vincent Ladeuil
Clean up test_osutils.py.
1311
        self.build_tree(tree)
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1312
        name0 = name0u.encode('utf8')
1313
        name1 = name1u.encode('utf8')
1314
        name2 = name2u.encode('utf8')
1315
1316
        # All of the abspaths should be in unicode, all of the relative paths
1317
        # should be in utf8
1318
        expected_dirblocks = [
1319
                (('', '.'),
1320
                 [(name0, name0, 'file', './' + name0u),
1321
                  (name1, name1, 'directory', './' + name1u),
1322
                  (name2, name2, 'file', './' + name2u),
1323
                 ]
1324
                ),
1325
                ((name1, './' + name1u),
1326
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
1327
                                                        + '/' + name0u),
1328
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
1329
                                                            + '/' + name1u),
1330
                 ]
1331
                ),
1332
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
1333
                 [
1334
                 ]
1335
                ),
1336
            ]
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1337
        result = list(osutils._walkdirs_utf8('.'))
2255.7.32 by John Arbash Meinel
Add tests that the walkdirs variants work on unicode paths.
1338
        self._filter_out_stat(result)
1339
        self.assertEqual(expected_dirblocks, result)
1340
3696.3.4 by John Arbash Meinel
Update the osutils test to find the objects in the right locations.
1341
    def test__walkdirs_utf8_win32readdir(self):
4913.2.26 by John Arbash Meinel
A bunch of osutils tests depended on features being available.
1342
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
3504.4.1 by John Arbash Meinel
Write an alternative 'walkdirs' implementation that uses win32 apis.
1343
        self.requireFeature(tests.UnicodeFilenameFeature)
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1344
        from bzrlib._walkdirs_win32 import Win32ReadDir
1345
        self._save_platform_info()
3696.3.4 by John Arbash Meinel
Update the osutils test to find the objects in the right locations.
1346
        osutils._selected_dir_reader = Win32ReadDir()
3504.4.1 by John Arbash Meinel
Write an alternative 'walkdirs' implementation that uses win32 apis.
1347
        name0u = u'0file-\xb6'
1348
        name1u = u'1dir-\u062c\u0648'
1349
        name2u = u'2file-\u0633'
1350
        tree = [
1351
            name0u,
1352
            name1u + '/',
1353
            name1u + '/' + name0u,
1354
            name1u + '/' + name1u + '/',
1355
            name2u,
1356
            ]
1357
        self.build_tree(tree)
1358
        name0 = name0u.encode('utf8')
1359
        name1 = name1u.encode('utf8')
1360
        name2 = name2u.encode('utf8')
1361
1362
        # All of the abspaths should be in unicode, all of the relative paths
1363
        # should be in utf8
1364
        expected_dirblocks = [
1365
                (('', '.'),
1366
                 [(name0, name0, 'file', './' + name0u),
1367
                  (name1, name1, 'directory', './' + name1u),
1368
                  (name2, name2, 'file', './' + name2u),
1369
                 ]
1370
                ),
1371
                ((name1, './' + name1u),
1372
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
1373
                                                        + '/' + name0u),
1374
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
1375
                                                            + '/' + name1u),
1376
                 ]
1377
                ),
1378
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
1379
                 [
1380
                 ]
1381
                ),
1382
            ]
3696.3.4 by John Arbash Meinel
Update the osutils test to find the objects in the right locations.
1383
        result = list(osutils._walkdirs_utf8(u'.'))
3504.4.1 by John Arbash Meinel
Write an alternative 'walkdirs' implementation that uses win32 apis.
1384
        self._filter_out_stat(result)
1385
        self.assertEqual(expected_dirblocks, result)
1386
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
1387
    def assertStatIsCorrect(self, path, win32stat):
1388
        os_stat = os.stat(path)
1389
        self.assertEqual(os_stat.st_size, win32stat.st_size)
3504.4.6 by John Arbash Meinel
Start exposing the times on the stat, this now seems to be a complete walkdirs implementation.
1390
        self.assertAlmostEqual(os_stat.st_mtime, win32stat.st_mtime, places=4)
1391
        self.assertAlmostEqual(os_stat.st_ctime, win32stat.st_ctime, places=4)
1392
        self.assertAlmostEqual(os_stat.st_atime, win32stat.st_atime, places=4)
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
1393
        self.assertEqual(os_stat.st_dev, win32stat.st_dev)
1394
        self.assertEqual(os_stat.st_ino, win32stat.st_ino)
1395
        self.assertEqual(os_stat.st_mode, win32stat.st_mode)
1396
1397
    def test__walkdirs_utf_win32_find_file_stat_file(self):
1398
        """make sure our Stat values are valid"""
4913.2.26 by John Arbash Meinel
A bunch of osutils tests depended on features being available.
1399
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
1400
        self.requireFeature(tests.UnicodeFilenameFeature)
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1401
        from bzrlib._walkdirs_win32 import Win32ReadDir
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
1402
        name0u = u'0file-\xb6'
1403
        name0 = name0u.encode('utf8')
1404
        self.build_tree([name0u])
1405
        # I hate to sleep() here, but I'm trying to make the ctime different
1406
        # from the mtime
1407
        time.sleep(2)
1408
        f = open(name0u, 'ab')
1409
        try:
1410
            f.write('just a small update')
1411
        finally:
1412
            f.close()
1413
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1414
        result = Win32ReadDir().read_dir('', u'.')
1415
        entry = result[0]
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
1416
        self.assertEqual((name0, name0, 'file'), entry[:3])
1417
        self.assertEqual(u'./' + name0u, entry[4])
1418
        self.assertStatIsCorrect(entry[4], entry[3])
3504.4.6 by John Arbash Meinel
Start exposing the times on the stat, this now seems to be a complete walkdirs implementation.
1419
        self.assertNotEqual(entry[3].st_mtime, entry[3].st_ctime)
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
1420
1421
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
1422
        """make sure our Stat values are valid"""
4913.2.26 by John Arbash Meinel
A bunch of osutils tests depended on features being available.
1423
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
1424
        self.requireFeature(tests.UnicodeFilenameFeature)
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1425
        from bzrlib._walkdirs_win32 import Win32ReadDir
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
1426
        name0u = u'0dir-\u062c\u0648'
1427
        name0 = name0u.encode('utf8')
1428
        self.build_tree([name0u + '/'])
1429
3696.3.1 by Robert Collins
Refactor bzrlib.osutils._walkdirs_utf8 to aid API migration in future.
1430
        result = Win32ReadDir().read_dir('', u'.')
1431
        entry = result[0]
3504.4.2 by John Arbash Meinel
Add a test case that shows the mtime is not being returned correctly.
1432
        self.assertEqual((name0, name0, 'directory'), entry[:3])
1433
        self.assertEqual(u'./' + name0u, entry[4])
1434
        self.assertStatIsCorrect(entry[4], entry[3])
1435
1773.3.1 by Robert Collins
Add path_prefix_key and compare_paths_prefix_order utility functions.
1436
    def assertPathCompare(self, path_less, path_greater):
1437
        """check that path_less and path_greater compare correctly."""
1438
        self.assertEqual(0, osutils.compare_paths_prefix_order(
1439
            path_less, path_less))
1440
        self.assertEqual(0, osutils.compare_paths_prefix_order(
1441
            path_greater, path_greater))
1442
        self.assertEqual(-1, osutils.compare_paths_prefix_order(
1443
            path_less, path_greater))
1444
        self.assertEqual(1, osutils.compare_paths_prefix_order(
1445
            path_greater, path_less))
1446
1447
    def test_compare_paths_prefix_order(self):
1448
        # root before all else
1449
        self.assertPathCompare("/", "/a")
1450
        # alpha within a dir
1451
        self.assertPathCompare("/a", "/b")
1452
        self.assertPathCompare("/b", "/z")
1453
        # high dirs before lower.
1454
        self.assertPathCompare("/z", "/a/a")
1773.3.2 by Robert Collins
New corner case from John Meinel, showing up the need to check the directory lexographically outside of a single tree's root. Fixed.
1455
        # except if the deeper dir should be output first
1456
        self.assertPathCompare("/a/b/c", "/d/g")
1773.3.1 by Robert Collins
Add path_prefix_key and compare_paths_prefix_order utility functions.
1457
        # lexical betwen dirs of the same height
1458
        self.assertPathCompare("/a/z", "/z/z")
1459
        self.assertPathCompare("/a/c/z", "/a/d/e")
1460
1461
        # this should also be consistent for no leading / paths
1462
        # root before all else
1463
        self.assertPathCompare("", "a")
1464
        # alpha within a dir
1465
        self.assertPathCompare("a", "b")
1466
        self.assertPathCompare("b", "z")
1467
        # high dirs before lower.
1468
        self.assertPathCompare("z", "a/a")
1773.3.2 by Robert Collins
New corner case from John Meinel, showing up the need to check the directory lexographically outside of a single tree's root. Fixed.
1469
        # except if the deeper dir should be output first
1470
        self.assertPathCompare("a/b/c", "d/g")
1773.3.1 by Robert Collins
Add path_prefix_key and compare_paths_prefix_order utility functions.
1471
        # lexical betwen dirs of the same height
1472
        self.assertPathCompare("a/z", "z/z")
1473
        self.assertPathCompare("a/c/z", "a/d/e")
1474
1773.3.3 by Robert Collins
Add new tests John Meinel asked for.
1475
    def test_path_prefix_sorting(self):
1476
        """Doing a sort on path prefix should match our sample data."""
1477
        original_paths = [
1478
            'a',
1479
            'a/b',
1480
            'a/b/c',
1481
            'b',
1482
            'b/c',
1483
            'd',
1484
            'd/e',
1485
            'd/e/f',
1486
            'd/f',
1487
            'd/g',
1488
            'g',
1489
            ]
1490
1491
        dir_sorted_paths = [
1492
            'a',
1493
            'b',
1494
            'd',
1495
            'g',
1496
            'a/b',
1497
            'a/b/c',
1498
            'b/c',
1499
            'd/e',
1500
            'd/f',
1501
            'd/g',
1502
            'd/e/f',
1503
            ]
1504
1505
        self.assertEqual(
1506
            dir_sorted_paths,
1507
            sorted(original_paths, key=osutils.path_prefix_key))
1508
        # using the comparison routine shoudl work too:
1509
        self.assertEqual(
1510
            dir_sorted_paths,
1511
            sorted(original_paths, cmp=osutils.compare_paths_prefix_order))
1711.4.10 by John Arbash Meinel
Pull out sys.stdout.encoding handling into a separate function so it can be tested, and used elsewhere.
1512
1513
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1514
class TestCopyTree(tests.TestCaseInTempDir):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1515
1907.3.1 by John Arbash Meinel
create a copy_tree wrapper around walkdirs()
1516
    def test_copy_basic_tree(self):
1517
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1518
        osutils.copy_tree('source', 'target')
2095.3.1 by Martin Pool
Tests shouldn't assume os.listdir returns sorted results
1519
        self.assertEqual(['a', 'b'], sorted(os.listdir('target')))
1907.3.1 by John Arbash Meinel
create a copy_tree wrapper around walkdirs()
1520
        self.assertEqual(['c'], os.listdir('target/b'))
1521
1522
    def test_copy_tree_target_exists(self):
1523
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c',
1524
                         'target/'])
1525
        osutils.copy_tree('source', 'target')
2095.3.1 by Martin Pool
Tests shouldn't assume os.listdir returns sorted results
1526
        self.assertEqual(['a', 'b'], sorted(os.listdir('target')))
1907.3.1 by John Arbash Meinel
create a copy_tree wrapper around walkdirs()
1527
        self.assertEqual(['c'], os.listdir('target/b'))
1528
1907.3.2 by John Arbash Meinel
Updated the copy_tree function to allow overriding functionality.
1529
    def test_copy_tree_symlinks(self):
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1530
        self.requireFeature(tests.SymlinkFeature)
1907.3.2 by John Arbash Meinel
Updated the copy_tree function to allow overriding functionality.
1531
        self.build_tree(['source/'])
1532
        os.symlink('a/generic/path', 'source/lnk')
1533
        osutils.copy_tree('source', 'target')
1534
        self.assertEqual(['lnk'], os.listdir('target'))
1535
        self.assertEqual('a/generic/path', os.readlink('target/lnk'))
1536
1537
    def test_copy_tree_handlers(self):
1538
        processed_files = []
1539
        processed_links = []
1540
        def file_handler(from_path, to_path):
1541
            processed_files.append(('f', from_path, to_path))
1542
        def dir_handler(from_path, to_path):
1543
            processed_files.append(('d', from_path, to_path))
1544
        def link_handler(from_path, to_path):
1545
            processed_links.append((from_path, to_path))
1546
        handlers = {'file':file_handler,
1547
                    'directory':dir_handler,
1548
                    'symlink':link_handler,
1549
                   }
1550
1551
        self.build_tree(['source/', 'source/a', 'source/b/', 'source/b/c'])
1552
        if osutils.has_symlinks():
1553
            os.symlink('a/generic/path', 'source/lnk')
1554
        osutils.copy_tree('source', 'target', handlers=handlers)
1555
1556
        self.assertEqual([('d', 'source', 'target'),
1557
                          ('f', 'source/a', 'target/a'),
1558
                          ('d', 'source/b', 'target/b'),
1559
                          ('f', 'source/b/c', 'target/b/c'),
1560
                         ], processed_files)
1561
        self.failIfExists('target')
1562
        if osutils.has_symlinks():
1563
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1564
1907.3.1 by John Arbash Meinel
create a copy_tree wrapper around walkdirs()
1565
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1566
class TestSetUnsetEnv(tests.TestCase):
1963.1.5 by John Arbash Meinel
Create an osutils helper function for modifying the environment
1567
    """Test updating the environment"""
1568
1569
    def setUp(self):
1570
        super(TestSetUnsetEnv, self).setUp()
1571
1572
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'),
1573
                         'Environment was not cleaned up properly.'
1574
                         ' Variable BZR_TEST_ENV_VAR should not exist.')
1575
        def cleanup():
1576
            if 'BZR_TEST_ENV_VAR' in os.environ:
1577
                del os.environ['BZR_TEST_ENV_VAR']
1578
        self.addCleanup(cleanup)
1579
1580
    def test_set(self):
1581
        """Test that we can set an env variable"""
1582
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
1583
        self.assertEqual(None, old)
1584
        self.assertEqual('foo', os.environ.get('BZR_TEST_ENV_VAR'))
1585
1586
    def test_double_set(self):
1587
        """Test that we get the old value out"""
1588
        osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
1589
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'bar')
1590
        self.assertEqual('foo', old)
1591
        self.assertEqual('bar', os.environ.get('BZR_TEST_ENV_VAR'))
1592
1593
    def test_unicode(self):
1594
        """Environment can only contain plain strings
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1595
1963.1.5 by John Arbash Meinel
Create an osutils helper function for modifying the environment
1596
        So Unicode strings must be encoded.
1597
        """
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1598
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
2785.1.5 by Alexander Belchenko
support for non-ascii BZR_HOME in show_version()
1599
        if uni_val is None:
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1600
            raise tests.TestSkipped(
1601
                'Cannot find a unicode character that works in encoding %s'
1602
                % (osutils.get_user_encoding(),))
1963.1.5 by John Arbash Meinel
Create an osutils helper function for modifying the environment
1603
1604
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', uni_val)
1605
        self.assertEqual(env_val, os.environ.get('BZR_TEST_ENV_VAR'))
1606
1607
    def test_unset(self):
1608
        """Test that passing None will remove the env var"""
1609
        osutils.set_or_unset_env('BZR_TEST_ENV_VAR', 'foo')
1610
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1611
        self.assertEqual('foo', old)
1612
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1613
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
1614
2215.6.2 by James Henstridge
add some simple tests for local_time_offset()
1615
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1616
class TestSizeShaFile(tests.TestCaseInTempDir):
3368.2.49 by Ian Clatworthy
added osutils.size_sha_file() with tests
1617
1618
    def test_sha_empty(self):
1619
        self.build_tree_contents([('foo', '')])
1620
        expected_sha = osutils.sha_string('')
1621
        f = open('foo')
1622
        self.addCleanup(f.close)
1623
        size, sha = osutils.size_sha_file(f)
1624
        self.assertEqual(0, size)
1625
        self.assertEqual(expected_sha, sha)
1626
1627
    def test_sha_mixed_endings(self):
1628
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
1629
        self.build_tree_contents([('foo', text)])
1630
        expected_sha = osutils.sha_string(text)
4789.25.1 by John Arbash Meinel
When computing the sha1sum for a file, make sure it is opened in binary mode.
1631
        f = open('foo', 'rb')
3368.2.49 by Ian Clatworthy
added osutils.size_sha_file() with tests
1632
        self.addCleanup(f.close)
1633
        size, sha = osutils.size_sha_file(f)
1634
        self.assertEqual(38, size)
1635
        self.assertEqual(expected_sha, sha)
1636
1637
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1638
class TestShaFileByName(tests.TestCaseInTempDir):
2922.1.2 by John Arbash Meinel
Add tests for sha_file_by_name.
1639
1640
    def test_sha_empty(self):
1641
        self.build_tree_contents([('foo', '')])
1642
        expected_sha = osutils.sha_string('')
1643
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
1644
1645
    def test_sha_mixed_endings(self):
1646
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
1647
        self.build_tree_contents([('foo', text)])
1648
        expected_sha = osutils.sha_string(text)
1649
        self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
3089.3.9 by Ian Clatworthy
add test for resource loading
1650
1651
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1652
class TestResourceLoading(tests.TestCaseInTempDir):
3089.3.9 by Ian Clatworthy
add test for resource loading
1653
1654
    def test_resource_string(self):
1655
        # test resource in bzrlib
1656
        text = osutils.resource_string('bzrlib', 'debug.py')
3959.1.4 by Martin Pool
test_resource_string shouldn't depend on the precise source file contents
1657
        self.assertContainsRe(text, "debug_flags = set()")
3089.3.9 by Ian Clatworthy
add test for resource loading
1658
        # test resource under bzrlib
1659
        text = osutils.resource_string('bzrlib.ui', 'text.py')
1660
        self.assertContainsRe(text, "class TextUIFactory")
1661
        # test unsupported package
1662
        self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
1663
            'yyy.xx')
1664
        # test unknown resource
1665
        self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
4183.6.4 by Martin Pool
Separate out re_compile_checked
1666
1667
4241.14.3 by Vincent Ladeuil
Cleanup imports.
1668
class TestReCompile(tests.TestCase):
4183.6.4 by Martin Pool
Separate out re_compile_checked
1669
1670
    def test_re_compile_checked(self):
1671
        r = osutils.re_compile_checked(r'A*', re.IGNORECASE)
1672
        self.assertTrue(r.match('aaaa'))
1673
        self.assertTrue(r.match('aAaA'))
1674
1675
    def test_re_compile_checked_error(self):
1676
        # like https://bugs.launchpad.net/bzr/+bug/251352
1677
        err = self.assertRaises(
1678
            errors.BzrCommandError,
1679
            osutils.re_compile_checked, '*', re.IGNORECASE, 'test case')
1680
        self.assertEqual(
1681
            "Invalid regular expression in test case: '*': "
1682
            "nothing to repeat",
1683
            str(err))
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
1684
1685
1686
class TestDirReader(tests.TestCaseInTempDir):
1687
1688
    # Set by load_tests
1689
    _dir_reader_class = None
1690
    _native_to_unicode = None
1691
1692
    def setUp(self):
1693
        tests.TestCaseInTempDir.setUp(self)
4985.2.1 by Vincent Ladeuil
Deploy addAttrCleanup on the whole test suite.
1694
        self.addAttrCleanup(osutils, '_selected_dir_reader')
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
1695
        osutils._selected_dir_reader = self._dir_reader_class()
1696
1697
    def _get_ascii_tree(self):
1698
        tree = [
1699
            '0file',
1700
            '1dir/',
1701
            '1dir/0file',
1702
            '1dir/1dir/',
1703
            '2file'
1704
            ]
1705
        expected_dirblocks = [
1706
                (('', '.'),
1707
                 [('0file', '0file', 'file'),
1708
                  ('1dir', '1dir', 'directory'),
1709
                  ('2file', '2file', 'file'),
1710
                 ]
1711
                ),
1712
                (('1dir', './1dir'),
1713
                 [('1dir/0file', '0file', 'file'),
1714
                  ('1dir/1dir', '1dir', 'directory'),
1715
                 ]
1716
                ),
1717
                (('1dir/1dir', './1dir/1dir'),
1718
                 [
1719
                 ]
1720
                ),
1721
            ]
1722
        return tree, expected_dirblocks
1723
1724
    def test_walk_cur_dir(self):
1725
        tree, expected_dirblocks = self._get_ascii_tree()
1726
        self.build_tree(tree)
1727
        result = list(osutils._walkdirs_utf8('.'))
1728
        # Filter out stat and abspath
1729
        self.assertEqual(expected_dirblocks,
1730
                         [(dirinfo, [line[0:3] for line in block])
1731
                          for dirinfo, block in result])
1732
1733
    def test_walk_sub_dir(self):
1734
        tree, expected_dirblocks = self._get_ascii_tree()
1735
        self.build_tree(tree)
1736
        # you can search a subdir only, with a supplied prefix.
1737
        result = list(osutils._walkdirs_utf8('./1dir', '1dir'))
1738
        # Filter out stat and abspath
1739
        self.assertEqual(expected_dirblocks[1:],
1740
                         [(dirinfo, [line[0:3] for line in block])
1741
                          for dirinfo, block in result])
1742
1743
    def _get_unicode_tree(self):
1744
        name0u = u'0file-\xb6'
1745
        name1u = u'1dir-\u062c\u0648'
1746
        name2u = u'2file-\u0633'
1747
        tree = [
1748
            name0u,
1749
            name1u + '/',
1750
            name1u + '/' + name0u,
1751
            name1u + '/' + name1u + '/',
1752
            name2u,
1753
            ]
1754
        name0 = name0u.encode('UTF-8')
1755
        name1 = name1u.encode('UTF-8')
1756
        name2 = name2u.encode('UTF-8')
1757
        expected_dirblocks = [
1758
                (('', '.'),
1759
                 [(name0, name0, 'file', './' + name0u),
1760
                  (name1, name1, 'directory', './' + name1u),
1761
                  (name2, name2, 'file', './' + name2u),
1762
                 ]
1763
                ),
1764
                ((name1, './' + name1u),
1765
                 [(name1 + '/' + name0, name0, 'file', './' + name1u
1766
                                                        + '/' + name0u),
1767
                  (name1 + '/' + name1, name1, 'directory', './' + name1u
1768
                                                            + '/' + name1u),
1769
                 ]
1770
                ),
1771
                ((name1 + '/' + name1, './' + name1u + '/' + name1u),
1772
                 [
1773
                 ]
1774
                ),
1775
            ]
1776
        return tree, expected_dirblocks
1777
4241.14.7 by Vincent Ladeuil
Add a test for symlinks name handling.
1778
    def _filter_out(self, raw_dirblocks):
1779
        """Filter out a walkdirs_utf8 result.
1780
1781
        stat field is removed, all native paths are converted to unicode
1782
        """
1783
        filtered_dirblocks = []
1784
        for dirinfo, block in raw_dirblocks:
4241.14.6 by Vincent Ladeuil
Start DirReader parametrized tests.
1785
            dirinfo = (dirinfo[0], self._native_to_unicode(dirinfo[1]))
1786
            details = []
1787
            for line in block:
4789.25.5 by John Arbash Meinel
Remove a pdb.set_trace() call.
1788
                details.append(line[0:3] + (self._native_to_unicode(line[4]), ))
4241.14.7 by Vincent Ladeuil
Add a test for symlinks name handling.
1789
            filtered_dirblocks.append((dirinfo, details))
1790
        return filtered_dirblocks
1791
1792
    def test_walk_unicode_tree(self):
4241.14.25 by Vincent Ladeuil
Fix PQM failures.
1793
        self.requireFeature(tests.UnicodeFilenameFeature)
4241.14.7 by Vincent Ladeuil
Add a test for symlinks name handling.
1794
        tree, expected_dirblocks = self._get_unicode_tree()
1795
        self.build_tree(tree)
1796
        result = list(osutils._walkdirs_utf8('.'))
1797
        self.assertEqual(expected_dirblocks, self._filter_out(result))
1798
1799
    def test_symlink(self):
1800
        self.requireFeature(tests.SymlinkFeature)
4241.14.25 by Vincent Ladeuil
Fix PQM failures.
1801
        self.requireFeature(tests.UnicodeFilenameFeature)
4241.14.14 by Vincent Ladeuil
Test and implements osutils.readlink().
1802
        target = u'target\N{Euro Sign}'
1803
        link_name = u'l\N{Euro Sign}nk'
4241.14.7 by Vincent Ladeuil
Add a test for symlinks name handling.
1804
        os.symlink(target, link_name)
1805
        target_utf8 = target.encode('UTF-8')
1806
        link_name_utf8 = link_name.encode('UTF-8')
1807
        expected_dirblocks = [
1808
                (('', '.'),
1809
                 [(link_name_utf8, link_name_utf8,
1810
                   'symlink', './' + link_name),],
1811
                 )]
1812
        result = list(osutils._walkdirs_utf8('.'))
1813
        self.assertEqual(expected_dirblocks, self._filter_out(result))
4241.14.14 by Vincent Ladeuil
Test and implements osutils.readlink().
1814
1815
1816
class TestReadLink(tests.TestCaseInTempDir):
1817
    """Exposes os.readlink() problems and the osutils solution.
1818
1819
    The only guarantee offered by os.readlink(), starting with 2.6, is that a
1820
    unicode string will be returned if a unicode string is passed.
1821
4241.14.25 by Vincent Ladeuil
Fix PQM failures.
1822
    But prior python versions failed to properly encode the passed unicode
4241.14.14 by Vincent Ladeuil
Test and implements osutils.readlink().
1823
    string.
1824
    """
4331.1.3 by Vincent Ladeuil
Revert previous patch, PQM now presents a unicode friendly file system encoding.
1825
    _test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
4241.14.14 by Vincent Ladeuil
Test and implements osutils.readlink().
1826
1827
    def setUp(self):
1828
        super(tests.TestCaseInTempDir, self).setUp()
1829
        self.link = u'l\N{Euro Sign}ink'
1830
        self.target = u'targe\N{Euro Sign}t'
1831
        os.symlink(self.target, self.link)
1832
1833
    def test_os_readlink_link_encoding(self):
1834
        if sys.version_info < (2, 6):
1835
            self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
1836
        else:
1837
            self.assertEquals(self.target,  os.readlink(self.link))
1838
1839
    def test_os_readlink_link_decoding(self):
1840
        self.assertEquals(self.target.encode(osutils._fs_enc),
1841
                          os.readlink(self.link.encode(osutils._fs_enc)))
4398.4.3 by Vincent Ladeuil
Detect # cores on win32 and Solaris too.
1842
1843
1844
class TestConcurrency(tests.TestCase):
1845
4766.3.4 by Matt Nordhoff
Change the environment variable to a global option.
1846
    def setUp(self):
1847
        super(TestConcurrency, self).setUp()
4985.2.1 by Vincent Ladeuil
Deploy addAttrCleanup on the whole test suite.
1848
        self.addAttrCleanup(osutils, '_cached_local_concurrency')
4766.3.4 by Matt Nordhoff
Change the environment variable to a global option.
1849
4398.4.3 by Vincent Ladeuil
Detect # cores on win32 and Solaris too.
1850
    def test_local_concurrency(self):
1851
        concurrency = osutils.local_concurrency()
1852
        self.assertIsInstance(concurrency, int)
4574.3.3 by Martin Pool
Add test for failure to load extensions
1853
4766.3.7 by Vincent Ladeuil
Mix BZR_CONCURRENCY and --concurrency so both are available.
1854
    def test_local_concurrency_environment_variable(self):
1855
        os.environ['BZR_CONCURRENCY'] = '2'
1856
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1857
        os.environ['BZR_CONCURRENCY'] = '3'
1858
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1859
        os.environ['BZR_CONCURRENCY'] = 'foo'
1860
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1861
1862
    def test_option_concurrency(self):
1863
        os.environ['BZR_CONCURRENCY'] = '1'
1864
        self.run_bzr('rocks --concurrency 42')
1865
        # Command line overrides envrionment variable
1866
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1867
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
4766.3.1 by Matt Nordhoff
Add a BZR_CONCURRENCY environment variable, so users can control osutils.local_concurrency()
1868
4574.3.3 by Martin Pool
Add test for failure to load extensions
1869
1870
class TestFailedToLoadExtension(tests.TestCase):
1871
1872
    def _try_loading(self):
1873
        try:
1874
            import bzrlib._fictional_extension_py
1875
        except ImportError, e:
4574.3.8 by Martin Pool
Only mutter extension load errors when they occur, and record for later
1876
            osutils.failed_to_load_extension(e)
4574.3.3 by Martin Pool
Add test for failure to load extensions
1877
            return True
1878
4574.3.8 by Martin Pool
Only mutter extension load errors when they occur, and record for later
1879
    def setUp(self):
1880
        super(TestFailedToLoadExtension, self).setUp()
4985.2.1 by Vincent Ladeuil
Deploy addAttrCleanup on the whole test suite.
1881
        self.addAttrCleanup(osutils, '_extension_load_failures')
1882
        osutils._extension_load_failures = []
4574.3.8 by Martin Pool
Only mutter extension load errors when they occur, and record for later
1883
4574.3.3 by Martin Pool
Add test for failure to load extensions
1884
    def test_failure_to_load(self):
4574.3.8 by Martin Pool
Only mutter extension load errors when they occur, and record for later
1885
        self._try_loading()
1886
        self.assertLength(1, osutils._extension_load_failures)
1887
        self.assertEquals(osutils._extension_load_failures[0],
1888
            "No module named _fictional_extension_py")
1889
4695.4.1 by Martin Pool
Give a shorter/cleaner message for missing extensions
1890
    def test_report_extension_load_failures_no_warning(self):
4574.3.8 by Martin Pool
Only mutter extension load errors when they occur, and record for later
1891
        self.assertTrue(self._try_loading())
1892
        warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
4695.4.1 by Martin Pool
Give a shorter/cleaner message for missing extensions
1893
        # it used to give a Python warning; it no longer does
1894
        self.assertLength(0, warnings)
1895
1896
    def test_report_extension_load_failures_message(self):
1897
        log = StringIO()
1898
        trace.push_log_file(log)
1899
        self.assertTrue(self._try_loading())
1900
        osutils.report_extension_load_failures()
1901
        self.assertContainsRe(
1902
            log.getvalue(),
1903
            r"bzr: warning: some compiled extensions could not be loaded; "
1904
            "see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
1905
            )
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1906
1907
1908
class TestTerminalWidth(tests.TestCase):
1909
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1910
    def replace_stdout(self, new):
4985.2.1 by Vincent Ladeuil
Deploy addAttrCleanup on the whole test suite.
1911
        self.addAttrCleanup(sys, 'stdout')
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1912
        sys.stdout = new
1913
1914
    def replace__terminal_size(self, new):
4985.2.1 by Vincent Ladeuil
Deploy addAttrCleanup on the whole test suite.
1915
        self.addAttrCleanup(osutils, '_terminal_size')
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1916
        osutils._terminal_size = new
1917
4747.4.7 by Vincent Ladeuil
Fix broken test (fail on windows).
1918
    def set_fake_tty(self):
1919
1920
        class I_am_a_tty(object):
1921
            def isatty(self):
1922
                return True
1923
1924
        self.replace_stdout(I_am_a_tty())
1925
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1926
    def test_default_values(self):
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1927
        self.assertEqual(80, osutils.default_terminal_width)
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1928
4747.3.7 by Vincent Ladeuil
Introduce BZR_COLUMNS since COLUMNS behaviour is too obscure.
1929
    def test_defaults_to_BZR_COLUMNS(self):
1930
        # BZR_COLUMNS is set by the test framework
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1931
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
4747.3.7 by Vincent Ladeuil
Introduce BZR_COLUMNS since COLUMNS behaviour is too obscure.
1932
        os.environ['BZR_COLUMNS'] = '12'
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1933
        self.assertEqual(12, osutils.terminal_width())
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1934
4747.4.3 by Vincent Ladeuil
Re-fix the priority order since there is a known valid case.
1935
    def test_falls_back_to_COLUMNS(self):
1936
        del os.environ['BZR_COLUMNS']
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1937
        self.assertNotEqual('42', os.environ['COLUMNS'])
4747.4.7 by Vincent Ladeuil
Fix broken test (fail on windows).
1938
        self.set_fake_tty()
4747.4.3 by Vincent Ladeuil
Re-fix the priority order since there is a known valid case.
1939
        os.environ['COLUMNS'] = '42'
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1940
        self.assertEqual(42, osutils.terminal_width())
4747.4.3 by Vincent Ladeuil
Re-fix the priority order since there is a known valid case.
1941
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1942
    def test_tty_default_without_columns(self):
4747.3.7 by Vincent Ladeuil
Introduce BZR_COLUMNS since COLUMNS behaviour is too obscure.
1943
        del os.environ['BZR_COLUMNS']
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1944
        del os.environ['COLUMNS']
4747.3.5 by Vincent Ladeuil
More precise test.
1945
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1946
        def terminal_size(w, h):
1947
            return 42, 42
1948
4747.4.7 by Vincent Ladeuil
Fix broken test (fail on windows).
1949
        self.set_fake_tty()
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1950
        # We need to override the osutils definition as it depends on the
1951
        # running environment that we can't control (PQM running without a
1952
        # controlling terminal is one example).
1953
        self.replace__terminal_size(terminal_size)
1954
        self.assertEqual(42, osutils.terminal_width())
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1955
1956
    def test_non_tty_default_without_columns(self):
4747.3.7 by Vincent Ladeuil
Introduce BZR_COLUMNS since COLUMNS behaviour is too obscure.
1957
        del os.environ['BZR_COLUMNS']
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1958
        del os.environ['COLUMNS']
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1959
        self.replace_stdout(None)
1960
        self.assertEqual(None, osutils.terminal_width())
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1961
4873.2.2 by John Arbash Meinel
Change the TIOCGWINSZ test to use a _ModuleFeature. (fixes bug #492561)
1962
    def test_no_TIOCGWINSZ(self):
4913.2.20 by John Arbash Meinel
Change all of the compiled_foo to compiled_foo_feature
1963
        self.requireFeature(term_ios_feature)
1964
        termios = term_ios_feature.module
4747.3.4 by Vincent Ladeuil
Add tests, introduce explicit default values, always respect COLUMNS.
1965
        # bug 63539 is about a termios without TIOCGWINSZ attribute
1966
        try:
1967
            orig = termios.TIOCGWINSZ
1968
        except AttributeError:
4873.2.2 by John Arbash Meinel
Change the TIOCGWINSZ test to use a _ModuleFeature. (fixes bug #492561)
1969
            # We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
1970
            pass
1971
        else:
4985.2.1 by Vincent Ladeuil
Deploy addAttrCleanup on the whole test suite.
1972
            self.addAttrCleanup(termios, 'TIOCGWINSZ')
4873.2.2 by John Arbash Meinel
Change the TIOCGWINSZ test to use a _ModuleFeature. (fixes bug #492561)
1973
            del termios.TIOCGWINSZ
4747.3.7 by Vincent Ladeuil
Introduce BZR_COLUMNS since COLUMNS behaviour is too obscure.
1974
        del os.environ['BZR_COLUMNS']
4747.3.6 by Vincent Ladeuil
terminal_width can now returns None.
1975
        del os.environ['COLUMNS']
4747.4.5 by Vincent Ladeuil
More robusts tests for osutils.terminal_width().
1976
        # Whatever the result is, if we don't raise an exception, it's ok.
1977
        osutils.terminal_width()