~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_osutils.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-02 19:56:24 UTC
  • mto: This revision was merged to the branch mainline in revision 4469.
  • Revision ID: john@arbash-meinel.com-20090602195624-utljsyz0qgmq63lg
Add a chunks_to_gzip function.
This allows the _record_to_data code to build up a list of chunks,
rather than requiring a single string.
It should be ~ the same performance when using a single string, since
we are only adding a for() loop over the chunks and an if check.
We could possibly just remove the if check and not worry about adding
some empty strings in there.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
21
21
import os
22
22
import re
23
23
import socket
 
24
import stat
24
25
import sys
25
26
import time
26
27
 
27
28
from bzrlib import (
28
29
    errors,
29
 
    lazy_regex,
30
30
    osutils,
31
 
    symbol_versioning,
32
31
    tests,
33
 
    trace,
34
32
    win32utils,
35
33
    )
36
34
from bzrlib.tests import (
37
 
    features,
38
35
    file_utils,
39
36
    test__walkdirs_win32,
40
37
    )
41
 
from bzrlib.tests.scenarios import load_tests_apply_scenarios
42
 
 
43
 
 
44
 
class _UTF8DirReaderFeature(features.Feature):
 
38
 
 
39
 
 
40
class _UTF8DirReaderFeature(tests.Feature):
45
41
 
46
42
    def _probe(self):
47
43
        try:
54
50
    def feature_name(self):
55
51
        return 'bzrlib._readdir_pyx'
56
52
 
57
 
UTF8DirReaderFeature = features.ModuleAvailableFeature('bzrlib._readdir_pyx')
58
 
 
59
 
term_ios_feature = features.ModuleAvailableFeature('termios')
 
53
UTF8DirReaderFeature = _UTF8DirReaderFeature()
60
54
 
61
55
 
62
56
def _already_unicode(s):
63
57
    return s
64
58
 
65
59
 
 
60
def _fs_enc_to_unicode(s):
 
61
    return s.decode(osutils._fs_enc)
 
62
 
 
63
 
66
64
def _utf8_to_unicode(s):
67
65
    return s.decode('UTF-8')
68
66
 
85
83
                          dict(_dir_reader_class=_readdir_pyx.UTF8DirReader,
86
84
                               _native_to_unicode=_utf8_to_unicode)))
87
85
 
88
 
    if test__walkdirs_win32.win32_readdir_feature.available():
 
86
    if test__walkdirs_win32.Win32ReadDirFeature.available():
89
87
        try:
90
88
            from bzrlib import _walkdirs_win32
 
89
            # TODO: check on windows, it may be that we need to use/add
 
90
            # safe_unicode instead of _fs_enc_to_unicode
91
91
            scenarios.append(
92
92
                ('win32',
93
93
                 dict(_dir_reader_class=_walkdirs_win32.Win32ReadDir,
94
 
                      _native_to_unicode=_already_unicode)))
 
94
                      _native_to_unicode=_fs_enc_to_unicode)))
95
95
        except ImportError:
96
96
            pass
97
97
    return scenarios
98
98
 
99
99
 
100
 
load_tests = load_tests_apply_scenarios
 
100
def load_tests(basic_tests, module, loader):
 
101
    suite = loader.suiteClass()
 
102
    dir_reader_tests, remaining_tests = tests.split_suite_by_condition(
 
103
        basic_tests, tests.condition_isinstance(TestDirReader))
 
104
    tests.multiply_tests(dir_reader_tests, dir_reader_scenarios(), suite)
 
105
    suite.addTest(remaining_tests)
 
106
    return suite
101
107
 
102
108
 
103
109
class TestContainsWhitespace(tests.TestCase):
104
110
 
105
111
    def test_contains_whitespace(self):
106
 
        self.assertTrue(osutils.contains_whitespace(u' '))
107
 
        self.assertTrue(osutils.contains_whitespace(u'hello there'))
108
 
        self.assertTrue(osutils.contains_whitespace(u'hellothere\n'))
109
 
        self.assertTrue(osutils.contains_whitespace(u'hello\nthere'))
110
 
        self.assertTrue(osutils.contains_whitespace(u'hello\rthere'))
111
 
        self.assertTrue(osutils.contains_whitespace(u'hello\tthere'))
 
112
        self.failUnless(osutils.contains_whitespace(u' '))
 
113
        self.failUnless(osutils.contains_whitespace(u'hello there'))
 
114
        self.failUnless(osutils.contains_whitespace(u'hellothere\n'))
 
115
        self.failUnless(osutils.contains_whitespace(u'hello\nthere'))
 
116
        self.failUnless(osutils.contains_whitespace(u'hello\rthere'))
 
117
        self.failUnless(osutils.contains_whitespace(u'hello\tthere'))
112
118
 
113
119
        # \xa0 is "Non-breaking-space" which on some python locales thinks it
114
120
        # is whitespace, but we do not.
115
 
        self.assertFalse(osutils.contains_whitespace(u''))
116
 
        self.assertFalse(osutils.contains_whitespace(u'hellothere'))
117
 
        self.assertFalse(osutils.contains_whitespace(u'hello\xa0there'))
 
121
        self.failIf(osutils.contains_whitespace(u''))
 
122
        self.failIf(osutils.contains_whitespace(u'hellothere'))
 
123
        self.failIf(osutils.contains_whitespace(u'hello\xa0there'))
118
124
 
119
125
 
120
126
class TestRename(tests.TestCaseInTempDir):
121
127
 
122
 
    def create_file(self, filename, content):
123
 
        f = open(filename, 'wb')
124
 
        try:
125
 
            f.write(content)
126
 
        finally:
127
 
            f.close()
128
 
 
129
 
    def _fancy_rename(self, a, b):
130
 
        osutils.fancy_rename(a, b, rename_func=os.rename,
131
 
                             unlink_func=os.unlink)
132
 
 
133
128
    def test_fancy_rename(self):
134
129
        # This should work everywhere
135
 
        self.create_file('a', 'something in a\n')
136
 
        self._fancy_rename('a', 'b')
137
 
        self.assertPathDoesNotExist('a')
138
 
        self.assertPathExists('b')
 
130
        def rename(a, b):
 
131
            osutils.fancy_rename(a, b,
 
132
                    rename_func=os.rename,
 
133
                    unlink_func=os.unlink)
 
134
 
 
135
        open('a', 'wb').write('something in a\n')
 
136
        rename('a', 'b')
 
137
        self.failIfExists('a')
 
138
        self.failUnlessExists('b')
139
139
        self.check_file_contents('b', 'something in a\n')
140
140
 
141
 
        self.create_file('a', 'new something in a\n')
142
 
        self._fancy_rename('b', 'a')
 
141
        open('a', 'wb').write('new something in a\n')
 
142
        rename('b', 'a')
143
143
 
144
144
        self.check_file_contents('a', 'something in a\n')
145
145
 
146
 
    def test_fancy_rename_fails_source_missing(self):
147
 
        # An exception should be raised, and the target should be left in place
148
 
        self.create_file('target', 'data in target\n')
149
 
        self.assertRaises((IOError, OSError), self._fancy_rename,
150
 
                          'missingsource', 'target')
151
 
        self.assertPathExists('target')
152
 
        self.check_file_contents('target', 'data in target\n')
153
 
 
154
 
    def test_fancy_rename_fails_if_source_and_target_missing(self):
155
 
        self.assertRaises((IOError, OSError), self._fancy_rename,
156
 
                          'missingsource', 'missingtarget')
157
 
 
158
146
    def test_rename(self):
159
147
        # Rename should be semi-atomic on all platforms
160
 
        self.create_file('a', 'something in a\n')
 
148
        open('a', 'wb').write('something in a\n')
161
149
        osutils.rename('a', 'b')
162
 
        self.assertPathDoesNotExist('a')
163
 
        self.assertPathExists('b')
 
150
        self.failIfExists('a')
 
151
        self.failUnlessExists('b')
164
152
        self.check_file_contents('b', 'something in a\n')
165
153
 
166
 
        self.create_file('a', 'new something in a\n')
 
154
        open('a', 'wb').write('new something in a\n')
167
155
        osutils.rename('b', 'a')
168
156
 
169
157
        self.check_file_contents('a', 'something in a\n')
231
219
            self.assertFalse(osutils.is_inside_or_parent_of_any(dirs, fn))
232
220
 
233
221
 
234
 
class TestLstat(tests.TestCaseInTempDir):
235
 
 
236
 
    def test_lstat_matches_fstat(self):
237
 
        # On Windows, lstat and fstat don't always agree, primarily in the
238
 
        # 'st_ino' and 'st_dev' fields. So we force them to be '0' in our
239
 
        # custom implementation.
240
 
        if sys.platform == 'win32':
241
 
            # We only have special lstat/fstat if we have the extension.
242
 
            # Without it, we may end up re-reading content when we don't have
243
 
            # to, but otherwise it doesn't effect correctness.
244
 
            self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
245
 
        f = open('test-file.txt', 'wb')
246
 
        self.addCleanup(f.close)
247
 
        f.write('some content\n')
248
 
        f.flush()
249
 
        self.assertEqualStat(osutils.fstat(f.fileno()),
250
 
                             osutils.lstat('test-file.txt'))
251
 
 
252
 
 
253
222
class TestRmTree(tests.TestCaseInTempDir):
254
223
 
255
224
    def test_rmtree(self):
267
236
 
268
237
        osutils.rmtree('dir')
269
238
 
270
 
        self.assertPathDoesNotExist('dir/file')
271
 
        self.assertPathDoesNotExist('dir')
272
 
 
273
 
 
274
 
class TestDeleteAny(tests.TestCaseInTempDir):
275
 
 
276
 
    def test_delete_any_readonly(self):
277
 
        # from <https://bugs.launchpad.net/bzr/+bug/218206>
278
 
        self.build_tree(['d/', 'f'])
279
 
        osutils.make_readonly('d')
280
 
        osutils.make_readonly('f')
281
 
 
282
 
        osutils.delete_any('f')
283
 
        osutils.delete_any('d')
 
239
        self.failIfExists('dir/file')
 
240
        self.failIfExists('dir')
284
241
 
285
242
 
286
243
class TestKind(tests.TestCaseInTempDir):
325
282
        self.assertEqual("/", osutils.kind_marker(osutils._directory_kind))
326
283
        self.assertEqual("@", osutils.kind_marker("symlink"))
327
284
        self.assertEqual("+", osutils.kind_marker("tree-reference"))
328
 
        self.assertEqual("", osutils.kind_marker("fifo"))
329
 
        self.assertEqual("", osutils.kind_marker("socket"))
330
 
        self.assertEqual("", osutils.kind_marker("unknown"))
 
285
        self.assertRaises(errors.BzrError, osutils.kind_marker, "unknown")
331
286
 
332
287
 
333
288
class TestUmask(tests.TestCaseInTempDir):
398
353
        # Instead blackbox.test_locale should check for localized
399
354
        # dates once they do occur in output strings.
400
355
 
401
 
    def test_format_date_with_offset_in_original_timezone(self):
402
 
        self.assertEqual("Thu 1970-01-01 00:00:00 +0000",
403
 
            osutils.format_date_with_offset_in_original_timezone(0))
404
 
        self.assertEqual("Fri 1970-01-02 03:46:40 +0000",
405
 
            osutils.format_date_with_offset_in_original_timezone(100000))
406
 
        self.assertEqual("Fri 1970-01-02 05:46:40 +0200",
407
 
            osutils.format_date_with_offset_in_original_timezone(100000, 7200))
408
 
 
409
356
    def test_local_time_offset(self):
410
357
        """Test that local_time_offset() returns a sane value."""
411
358
        offset = osutils.local_time_offset()
429
376
class TestLinks(tests.TestCaseInTempDir):
430
377
 
431
378
    def test_dereference_path(self):
432
 
        self.requireFeature(features.SymlinkFeature)
 
379
        self.requireFeature(tests.SymlinkFeature)
433
380
        cwd = osutils.realpath('.')
434
381
        os.mkdir('bar')
435
382
        bar_path = osutils.pathjoin(cwd, 'bar')
482
429
 
483
430
class TestCanonicalRelPath(tests.TestCaseInTempDir):
484
431
 
485
 
    _test_needs_features = [features.CaseInsCasePresFilenameFeature]
 
432
    _test_needs_features = [tests.CaseInsCasePresFilenameFeature]
486
433
 
487
434
    def test_canonical_relpath_simple(self):
488
435
        f = file('MixedCaseName', 'w')
489
436
        f.close()
490
 
        actual = osutils.canonical_relpath(self.test_base_dir, 'mixedcasename')
491
 
        self.assertEqual('work/MixedCaseName', actual)
 
437
        # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
 
438
        real_base_dir = osutils.realpath(self.test_base_dir)
 
439
        actual = osutils.canonical_relpath(real_base_dir, 'mixedcasename')
 
440
        self.failUnlessEqual('work/MixedCaseName', actual)
492
441
 
493
442
    def test_canonical_relpath_missing_tail(self):
494
443
        os.mkdir('MixedCaseParent')
495
 
        actual = osutils.canonical_relpath(self.test_base_dir,
 
444
        # Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
 
445
        real_base_dir = osutils.realpath(self.test_base_dir)
 
446
        actual = osutils.canonical_relpath(real_base_dir,
496
447
                                           'mixedcaseparent/nochild')
497
 
        self.assertEqual('work/MixedCaseParent/nochild', actual)
498
 
 
499
 
 
500
 
class Test_CICPCanonicalRelpath(tests.TestCaseWithTransport):
501
 
 
502
 
    def assertRelpath(self, expected, base, path):
503
 
        actual = osutils._cicp_canonical_relpath(base, path)
504
 
        self.assertEqual(expected, actual)
505
 
 
506
 
    def test_simple(self):
507
 
        self.build_tree(['MixedCaseName'])
508
 
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
509
 
        self.assertRelpath('MixedCaseName', base, 'mixedcAsename')
510
 
 
511
 
    def test_subdir_missing_tail(self):
512
 
        self.build_tree(['MixedCaseParent/', 'MixedCaseParent/a_child'])
513
 
        base = osutils.realpath(self.get_transport('.').local_abspath('.'))
514
 
        self.assertRelpath('MixedCaseParent/a_child', base,
515
 
                           'MixedCaseParent/a_child')
516
 
        self.assertRelpath('MixedCaseParent/a_child', base,
517
 
                           'MixedCaseParent/A_Child')
518
 
        self.assertRelpath('MixedCaseParent/not_child', base,
519
 
                           'MixedCaseParent/not_child')
520
 
 
521
 
    def test_at_root_slash(self):
522
 
        # We can't test this on Windows, because it has a 'MIN_ABS_PATHLENGTH'
523
 
        # check...
524
 
        if osutils.MIN_ABS_PATHLENGTH > 1:
525
 
            raise tests.TestSkipped('relpath requires %d chars'
526
 
                                    % osutils.MIN_ABS_PATHLENGTH)
527
 
        self.assertRelpath('foo', '/', '/foo')
528
 
 
529
 
    def test_at_root_drive(self):
530
 
        if sys.platform != 'win32':
531
 
            raise tests.TestNotApplicable('we can only test drive-letter relative'
532
 
                                          ' paths on Windows where we have drive'
533
 
                                          ' letters.')
534
 
        # see bug #322807
535
 
        # The specific issue is that when at the root of a drive, 'abspath'
536
 
        # returns "C:/" or just "/". However, the code assumes that abspath
537
 
        # always returns something like "C:/foo" or "/foo" (no trailing slash).
538
 
        self.assertRelpath('foo', 'C:/', 'C:/foo')
539
 
        self.assertRelpath('foo', 'X:/', 'X:/foo')
540
 
        self.assertRelpath('foo', 'X:/', 'X://foo')
 
448
        self.failUnlessEqual('work/MixedCaseParent/nochild', actual)
541
449
 
542
450
 
543
451
class TestPumpFile(tests.TestCase):
705
613
        self.assertEqual("1234", output.getvalue())
706
614
 
707
615
 
708
 
class TestRelpath(tests.TestCase):
709
 
 
710
 
    def test_simple_relpath(self):
711
 
        cwd = osutils.getcwd()
712
 
        subdir = cwd + '/subdir'
713
 
        self.assertEqual('subdir', osutils.relpath(cwd, subdir))
714
 
 
715
 
    def test_deep_relpath(self):
716
 
        cwd = osutils.getcwd()
717
 
        subdir = cwd + '/sub/subsubdir'
718
 
        self.assertEqual('sub/subsubdir', osutils.relpath(cwd, subdir))
719
 
 
720
 
    def test_not_relative(self):
721
 
        self.assertRaises(errors.PathNotChild,
722
 
                          osutils.relpath, 'C:/path', 'H:/path')
723
 
        self.assertRaises(errors.PathNotChild,
724
 
                          osutils.relpath, 'C:/', 'H:/path')
725
 
 
726
 
 
727
616
class TestSafeUnicode(tests.TestCase):
728
617
 
729
618
    def test_from_ascii_string(self):
876
765
        self.assertEqual('//HOST/path', osutils._win98_abspath('//HOST/path'))
877
766
        # relative path
878
767
        cwd = osutils.getcwd().rstrip('/')
879
 
        drive = osutils.ntpath.splitdrive(cwd)[0]
 
768
        drive = osutils._nt_splitdrive(cwd)[0]
880
769
        self.assertEqual(cwd+'/path', osutils._win98_abspath('path'))
881
770
        self.assertEqual(drive+'/path', osutils._win98_abspath('/path'))
882
771
        # unicode path
888
777
    """Test win32 functions that create files."""
889
778
 
890
779
    def test_getcwd(self):
891
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
780
        self.requireFeature(tests.UnicodeFilenameFeature)
892
781
        os.mkdir(u'mu-\xb5')
893
782
        os.chdir(u'mu-\xb5')
894
783
        # TODO: jam 20060427 This will probably fail on Mac OSX because
924
813
        b.close()
925
814
 
926
815
        osutils._win32_rename('b', 'a')
927
 
        self.assertPathExists('a')
928
 
        self.assertPathDoesNotExist('b')
 
816
        self.failUnlessExists('a')
 
817
        self.failIfExists('b')
929
818
        self.assertFileEqual('baz\n', 'a')
930
819
 
931
820
    def test_rename_missing_file(self):
984
873
    """Test mac special functions that require directories."""
985
874
 
986
875
    def test_getcwd(self):
987
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
876
        self.requireFeature(tests.UnicodeFilenameFeature)
988
877
        os.mkdir(u'B\xe5gfors')
989
878
        os.chdir(u'B\xe5gfors')
990
879
        self.assertEndsWith(osutils._mac_getcwd(), u'B\xe5gfors')
991
880
 
992
881
    def test_getcwd_nonnorm(self):
993
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
882
        self.requireFeature(tests.UnicodeFilenameFeature)
994
883
        # Test that _mac_getcwd() will normalize this path
995
884
        os.mkdir(u'Ba\u030agfors')
996
885
        os.chdir(u'Ba\u030agfors')
1007
896
 
1008
897
    def test_osutils_binding(self):
1009
898
        from bzrlib.tests import test__chunks_to_lines
1010
 
        if test__chunks_to_lines.compiled_chunkstolines_feature.available():
 
899
        if test__chunks_to_lines.CompiledChunksToLinesFeature.available():
1011
900
            from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1012
901
        else:
1013
902
            from bzrlib._chunks_to_lines_py import chunks_to_lines
1079
968
        self.assertExpectedBlocks(expected_dirblocks[1:], result)
1080
969
 
1081
970
    def test_walkdirs_os_error(self):
1082
 
        # <https://bugs.launchpad.net/bzr/+bug/338653>
 
971
        # <https://bugs.edge.launchpad.net/bzr/+bug/338653>
1083
972
        # Pyrex readdir didn't raise useful messages if it had an error
1084
973
        # reading the directory
1085
974
        if sys.platform == 'win32':
1086
975
            raise tests.TestNotApplicable(
1087
976
                "readdir IOError not tested on win32")
1088
 
        self.requireFeature(features.not_running_as_root)
1089
977
        os.mkdir("test-unreadable")
1090
978
        os.chmod("test-unreadable", 0000)
1091
979
        # must chmod it back so that it can be removed
1099
987
        # Ensure the message contains the file name
1100
988
        self.assertContainsRe(str(e), "\./test-unreadable")
1101
989
 
1102
 
 
1103
 
    def test_walkdirs_encoding_error(self):
1104
 
        # <https://bugs.launchpad.net/bzr/+bug/488519>
1105
 
        # walkdirs didn't raise a useful message when the filenames
1106
 
        # are not using the filesystem's encoding
1107
 
 
1108
 
        # require a bytestring based filesystem
1109
 
        self.requireFeature(features.ByteStringNamedFilesystem)
1110
 
 
1111
 
        tree = [
1112
 
            '.bzr',
1113
 
            '0file',
1114
 
            '1dir/',
1115
 
            '1dir/0file',
1116
 
            '1dir/1dir/',
1117
 
            '1file'
1118
 
            ]
1119
 
 
1120
 
        self.build_tree(tree)
1121
 
 
1122
 
        # rename the 1file to a latin-1 filename
1123
 
        os.rename("./1file", "\xe8file")
1124
 
        if "\xe8file" not in os.listdir("."):
1125
 
            self.skip("Lack filesystem that preserves arbitrary bytes")
1126
 
 
1127
 
        self._save_platform_info()
1128
 
        win32utils.winver = None # Avoid the win32 detection code
1129
 
        osutils._fs_enc = 'UTF-8'
1130
 
 
1131
 
        # this should raise on error
1132
 
        def attempt():
1133
 
            for dirdetail, dirblock in osutils.walkdirs('.'):
1134
 
                pass
1135
 
 
1136
 
        self.assertRaises(errors.BadFilenameEncoding, attempt)
1137
 
 
1138
990
    def test__walkdirs_utf8(self):
1139
991
        tree = [
1140
992
            '.bzr',
1190
1042
            dirblock[:] = new_dirblock
1191
1043
 
1192
1044
    def _save_platform_info(self):
1193
 
        self.overrideAttr(win32utils, 'winver')
1194
 
        self.overrideAttr(osutils, '_fs_enc')
1195
 
        self.overrideAttr(osutils, '_selected_dir_reader')
 
1045
        cur_winver = win32utils.winver
 
1046
        cur_fs_enc = osutils._fs_enc
 
1047
        cur_dir_reader = osutils._selected_dir_reader
 
1048
        def restore():
 
1049
            win32utils.winver = cur_winver
 
1050
            osutils._fs_enc = cur_fs_enc
 
1051
            osutils._selected_dir_reader = cur_dir_reader
 
1052
        self.addCleanup(restore)
1196
1053
 
1197
1054
    def assertDirReaderIs(self, expected):
1198
1055
        """Assert the right implementation for _walkdirs_utf8 is chosen."""
1207
1064
        self._save_platform_info()
1208
1065
        win32utils.winver = None # Avoid the win32 detection code
1209
1066
        osutils._fs_enc = 'UTF-8'
1210
 
        self.assertDirReaderIs(
1211
 
            UTF8DirReaderFeature.module.UTF8DirReader)
 
1067
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1212
1068
 
1213
1069
    def test_force_walkdirs_utf8_fs_ascii(self):
1214
1070
        self.requireFeature(UTF8DirReaderFeature)
1215
1071
        self._save_platform_info()
1216
1072
        win32utils.winver = None # Avoid the win32 detection code
1217
1073
        osutils._fs_enc = 'US-ASCII'
1218
 
        self.assertDirReaderIs(
1219
 
            UTF8DirReaderFeature.module.UTF8DirReader)
 
1074
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1220
1075
 
1221
1076
    def test_force_walkdirs_utf8_fs_ANSI(self):
1222
1077
        self.requireFeature(UTF8DirReaderFeature)
1223
1078
        self._save_platform_info()
1224
1079
        win32utils.winver = None # Avoid the win32 detection code
1225
1080
        osutils._fs_enc = 'ANSI_X3.4-1968'
1226
 
        self.assertDirReaderIs(
1227
 
            UTF8DirReaderFeature.module.UTF8DirReader)
 
1081
        self.assertDirReaderIs(UTF8DirReaderFeature.reader)
1228
1082
 
1229
1083
    def test_force_walkdirs_utf8_fs_latin1(self):
1230
1084
        self._save_platform_info()
1234
1088
 
1235
1089
    def test_force_walkdirs_utf8_nt(self):
1236
1090
        # Disabled because the thunk of the whole walkdirs api is disabled.
1237
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1091
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
1238
1092
        self._save_platform_info()
1239
1093
        win32utils.winver = 'Windows NT'
1240
1094
        from bzrlib._walkdirs_win32 import Win32ReadDir
1241
1095
        self.assertDirReaderIs(Win32ReadDir)
1242
1096
 
1243
1097
    def test_force_walkdirs_utf8_98(self):
1244
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
 
1098
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
1245
1099
        self._save_platform_info()
1246
1100
        win32utils.winver = 'Windows 98'
1247
1101
        self.assertDirReaderIs(osutils.UnicodeDirReader)
1248
1102
 
1249
1103
    def test_unicode_walkdirs(self):
1250
1104
        """Walkdirs should always return unicode paths."""
1251
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
1105
        self.requireFeature(tests.UnicodeFilenameFeature)
1252
1106
        name0 = u'0file-\xb6'
1253
1107
        name1 = u'1dir-\u062c\u0648'
1254
1108
        name2 = u'2file-\u0633'
1291
1145
 
1292
1146
        The abspath portion might be in unicode or utf-8
1293
1147
        """
1294
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
1148
        self.requireFeature(tests.UnicodeFilenameFeature)
1295
1149
        name0 = u'0file-\xb6'
1296
1150
        name1 = u'1dir-\u062c\u0648'
1297
1151
        name2 = u'2file-\u0633'
1352
1206
 
1353
1207
        The abspath portion should be in unicode
1354
1208
        """
1355
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
1209
        self.requireFeature(tests.UnicodeFilenameFeature)
1356
1210
        # Use the unicode reader. TODO: split into driver-and-driven unit
1357
1211
        # tests.
1358
1212
        self._save_platform_info()
1398
1252
        self.assertEqual(expected_dirblocks, result)
1399
1253
 
1400
1254
    def test__walkdirs_utf8_win32readdir(self):
1401
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1402
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
1255
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1256
        self.requireFeature(tests.UnicodeFilenameFeature)
1403
1257
        from bzrlib._walkdirs_win32 import Win32ReadDir
1404
1258
        self._save_platform_info()
1405
1259
        osutils._selected_dir_reader = Win32ReadDir()
1455
1309
 
1456
1310
    def test__walkdirs_utf_win32_find_file_stat_file(self):
1457
1311
        """make sure our Stat values are valid"""
1458
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1459
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
1312
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1313
        self.requireFeature(tests.UnicodeFilenameFeature)
1460
1314
        from bzrlib._walkdirs_win32 import Win32ReadDir
1461
1315
        name0u = u'0file-\xb6'
1462
1316
        name0 = name0u.encode('utf8')
1479
1333
 
1480
1334
    def test__walkdirs_utf_win32_find_file_stat_directory(self):
1481
1335
        """make sure our Stat values are valid"""
1482
 
        self.requireFeature(test__walkdirs_win32.win32_readdir_feature)
1483
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
1336
        self.requireFeature(test__walkdirs_win32.Win32ReadDirFeature)
 
1337
        self.requireFeature(tests.UnicodeFilenameFeature)
1484
1338
        from bzrlib._walkdirs_win32 import Win32ReadDir
1485
1339
        name0u = u'0dir-\u062c\u0648'
1486
1340
        name0 = name0u.encode('utf8')
1586
1440
        self.assertEqual(['c'], os.listdir('target/b'))
1587
1441
 
1588
1442
    def test_copy_tree_symlinks(self):
1589
 
        self.requireFeature(features.SymlinkFeature)
 
1443
        self.requireFeature(tests.SymlinkFeature)
1590
1444
        self.build_tree(['source/'])
1591
1445
        os.symlink('a/generic/path', 'source/lnk')
1592
1446
        osutils.copy_tree('source', 'target')
1617
1471
                          ('d', 'source/b', 'target/b'),
1618
1472
                          ('f', 'source/b/c', 'target/b/c'),
1619
1473
                         ], processed_files)
1620
 
        self.assertPathDoesNotExist('target')
 
1474
        self.failIfExists('target')
1621
1475
        if osutils.has_symlinks():
1622
1476
            self.assertEqual([('source/lnk', 'target/lnk')], processed_links)
1623
1477
 
1634
1488
        def cleanup():
1635
1489
            if 'BZR_TEST_ENV_VAR' in os.environ:
1636
1490
                del os.environ['BZR_TEST_ENV_VAR']
 
1491
 
1637
1492
        self.addCleanup(cleanup)
1638
1493
 
1639
1494
    def test_set(self):
1669
1524
        old = osutils.set_or_unset_env('BZR_TEST_ENV_VAR', None)
1670
1525
        self.assertEqual('foo', old)
1671
1526
        self.assertEqual(None, os.environ.get('BZR_TEST_ENV_VAR'))
1672
 
        self.assertFalse('BZR_TEST_ENV_VAR' in os.environ)
 
1527
        self.failIf('BZR_TEST_ENV_VAR' in os.environ)
1673
1528
 
1674
1529
 
1675
1530
class TestSizeShaFile(tests.TestCaseInTempDir):
1687
1542
        text = 'test\r\nwith\nall\rpossible line endings\r\n'
1688
1543
        self.build_tree_contents([('foo', text)])
1689
1544
        expected_sha = osutils.sha_string(text)
1690
 
        f = open('foo', 'rb')
 
1545
        f = open('foo')
1691
1546
        self.addCleanup(f.close)
1692
1547
        size, sha = osutils.size_sha_file(f)
1693
1548
        self.assertEqual(38, size)
1726
1581
 
1727
1582
class TestReCompile(tests.TestCase):
1728
1583
 
1729
 
    def _deprecated_re_compile_checked(self, *args, **kwargs):
1730
 
        return self.applyDeprecated(symbol_versioning.deprecated_in((2, 2, 0)),
1731
 
            osutils.re_compile_checked, *args, **kwargs)
1732
 
 
1733
1584
    def test_re_compile_checked(self):
1734
 
        r = self._deprecated_re_compile_checked(r'A*', re.IGNORECASE)
 
1585
        r = osutils.re_compile_checked(r'A*', re.IGNORECASE)
1735
1586
        self.assertTrue(r.match('aaaa'))
1736
1587
        self.assertTrue(r.match('aAaA'))
1737
1588
 
1738
1589
    def test_re_compile_checked_error(self):
1739
1590
        # like https://bugs.launchpad.net/bzr/+bug/251352
1740
 
 
1741
 
        # Due to possible test isolation error, re.compile is not lazy at
1742
 
        # this point. We re-install lazy compile.
1743
 
        lazy_regex.install_lazy_compile()
1744
1591
        err = self.assertRaises(
1745
1592
            errors.BzrCommandError,
1746
 
            self._deprecated_re_compile_checked, '*', re.IGNORECASE, 'test case')
 
1593
            osutils.re_compile_checked, '*', re.IGNORECASE, 'test case')
1747
1594
        self.assertEqual(
1748
 
            'Invalid regular expression in test case: '
1749
 
            '"*" nothing to repeat',
 
1595
            "Invalid regular expression in test case: '*': "
 
1596
            "nothing to repeat",
1750
1597
            str(err))
1751
1598
 
1752
1599
 
1753
1600
class TestDirReader(tests.TestCaseInTempDir):
1754
1601
 
1755
 
    scenarios = dir_reader_scenarios()
1756
 
 
1757
1602
    # Set by load_tests
1758
1603
    _dir_reader_class = None
1759
1604
    _native_to_unicode = None
1760
1605
 
1761
1606
    def setUp(self):
1762
1607
        tests.TestCaseInTempDir.setUp(self)
1763
 
        self.overrideAttr(osutils,
1764
 
                          '_selected_dir_reader', self._dir_reader_class())
 
1608
 
 
1609
        # Save platform specific info and reset it
 
1610
        cur_dir_reader = osutils._selected_dir_reader
 
1611
 
 
1612
        def restore():
 
1613
            osutils._selected_dir_reader = cur_dir_reader
 
1614
        self.addCleanup(restore)
 
1615
 
 
1616
        osutils._selected_dir_reader = self._dir_reader_class()
1765
1617
 
1766
1618
    def _get_ascii_tree(self):
1767
1619
        tree = [
1859
1711
        return filtered_dirblocks
1860
1712
 
1861
1713
    def test_walk_unicode_tree(self):
1862
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
1714
        self.requireFeature(tests.UnicodeFilenameFeature)
1863
1715
        tree, expected_dirblocks = self._get_unicode_tree()
1864
1716
        self.build_tree(tree)
1865
1717
        result = list(osutils._walkdirs_utf8('.'))
1866
1718
        self.assertEqual(expected_dirblocks, self._filter_out(result))
1867
1719
 
1868
1720
    def test_symlink(self):
1869
 
        self.requireFeature(features.SymlinkFeature)
1870
 
        self.requireFeature(features.UnicodeFilenameFeature)
 
1721
        self.requireFeature(tests.SymlinkFeature)
 
1722
        self.requireFeature(tests.UnicodeFilenameFeature)
1871
1723
        target = u'target\N{Euro Sign}'
1872
1724
        link_name = u'l\N{Euro Sign}nk'
1873
1725
        os.symlink(target, link_name)
1891
1743
    But prior python versions failed to properly encode the passed unicode
1892
1744
    string.
1893
1745
    """
1894
 
    _test_needs_features = [features.SymlinkFeature, features.UnicodeFilenameFeature]
 
1746
    _test_needs_features = [tests.SymlinkFeature, tests.UnicodeFilenameFeature]
1895
1747
 
1896
1748
    def setUp(self):
1897
1749
        super(tests.TestCaseInTempDir, self).setUp()
1900
1752
        os.symlink(self.target, self.link)
1901
1753
 
1902
1754
    def test_os_readlink_link_encoding(self):
1903
 
        self.assertEquals(self.target,  os.readlink(self.link))
 
1755
        if sys.version_info < (2, 6):
 
1756
            self.assertRaises(UnicodeEncodeError, os.readlink, self.link)
 
1757
        else:
 
1758
            self.assertEquals(self.target,  os.readlink(self.link))
1904
1759
 
1905
1760
    def test_os_readlink_link_decoding(self):
1906
1761
        self.assertEquals(self.target.encode(osutils._fs_enc),
1907
1762
                          os.readlink(self.link.encode(osutils._fs_enc)))
1908
 
 
1909
 
 
1910
 
class TestConcurrency(tests.TestCase):
1911
 
 
1912
 
    def setUp(self):
1913
 
        super(TestConcurrency, self).setUp()
1914
 
        self.overrideAttr(osutils, '_cached_local_concurrency')
1915
 
 
1916
 
    def test_local_concurrency(self):
1917
 
        concurrency = osutils.local_concurrency()
1918
 
        self.assertIsInstance(concurrency, int)
1919
 
 
1920
 
    def test_local_concurrency_environment_variable(self):
1921
 
        self.overrideEnv('BZR_CONCURRENCY', '2')
1922
 
        self.assertEqual(2, osutils.local_concurrency(use_cache=False))
1923
 
        self.overrideEnv('BZR_CONCURRENCY', '3')
1924
 
        self.assertEqual(3, osutils.local_concurrency(use_cache=False))
1925
 
        self.overrideEnv('BZR_CONCURRENCY', 'foo')
1926
 
        self.assertEqual(1, osutils.local_concurrency(use_cache=False))
1927
 
 
1928
 
    def test_option_concurrency(self):
1929
 
        self.overrideEnv('BZR_CONCURRENCY', '1')
1930
 
        self.run_bzr('rocks --concurrency 42')
1931
 
        # Command line overrides environment variable
1932
 
        self.assertEquals('42', os.environ['BZR_CONCURRENCY'])
1933
 
        self.assertEquals(42, osutils.local_concurrency(use_cache=False))
1934
 
 
1935
 
 
1936
 
class TestFailedToLoadExtension(tests.TestCase):
1937
 
 
1938
 
    def _try_loading(self):
1939
 
        try:
1940
 
            import bzrlib._fictional_extension_py
1941
 
        except ImportError, e:
1942
 
            osutils.failed_to_load_extension(e)
1943
 
            return True
1944
 
 
1945
 
    def setUp(self):
1946
 
        super(TestFailedToLoadExtension, self).setUp()
1947
 
        self.overrideAttr(osutils, '_extension_load_failures', [])
1948
 
 
1949
 
    def test_failure_to_load(self):
1950
 
        self._try_loading()
1951
 
        self.assertLength(1, osutils._extension_load_failures)
1952
 
        self.assertEquals(osutils._extension_load_failures[0],
1953
 
            "No module named _fictional_extension_py")
1954
 
 
1955
 
    def test_report_extension_load_failures_no_warning(self):
1956
 
        self.assertTrue(self._try_loading())
1957
 
        warnings, result = self.callCatchWarnings(osutils.report_extension_load_failures)
1958
 
        # it used to give a Python warning; it no longer does
1959
 
        self.assertLength(0, warnings)
1960
 
 
1961
 
    def test_report_extension_load_failures_message(self):
1962
 
        log = StringIO()
1963
 
        trace.push_log_file(log)
1964
 
        self.assertTrue(self._try_loading())
1965
 
        osutils.report_extension_load_failures()
1966
 
        self.assertContainsRe(
1967
 
            log.getvalue(),
1968
 
            r"bzr: warning: some compiled extensions could not be loaded; "
1969
 
            "see <https://answers\.launchpad\.net/bzr/\+faq/703>\n"
1970
 
            )
1971
 
 
1972
 
 
1973
 
class TestTerminalWidth(tests.TestCase):
1974
 
 
1975
 
    def setUp(self):
1976
 
        tests.TestCase.setUp(self)
1977
 
        self._orig_terminal_size_state = osutils._terminal_size_state
1978
 
        self._orig_first_terminal_size = osutils._first_terminal_size
1979
 
        self.addCleanup(self.restore_osutils_globals)
1980
 
        osutils._terminal_size_state = 'no_data'
1981
 
        osutils._first_terminal_size = None
1982
 
 
1983
 
    def restore_osutils_globals(self):
1984
 
        osutils._terminal_size_state = self._orig_terminal_size_state
1985
 
        osutils._first_terminal_size = self._orig_first_terminal_size
1986
 
 
1987
 
    def replace_stdout(self, new):
1988
 
        self.overrideAttr(sys, 'stdout', new)
1989
 
 
1990
 
    def replace__terminal_size(self, new):
1991
 
        self.overrideAttr(osutils, '_terminal_size', new)
1992
 
 
1993
 
    def set_fake_tty(self):
1994
 
 
1995
 
        class I_am_a_tty(object):
1996
 
            def isatty(self):
1997
 
                return True
1998
 
 
1999
 
        self.replace_stdout(I_am_a_tty())
2000
 
 
2001
 
    def test_default_values(self):
2002
 
        self.assertEqual(80, osutils.default_terminal_width)
2003
 
 
2004
 
    def test_defaults_to_BZR_COLUMNS(self):
2005
 
        # BZR_COLUMNS is set by the test framework
2006
 
        self.assertNotEqual('12', os.environ['BZR_COLUMNS'])
2007
 
        self.overrideEnv('BZR_COLUMNS', '12')
2008
 
        self.assertEqual(12, osutils.terminal_width())
2009
 
 
2010
 
    def test_BZR_COLUMNS_0_no_limit(self):
2011
 
        self.overrideEnv('BZR_COLUMNS', '0')
2012
 
        self.assertEqual(None, osutils.terminal_width())
2013
 
 
2014
 
    def test_falls_back_to_COLUMNS(self):
2015
 
        self.overrideEnv('BZR_COLUMNS', None)
2016
 
        self.assertNotEqual('42', os.environ['COLUMNS'])
2017
 
        self.set_fake_tty()
2018
 
        self.overrideEnv('COLUMNS', '42')
2019
 
        self.assertEqual(42, osutils.terminal_width())
2020
 
 
2021
 
    def test_tty_default_without_columns(self):
2022
 
        self.overrideEnv('BZR_COLUMNS', None)
2023
 
        self.overrideEnv('COLUMNS', None)
2024
 
 
2025
 
        def terminal_size(w, h):
2026
 
            return 42, 42
2027
 
 
2028
 
        self.set_fake_tty()
2029
 
        # We need to override the osutils definition as it depends on the
2030
 
        # running environment that we can't control (PQM running without a
2031
 
        # controlling terminal is one example).
2032
 
        self.replace__terminal_size(terminal_size)
2033
 
        self.assertEqual(42, osutils.terminal_width())
2034
 
 
2035
 
    def test_non_tty_default_without_columns(self):
2036
 
        self.overrideEnv('BZR_COLUMNS', None)
2037
 
        self.overrideEnv('COLUMNS', None)
2038
 
        self.replace_stdout(None)
2039
 
        self.assertEqual(None, osutils.terminal_width())
2040
 
 
2041
 
    def test_no_TIOCGWINSZ(self):
2042
 
        self.requireFeature(term_ios_feature)
2043
 
        termios = term_ios_feature.module
2044
 
        # bug 63539 is about a termios without TIOCGWINSZ attribute
2045
 
        try:
2046
 
            orig = termios.TIOCGWINSZ
2047
 
        except AttributeError:
2048
 
            # We won't remove TIOCGWINSZ, because it doesn't exist anyway :)
2049
 
            pass
2050
 
        else:
2051
 
            self.overrideAttr(termios, 'TIOCGWINSZ')
2052
 
            del termios.TIOCGWINSZ
2053
 
        self.overrideEnv('BZR_COLUMNS', None)
2054
 
        self.overrideEnv('COLUMNS', None)
2055
 
        # Whatever the result is, if we don't raise an exception, it's ok.
2056
 
        osutils.terminal_width()
2057
 
 
2058
 
 
2059
 
class TestCreationOps(tests.TestCaseInTempDir):
2060
 
    _test_needs_features = [features.chown_feature]
2061
 
 
2062
 
    def setUp(self):
2063
 
        tests.TestCaseInTempDir.setUp(self)
2064
 
        self.overrideAttr(os, 'chown', self._dummy_chown)
2065
 
 
2066
 
        # params set by call to _dummy_chown
2067
 
        self.path = self.uid = self.gid = None
2068
 
 
2069
 
    def _dummy_chown(self, path, uid, gid):
2070
 
        self.path, self.uid, self.gid = path, uid, gid
2071
 
 
2072
 
    def test_copy_ownership_from_path(self):
2073
 
        """copy_ownership_from_path test with specified src."""
2074
 
        ownsrc = '/'
2075
 
        f = open('test_file', 'wt')
2076
 
        osutils.copy_ownership_from_path('test_file', ownsrc)
2077
 
 
2078
 
        s = os.stat(ownsrc)
2079
 
        self.assertEquals(self.path, 'test_file')
2080
 
        self.assertEquals(self.uid, s.st_uid)
2081
 
        self.assertEquals(self.gid, s.st_gid)
2082
 
 
2083
 
    def test_copy_ownership_nonesrc(self):
2084
 
        """copy_ownership_from_path test with src=None."""
2085
 
        f = open('test_file', 'wt')
2086
 
        # should use parent dir for permissions
2087
 
        osutils.copy_ownership_from_path('test_file')
2088
 
 
2089
 
        s = os.stat('..')
2090
 
        self.assertEquals(self.path, 'test_file')
2091
 
        self.assertEquals(self.uid, s.st_uid)
2092
 
        self.assertEquals(self.gid, s.st_gid)
2093
 
 
2094
 
 
2095
 
class TestGetuserUnicode(tests.TestCase):
2096
 
 
2097
 
    def test_ascii_user(self):
2098
 
        self.overrideEnv('LOGNAME', 'jrandom')
2099
 
        self.assertEqual(u'jrandom', osutils.getuser_unicode())
2100
 
 
2101
 
    def test_unicode_user(self):
2102
 
        ue = osutils.get_user_encoding()
2103
 
        uni_val, env_val = tests.probe_unicode_in_user_encoding()
2104
 
        if uni_val is None:
2105
 
            raise tests.TestSkipped(
2106
 
                'Cannot find a unicode character that works in encoding %s'
2107
 
                % (osutils.get_user_encoding(),))
2108
 
        uni_username = u'jrandom' + uni_val
2109
 
        encoded_username = uni_username.encode(ue)
2110
 
        self.overrideEnv('LOGNAME', encoded_username)
2111
 
        self.assertEqual(uni_username, osutils.getuser_unicode())
2112
 
        self.overrideEnv('LOGNAME', u'jrandom\xb6'.encode(ue))
2113
 
        self.assertEqual(u'jrandom\xb6', osutils.getuser_unicode())
2114
 
 
2115
 
    def test_no_username_bug_660174(self):
2116
 
        self.requireFeature(features.win32_feature)
2117
 
        for name in ('LOGNAME', 'USER', 'LNAME', 'USERNAME'):
2118
 
            self.overrideEnv(name, None)
2119
 
        self.assertEqual(u'UNKNOWN', osutils.getuser_unicode())
2120
 
 
2121
 
 
2122
 
class TestBackupNames(tests.TestCase):
2123
 
 
2124
 
    def setUp(self):
2125
 
        super(TestBackupNames, self).setUp()
2126
 
        self.backups = []
2127
 
 
2128
 
    def backup_exists(self, name):
2129
 
        return name in self.backups
2130
 
 
2131
 
    def available_backup_name(self, name):
2132
 
        backup_name = osutils.available_backup_name(name, self.backup_exists)
2133
 
        self.backups.append(backup_name)
2134
 
        return backup_name
2135
 
 
2136
 
    def assertBackupName(self, expected, name):
2137
 
        self.assertEqual(expected, self.available_backup_name(name))
2138
 
 
2139
 
    def test_empty(self):
2140
 
        self.assertBackupName('file.~1~', 'file')
2141
 
 
2142
 
    def test_existing(self):
2143
 
        self.available_backup_name('file')
2144
 
        self.available_backup_name('file')
2145
 
        self.assertBackupName('file.~3~', 'file')
2146
 
        # Empty slots are found, this is not a strict requirement and may be
2147
 
        # revisited if we test against all implementations.
2148
 
        self.backups.remove('file.~2~')
2149
 
        self.assertBackupName('file.~2~', 'file')
2150
 
 
2151
 
 
2152
 
class TestFindExecutableInPath(tests.TestCase):
2153
 
 
2154
 
    def test_windows(self):
2155
 
        if sys.platform != 'win32':
2156
 
            raise tests.TestSkipped('test requires win32')
2157
 
        self.assertTrue(osutils.find_executable_on_path('explorer') is not None)
2158
 
        self.assertTrue(
2159
 
            osutils.find_executable_on_path('explorer.exe') is not None)
2160
 
        self.assertTrue(
2161
 
            osutils.find_executable_on_path('EXPLORER.EXE') is not None)
2162
 
        self.assertTrue(
2163
 
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)
2164
 
        self.assertTrue(osutils.find_executable_on_path('file.txt') is None)
2165
 
 
2166
 
    def test_other(self):
2167
 
        if sys.platform == 'win32':
2168
 
            raise tests.TestSkipped('test requires non-win32')
2169
 
        self.assertTrue(osutils.find_executable_on_path('sh') is not None)
2170
 
        self.assertTrue(
2171
 
            osutils.find_executable_on_path('THIS SHOULD NOT EXIST') is None)