fix unittest documentation #11128

[manuel-sommer]

No description provided.

[dryrunsecurity]

DryRun Security Summary

The provided text summarizes an update to the documentation for writing a parser for the DefectDojo application, including changes to the development environment setup, guidance on running unit tests, expanded information on the "Factory contract" and best practices for secure parser development.

Expand for full summary

Summary:

This code change appears to be an update to the documentation for how to write a parser for the DefectDojo application. The key changes include updates to the development environment setup instructions, additional guidance on running unit tests for specific parsers, and expanded documentation on the "Factory contract" that parsers must follow, including required methods and class naming conventions. The documentation also provides best practices for parser development, such as using secure libraries for parsing input data, handling missing data gracefully, leveraging pre-defined deduplication algorithms, and ensuring comprehensive unit tests are written. From an application security perspective, these changes are positive as they emphasize secure coding practices and help to maintain a consistent and secure design across the different parsers in the application.

Files Changed:

• docs/content/en/contributing/how-to-write-a-parser.md: This file has been updated to provide more detailed and comprehensive documentation for developers on how to write a parser for the DefectDojo application. The changes include updates to the development environment setup instructions, new guidance on running unit tests, expanded information on the "Factory contract" and best practices for parser development, and additional details on other files that may need to be updated to support new file types or parser functionality.

Code Analysis

We ran 9 analyzers against 1 file and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.

[mtesauro]

Approved

[cneill]

Just some tiny suggestions on the examples

[mtesauro]

@kiblik Last call before we merge this