1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
# copyright 2003-2012 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of logilab-common.
#
# logilab-common is free software: you can redistribute it and/or modify it under
# the terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option) any
# later version.
#
# logilab-common is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with logilab-common. If not, see <http://www.gnu.org/licenses/>.
"""unit tests for logilab.common.fileutils"""
import doctest
import sys
import os
import tempfile
import shutil
from stat import S_IWRITE
from os.path import join
from logilab.common.testlib import TestCase, unittest_main
from logilab.common.fileutils import (
first_level_directory,
is_binary,
write_open_mode,
lines,
export,
exists,
ProtectedFile,
)
DATA_DIR = join(os.path.abspath(os.path.dirname(__file__)), "data")
NEWLINES_TXT = join(DATA_DIR, "newlines.txt")
class FirstleveldirectoryTC(TestCase):
def test_known_values_first_level_directory(self):
"""return the first level directory of a path"""
self.assertEqual(first_level_directory("truc/bidule/chouette"), "truc", None)
self.assertEqual(first_level_directory("/truc/bidule/chouette"), "/", None)
class IsBinaryTC(TestCase):
def test(self):
self.assertEqual(is_binary("toto.txt"), 0)
# self.assertEqual(is_binary('toto.xml'), 0)
self.assertEqual(is_binary("toto.bin"), 1)
self.assertEqual(is_binary("toto.sxi"), 1)
self.assertEqual(is_binary("toto.whatever"), 1)
class GetModeTC(TestCase):
def test(self):
self.assertEqual(write_open_mode("toto.txt"), "w")
# self.assertEqual(write_open_mode('toto.xml'), 'w')
self.assertEqual(write_open_mode("toto.bin"), "wb")
self.assertEqual(write_open_mode("toto.sxi"), "wb")
class NormReadTC(TestCase):
def test_known_values_norm_read(self):
with open(NEWLINES_TXT) as f:
data = f.read()
self.assertEqual(data.strip(), "\n".join(["# mixed new lines", "1", "2", "3"]))
class LinesTC(TestCase):
def test_known_values_lines(self):
self.assertEqual(lines(NEWLINES_TXT), ["# mixed new lines", "1", "2", "3"])
def test_known_values_lines_comment(self):
self.assertEqual(lines(NEWLINES_TXT, comments="#"), ["1", "2", "3"])
class ExportTC(TestCase):
def setUp(self):
self.tempdir = tempfile.mktemp()
os.mkdir(self.tempdir)
def test(self):
export(DATA_DIR, self.tempdir, verbose=0)
self.assertTrue(exists(join(self.tempdir, "__init__.py")))
self.assertTrue(exists(join(self.tempdir, "sub")))
self.assertTrue(not exists(join(self.tempdir, "__init__.pyc")))
self.assertTrue(not exists(join(self.tempdir, "CVS")))
def tearDown(self):
shutil.rmtree(self.tempdir)
class ProtectedFileTC(TestCase):
def setUp(self):
self.rpath = join(DATA_DIR, "write_protected_file.txt")
self.rwpath = join(DATA_DIR, "normal_file.txt")
# Make sure rpath is not writable !
os.chmod(self.rpath, 33060)
# Make sure rwpath is writable !
os.chmod(self.rwpath, 33188)
def test_mode_change(self):
"""tests that mode is changed when needed"""
# test on non-writable file
# self.assertTrue(not os.access(self.rpath, os.W_OK))
self.assertTrue(not os.stat(self.rpath).st_mode & S_IWRITE)
# for some reason if you remove "wp_file =" the test fails
wp_file = ProtectedFile(self.rpath, "w") # noqa
self.assertTrue(os.stat(self.rpath).st_mode & S_IWRITE)
self.assertTrue(os.access(self.rpath, os.W_OK))
# test on writable-file
self.assertTrue(os.stat(self.rwpath).st_mode & S_IWRITE)
self.assertTrue(os.access(self.rwpath, os.W_OK))
ProtectedFile(self.rwpath, "w")
self.assertTrue(os.stat(self.rwpath).st_mode & S_IWRITE)
self.assertTrue(os.access(self.rwpath, os.W_OK))
def test_restore_on_close(self):
"""tests original mode is restored on close"""
# test on non-writable file
# self.assertTrue(not os.access(self.rpath, os.W_OK))
self.assertTrue(not os.stat(self.rpath).st_mode & S_IWRITE)
ProtectedFile(self.rpath, "w").close()
# self.assertTrue(not os.access(self.rpath, os.W_OK))
self.assertTrue(not os.stat(self.rpath).st_mode & S_IWRITE)
# test on writable-file
self.assertTrue(os.access(self.rwpath, os.W_OK))
self.assertTrue(os.stat(self.rwpath).st_mode & S_IWRITE)
ProtectedFile(self.rwpath, "w").close()
self.assertTrue(os.access(self.rwpath, os.W_OK))
self.assertTrue(os.stat(self.rwpath).st_mode & S_IWRITE)
def test_mode_change_on_append(self):
"""tests that mode is changed when file is opened in 'a' mode"""
# self.assertTrue(not os.access(self.rpath, os.W_OK))
self.assertTrue(not os.stat(self.rpath).st_mode & S_IWRITE)
wp_file = ProtectedFile(self.rpath, "a")
self.assertTrue(os.access(self.rpath, os.W_OK))
self.assertTrue(os.stat(self.rpath).st_mode & S_IWRITE)
wp_file.close()
# self.assertTrue(not os.access(self.rpath, os.W_OK))
self.assertTrue(not os.stat(self.rpath).st_mode & S_IWRITE)
if sys.version_info < (3, 0):
def load_tests(loader, tests, ignore):
from logilab.common import fileutils
tests.addTests(doctest.DocTestSuite(fileutils))
return tests
if __name__ == "__main__":
unittest_main()
|
