~bzr-pqm/bzr/bzr.dev

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