Passed
Pull Request — master (#314)
by Jaspar
11:34 queued 11s
created

send-targets   A

Complexity

Total Complexity 25

Size/Duplication

Total Lines 170
Duplicated Lines 7.06 %

Importance

Changes 0
Metric Value
eloc 96
dl 12
loc 170
rs 10
c 0
b 0
f 0
wmc 25

6 Functions

Rating   Name   Duplication   Size   Complexity  
A yes_or_no() 0 8 3
A error_and_exit() 0 3 1
A check_args() 0 16 2
A main() 0 13 1
F parse_send_xml_tree() 0 79 15
A create_xml_tree() 12 12 3

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
# -*- coding: utf-8 -*-
2
# Copyright (C) 2018-2019 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
import sys
20
from gvm.protocols.gmpv9.types import get_alive_test_from_string
21
22
from lxml import etree as e
23
24
25
def check_args(args):
26
    len_args = len(args.script) - 1
27
    if len_args != 1:
28
        message = """
29
        This script pulls target data from an xml document and feeds it to \
30
    a desired GSM
31
        One parameter after the script name is required.
32
33
        1. <xml_doc>  -- .xml file containing targets
34
35
        Example:
36
            $ gvm-script --gmp-username name --gmp-password pass \
37
    ssh --hostname <gsm> scripts/send-targets.gmp.py example_file.xml
38
        """
39
        print(message)
40
        quit()
41
42
43
def error_and_exit(msg):
44
    print("Error: {}\n".format(msg), file=sys.stderr)
45
    sys.exit(1)
46
47
48
def yes_or_no(question):
49
    reply = str(input(question + ' (y/n): ')).lower().strip()
50
    if reply[0] == ('y'):
51
        return True
52
    if reply[0] == ('n'):
53
        return False
54
    else:
55
        return yes_or_no("Please enter 'y' or 'n'")
56
57
58 View Code Duplication
def create_xml_tree(xml_doc):
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
59
    try:
60
        xml_tree = e.parse(xml_doc)
61
        xml_tree = e.tostring(xml_tree)
62
        xml_tree = e.XML(xml_tree)
63
    except IOError as err:
64
        error_and_exit("Failed to read xml_file: {} (exit)".format(str(err)))
65
66
    if len(xml_tree) == 0:
67
        error_and_exit("XML file is empty (exit)")
68
69
    return xml_tree
70
71
72
def parse_send_xml_tree(gmp, xml_tree):
73
    credential_options = [
74
        'ssh_credential',
75
        'smb_credential',
76
        'esxi_credential',
77
        'snmp_credential',
78
    ]
79
    counter = 1
80
81
    for target in xml_tree.xpath('target'):
82
        keywords = {}  # {'make_unique': True}
83
84
        keywords['name'] = target.find('name').text
85
86
        keywords['hosts'] = target.find('hosts').text.split(',')
87
88
        exclude_hosts = target.find('exclude_hosts').text
89
        if exclude_hosts is not None:
90
            keywords['exclude_hosts'] = exclude_hosts.split(',')
91
92
        comment = target.find('comment').text
93
        if comment is not None:
94
            keywords['comment'] = comment
95
96
        credentials = gmp.get_credentials()[0].xpath("//credential/@id")
97
98
        for credential in credential_options:
99
            cred_id = target.find(credential).xpath('@id')[0]
100
            if cred_id == '':
101
                continue
102
            if cred_id not in credentials:
103
                response = yes_or_no(
104
                    "\nThe credential '{}' for 'target {}' could not be "
105
                    "located...\nWould you like to continue?".format(
106
                        credential, counter
107
                    )
108
                )
109
110
                if response is False:
111
                    print("Terminating...\n")
112
                    quit()
113
                else:
114
                    continue
115
116
            key = '{}_id'.format(credential)
117
            keywords[key] = cred_id
118
            elem_path = target.find(credential)
119
            port = elem_path.find('port')
120
            if port and port.text is not None:
121
                port_key = '{}_port'.format(credential)
122
                keywords[port_key] = elem_path.find('port').text
123
124
        alive_test = get_alive_test_from_string(target.find('alive_tests').text)
125
126
        if alive_test is not None:
127
            keywords['alive_test'] = alive_test
128
129
        reverse_lookup_only = target.find('reverse_lookup_only').text
130
        if reverse_lookup_only == '1':
131
            keywords['reverse_lookup_only'] = 1
132
133
        reverse_lookup_unify = target.find('reverse_lookup_unify').text
134
        if reverse_lookup_unify == '1':
135
            keywords['reverse_lookup_unify'] = 1
136
137
        port_range = target.find('port_range')
138
        if port_range is not None:
139
            keywords['port_range'] = port_range.text
140
141
        if target.xpath('port_list/@id') is not None:
142
            port_list = {}
143
            port_list = target.xpath('port_list/@id')[0]
144
            keywords['port_list_id'] = port_list
145
146
        print(keywords)
147
148
        gmp.create_target(**keywords)
149
150
        counter += 1
151
152
153
def main(gmp, args):
154
    # pylint: disable=undefined-variable
155
156
    check_args(args)
157
158
    xml_doc = args.script[1]
159
160
    print('\nSending targets...')
161
162
    xml_tree = create_xml_tree(xml_doc)
163
    parse_send_xml_tree(gmp, xml_tree)
164
165
    print('\n  Target(s) created!\n')
166
167
168
if __name__ == '__gmp__':
169
    main(gmp, args)  # pylint: disable=undefined-variable
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable args does not seem to be defined.
Loading history...
Comprehensibility Best Practice introduced by
The variable gmp does not seem to be defined.
Loading history...
170