Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions gvm/protocols/gmp/_gmpnext.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
OCIImageTargets,
ReportApplications,
ReportHosts,
ReportOperatingSystems,
ReportPorts,
Tasks,
)
Expand Down Expand Up @@ -1026,6 +1027,36 @@ def get_report_hosts(
)
)

def get_report_operating_systems(
self,
report_id: EntityID,
*,
filter_string: str | None = None,
filter_id: str | None = None,
ignore_pagination: bool | None = None,
details: bool | None = True,
) -> T:
"""Request operating systems of a single report.

Args:
report_id: UUID of an existing report.
filter_string: Filter term to use to filter results in the report
filter_id: UUID of filter to use to filter results in the report
ignore_pagination: Whether to ignore the filter terms "first" and
"rows".
details: Request additional report operating system information details.
Defaults to True.
"""
return self._send_request_and_transform_response(
ReportOperatingSystems.get_report_operating_systems(
report_id=report_id,
filter_string=filter_string,
filter_id=filter_id,
ignore_pagination=ignore_pagination,
details=details,
)
)

def get_report_ports(
self,
report_id: EntityID,
Expand Down
4 changes: 4 additions & 0 deletions gvm/protocols/gmp/requests/next/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
from gvm.protocols.gmp.requests.next._report_hosts import (
ReportHosts,
)
from gvm.protocols.gmp.requests.next._report_operating_systems import (
ReportOperatingSystems,
)
from gvm.protocols.gmp.requests.next._report_ports import (
ReportPorts,
)
Expand Down Expand Up @@ -147,6 +150,7 @@
"ReportFormatType",
"ReportFormats",
"ReportHosts",
"ReportOperatingSystems",
"ReportPorts",
"Reports",
"ResourceNames",
Expand Down
47 changes: 47 additions & 0 deletions gvm/protocols/gmp/requests/next/_report_operating_systems.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
from gvm.errors import RequiredArgument
from gvm.protocols.core import Request
from gvm.protocols.gmp.requests import EntityID
from gvm.utils import to_bool
from gvm.xml import XmlCommand


class ReportOperatingSystems:
@classmethod
def get_report_operating_systems(
cls,
report_id: EntityID,
*,
filter_string: str | None = None,
filter_id: str | None = None,
ignore_pagination: bool | None = None,
details: bool | None = True,
) -> Request:
"""Request operating systems of a single report.

Args:
report_id: UUID of an existing report.
filter_string: Filter term to use to filter results in the report
filter_id: UUID of filter to use to filter results in the report
ignore_pagination: Whether to ignore the filter terms "first" and
"rows".
details: Request additional report operating systems information details.
Defaults to True.
"""
cmd = XmlCommand("get_report_operating_systems")

if not report_id:
raise RequiredArgument(
function=cls.get_report_operating_systems.__name__,
argument="report_id",
)

cmd.set_attribute("report_id", str(report_id))

cmd.add_filter(filter_string, filter_id)

if ignore_pagination is not None:
cmd.set_attribute("ignore_pagination", to_bool(ignore_pagination))

cmd.set_attribute("details", to_bool(details))

return cmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# SPDX-FileCopyrightText: 2026 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#

from gvm.errors import RequiredArgument


class GmpGetReportOperatingSystemsTestMixin:
def test_get_report_operating_systems_without_id(self):
with self.assertRaises(RequiredArgument):
self.gmp.get_report_operating_systems(None)

with self.assertRaises(RequiredArgument):
self.gmp.get_report_operating_systems("")

def test_get_report_operating_systems_with_filter_string(self):
self.gmp.get_report_operating_systems(
report_id="r1", filter_string="name=foo"
)

self.connection.send.has_been_called_with(
b'<get_report_operating_systems report_id="r1" filter="name=foo" details="1"/>'
)

def test_get_report_operating_systems_with_filter_id(self):
self.gmp.get_report_operating_systems(report_id="r1", filter_id="f1")

self.connection.send.has_been_called_with(
b'<get_report_operating_systems report_id="r1" filt_id="f1" details="1"/>'
)

def test_get_report_operating_systems_with_ignore_pagination(self):
self.gmp.get_report_operating_systems(
report_id="r1", ignore_pagination=True
)

self.connection.send.has_been_called_with(
b'<get_report_operating_systems report_id="r1" ignore_pagination="1" details="1"/>'
)

self.gmp.get_report_operating_systems(
report_id="r1", ignore_pagination=False
)

self.connection.send.has_been_called_with(
b'<get_report_operating_systems report_id="r1" ignore_pagination="0" details="1"/>'
)

def test_get_report_operating_systems_with_details(self):
self.gmp.get_report_operating_systems(report_id="r1", details=True)

self.connection.send.has_been_called_with(
b'<get_report_operating_systems report_id="r1" details="1"/>'
)

self.gmp.get_report_operating_systems(report_id="r1", details=False)

self.connection.send.has_been_called_with(
b'<get_report_operating_systems report_id="r1" details="0"/>'
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# SPDX-FileCopyrightText: 2026 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#

from ...gmpnext import GMPTestCase
from .report_operating_systems.test_get_report_operating_systems import (
GmpGetReportOperatingSystemsTestMixin,
)


class GmpGetReportOperatingSystemsTestCase(
GmpGetReportOperatingSystemsTestMixin, GMPTestCase
):
pass
Loading