Passed
Push — master ( b75d19...555acd )
by Matěj
04:11 queued 10s
created

oval_graph.client.Client._get_message()   A

Complexity

Conditions 1

Size

Total Lines 7
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 0
Metric Value
cc 1
eloc 6
nop 1
dl 0
loc 7
ccs 3
cts 3
cp 1
crap 1
rs 10
c 0
b 0
f 0
1 1
import re
2 1
import argparse
3 1
import tempfile
4 1
import os
5 1
import webbrowser
6 1
import json
7 1
import shutil
8 1
from datetime import datetime
9 1
import sys
10
11 1
from .xml_parser import XmlParser
12 1
from .exceptions import NotChecked
13 1
from ._builder_html_graph import BuilderHtmlGraph
14
15
16 1
class Client():
17 1
    def __init__(self, args):
18 1
        self.parser = None
19 1
        self.MESSAGES = self._get_message()
20 1
        self.arg = self.parse_arguments(args)
21 1
        self.hide_passing_tests = self.arg.hide_passing_tests
22 1
        self.source_filename = self.arg.source_filename
23 1
        self.rule_name = self.arg.rule_id
24 1
        self.out = self.arg.output
25 1
        self.all_rules = self.arg.all
26 1
        self.all_in_one = None
27 1
        self.display_html = None
28 1
        self.isatty = sys.stdout.isatty()
29 1
        self.show_failed_rules = False
30 1
        self.show_not_selected_rules = False
31 1
        self.xml_parser = XmlParser(
32
            self.source_filename)
33 1
        self.parts = self.get_src('parts')
34 1
        self.START_OF_FILE_NAME = 'graph-of-'
35 1
        self.date = str(datetime.now().strftime("-%d_%m_%Y-%H_%M_%S"))
36 1
        self.verbose = self.arg.verbose
37
38 1
    def _get_message(self):
39 1
        MESSAGES = {
40
            'description': '',
41
            '--output': '',
42
            'source_filename': '',
43
        }
44 1
        return MESSAGES
45
46 1
    def print_red_text(self, text):
47
        CRED = '\033[91m'
48
        CEND = '\033[0m'
49
        print(CRED + str(text) + CEND)
50
51 1
    def run_gui_and_return_answers(self):
52 1
        if self.isatty:
53 1
            if self.all_rules:
54
                return self._get_rules()
55
            else:
56 1
                try:
57 1
                    import inquirer
58 1
                    return inquirer.prompt(self.get_questions())
59 1
                except ImportError:
60 1
                    print(self.get_selection_rules())
61 1
                    return None
62
        else:
63 1
            return self._get_rules()
64
65 1
    def _get_rules(self):
66 1
        return {
67
            'rules': self._get_only_fail_rule(
68
                self.search_rules_id())} if self.show_failed_rules else {
69
            'rules': self.search_rules_id()}
70
71 1
    def get_list_of_matched_rules(self):
72 1
        return self._get_only_fail_rule(
73
            self.search_rules_id()) if self.show_failed_rules else self.search_rules_id()
74
75 1
    def get_list_of_lines(self):
76 1
        lines = ['== The Rule IDs ==']
77 1
        for rule in self.get_list_of_matched_rules():
78 1
            lines.append("'" + rule + r'\b' + "'")
79 1
        if self.show_not_selected_rules:
80 1
            for line in self.get_lines_of_wanted_not_selected_rules():
81 1
                lines.append(line)
82 1
        lines.append(
83
            "You haven't got installed inquirer lib. "
84
            "Please copy id rule with you want use and put it in command")
85 1
        return lines
86
87 1
    def get_selection_rules(self):
88 1
        return "\n".join(self.get_list_of_lines())
89
90 1
    def get_lines_of_wanted_not_selected_rules(self):
91 1
        out = []
92 1
        out.append('== The not selected rule IDs ==')
93 1
        for rule in self._get_wanted_rules_from_array_of_IDs(
94
                self.xml_parser.notselected_rules):
95 1
            out.append(rule + '(Not selected)')
96 1
        return out
97
98 1
    def get_choices(self):
99 1
        if self.show_not_selected_rules:
100 1
            print("\n".join(self.get_lines_of_wanted_not_selected_rules()))
101 1
        return self.get_list_of_matched_rules()
102
103 1
    def get_questions(self):
104 1
        choices = self.get_choices()
105 1
        from inquirer.questions import Checkbox as checkbox
106 1
        questions = [
107
            checkbox(
108
                'rules',
109
                message=(
110
                    "= The Rules IDs = (move - UP and DOWN arrows,"
111
                    " select - SPACE or LEFT and RIGHT arrows, submit - ENTER)"),
112
                choices=choices,
113
            ),
114
        ]
115 1
        return questions
116
117 1
    def _get_only_fail_rule(self, rules):
118 1
        return list(
119
            filter(
120
                lambda rule: self.xml_parser.used_rules[rule]['result'] == 'fail',
121
                rules))
122
123 1
    def _get_wanted_rules_from_array_of_IDs(self, rules):
124 1
        return [
125
            x for x in rules if re.search(
126
                self.rule_name, x)]
127
128 1
    def search_rules_id(self):
129 1
        return self._check_rules_id(
130
            self._get_wanted_rules_from_array_of_IDs(
131
                self.xml_parser.used_rules.keys()),
132
            self._get_wanted_rules_from_array_of_IDs(
133
                self.xml_parser.notselected_rules))
134
135 1
    def _check_rules_id(self, rules, notselected_rules):
136 1
        if len(notselected_rules) and not rules:
137 1
            raise ValueError(
138
                ('Rule(s) "{}" was not selected, '
139
                 "so there are no results. The rule is"
140
                 ' "notselected" because it'
141
                 " wasn't a part of the executed profile"
142
                 " and therefore it wasn't evaluated "
143
                 "during the scan.")
144
                .format(notselected_rules))
145 1
        elif not notselected_rules and not rules:
146 1
            raise ValueError('404 rule "{}" not found!'.format(self.rule_name))
147
        else:
148 1
            return rules
149
150 1
    def get_save_src(self, rule):
151 1
        if self.out is not None:
152 1
            os.makedirs(self.out, exist_ok=True)
153 1
            return os.path.join(
154
                self.out,
155
                self.START_OF_FILE_NAME + rule + '.html')
156 1
        return os.path.join(
157
            tempfile.gettempdir(),
158
            self.START_OF_FILE_NAME + rule + '.html')
159
160 1
    def get_src(self, src):
161 1
        _dir = os.path.dirname(os.path.realpath(__file__))
162 1
        return str(os.path.join(_dir, src))
163
164 1
    def _build_and_save_html(self, dict_oval_trees, src, rules, out):
165 1
        builder = BuilderHtmlGraph(
166
            self.parts, self.display_html, self.verbose)
167 1
        builder.save_html_and_open_html(dict_oval_trees, src, rules, out)
168
169 1
    def _prepare_data(self, rules, dict_oval_trees, out):
170 1
        for rule in rules['rules']:
171 1
            try:
172 1
                self._put_to_dict_oval_trees(dict_oval_trees, rule)
173 1
                if not self.all_in_one:
174 1
                    self._build_and_save_html(
175
                        dict_oval_trees, self._get_src_for_one_graph(
176
                            rule), dict(
177
                            rules=[rule]), out)
178 1
                    dict_oval_trees = {}
179 1
            except NotChecked as error:
180
                self.print_red_text(error)
181 1
        if self.all_in_one:
182
            self._build_and_save_html(
183
                dict_oval_trees, self.get_save_src(
184
                    'rules' + self.date), rules, out)
185 1
        return out
186
187 1
    def prepare_data(self, rules):
188 1
        out = []
189 1
        oval_tree_dict = dict()
190 1
        return self._prepare_data(rules, oval_tree_dict, out)
191
192 1
    def parse_arguments(self, args):
193 1
        self.prepare_parser()
194 1
        return self.parser.parse_args(args)
195
196 1
    def prepare_parser(self):
197 1
        self.parser = argparse.ArgumentParser(
198
            description=self.MESSAGES.get('description'))
199 1
        self.parser.add_argument(
200
            '--all',
201
            action="store_true",
202
            default=False,
203
            help="Process all matched rules.")
204 1
        self.parser.add_argument(
205
            '--hide-passing-tests',
206
            action="store_true",
207
            default=False,
208
            help=(
209
                "Do not display passing tests for better orientation in"
210
                " graphs that contain a large amount of nodes.(Not implemented)"))
211 1
        self.parser.add_argument(
212
            '--verbose',
213
            action="store_true",
214
            default=False,
215
            help="Displays details about the results of the running command.")
216 1
        self.parser.add_argument(
217
            '-o',
218
            '--output',
219
            action="store",
220
            default=None,
221
            help=self.MESSAGES.get('--output'))
222 1
        self.parser.add_argument(
223
            "source_filename",
224
            help=self.MESSAGES.get('source_filename'))
225 1
        self.parser.add_argument(
226
            "rule_id", help=(
227
                "Rule ID to be visualized. A part from the full rule ID"
228
                " a part of the ID or a regular expression can be used."
229
                " If brackets are used in the regular expression "
230
                "the regular expression must be quoted."))
231