add argument scan_config_id for get_report to get customizable reports

added the option to use the config id with get_report to get customizable reports

Author: Chrxxxxs

gvm/protocols/gmp/_gmp224.py

@@ -2907,6 +2907,7 @@ def get_report(
         filter_id: Optional[str] = None,
         delta_report_id: Optional[EntityID] = None,
         report_format_id: Optional[Union[str, ReportFormatType]] = None,
+        report_config_id: Optional[str] = None,
         ignore_pagination: Optional[bool] = None,
         details: Optional[bool] = True,
     ) -> T:
@@ -2919,6 +2920,7 @@ def get_report(
             delta_report_id: UUID of an existing report to compare report to.
             report_format_id: UUID of report format to use
                               or ReportFormatType (enum)
+            report_config_id: UUID of report format config to use
             ignore_pagination: Whether to ignore the filter terms "first" and
                 "rows".
             details: Request additional report information details
@@ -2931,6 +2933,7 @@ def get_report(
                 filter_id=filter_id,
                 delta_report_id=delta_report_id,
                 report_format_id=report_format_id,
+                report_config_id=report_config_id,
                 ignore_pagination=ignore_pagination,
                 details=details,
             )

gvm/protocols/gmp/_gmp226.py

@@ -103,6 +103,7 @@ def get_report(
         filter_id: Optional[str] = None,
         delta_report_id: Optional[EntityID] = None,
         report_format_id: Optional[Union[str, ReportFormatType]] = None,
+        report_config_id: Optional[str] = None,
         ignore_pagination: Optional[bool] = None,
         details: Optional[bool] = True,
     ) -> T:
@@ -115,6 +116,7 @@ def get_report(
             delta_report_id: UUID of an existing report to compare report to.
             report_format_id: UUID of report format to use
                               or ReportFormatType (enum)
+            report_config_id: UUID of report format config to use
             ignore_pagination: Whether to ignore the filter terms "first" and
                 "rows".
             details: Request additional report information details
@@ -127,6 +129,7 @@ def get_report(
                 filter_id=filter_id,
                 delta_report_id=delta_report_id,
                 report_format_id=report_format_id,
+                report_config_id=report_config_id,
                 ignore_pagination=ignore_pagination,
                 details=details,
             )

gvm/protocols/gmp/requests/v224/_reports.py

@@ -41,6 +41,7 @@ def get_report(
         filter_id: Optional[str] = None,
         delta_report_id: Optional[EntityID] = None,
         report_format_id: Optional[Union[str, ReportFormatType]] = None,
+        report_config_id: Optional[str] = None,
         ignore_pagination: Optional[bool] = None,
         details: Optional[bool] = True,
     ) -> Request:
@@ -53,6 +54,7 @@ def get_report(
             delta_report_id: UUID of an existing report to compare report to.
             report_format_id: UUID of report format to use
                               or ReportFormatType (enum)
+            report_config_id: UUID of report format config to use
             ignore_pagination: Whether to ignore the filter terms "first" and
                 "rows".
             details: Request additional report information details
@@ -75,6 +77,9 @@ def get_report(
         if report_format_id:
             cmd.set_attribute("format_id", str(report_format_id))
 
+        if report_config_id:
+            cmd.set_attribute("config_id", str(report_config_id))
+
         if ignore_pagination is not None:
             cmd.set_attribute("ignore_pagination", to_bool(ignore_pagination))
 

gvm/protocols/gmp/requests/v226/_reports.py

@@ -41,6 +41,7 @@ def get_report(
         filter_id: Optional[str] = None,
         delta_report_id: Optional[EntityID] = None,
         report_format_id: Optional[Union[str, ReportFormatType]] = None,
+        report_config_id: Optional[str] = None,
         ignore_pagination: Optional[bool] = None,
         details: Optional[bool] = True,
     ) -> Request:
@@ -53,6 +54,7 @@ def get_report(
             delta_report_id: UUID of an existing report to compare report to.
             report_format_id: UUID of report format to use
                               or ReportFormatType (enum)
+            report_config_id: UUID of report format config to use
             ignore_pagination: Whether to ignore the filter terms "first" and
                 "rows".
             details: Request additional report information details
@@ -76,6 +78,9 @@ def get_report(
         if report_format_id:
             cmd.set_attribute("format_id", str(report_format_id))
 
+        if report_config_id:
+            cmd.set_attribute("config_id", str(report_config_id))
+
         if ignore_pagination is not None:
             cmd.set_attribute("ignore_pagination", to_bool(ignore_pagination))
 

tests/protocols/gmpv226/entities/reports/test_get_report.py

@@ -36,6 +36,15 @@ def test_get_report_with_report_format_id(self):
             b'<get_reports report_id="r1" usage_type="scan" format_id="bar" details="1"/>'
         )
 
+    def test_get_report_with_report_format_id_and_config_id(self):
+        self.gmp.get_report(
+            report_id="r1", report_format_id="bar", report_config_id="c1"
+        )
+
+        self.connection.send.has_been_called_with(
+            b'<get_reports report_id="r1" usage_type="scan" format_id="bar" config_id="c1" details="1"/>'
+        )
+
     def test_get_report_with_report_format_type(self):
         self.gmp.get_report(
             report_id="r1", report_format_id=ReportFormatType.TXT