Code Duplication    Length = 111-141 lines in 2 locations

gvm/protocols/gmpv7/gmpv7.py 1 location

@@ 1986-2126 (lines=141) @@
1983
        cmd.add_element("copy", target_id)
1984
        return self._send_xml_command(cmd)
1985
1986
    def create_task(
1987
        self,
1988
        name: str,
1989
        config_id: str,
1990
        target_id: str,
1991
        scanner_id: str,
1992
        *,
1993
        alterable: Optional[bool] = None,
1994
        hosts_ordering: Optional[HostsOrdering] = None,
1995
        schedule_id: Optional[str] = None,
1996
        alert_ids: Optional[List[str]] = None,
1997
        comment: Optional[str] = None,
1998
        schedule_periods: Optional[int] = None,
1999
        observers: Optional[List[str]] = None,
2000
        preferences: Optional[dict] = None
2001
    ) -> Any:
2002
        """Create a new task
2003
2004
        Arguments:
2005
            name: Name of the task
2006
            config_id: UUID of scan config to use by the task
2007
            target_id: UUID of target to be scanned
2008
            scanner_id: UUID of scanner to use for scanning the target
2009
            comment: Comment for the task
2010
            alterable: Whether the task should be alterable
2011
            alert_ids: List of UUIDs for alerts to be applied to the task
2012
            hosts_ordering: The order hosts are scanned in
2013
            schedule_id: UUID of a schedule when the task should be run.
2014
            schedule_periods: A limit to the number of times the task will be
2015
                scheduled, or 0 for no limit
2016
            observers: List of names or ids of users which should be allowed to
2017
                observe this task
2018
            preferences: Name/Value pairs of scanner preferences.
2019
2020
        Returns:
2021
            The response. See :py:meth:`send_command` for details.
2022
        """
2023
        if not name:
2024
            raise RequiredArgument(
2025
                function=self.create_task.__name__, argument='name'
2026
            )
2027
2028
        if not config_id:
2029
            raise RequiredArgument(
2030
                function=self.create_task.__name__, argument='config_id'
2031
            )
2032
2033
        if not target_id:
2034
            raise RequiredArgument(
2035
                function=self.create_task.__name__, argument='target_id'
2036
            )
2037
2038
        if not scanner_id:
2039
            raise RequiredArgument(
2040
                function=self.create_task.__name__, argument='scanner_id'
2041
            )
2042
2043
        # don't allow to create a container task with create_task
2044
        if target_id == '0':
2045
            raise InvalidArgument(
2046
                'Invalid argument {} for target_id'.format(target_id)
2047
            )
2048
2049
        cmd = XmlCommand("create_task")
2050
        cmd.add_element("name", name)
2051
        cmd.add_element("config", attrs={"id": config_id})
2052
        cmd.add_element("target", attrs={"id": target_id})
2053
        cmd.add_element("scanner", attrs={"id": scanner_id})
2054
2055
        if comment:
2056
            cmd.add_element("comment", comment)
2057
2058
        if alterable is not None:
2059
            cmd.add_element("alterable", _to_bool(alterable))
2060
2061
        if hosts_ordering:
2062
            if not isinstance(hosts_ordering, HostsOrdering):
2063
                raise InvalidArgumentType(
2064
                    function=self.create_task.__name__,
2065
                    argument='hosts_ordering',
2066
                    arg_type=HostsOrdering.__name__,
2067
                )
2068
            cmd.add_element("hosts_ordering", hosts_ordering.value)
2069
2070
        if alert_ids:
2071
            if isinstance(alert_ids, str):
2072
                deprecation(
2073
                    "Please pass a list as alert_ids parameter to create_task. "
2074
                    "Passing a string is deprecated and will be removed in "
2075
                    "future."
2076
                )
2077
2078
                # if a single id is given as a string wrap it into a list
2079
                alert_ids = [alert_ids]
2080
            if _is_list_like(alert_ids):
2081
                # parse all given alert id's
2082
                for alert in alert_ids:
2083
                    cmd.add_element("alert", attrs={"id": str(alert)})
2084
2085
        if schedule_id:
2086
            cmd.add_element("schedule", attrs={"id": schedule_id})
2087
2088
            if schedule_periods is not None:
2089
                if (
2090
                    not isinstance(schedule_periods, numbers.Integral)
2091
                    or schedule_periods < 0
2092
                ):
2093
                    raise InvalidArgument(
2094
                        "schedule_periods must be an integer greater or equal "
2095
                        "than 0"
2096
                    )
2097
                cmd.add_element("schedule_periods", str(schedule_periods))
2098
2099
        if observers is not None:
2100
            if not _is_list_like(observers):
2101
                raise InvalidArgumentType(
2102
                    function=self.create_task.__name__,
2103
                    argument='observers',
2104
                    arg_type='list',
2105
                )
2106
2107
            # gvmd splits by comma and space
2108
            # gvmd tries to lookup each value as user name and afterwards as
2109
            # user id. So both user name and user id are possible
2110
            cmd.add_element("observers", _to_comma_list(observers))
2111
2112
        if preferences is not None:
2113
            if not isinstance(preferences, collections.abc.Mapping):
2114
                raise InvalidArgumentType(
2115
                    function=self.create_task.__name__,
2116
                    argument='preferences',
2117
                    arg_type=collections.abc.Mapping.__name__,
2118
                )
2119
2120
            _xmlprefs = cmd.add_element("preferences")
2121
            for pref_name, pref_value in preferences.items():
2122
                _xmlpref = _xmlprefs.add_element("preference")
2123
                _xmlpref.add_element("scanner_name", pref_name)
2124
                _xmlpref.add_element("value", str(pref_value))
2125
2126
        return self._send_xml_command(cmd)
2127
2128
    def create_container_task(
2129
        self, name: str, *, comment: Optional[str] = None

gvm/protocols/gmpv9/gmpv9.py 1 location

@@ 1518-1628 (lines=111) @@
1515
1516
        return self._send_xml_command(cmd)
1517
1518
    def __create_task(
1519
        self,
1520
        name: str,
1521
        config_id: str,
1522
        target_id: str,
1523
        scanner_id: str,
1524
        usage_type: UsageType,
1525
        function: str,
1526
        *,
1527
        alterable: Optional[bool] = None,
1528
        hosts_ordering: Optional[HostsOrdering] = None,
1529
        schedule_id: Optional[str] = None,
1530
        alert_ids: Optional[List[str]] = None,
1531
        comment: Optional[str] = None,
1532
        schedule_periods: Optional[int] = None,
1533
        observers: Optional[List[str]] = None,
1534
        preferences: Optional[dict] = None
1535
    ) -> Any:
1536
        if not name:
1537
            raise RequiredArgument(function=function, argument='name')
1538
1539
        if not config_id:
1540
            raise RequiredArgument(function=function, argument='config_id')
1541
1542
        if not target_id:
1543
            raise RequiredArgument(function=function, argument='target_id')
1544
1545
        if not scanner_id:
1546
            raise RequiredArgument(function=function, argument='scanner_id')
1547
1548
        # don't allow to create a container task with create_task
1549
        if target_id == '0':
1550
            raise InvalidArgument(function=function, argument='target_id')
1551
1552
        cmd = XmlCommand("create_task")
1553
        cmd.add_element("name", name)
1554
        cmd.add_element("usage_type", usage_type.value)
1555
        cmd.add_element("config", attrs={"id": config_id})
1556
        cmd.add_element("target", attrs={"id": target_id})
1557
        cmd.add_element("scanner", attrs={"id": scanner_id})
1558
1559
        if comment:
1560
            cmd.add_element("comment", comment)
1561
1562
        if alterable is not None:
1563
            cmd.add_element("alterable", _to_bool(alterable))
1564
1565
        if hosts_ordering:
1566
            if not isinstance(hosts_ordering, self.types.HostsOrdering):
1567
                raise InvalidArgumentType(
1568
                    function=function,
1569
                    argument='hosts_ordering',
1570
                    arg_type=HostsOrdering.__name__,
1571
                )
1572
            cmd.add_element("hosts_ordering", hosts_ordering.value)
1573
1574
        if alert_ids:
1575
            if isinstance(alert_ids, str):
1576
                deprecation(
1577
                    "Please pass a list as alert_ids parameter to {}. "
1578
                    "Passing a string is deprecated and will be removed in "
1579
                    "future.".format(function)
1580
                )
1581
1582
                # if a single id is given as a string wrap it into a list
1583
                alert_ids = [alert_ids]
1584
            if _is_list_like(alert_ids):
1585
                # parse all given alert id's
1586
                for alert in alert_ids:
1587
                    cmd.add_element("alert", attrs={"id": str(alert)})
1588
1589
        if schedule_id:
1590
            cmd.add_element("schedule", attrs={"id": schedule_id})
1591
1592
            if schedule_periods is not None:
1593
                if (
1594
                    not isinstance(schedule_periods, numbers.Integral)
1595
                    or schedule_periods < 0
1596
                ):
1597
                    raise InvalidArgument(
1598
                        "schedule_periods must be an integer greater or equal "
1599
                        "than 0"
1600
                    )
1601
                cmd.add_element("schedule_periods", str(schedule_periods))
1602
1603
        if observers is not None:
1604
            if not _is_list_like(observers):
1605
                raise InvalidArgumentType(
1606
                    function=function, argument='observers', arg_type='list'
1607
                )
1608
1609
            # gvmd splits by comma and space
1610
            # gvmd tries to lookup each value as user name and afterwards as
1611
            # user id. So both user name and user id are possible
1612
            cmd.add_element("observers", _to_comma_list(observers))
1613
1614
        if preferences is not None:
1615
            if not isinstance(preferences, collections.abc.Mapping):
1616
                raise InvalidArgumentType(
1617
                    function=function,
1618
                    argument='preferences',
1619
                    arg_type=collections.abc.Mapping.__name__,
1620
                )
1621
1622
            _xmlprefs = cmd.add_element("preferences")
1623
            for pref_name, pref_value in preferences.items():
1624
                _xmlpref = _xmlprefs.add_element("preference")
1625
                _xmlpref.add_element("scanner_name", pref_name)
1626
                _xmlpref.add_element("value", str(pref_value))
1627
1628
        return self._send_xml_command(cmd)
1629
1630
    def __create_config(
1631
        self,