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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
# Copyright (c) 2008-2012 testtools developers. See LICENSE for details.
import os
import shutil
import tarfile
import tempfile
from collections.abc import Callable
from typing import Any
from testtools import TestCase
from testtools.matchers import (
Contains,
DocTestMatches,
Equals,
)
from testtools.matchers._filesystem import (
DirContains,
DirExists,
FileContains,
FileExists,
HasPermissions,
PathExists,
SamePath,
TarballContains,
)
class PathHelpers:
# This is provided by TestCase when mixed in
addCleanup: Callable[..., Any]
def mkdtemp(self):
directory = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, directory)
return directory
def create_file(self, filename, contents=""):
fp = open(filename, "w")
try:
fp.write(contents)
finally:
fp.close()
def touch(self, filename):
return self.create_file(filename)
class TestPathExists(TestCase, PathHelpers):
def test_exists(self):
tempdir = self.mkdtemp()
self.assertThat(tempdir, PathExists())
def test_not_exists(self):
doesntexist = os.path.join(self.mkdtemp(), "doesntexist")
mismatch = PathExists().match(doesntexist)
self.assertThat(f"{doesntexist} does not exist.", Equals(mismatch.describe()))
class TestDirExists(TestCase, PathHelpers):
def test_exists(self):
tempdir = self.mkdtemp()
self.assertThat(tempdir, DirExists())
def test_not_exists(self):
doesntexist = os.path.join(self.mkdtemp(), "doesntexist")
mismatch = DirExists().match(doesntexist)
self.assertThat(
PathExists().match(doesntexist).describe(), Equals(mismatch.describe())
)
def test_not_a_directory(self):
filename = os.path.join(self.mkdtemp(), "foo")
self.touch(filename)
mismatch = DirExists().match(filename)
self.assertThat(f"{filename} is not a directory.", Equals(mismatch.describe()))
class TestFileExists(TestCase, PathHelpers):
def test_exists(self):
tempdir = self.mkdtemp()
filename = os.path.join(tempdir, "filename")
self.touch(filename)
self.assertThat(filename, FileExists())
def test_not_exists(self):
doesntexist = os.path.join(self.mkdtemp(), "doesntexist")
mismatch = FileExists().match(doesntexist)
self.assertThat(
PathExists().match(doesntexist).describe(), Equals(mismatch.describe())
)
def test_not_a_file(self):
tempdir = self.mkdtemp()
mismatch = FileExists().match(tempdir)
self.assertThat(f"{tempdir} is not a file.", Equals(mismatch.describe()))
class TestDirContains(TestCase, PathHelpers):
def test_empty(self):
tempdir = self.mkdtemp()
self.assertThat(tempdir, DirContains([]))
def test_not_exists(self):
doesntexist = os.path.join(self.mkdtemp(), "doesntexist")
mismatch = DirContains([]).match(doesntexist)
self.assertThat(
PathExists().match(doesntexist).describe(), Equals(mismatch.describe())
)
def test_contains_files(self):
tempdir = self.mkdtemp()
self.touch(os.path.join(tempdir, "foo"))
self.touch(os.path.join(tempdir, "bar"))
self.assertThat(tempdir, DirContains(["bar", "foo"]))
def test_matcher(self):
tempdir = self.mkdtemp()
self.touch(os.path.join(tempdir, "foo"))
self.touch(os.path.join(tempdir, "bar"))
self.assertThat(tempdir, DirContains(matcher=Contains("bar")))
def test_neither_specified(self):
self.assertRaises(AssertionError, DirContains)
def test_both_specified(self):
self.assertRaises(
AssertionError, DirContains, filenames=[], matcher=Contains("a")
)
def test_does_not_contain_files(self):
tempdir = self.mkdtemp()
self.touch(os.path.join(tempdir, "foo"))
mismatch = DirContains(["bar", "foo"]).match(tempdir)
self.assertThat(
Equals(["bar", "foo"]).match(["foo"]).describe(),
Equals(mismatch.describe()),
)
class TestFileContains(TestCase, PathHelpers):
def test_not_exists(self):
doesntexist = os.path.join(self.mkdtemp(), "doesntexist")
mismatch = FileContains("").match(doesntexist)
self.assertThat(
PathExists().match(doesntexist).describe(), Equals(mismatch.describe())
)
def test_contains(self):
tempdir = self.mkdtemp()
filename = os.path.join(tempdir, "foo")
self.create_file(filename, "Hello World!")
self.assertThat(filename, FileContains("Hello World!"))
def test_matcher(self):
tempdir = self.mkdtemp()
filename = os.path.join(tempdir, "foo")
self.create_file(filename, "Hello World!")
self.assertThat(filename, FileContains(matcher=DocTestMatches("Hello World!")))
def test_neither_specified(self):
self.assertRaises(AssertionError, FileContains)
def test_both_specified(self):
self.assertRaises(
AssertionError, FileContains, contents=[], matcher=Contains("a")
)
def test_does_not_contain(self):
tempdir = self.mkdtemp()
filename = os.path.join(tempdir, "foo")
self.create_file(filename, "Goodbye Cruel World!")
mismatch = FileContains("Hello World!").match(filename)
self.assertThat(
Equals("Hello World!").match("Goodbye Cruel World!").describe(),
Equals(mismatch.describe()),
)
def test_binary_content(self):
tempdir = self.mkdtemp()
filename = os.path.join(tempdir, "binary_file")
binary_data = b"\x00\x01\x02\x03\xff\xfe"
with open(filename, "wb") as f:
f.write(binary_data)
self.assertThat(filename, FileContains(binary_data))
def test_binary_content_mismatch(self):
tempdir = self.mkdtemp()
filename = os.path.join(tempdir, "binary_file")
with open(filename, "wb") as f:
f.write(b"\x00\x01\x02")
mismatch = FileContains(b"\xff\xfe\xfd").match(filename)
self.assertThat(
Equals(b"\xff\xfe\xfd").match(b"\x00\x01\x02").describe(),
Equals(mismatch.describe()),
)
def test_text_with_encoding(self):
tempdir = self.mkdtemp()
filename = os.path.join(tempdir, "utf8_file")
text_data = "Hello 世界!"
with open(filename, "w", encoding="utf-8") as f:
f.write(text_data)
self.assertThat(filename, FileContains(text_data, encoding="utf-8"))
def test_text_default_encoding(self):
tempdir = self.mkdtemp()
filename = os.path.join(tempdir, "text_file")
text_data = "Hello World!"
with open(filename, "w") as f:
f.write(text_data)
self.assertThat(filename, FileContains(text_data))
class TestTarballContains(TestCase, PathHelpers):
def test_match(self):
tempdir = self.mkdtemp()
def in_temp_dir(x):
return os.path.join(tempdir, x)
self.touch(in_temp_dir("a"))
self.touch(in_temp_dir("b"))
tarball = tarfile.open(in_temp_dir("foo.tar.gz"), "w")
tarball.add(in_temp_dir("a"), "a")
tarball.add(in_temp_dir("b"), "b")
tarball.close()
self.assertThat(in_temp_dir("foo.tar.gz"), TarballContains(["b", "a"]))
def test_mismatch(self):
tempdir = self.mkdtemp()
def in_temp_dir(x):
return os.path.join(tempdir, x)
self.touch(in_temp_dir("a"))
self.touch(in_temp_dir("b"))
tarball = tarfile.open(in_temp_dir("foo.tar.gz"), "w")
tarball.add(in_temp_dir("a"), "a")
tarball.add(in_temp_dir("b"), "b")
tarball.close()
mismatch = TarballContains(["d", "c"]).match(in_temp_dir("foo.tar.gz"))
self.assertEqual(
mismatch.describe(), Equals(["c", "d"]).match(["a", "b"]).describe()
)
class TestSamePath(TestCase, PathHelpers):
def test_same_string(self):
self.assertThat("foo", SamePath("foo"))
def test_relative_and_absolute(self):
path = "foo"
abspath = os.path.abspath(path)
self.assertThat(path, SamePath(abspath))
self.assertThat(abspath, SamePath(path))
def test_real_path(self):
tempdir = self.mkdtemp()
source = os.path.join(tempdir, "source")
self.touch(source)
target = os.path.join(tempdir, "target")
try:
os.symlink(source, target)
except (AttributeError, NotImplementedError):
self.skipTest("No symlink support")
self.assertThat(source, SamePath(target))
self.assertThat(target, SamePath(source))
class TestHasPermissions(TestCase, PathHelpers):
def test_match(self):
tempdir = self.mkdtemp()
filename = os.path.join(tempdir, "filename")
self.touch(filename)
permissions = oct(os.stat(filename).st_mode)[-4:]
self.assertThat(filename, HasPermissions(permissions))
def test_suite():
from unittest import TestLoader
return TestLoader().loadTestsFromName(__name__)
|
