forked from ahupp/python-magic
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpython_magic_test.py
More file actions
executable file
·326 lines (285 loc) · 10.2 KB
/
python_magic_test.py
File metadata and controls
executable file
·326 lines (285 loc) · 10.2 KB
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
from dataclasses import dataclass
from enum import Enum
import os
import os.path
import shutil
import sys
import tempfile
from typing import List, Union
import unittest
import pytest
# for output which reports a local time
os.environ["TZ"] = "GMT"
if os.environ.get("LC_ALL", "") != "en_US.UTF-8":
# this ensure we're in a utf-8 default filesystem encoding which is
# necessary for some tests
raise Exception("must run `export LC_ALL=en_US.UTF-8` before running test suite")
import magic
@dataclass
class TestFile:
file_name: str
mime_results: List[str]
text_results: List[str]
no_check_elf_results: Union[List[str], None]
buf_equals_file: bool = True
# magic_descriptor is broken (?) in centos 7, so don't run those tests
SKIP_FROM_DESCRIPTOR = bool(os.environ.get("SKIP_FROM_DESCRIPTOR"))
COMMON_PLAIN = [{}]
NO_SOFT = [{"check_soft": False}]
COMMON_MIME = [{"mime": True}]
CASES = {
b"magic._pyc_": [
(
COMMON_MIME,
[
"application/octet-stream",
"text/x-bytecode.python",
"application/x-bytecode.python",
],
),
(COMMON_PLAIN, ["python 2.4 byte-compiled"]),
(NO_SOFT, ["data"]),
],
b"test.pdf": [
(COMMON_MIME, ["application/pdf"]),
(
COMMON_PLAIN,
[
"PDF document, version 1.2",
"PDF document, version 1.2, 2 pages",
"PDF document, version 1.2, 2 page(s)",
],
),
(NO_SOFT, ["ASCII text"]),
],
b"test.gz": [
(COMMON_MIME, ["application/gzip", "application/x-gzip"]),
(
COMMON_PLAIN,
[
'gzip compressed data, was "test", from Unix, last modified: Sun Jun 29 01:32:52 2008',
'gzip compressed data, was "test", last modified: Sun Jun 29 01:32:52 2008, from Unix',
'gzip compressed data, was "test", last modified: Sun Jun 29 01:32:52 2008, from Unix, original size 15',
'gzip compressed data, was "test", last modified: Sun Jun 29 01:32:52 2008, from Unix, original size modulo 2^32 15',
'gzip compressed data, was "test", last modified: Sun Jun 29 01:32:52 2008, from Unix, truncated',
],
),
(
[{"extension": True}],
[
# some versions return '' for the extensions of a gz file,
# including w/ the command line. Who knows...
"gz/tgz/tpz/zabw/svgz/adz/kmy/xcfgz",
"gz/tgz/tpz/zabw/svgz",
"",
"???",
],
),
(NO_SOFT, ["data"]),
],
b"test.snappy.parquet": [
(COMMON_MIME, ["application/octet-stream"]),
(COMMON_PLAIN, ["Apache Parquet", "Par archive data"]),
(NO_SOFT, ["data"]),
],
b"test.json": [
(COMMON_MIME, ["application/json"]),
(COMMON_PLAIN, ["JSON text data"]),
(
[{"mime": True, "check_json": False}],
[
"text/plain",
],
),
(NO_SOFT, ["JSON text data"]),
],
b"elf-NetBSD-x86_64-echo": [
# TODO: soft, no elf
(
COMMON_PLAIN,
[
"ELF 64-bit LSB shared object, x86-64, version 1 (SYSV)",
"ELF 64-bit LSB pie executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /libexec/ld.elf_so, for NetBSD 8.0, not stripped",
],
),
(
COMMON_MIME,
[
"application/x-pie-executable",
"application/x-sharedlib",
],
),
(
[{"check_elf": False}],
[
"ELF 64-bit LSB shared object, x86-64, version 1 (SYSV)",
],
),
# TODO: sometimes
# "ELF 64-bit LSB pie executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /libexec/ld.elf_so, for NetBSD 8.0, not stripped",
(NO_SOFT, ["data"]),
],
b"text.txt": [
(COMMON_MIME, ["text/plain"]),
(COMMON_PLAIN, ["ASCII text"]),
(
[{"mime_encoding": True}],
[
"us-ascii",
],
),
(NO_SOFT, ["ASCII text"]),
],
b"text-iso8859-1.txt": [
(
[{"mime_encoding": True}],
[
"iso-8859-1",
],
),
],
b"\xce\xbb": [
(COMMON_MIME, ["text/plain"]),
],
b"name_use.jpg": [
([{"extension": True}], ["jpeg/jpg/jpe/jfif"]),
],
b"keep-going.jpg": [
(COMMON_MIME, ["image/jpeg"]),
(
[{"mime": True, "keep_going": True}],
[
"image/jpeg\\012- application/octet-stream",
],
),
],
b"../../magic/loader.py": [
(
COMMON_MIME,
[
"text/x-python",
"text/x-script.python",
],
)
],
}
class MagicTest(unittest.TestCase):
TESTDATA_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), "testdata"))
def test_version(self):
try:
self.assertTrue(magic.version() > 0)
except NotImplementedError:
pass
def test_fs_encoding(self):
self.assertEqual("utf-8", sys.getfilesystemencoding().lower())
def test_from_file_str_and_bytes(self):
filename = os.path.join(self.TESTDATA_DIR, "test.pdf")
self.assertEqual("application/pdf", magic.from_file(filename, mime=True))
self.assertEqual(
"application/pdf", magic.from_file(filename.encode("utf-8"), mime=True)
)
def test_all_cases(self):
# TODO:
# * MAGIC_EXTENSION not supported
# * keep_going not supported
# * buffer checks
dest = os.path.join(MagicTest.TESTDATA_DIR, b"\xce\xbb".decode("utf-8"))
shutil.copyfile(os.path.join(MagicTest.TESTDATA_DIR, "lambda"), dest)
os.environ["TZ"] = "UTC"
try:
for filename, cases in CASES.items():
filename = os.path.join(self.TESTDATA_DIR.encode("utf-8"), filename)
print("test case ", filename, file=sys.stderr)
for flag_variants, outputs in cases:
for flags in flag_variants:
print("flags", flags, file=sys.stderr)
m = magic.Magic(**flags)
with open(filename) as f:
self.assertIn(m.from_descriptor(f.fileno()), outputs)
self.assertIn(m.from_file(filename), outputs)
fname_str = filename.decode("utf-8")
self.assertIn(m.from_file(fname_str), outputs)
with open(filename, "rb") as f:
buf_result = m.from_buffer(f.read(1024))
self.assertIn(buf_result, outputs)
finally:
del os.environ["TZ"]
os.unlink(dest)
def test_unicode_result_nonraw(self):
m = magic.Magic(raw=False)
src = os.path.join(MagicTest.TESTDATA_DIR, "pgpunicode")
result = m.from_file(src)
# NOTE: This check is added as otherwise some magic files don't identify the test case as a PGP key.
if "PGP" in result:
assert r"PGP\011Secret Sub-key -" == result
else:
raise unittest.SkipTest("Magic file doesn't return expected type.")
def test_unicode_result_raw(self):
m = magic.Magic(raw=True)
src = os.path.join(MagicTest.TESTDATA_DIR, "pgpunicode")
result = m.from_file(src)
if "PGP" in result:
assert b"PGP\tSecret Sub-key -" == result.encode("utf-8")
else:
raise unittest.SkipTest("Magic file doesn't return expected type.")
def test_errors(self):
m = magic.Magic()
self.assertRaises(IOError, m.from_file, "nonexistent")
self.assertRaises(magic.MagicException, magic.Magic, magic_file="nonexistent")
os.environ["MAGIC"] = "nonexistent"
try:
self.assertRaises(magic.MagicException, magic.Magic)
finally:
del os.environ["MAGIC"]
def test_rethrow(self):
old = magic.magic_buffer
try:
def t(x, y):
raise magic.MagicException("passthrough")
magic.magic_buffer = t
with self.assertRaises(magic.MagicException):
magic.from_buffer("hello", True)
finally:
magic.magic_buffer = old
def test_getparam(self):
m = magic.Magic(mime=True)
try:
m.setparam(magic.MAGIC_PARAM_INDIR_MAX, 1)
self.assertEqual(m.getparam(magic.MAGIC_PARAM_INDIR_MAX), 1)
except NotImplementedError:
pass
def test_name_count(self):
m = magic.Magic()
with open(os.path.join(self.TESTDATA_DIR, "name_use.jpg"), "rb") as f:
m.from_buffer(f.read())
def test_pathlike(self):
if sys.version_info < (3, 6):
return
from pathlib import Path
path = Path(self.TESTDATA_DIR, "test.pdf")
m = magic.Magic(mime=True)
self.assertEqual("application/pdf", m.from_file(path))
def test_symlink(self):
# TODO: 3.0
if not hasattr(tempfile, "TemporaryDirectory"):
return
with tempfile.TemporaryDirectory() as tmp:
tmp_link = os.path.join(tmp, "test_link")
tmp_broken = os.path.join(tmp, "nonexistent")
os.symlink(
os.path.join(self.TESTDATA_DIR, "test.pdf"),
tmp_link,
)
os.symlink("/nonexistent", tmp_broken)
m = magic.Magic()
m_follow = magic.Magic(follow_symlinks=True)
self.assertTrue(m.from_file(tmp_link).startswith("symbolic link to "))
self.assertTrue(m_follow.from_file(tmp_link).startswith("PDF document"))
self.assertTrue(
m.from_file(tmp_broken).startswith(
"broken symbolic link to /nonexistent"
)
)
self.assertRaises(IOError, m_follow.from_file, tmp_broken)
if __name__ == "__main__":
unittest.main()