/
test_parsers.py
95 lines (85 loc) · 5.07 KB
/
test_parsers.py
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
from .dojo_test_case import DojoTestCase, get_unit_tests_path
import os
import re
basedir = os.path.join(get_unit_tests_path(), '..')
class TestParsers(DojoTestCase):
def test_file_existence(self):
for parser_dir in os.scandir(os.path.join(basedir, 'dojo', 'tools')):
if parser_dir.is_file() or parser_dir.name == '__pycache__':
continue # this is not parser dir but some support file
if parser_dir.name.startswith("api_"):
doc_name = parser_dir.name[4:]
category = 'api'
else:
doc_name = parser_dir.name
category = 'file'
if doc_name not in [
'checkmarx_osa', # it is documented in 'checkmarx'
]:
with self.subTest(parser=parser_dir.name, category='docs'):
doc_file = os.path.join(basedir, 'docs', 'content', 'en', 'integrations', 'parsers', category, f"{doc_name}.md")
self.assertTrue(
os.path.isfile(doc_file),
f"Documentation file '{doc_file}' is missing or using different name"
)
content = open(doc_file).read()
self.assertTrue(re.search("title:", content),
f"Documentation file '{doc_file}' does not contain a title"
)
self.assertTrue(re.search("toc_hide: true", content),
f"Documentation file '{doc_file}' does not contain toc_hide: true"
)
if category == "file":
self.assertTrue(re.search("### Sample Scan Data", content),
f"Documentation file '{doc_file}' does not contain ### Sample Scan Data"
)
self.assertTrue(re.search("https://github.com/DefectDojo/django-DefectDojo/tree/master/unittests/scans", content),
f"Documentation file '{doc_file}' does not contain https://github.com/DefectDojo/django-DefectDojo/tree/master/unittests/scans"
)
if parser_dir.name not in [
# there is not exception for now
]:
with self.subTest(parser=parser_dir.name, category='parser'):
parser_test_file = os.path.join(basedir, 'unittests', 'tools', f"test_{parser_dir.name}_parser.py")
self.assertTrue(
os.path.isfile(parser_test_file),
f"Unittest of parser '{parser_test_file}' is missing or using different name"
)
if parser_dir.name not in [
'vcg', # content of the sample report is string the directly in unittest
]:
with self.subTest(parser=parser_dir.name, category='testfiles'):
scan_dir = os.path.join(basedir, 'unittests', 'scans', parser_dir.name)
self.assertTrue(
os.path.isdir(scan_dir),
f"Test files for unittest of parser '{scan_dir}' are missing or using different name"
)
if category == 'api':
if parser_dir.name not in [
'api_blackduck', # TODO
'api_vulners', # TODO
]:
with self.subTest(parser=parser_dir.name, category='importer'):
importer_test_file = os.path.join(basedir, 'unittests', 'tools', f"test_{parser_dir.name}_importer.py")
self.assertTrue(
os.path.isfile(importer_test_file),
f"Unittest of importer '{importer_test_file}' is missing or using different name"
)
for file in os.scandir(os.path.join(basedir, 'dojo', 'tools', parser_dir.name)):
if file.is_file() and file.name != '__pycache__' and file.name != "__init__.py":
f = os.path.join(basedir, 'dojo', 'tools', parser_dir.name, file.name)
read_true = False
for line in open(f, "r").readlines():
if read_true is True:
if ('"utf-8"' in str(line) or "'utf-8'" in str(line) or '"utf-8-sig"' in str(line) or "'utf-8-sig'" in str(line)) and i <= 4:
read_true = False
i = 0
elif i > 4:
self.assertTrue(False, "In file " + str(os.path.join('dojo', 'tools', parser_dir.name, file.name)) + " the test is failing because you don't have utf-8 after .read()")
i = 0
read_true = False
else:
i += 1
if ".read()" in str(line):
read_true = True
i = 0