Merge pull request #73 from OWASP/72-feature-output-filter

FEATURE: do not store errored requests into output file

src/offat/__main__.py

@@ -119,6 +119,13 @@ def start():
         action='store_true',
         help='Enable SSL Verification',
     )
+    parser.add_argument(
+        '-cf',
+        '--capture-failed',
+        dest='capture_failed',
+        action='store_true',
+        help='Captures failed requests due to any exceptions into output file',
+    )
     args = parser.parse_args()
 
     # convert req headers str to dict
@@ -146,6 +153,7 @@ def start():
         test_data_config=test_data_config,
         proxies=args.proxies_list,
         ssl=args.ssl,
+        capture_failed=args.capture_failed,
     )
 
 

src/offat/report/generator.py

@@ -120,12 +120,21 @@ def save_report(report_path: str | None, report_file_content: str | Table | None
 
     @staticmethod
     def generate_report(
-        results: list[dict], report_format: str | None, report_path: str | None
+        results: list[dict],
+        report_format: str | None,
+        report_path: str | None,
+        capture_failed: bool = False,
     ):
         """main function used to generate report"""
         if report_path:
             report_format = report_path.split('.')[-1]
 
+        # do not store errored results if `capture_failed` is False
+        if not capture_failed:
+            results = list(
+                filter(lambda result: result.get('error', True) == False, results)
+            )
+
         formatted_results = ReportGenerator.handle_report_format(
             results=results, report_format=report_format
         )

src/offat/tester/tester_utils.py

@@ -119,6 +119,7 @@ def generate_and_run_tests(
     proxies: list[str] | None = None,
     test_data_config: dict | None = None,
     ssl: bool = False,
+    capture_failed: bool = False,
 ):
     '''
     Generates and runs tests for provied OAS/Swagger file.