gvm.protocols.gmpv208.entities.tickets.TicketsMixin.modify_ticket() - Code Metrics - Inspection of "Merge pull request #470 from y0urself/detach-rest" - greenbone/python-gvm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( af96e1...147191 )

by Jaspar

created 2021-05-21 06:13 UTC

TicketsMixin.modify_ticket() C

↳ Parent: gvm.protocols.gmpv208.entities.tickets

Complexity

Conditions

Size

Total Lines	60
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	34
nop	7
dl	0
loc	60
rs	5.9999
c	0
b	0
f	0

How to fix Long Method Complexity

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

If many parameters/temporary variables are present:
- Replace temporary variables with Query
- Introduce parameter object; often combined with preserve whole object
- If the above two are insufficient: Replace method with method object
If you have long conditionals: Decompose Conditional
Otherwise: Extract method

Complexity

Complex classes like gvm.protocols.gmpv208.entities.tickets.TicketsMixin.modify_ticket() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

# -*- coding: utf-8 -*-
# Copyright (C) 2021 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

# pylint:  disable=redefined-builtin

from enum import Enum

from typing import Any, Optional

from gvm.errors import InvalidArgument, InvalidArgumentType, RequiredArgument
from gvm.utils import add_filter, to_bool
from gvm.xml import XmlCommand


class TicketStatus(Enum):
    """Enum for ticket status"""

    OPEN = 'Open'
    FIXED = 'Fixed'
    CLOSED = 'Closed'


def get_ticket_status_from_string(
    ticket_status: Optional[str],
) -> Optional[TicketStatus]:
    """Convert a ticket status string into a TicketStatus instance"""
    if not ticket_status:
        return None

    try:
        return TicketStatus[ticket_status.upper()]
    except KeyError:
        raise InvalidArgument(
            argument='ticket_status',
            function=get_ticket_status_from_string.__name__,
        ) from None


class TicketsMixin:
    def clone_ticket(self, ticket_id: str) -> Any:
        """Clone an existing ticket

        Arguments:
            ticket_id: UUID of an existing ticket to clone from

        Returns:
            The response. See :py:meth:`send_command` for details.
        """
        if not ticket_id:
            raise RequiredArgument(
                function=self.clone_ticket.__name__, argument='ticket_id'
            )

        cmd = XmlCommand("create_ticket")

        _copy = cmd.add_element("copy", ticket_id)

        return self._send_xml_command(cmd)

    def create_ticket(
        self,
        *,
        result_id: str,
        assigned_to_user_id: str,
        note: str,
        comment: Optional[str] = None,
    ) -> Any:
        """Create a new ticket

        Arguments:
            result_id: UUID of the result the ticket applies to
            assigned_to_user_id: UUID of a user the ticket should be assigned to
            note: A note about opening the ticket
            comment: Comment for the ticket

        Returns:
            The response. See :py:meth:`send_command` for details.
        """
        if not result_id:
            raise RequiredArgument(
                function=self.create_ticket.__name__, argument='result_id'
            )

        if not assigned_to_user_id:
            raise RequiredArgument(
                function=self.create_ticket.__name__,
                argument='assigned_to_user_id',
            )

        if not note:
            raise RequiredArgument(
                function=self.create_ticket.__name__, argument='note'
            )

        cmd = XmlCommand("create_ticket")

        _result = cmd.add_element("result")
        _result.set_attribute("id", result_id)

        _assigned = cmd.add_element("assigned_to")
        _user = _assigned.add_element("user")
        _user.set_attribute("id", assigned_to_user_id)

        _note = cmd.add_element("open_note", note)

        if comment:
            cmd.add_element("comment", comment)

        return self._send_xml_command(cmd)

    def delete_ticket(
        self, ticket_id: str, *, ultimate: Optional[bool] = False
    ):
        """Deletes an existing ticket

        Arguments:
            ticket_id: UUID of the ticket to be deleted.
            ultimate: Whether to remove entirely, or to the trashcan.
        """
        if not ticket_id:
            raise RequiredArgument(
                function=self.delete_ticket.__name__, argument='ticket_id'
            )

        cmd = XmlCommand("delete_ticket")
        cmd.set_attribute("ticket_id", ticket_id)
        cmd.set_attribute("ultimate", to_bool(ultimate))

        return self._send_xml_command(cmd)

    def get_tickets(

        self,
        *,
        trash: Optional[bool] = None,
        filter: Optional[str] = None,
        filter_id: Optional[str] = None,
    ) -> Any:
        """Request a list of tickets

        Arguments:
            filter: Filter term to use for the query
            filter_id: UUID of an existing filter to use for the query
            trash: True to request the tickets in the trashcan

        Returns:
            The response. See :py:meth:`send_command` for details.
        """
        cmd = XmlCommand("get_tickets")

        add_filter(cmd, filter, filter_id)

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

        return self._send_xml_command(cmd)

    def get_ticket(self, ticket_id: str) -> Any:
        """Request a single ticket

        Arguments:
            ticket_id: UUID of an existing ticket

        Returns:
            The response. See :py:meth:`send_command` for details.
        """
        if not ticket_id:
            raise RequiredArgument(
                function=self.get_ticket.__name__, argument='ticket_id'
            )

        cmd = XmlCommand("get_tickets")
        cmd.set_attribute("ticket_id", ticket_id)
        return self._send_xml_command(cmd)

    def modify_ticket(
        self,
        ticket_id: str,
        *,
        status: Optional[TicketStatus] = None,
        note: Optional[str] = None,
        assigned_to_user_id: Optional[str] = None,
        comment: Optional[str] = None,
    ) -> Any:
        """Modify a single ticket

        Arguments:
            ticket_id: UUID of an existing ticket
            status: New status for the ticket
            note: Note for the status change. Required if status is set.
            assigned_to_user_id: UUID of the user the ticket should be assigned
                to
            comment: Comment for the ticket

        Returns:
            The response. See :py:meth:`send_command` for details.
        """
        if not ticket_id:
            raise RequiredArgument(
                function=self.modify_ticket.__name__, argument='ticket_id'
            )

        if status and not note:
            raise RequiredArgument(
                function=self.modify_ticket.__name__, argument='note'
            )

        if note and not status:
            raise RequiredArgument(
                function=self.modify_ticket.__name__, argument='status'
            )

        cmd = XmlCommand("modify_ticket")
        cmd.set_attribute("ticket_id", ticket_id)

        if assigned_to_user_id:
            _assigned = cmd.add_element("assigned_to")
            _user = _assigned.add_element("user")
            _user.set_attribute("id", assigned_to_user_id)

        if status:
            if not isinstance(status, TicketStatus):
                raise InvalidArgumentType(
                    function=self.modify_ticket.__name__,
                    argument='status',
                    arg_type=TicketStatus.__name__,
                )

            cmd.add_element('status', status.value)
            cmd.add_element('{}_note'.format(status.name.lower()), note)

        if comment:
            cmd.add_element("comment", comment)

        return self._send_xml_command(cmd)


1		# -- coding: utf-8 --
2		# Copyright (C) 2021 Greenbone Networks GmbH
3		#
4		# SPDX-License-Identifier: GPL-3.0-or-later
5		#
6		# This program is free software: you can redistribute it and/or modify
7		# it under the terms of the GNU General Public License as published by
8		# the Free Software Foundation, either version 3 of the License, or
9		# (at your option) any later version.
10		#
11		# This program is distributed in the hope that it will be useful,
12		# but WITHOUT ANY WARRANTY; without even the implied warranty of
13		# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14		# GNU General Public License for more details.
15		#
16		# You should have received a copy of the GNU General Public License
17		# along with this program. If not, see <http://www.gnu.org/licenses/>.
18
19		# pylint: disable=redefined-builtin
20
21		from enum import Enum
22
23		from typing import Any, Optional
24
25		from gvm.errors import InvalidArgument, InvalidArgumentType, RequiredArgument
26		from gvm.utils import add_filter, to_bool
27		from gvm.xml import XmlCommand
28
29
30		class TicketStatus(Enum):
31		"""Enum for ticket status"""
32
33		OPEN = 'Open'
34		FIXED = 'Fixed'
35		CLOSED = 'Closed'
36
37
38		def get_ticket_status_from_string(
39		ticket_status: Optional[str],
40		) -> Optional[TicketStatus]:
41		"""Convert a ticket status string into a TicketStatus instance"""
42		if not ticket_status:
43		return None
44
45		try:
46		return TicketStatus[ticket_status.upper()]
47		except KeyError:
48		raise InvalidArgument(
49		argument='ticket_status',
50		function=get_ticket_status_from_string.__name__,
51		) from None
52
53
54		class TicketsMixin:
55		def clone_ticket(self, ticket_id: str) -> Any:
56		"""Clone an existing ticket
57
58		Arguments:
59		ticket_id: UUID of an existing ticket to clone from
60
61		Returns:
62		The response. See :py:meth:`send_command` for details.
63		"""
64		if not ticket_id:
65		raise RequiredArgument(
66		function=self.clone_ticket.__name__, argument='ticket_id'
67		)
68
69		cmd = XmlCommand("create_ticket")
70
71		_copy = cmd.add_element("copy", ticket_id)
72
73		return self._send_xml_command(cmd)
74
75		def create_ticket(
76		self,
77		*,
78		result_id: str,
79		assigned_to_user_id: str,
80		note: str,
81		comment: Optional[str] = None,
82		) -> Any:
83		"""Create a new ticket
84
85		Arguments:
86		result_id: UUID of the result the ticket applies to
87		assigned_to_user_id: UUID of a user the ticket should be assigned to
88		note: A note about opening the ticket
89		comment: Comment for the ticket
90
91		Returns:
92		The response. See :py:meth:`send_command` for details.
93		"""
94		if not result_id:
95		raise RequiredArgument(
96		function=self.create_ticket.__name__, argument='result_id'
97		)
98
99		if not assigned_to_user_id:
100		raise RequiredArgument(
101		function=self.create_ticket.__name__,
102		argument='assigned_to_user_id',
103		)
104
105		if not note:
106		raise RequiredArgument(
107		function=self.create_ticket.__name__, argument='note'
108		)
109
110		cmd = XmlCommand("create_ticket")
111
112		_result = cmd.add_element("result")
113		_result.set_attribute("id", result_id)
114
115		_assigned = cmd.add_element("assigned_to")
116		_user = _assigned.add_element("user")
117		_user.set_attribute("id", assigned_to_user_id)
118
119		_note = cmd.add_element("open_note", note)
120
121		if comment:
122		cmd.add_element("comment", comment)
123
124		return self._send_xml_command(cmd)
125
126		def delete_ticket(
127		self, ticket_id: str, *, ultimate: Optional[bool] = False
128		):
129		"""Deletes an existing ticket
130
131		Arguments:
132		ticket_id: UUID of the ticket to be deleted.
133		ultimate: Whether to remove entirely, or to the trashcan.
134		"""
135		if not ticket_id:
136		raise RequiredArgument(
137		function=self.delete_ticket.__name__, argument='ticket_id'
138		)
139
140		cmd = XmlCommand("delete_ticket")
141		cmd.set_attribute("ticket_id", ticket_id)
142		cmd.set_attribute("ultimate", to_bool(ultimate))
143
144		return self._send_xml_command(cmd)
145
146	View Code Duplication	def get_tickets(
		0 ignored issues – show Duplication introduced 2019-07-12 12:14 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
147		self,
148		*,
149		trash: Optional[bool] = None,
150		filter: Optional[str] = None,
151		filter_id: Optional[str] = None,
152		) -> Any:
153		"""Request a list of tickets
154
155		Arguments:
156		filter: Filter term to use for the query
157		filter_id: UUID of an existing filter to use for the query
158		trash: True to request the tickets in the trashcan
159
160		Returns:
161		The response. See :py:meth:`send_command` for details.
162		"""
163		cmd = XmlCommand("get_tickets")
164
165		add_filter(cmd, filter, filter_id)
166
167		if trash is not None:
168		cmd.set_attribute("trash", to_bool(trash))
169
170		return self._send_xml_command(cmd)
171
172		def get_ticket(self, ticket_id: str) -> Any:
173		"""Request a single ticket
174
175		Arguments:
176		ticket_id: UUID of an existing ticket
177
178		Returns:
179		The response. See :py:meth:`send_command` for details.
180		"""
181		if not ticket_id:
182		raise RequiredArgument(
183		function=self.get_ticket.__name__, argument='ticket_id'
184		)
185
186		cmd = XmlCommand("get_tickets")
187		cmd.set_attribute("ticket_id", ticket_id)
188		return self._send_xml_command(cmd)
189
190		def modify_ticket(
191		self,
192		ticket_id: str,
193		*,
194		status: Optional[TicketStatus] = None,
195		note: Optional[str] = None,
196		assigned_to_user_id: Optional[str] = None,
197		comment: Optional[str] = None,
198		) -> Any:
199		"""Modify a single ticket
200
201		Arguments:
202		ticket_id: UUID of an existing ticket
203		status: New status for the ticket
204		note: Note for the status change. Required if status is set.
205		assigned_to_user_id: UUID of the user the ticket should be assigned
206		to
207		comment: Comment for the ticket
208
209		Returns:
210		The response. See :py:meth:`send_command` for details.
211		"""
212		if not ticket_id:
213		raise RequiredArgument(
214		function=self.modify_ticket.__name__, argument='ticket_id'
215		)
216
217		if status and not note:
218		raise RequiredArgument(
219		function=self.modify_ticket.__name__, argument='note'
220		)
221
222		if note and not status:
223		raise RequiredArgument(
224		function=self.modify_ticket.__name__, argument='status'
225		)
226
227		cmd = XmlCommand("modify_ticket")
228		cmd.set_attribute("ticket_id", ticket_id)
229
230		if assigned_to_user_id:
231		_assigned = cmd.add_element("assigned_to")
232		_user = _assigned.add_element("user")
233		_user.set_attribute("id", assigned_to_user_id)
234
235		if status:
236		if not isinstance(status, TicketStatus):
237		raise InvalidArgumentType(
238		function=self.modify_ticket.__name__,
239		argument='status',
240		arg_type=TicketStatus.__name__,
241		)
242
243		cmd.add_element('status', status.value)
244		cmd.add_element('{}_note'.format(status.name.lower()), note)
245
246		if comment:
247		cmd.add_element("comment", comment)
248
249		return self._send_xml_command(cmd)
250

greenbone / python-gvm

Push — master ( af96e1...147191 )

TicketsMixin.modify_ticket() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Complexity

Duplication Side-by-Side

Filter issues like