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