{{ message }}
forked from google/magika
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_magika_python_module.py
More file actions
816 lines (673 loc) · 28.6 KB
/
Copy pathtest_magika_python_module.py
File metadata and controls
816 lines (673 loc) · 28.6 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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import io
import signal
import tempfile
from pathlib import Path
from typing import Any, List, Optional
import pytest
from magika import Magika, PredictionMode
from magika.types import (
ContentTypeInfo,
ContentTypeLabel,
MagikaPrediction,
MagikaResult,
Status,
)
from magika.types.overwrite_reason import OverwriteReason
from tests import utils
@pytest.mark.smoketest
def test_magika_module_check_version() -> None:
import magika as magika_module
assert isinstance(magika_module.__version__, str)
m = Magika()
assert m.get_module_version() == magika_module.__version__
# Check that, when we don't specify `model_dir`, Magika uses the default
# model.
assert m.get_model_name() == m._get_default_model_name()
@pytest.mark.smoketest
def test_magika_module_with_one_test_file() -> None:
test_path = utils.get_one_basic_test_file_path()
m = Magika()
_ = m.identify_path(test_path)
_ = m.identify_paths([test_path])
_ = m.identify_bytes(test_path.read_bytes())
with open(test_path, "rb") as f:
_ = m.identify_stream(f)
@pytest.mark.smoketest
def test_magika_module_with_explicit_model_dir() -> None:
model_dir = utils.get_default_model_dir()
test_path = utils.get_one_basic_test_file_path()
m = Magika(model_dir=model_dir)
_ = m.identify_path(test_path)
_ = m.identify_paths([test_path])
_ = m.identify_bytes(test_path.read_bytes())
with open(test_path, "rb") as f:
_ = m.identify_stream(f)
def test_magika_module_with_basic_tests_by_paths() -> None:
tests_paths = utils.get_basic_test_files_paths()
m = Magika()
results = m.identify_paths(tests_paths)
check_results_vs_expected_results(tests_paths, results)
def test_magika_module_with_basic_tests_by_path() -> None:
tests_paths = utils.get_basic_test_files_paths()
m = Magika()
for test_path in tests_paths:
result = m.identify_path(test_path)
check_result_vs_expected_result(test_path, result)
def test_magika_module_with_basic_tests_by_bytes() -> None:
tests_paths = utils.get_basic_test_files_paths()
m = Magika()
for test_path in tests_paths:
content = test_path.read_bytes()
result = m.identify_bytes(content)
check_result_vs_expected_result(
test_path, result, expected_result_path=Path("-")
)
def test_magika_module_with_basic_tests_by_stream() -> None:
tests_paths = utils.get_basic_test_files_paths()
m = Magika()
for test_path in tests_paths:
with open(test_path, "rb") as f:
result = m.identify_stream(f)
check_result_vs_expected_result(
test_path, result, expected_result_path=Path("-")
)
def test_magika_module_with_all_models() -> None:
tests_paths = utils.get_basic_test_files_paths()
models_dir = utils.get_models_dir()
for model_dir in models_dir.iterdir():
m = Magika(model_dir=model_dir)
for test_path in tests_paths:
result = m.identify_path(test_path)
check_result_vs_expected_result(test_path, result)
def test_magika_module_with_previously_missdetected_samples() -> None:
model_dir = utils.get_default_model_dir()
tests_paths = utils.get_previously_missdetected_files_paths()
m = Magika(model_dir=model_dir)
results = m.identify_paths(tests_paths)
check_results_vs_expected_results(tests_paths, results)
def test_magika_module_with_empty_content() -> None:
m = Magika()
empty_content = b""
res = m.identify_bytes(empty_content)
assert res.ok
assert res.path == Path("-")
assert res.prediction.dl.label == ContentTypeLabel.UNDEFINED
assert res.prediction.output.label == ContentTypeLabel.EMPTY
assert res.prediction.score == 1.0
with tempfile.TemporaryDirectory() as td:
tf_path = Path(td) / "empty.dat"
tf_path.write_bytes(empty_content)
res = m.identify_path(tf_path)
assert res.path == tf_path
assert res.ok
assert res.prediction.dl.label == ContentTypeLabel.UNDEFINED
assert res.prediction.output.label == ContentTypeLabel.EMPTY
assert res.prediction.score == 1.0
res = m.identify_stream(io.BytesIO(b""))
assert res.path == Path("-")
assert res.ok
assert res.prediction.dl.label == ContentTypeLabel.UNDEFINED
assert res.prediction.output.label == ContentTypeLabel.EMPTY
assert res.prediction.score == 1.0
def test_magika_module_with_short_content() -> None:
m = Magika()
text_content = b"asd"
binary_content = b"\x80\x80\x80"
for content, expected_ct_label in zip(
[text_content, binary_content],
[ContentTypeLabel.TXT, ContentTypeLabel.UNKNOWN],
):
with tempfile.TemporaryDirectory() as td:
# prediction via path
tf_path = Path(td) / "file.txt"
tf_path.write_bytes(content)
res = m.identify_path(tf_path)
assert res.path == tf_path
assert res.ok
assert res.prediction.dl.label == ContentTypeLabel.UNDEFINED
assert res.prediction.output.label == expected_ct_label
assert res.prediction.score == 1.0
# prediction via bytes
res = m.identify_bytes(content)
assert res.path == Path("-")
assert res.ok
assert res.prediction.dl.label == ContentTypeLabel.UNDEFINED
assert res.prediction.output.label == expected_ct_label
assert res.prediction.score == 1.0
# prediction via stream
res = m.identify_stream(io.BytesIO(content))
assert res.path == Path("-")
assert res.ok
assert res.prediction.dl.label == ContentTypeLabel.UNDEFINED
assert res.prediction.output.label == expected_ct_label
assert res.prediction.score == 1.0
def test_magika_module_with_python_and_non_python_content() -> None:
python_content = (
b"import flask\nimport requests\n\ndef foo(a):\n print(f'Test {a}')\n"
)
non_python_content = b"clearly not python"
m = Magika()
res = m.identify_bytes(python_content)
assert res.ok
assert res.prediction.output.label == ContentTypeLabel.PYTHON
res = m.identify_bytes(non_python_content)
assert res.ok
assert res.prediction.output.label == ContentTypeLabel.TXT
def test_magika_module_identify_stream_does_not_alter_position() -> None:
m = Magika()
contents = [
b"",
b"short",
b"A" * 100,
b"A" * 1000,
b"A" * 10000,
]
for content in contents:
stream = io.BytesIO(content)
# seek to a specific non-special position
pos = min(2, len(content))
stream.seek(pos)
res = m.identify_stream(stream)
assert res.ok
assert stream.tell() == pos
def test_magika_module_with_whitespaces() -> None:
m = Magika()
ws_nums = sorted(
{
1,
m._model_config.min_file_size_for_dl - 1,
m._model_config.min_file_size_for_dl,
m._model_config.min_file_size_for_dl + 1,
m._model_config.beg_size - 1,
m._model_config.beg_size,
m._model_config.beg_size + 1,
m._model_config.end_size - 1,
m._model_config.end_size,
m._model_config.end_size + 1,
m._model_config.beg_size + m._model_config.end_size - 1,
m._model_config.beg_size + m._model_config.end_size,
m._model_config.beg_size + m._model_config.end_size + 1,
m._model_config.beg_size + m._model_config.end_size + 1,
m._model_config.block_size - 1,
m._model_config.block_size,
m._model_config.block_size + 1,
2 * m._model_config.block_size - 1,
2 * m._model_config.block_size,
2 * m._model_config.block_size + 1,
4 * m._model_config.block_size - 1,
4 * m._model_config.block_size,
4 * m._model_config.block_size + 1,
}
)
for ws_num in ws_nums:
print(f"Calling indentify_bytes with {ws_num} whitespaces")
content = b" " * ws_num
res = m.identify_bytes(content)
assert (
res.ok
and res.dl.label == ContentTypeLabel.UNDEFINED
and res.output.label == ContentTypeLabel.TXT
)
res = m.identify_stream(io.BytesIO(content))
assert (
res.ok
and res.dl.label == ContentTypeLabel.UNDEFINED
and res.output.label == ContentTypeLabel.TXT
)
with tempfile.TemporaryDirectory() as td:
tf_path = Path(td) / "test.bin"
tf_path.write_bytes(content)
res = m.identify_path(tf_path)
assert (
res.ok
and res.dl.label == ContentTypeLabel.UNDEFINED
and res.output.label == ContentTypeLabel.TXT
)
def test_magika_module_with_different_prediction_modes() -> None:
model_dir = utils.get_default_model_dir()
m = Magika(model_dir=model_dir, prediction_mode=PredictionMode.BEST_GUESS)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.01
) == (
ContentTypeLabel.PYTHON,
OverwriteReason.NONE,
)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.40
) == (
ContentTypeLabel.PYTHON,
OverwriteReason.NONE,
)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.60
) == (
ContentTypeLabel.PYTHON,
OverwriteReason.NONE,
)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.99
) == (
ContentTypeLabel.PYTHON,
OverwriteReason.NONE,
)
m = Magika(model_dir=model_dir, prediction_mode=PredictionMode.MEDIUM_CONFIDENCE)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.01
) == (
ContentTypeLabel.TXT,
OverwriteReason.LOW_CONFIDENCE,
)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, m._model_config.medium_confidence_threshold - 0.01
) == (ContentTypeLabel.TXT, OverwriteReason.LOW_CONFIDENCE)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.60
) == (
ContentTypeLabel.PYTHON,
OverwriteReason.NONE,
)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.99
) == (
ContentTypeLabel.PYTHON,
OverwriteReason.NONE,
)
m = Magika(model_dir=model_dir, prediction_mode=PredictionMode.HIGH_CONFIDENCE)
high_confidence_threshold = m._model_config.thresholds.get(
ContentTypeLabel.PYTHON, m._model_config.medium_confidence_threshold
)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.01
) == (
ContentTypeLabel.TXT,
OverwriteReason.LOW_CONFIDENCE,
)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, high_confidence_threshold - 0.01
) == (ContentTypeLabel.TXT, OverwriteReason.LOW_CONFIDENCE)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, high_confidence_threshold + 0.01
) == (ContentTypeLabel.PYTHON, OverwriteReason.NONE)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.99
) == (
ContentTypeLabel.PYTHON,
OverwriteReason.NONE,
)
# test that the default is HIGH_CONFIDENCE
m = Magika(model_dir=model_dir)
high_confidence_threshold = m._model_config.thresholds.get(
ContentTypeLabel.PYTHON, m._model_config.medium_confidence_threshold
)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.01
) == (
ContentTypeLabel.TXT,
OverwriteReason.LOW_CONFIDENCE,
)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, high_confidence_threshold - 0.01
) == (ContentTypeLabel.TXT, OverwriteReason.LOW_CONFIDENCE)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, high_confidence_threshold + 0.01
) == (ContentTypeLabel.PYTHON, OverwriteReason.NONE)
assert m._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, 0.99
) == (
ContentTypeLabel.PYTHON,
OverwriteReason.NONE,
)
def test_magika_module_overwrite_reason() -> None:
m_high = Magika(prediction_mode=PredictionMode.HIGH_CONFIDENCE)
m_medium = Magika(prediction_mode=PredictionMode.MEDIUM_CONFIDENCE)
m_best = Magika(prediction_mode=PredictionMode.BEST_GUESS)
python_high_confidence_threshold = m_high._model_config.thresholds.get(
ContentTypeLabel.PYTHON, m_high._model_config.medium_confidence_threshold
)
medium_confidence_threshold = m_medium._model_config.medium_confidence_threshold
assert m_high._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, python_high_confidence_threshold + 0.01
) == (ContentTypeLabel.PYTHON, OverwriteReason.NONE)
assert m_high._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, python_high_confidence_threshold - 0.01
) == (ContentTypeLabel.TXT, OverwriteReason.LOW_CONFIDENCE)
assert m_medium._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, medium_confidence_threshold + 0.01
) == (ContentTypeLabel.PYTHON, OverwriteReason.NONE)
assert m_medium._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, medium_confidence_threshold - 0.01
) == (ContentTypeLabel.TXT, OverwriteReason.LOW_CONFIDENCE)
assert m_best._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, medium_confidence_threshold + 0.01
) == (ContentTypeLabel.PYTHON, OverwriteReason.NONE)
assert m_best._get_output_label_from_dl_label_and_score(
ContentTypeLabel.PYTHON, medium_confidence_threshold - 0.01
) == (ContentTypeLabel.PYTHON, OverwriteReason.NONE)
for overwrite_map_ct_key in sorted(m_high._model_config.overwrite_map.keys()):
overwrite_map_ct_value = m_high._model_config.overwrite_map[
overwrite_map_ct_key
]
is_overwrite_map_ct_target_text = m_high._cts_infos[
overwrite_map_ct_value
].is_text
overwrite_map_ct_high_confidence_threshold = (
m_high._model_config.thresholds.get(
overwrite_map_ct_key, m_high._model_config.medium_confidence_threshold
)
)
assert m_high._get_output_label_from_dl_label_and_score(
overwrite_map_ct_key, overwrite_map_ct_high_confidence_threshold + 0.01
) == (overwrite_map_ct_value, OverwriteReason.OVERWRITE_MAP)
assert m_high._get_output_label_from_dl_label_and_score(
overwrite_map_ct_key, overwrite_map_ct_high_confidence_threshold - 0.01
) == (
ContentTypeLabel.TXT
if is_overwrite_map_ct_target_text
else ContentTypeLabel.UNKNOWN,
OverwriteReason.LOW_CONFIDENCE,
)
for generic_ct in [ContentTypeLabel.TXT, ContentTypeLabel.UNKNOWN]:
generic_type_high_confidence_threshold = m_high._model_config.thresholds.get(
generic_ct,
m_high._model_config.medium_confidence_threshold,
)
assert m_high._get_output_label_from_dl_label_and_score(
generic_ct,
generic_type_high_confidence_threshold - 0.01,
) == (generic_ct, OverwriteReason.NONE)
assert m_medium._get_output_label_from_dl_label_and_score(
generic_ct, medium_confidence_threshold - 0.01
) == (generic_ct, OverwriteReason.NONE)
def test_magika_module_with_directory() -> None:
m = Magika()
with tempfile.TemporaryDirectory() as td:
td_path = Path(td)
res = m.identify_path(td_path)
assert res.path == td_path
assert res.ok
assert res.prediction.dl.label == ContentTypeLabel.UNDEFINED
assert res.prediction.output.label == ContentTypeLabel.DIRECTORY
assert res.prediction.score == 1.0
def test_magika_module_multiple_copies_of_the_same_file() -> None:
with tempfile.TemporaryDirectory() as td:
test_path = Path(td) / "test.txt"
test_path.write_text("test")
test_paths = [test_path] * 3
m = Magika()
results = m.identify_paths(test_paths)
assert len(results) == len(test_paths)
for result in results:
assert result.path == test_path
assert result.ok
assert result.prediction.output.label == ContentTypeLabel.TXT
def test_magika_module_with_symlink() -> None:
with tempfile.TemporaryDirectory() as td:
test_path = Path(td) / "test.txt"
test_path.write_text("test")
symlink_path = Path(td) / "symlink-test.txt"
symlink_path.symlink_to(test_path)
m = Magika()
res = m.identify_path(test_path)
assert res.path == test_path
assert res.ok
assert res.prediction.output.label == ContentTypeLabel.TXT
res = m.identify_path(symlink_path)
assert res.path == symlink_path
assert res.ok
assert res.prediction.output.label == ContentTypeLabel.TXT
m = Magika(no_dereference=True)
res = m.identify_path(test_path)
assert res.path == test_path
assert res.ok
assert res.prediction.output.label == ContentTypeLabel.TXT
res = m.identify_path(symlink_path)
assert res.path == symlink_path
assert res.ok
assert res.prediction.output.label == ContentTypeLabel.SYMLINK
def test_magika_module_with_non_existing_file() -> None:
m = Magika()
with tempfile.TemporaryDirectory() as td:
non_existing_path = Path(td) / "non_existing.txt"
res = m.identify_path(non_existing_path)
assert res.path == non_existing_path
assert not res.ok
assert res.status == Status.FILE_NOT_FOUND_ERROR
def test_magika_module_with_permission_error() -> None:
m = Magika()
with tempfile.TemporaryDirectory() as td:
unreadable_test_path = Path(td) / "test.txt"
unreadable_test_path.write_text("text")
unreadable_test_path.chmod(0o000)
res = m.identify_path(unreadable_test_path)
assert res.path == unreadable_test_path
assert not res.ok
assert res.status == Status.PERMISSION_ERROR
# Check that an empty, non-accessible file is marked as "permission error".
# Note that on some file-systems, one can read the file size even without
# read permission, and it would thus be possible to return "empty" (this is
# what we were actually doing in the past). However, returning
# "permission_error" makes the expected behavior consistent across file
# systems and it simplifies the implementation.
with tempfile.TemporaryDirectory() as td:
unreadable_test_path = Path(td) / "test.txt"
unreadable_test_path.write_text("")
unreadable_test_path.chmod(0o000)
res = m.identify_path(unreadable_test_path)
assert res.path == unreadable_test_path
assert not res.ok
assert res.status == Status.PERMISSION_ERROR
@pytest.mark.skip
def test_magika_module_with_really_many_files() -> None:
test_file_path = utils.get_one_basic_test_file_path()
m = Magika()
for n in [10000]:
test_files_paths = [test_file_path] * n
results = m.identify_paths(test_files_paths)
for result in results:
assert result.ok
# TODO: add more checks
@pytest.mark.slow
def test_magika_module_with_big_file() -> None:
def signal_handler(signum: int, frame: Any) -> None:
raise Exception("Timeout")
signal.signal(signal.SIGALRM, signal_handler)
# It should take much less than this, but pytest weird scheduling sometimes
# creates unexpected slow downs.
timeout = 2
m = Magika()
for sample_size in [1000, 10000, 1_000_000, 1_000_000_000, 10_000_000_000]:
with tempfile.TemporaryDirectory() as td:
sample_path = Path(td) / "sample.dat"
utils.write_random_file_with_size(sample_path, sample_size)
print(f"Starting running Magika with a timeout of {timeout}")
signal.alarm(timeout)
res = m.identify_path(sample_path)
assert res.ok
signal.alarm(0)
print("Done running Magika")
def test_api_call_with_bad_types() -> None:
m = Magika()
_ = m.identify_path(Path("/non_existing.txt"))
_ = m.identify_path("/non_existing.txt")
with pytest.raises(TypeError):
_ = m.identify_path(b"/non_existing.txt") # type: ignore[arg-type]
_ = m.identify_paths([Path("/non_existing.txt")])
_ = m.identify_paths(["/non_existing.txt"])
_ = m.identify_paths([Path("/non_existing.txt"), Path("/not_existing2.txt")])
_ = m.identify_paths([Path("/non_existing.txt"), "/not_existing2.txt"])
_ = m.identify_paths(["/non_existing.txt", "/not_existing2.txt"])
with pytest.raises(TypeError):
_ = m.identify_paths(Path("/non_existing.txt")) # type: ignore[arg-type]
with pytest.raises(TypeError):
_ = m.identify_paths([b"/non_existing.txt"]) # type: ignore[list-item]
with pytest.raises(TypeError):
_ = m.identify_paths([Path("/non_existing.txt"), b"/not_existing2.txt"]) # type: ignore[list-item]
_ = m.identify_bytes(b"bytes content")
with pytest.raises(TypeError):
_ = m.identify_bytes("str content") # type: ignore[arg-type]
_ = m.identify_stream(io.BytesIO(b"bytes stream content"))
with pytest.raises(TypeError):
_ = m.identify_stream(io.StringIO("str stream content")) # type: ignore[arg-type]
with pytest.raises(TypeError):
_ = m.identify_stream(b"bytes content") # type: ignore[arg-type]
with pytest.raises(TypeError):
_ = m.identify_stream("str content") # type: ignore[arg-type]
def test_access_magika_result_and_prediction():
m = Magika()
res = m.identify_bytes(b"text")
assert isinstance(res, MagikaResult)
assert isinstance(res.path, Path)
assert isinstance(res.ok, bool)
assert isinstance(res.status, Status)
assert isinstance(res.prediction, MagikaPrediction)
assert isinstance(res.prediction.dl, ContentTypeInfo)
assert isinstance(res.prediction.output, ContentTypeInfo)
assert isinstance(res.prediction.score, float)
# test access to forwarded properties
assert isinstance(res.dl, ContentTypeInfo)
assert isinstance(res.output, ContentTypeInfo)
assert isinstance(res.score, float)
# test access to non-existing properties
with pytest.raises(AttributeError):
_ = res.foo # type: ignore[attr-defined]
with pytest.raises(AttributeError):
_ = res.prediction.foo # type: ignore[attr-defined]
res = m.identify_path(Path("/non_existing.txt"))
assert isinstance(res, MagikaResult)
assert isinstance(res.path, Path)
assert isinstance(res.ok, bool)
assert isinstance(res.status, Status)
with pytest.raises(ValueError):
_ = res.prediction
with pytest.raises(ValueError):
_ = res.prediction.dl
with pytest.raises(ValueError):
_ = res.prediction.output
with pytest.raises(ValueError):
_ = res.prediction.score
with pytest.raises(ValueError):
_ = res.dl
with pytest.raises(ValueError):
_ = res.output
with pytest.raises(ValueError):
_ = res.score
with pytest.raises(AttributeError):
_ = res.foo # type: ignore[attr-defined]
with pytest.raises(ValueError):
_ = res.prediction.foo # type: ignore[attr-defined]
def test_access_backward_compatibility_layer() -> None:
m = Magika()
res = m.identify_bytes(b"text")
assert isinstance(res, MagikaResult)
assert isinstance(res.path, Path)
assert isinstance(res.ok, bool)
assert isinstance(res.status, Status)
assert isinstance(res.prediction, MagikaPrediction)
assert isinstance(res.prediction.dl, ContentTypeInfo)
assert isinstance(res.prediction.output, ContentTypeInfo)
assert isinstance(res.prediction.score, float)
with pytest.warns(DeprecationWarning):
assert res.dl.ct_label == res.prediction.dl.label
with pytest.warns(DeprecationWarning):
assert res.output.ct_label == res.prediction.output.label
with pytest.raises(AttributeError):
_ = res.dl.score
with pytest.raises(AttributeError):
_ = res.output.score
with pytest.warns(DeprecationWarning):
assert res.dl.magic == res.prediction.dl.description
with pytest.warns(DeprecationWarning):
assert res.output.magic == res.prediction.output.description
def test_get_model_and_output_content_types() -> None:
m = Magika()
output_content_types = m.get_output_content_types()
output_content_types_set = set(output_content_types)
model_content_types = m.get_model_content_types()
model_content_types_set = set(model_content_types)
assert isinstance(output_content_types, List)
assert len(output_content_types) > 0
assert isinstance(model_content_types, List)
assert len(model_content_types) > 0
for ct in output_content_types:
assert isinstance(ct, ContentTypeLabel)
# Check for no duplicates
assert len(output_content_types) == len(output_content_types_set)
# Check basic properties about special ContentTypeLabel entries
special_output_content_types = {
ContentTypeLabel.DIRECTORY,
ContentTypeLabel.EMPTY,
ContentTypeLabel.SYMLINK,
ContentTypeLabel.TXT,
ContentTypeLabel.UNKNOWN,
}
special_model_content_types = {ContentTypeLabel.UNDEFINED}
assert special_output_content_types.issubset(output_content_types_set)
assert not special_model_content_types.issubset(output_content_types_set)
assert special_model_content_types.issubset(model_content_types_set)
assert not special_output_content_types.issubset(model_content_types_set)
# Spot check for popular content types
assert {
ContentTypeLabel.ELF,
ContentTypeLabel.PDF,
}.issubset(output_content_types_set)
assert {
ContentTypeLabel.ELF,
ContentTypeLabel.PDF,
}.issubset(model_content_types_set)
def test_magika_imports():
imported_modules = utils.get_imported_objects_after_wildcard()
# Check that Magika and other public classes are correctly imported
from magika import (
ContentTypeInfo,
ContentTypeLabel,
Magika,
MagikaError,
MagikaPrediction,
MagikaResult,
OverwriteReason,
PredictionMode,
Status,
)
assert imported_modules.get("ContentTypeInfo") == ContentTypeInfo
assert imported_modules.get("ContentTypeLabel") == ContentTypeLabel
assert imported_modules.get("Magika") == Magika
assert imported_modules.get("MagikaError") == MagikaError
assert imported_modules.get("MagikaPrediction") == MagikaPrediction
assert imported_modules.get("MagikaResult") == MagikaResult
assert imported_modules.get("OverwriteReason") == OverwriteReason
assert imported_modules.get("PredictionMode") == PredictionMode
assert imported_modules.get("Status") == Status
# Check that internal classes are not imported
assert imported_modules.get("ModelFeatures") is None
assert imported_modules.get("ModelOutput") is None
def get_expected_content_type_label_from_test_file_path(
test_path: Path,
) -> ContentTypeLabel:
return ContentTypeLabel(test_path.parent.name)
def check_result_vs_expected_result(
file_path: Path, result: MagikaResult, expected_result_path: Optional[Path] = None
) -> None:
if expected_result_path is None:
expected_result_path = file_path
assert result.path == expected_result_path
assert result.ok
expected_ct_label = get_expected_content_type_label_from_test_file_path(file_path)
assert result.prediction.output.label == expected_ct_label
def check_results_vs_expected_results(
files_paths: List[Path], results: List[MagikaResult]
) -> None:
for file_path, result in zip(files_paths, results):
check_result_vs_expected_result(file_path, result)
You can’t perform that action at this time.