You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`unittests/scans/<parser_dir>/{many_vulns,no_vuln,one_vuln}.json` | Sample files containing meaningful data for unit tests. The minimal set.
38
38
|`unittests/tools/test_<parser_name>_parser.py` | Unit tests of the parser.
39
39
|`dojo/settings/settings.dist.py` | If you want to use a modern hashcode based deduplication algorithm
40
-
|`docs/content/en/connecting_your_tools/parsers/<file/api>/<parser_file>.md` | Documentation, what kind of file format is required and how it should be obtained
41
-
40
+
|`doc/content/en/integrations/parsers/<file/api>/<parser_file>.md` | Documentation, what kind of file format is required and how it should be obtained
42
41
43
42
## Factory contract
44
43
@@ -51,7 +50,7 @@ Parsers are loaded dynamicaly with a factory pattern. To have your parser loaded
51
50
3. The name of this class **MUST** be the Python module name without underscores and with `Parser` suffix.
52
51
- ex: `dojo.tools.my_tool.parser.MyToolParser`
53
52
4. This class **MUST** have an empty constructor or no constructor
54
-
5. This class **MUST** implement 4 methods:
53
+
5. This class **MUST** implement 3 methods:
55
54
1.`def get_scan_types(self)` This function return a list of all the *scan_type* supported by your parser. This identifiers are used internally. Your parser can support more than one *scan_type*. For example some parsers use different identifier to modify the behavior of the parser (aggregate, filter, etc...)
56
55
2.`def get_label_for_scan_types(self, scan_type):` This function return a string used to provide some text in the UI (short label)
57
56
3.`def get_description_for_scan_types(self, scan_type):` This function return a string used to provide some text in the UI (long description)
@@ -358,7 +357,7 @@ If you want to take a look at previous parsers that are now part of DefectDojo,
358
357
359
358
## Update the import page documentation
360
359
361
-
Please add a new .md file in [`docs/content/en/connecting_your_tools/parsers`] with the details of your new parser. Include the following content headings:
360
+
Please add a new .md file in [`docs/content/en/integrations/parsers`] with the details of your new parser. Include the following content headings:
362
361
363
362
* Acceptable File Type(s) - please include how to generate this type of file from the related tool, as some tools have multiple methods or require specific commands.
0 commit comments