Passed
Push — master ( 23c8bb...7778bf )
by Matěj
07:59 queued 10s
created

oval_graph.client.Client.save_dict()   A

Complexity

Conditions 2

Size

Total Lines 4
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 2

Importance

Changes 0
Metric Value
cc 2
eloc 4
nop 3
dl 0
loc 4
ccs 3
cts 3
cp 1
crap 2
rs 10
c 0
b 0
f 0
1 1
import re
2 1
import webbrowser
3 1
import json
4 1
import argparse
5 1
import tempfile
6 1
import os
7 1
import shutil
8 1
from datetime import datetime
9
10 1
from .xml_parser import XmlParser
11 1
from .oval_node import OvalNode
12 1
from .converter import Converter
13
14
15 1
class Client():
16 1
    def __init__(self, args):
17 1
        self.arg = self.parse_arguments(args)
18 1
        self.remove_pass_tests = self.arg.remove_pass_tests
19 1
        self.show_fail_rules = self.arg.show_fail_rules
20 1
        self.show_not_selected_rules = self.arg.show_not_selected_rules
21 1
        self.off_webbrowser = self.arg.off_web_browser
22 1
        self.source_filename = self.arg.source_filename
23 1
        self.rule_name = self.arg.rule_id
24 1
        self.XmlParser = XmlParser(
25
            self.source_filename)
26 1
        self.html_interpreter = 'tree_html_interpreter'
27 1
        if self.remove_pass_tests:
28
            raise NotImplementedError('Not implemented!')
29
30 1
    def run_gui_and_return_answers(self):
31 1
        try:
32 1
            import inquirer
33
            return inquirer.prompt(self.get_questions())
34 1
        except ImportError:
35 1
            print('== The Rule IDs ==')
36 1
            rules = self.search_rules_id()
37 1
            if self.show_fail_rules:
38 1
                rules = self.get_only_fail_rule(rules)
39 1
            for rule in rules:
40 1
                print(rule['id_rule'] + r'\b')
41 1
            if self.show_not_selected_rules:
42 1
                print('== The not selected rule IDs ==')
43 1
                for rule in self._get_wanted_not_selected_rules():
44 1
                    print(rule['id_rule'] + '(Not selected)')
45 1
            return None
46
47 1
    def get_questions(self):
48 1
        rules = self.search_rules_id()
49 1
        if self.show_fail_rules:
50 1
            rules = self.get_only_fail_rule(rules)
51 1
        choices_ = []
52 1
        for rule in rules:
53 1
            choices_.append(rule['id_rule'])
54 1
        if self.show_not_selected_rules:
55 1
            print('== The not selected rule IDs ==')
56 1
            for rule in self._get_wanted_not_selected_rules():
57 1
                print(rule['id_rule'] + '(Not selected)')
58 1
        from inquirer.questions import Checkbox as checkbox
59 1
        questions = [
60
            checkbox(
61
                'rules',
62
                message=(
63
                    "= The Rules IDs = (move - UP and DOWN arrows,"
64
                    " select - SPACE or LEFT and RIGHT arrows, submit - ENTER)"),
65
                choices=choices_,
66
            ),
67
        ]
68 1
        return questions
69
70 1
    def get_only_fail_rule(self, rules):
71 1
        return list(filter(lambda rule: rule['result'] == 'fail', rules))
72
73 1
    def _get_wanted_rules(self):
74 1
        return [
75
            x for x in self.XmlParser.get_used_rules() if re.search(
76
                self.rule_name, x['id_rule'])]
77
78 1
    def _get_wanted_not_selected_rules(self):
79 1
        return [
80
            x for x in self.XmlParser.get_notselected_rules() if re.search(
81
                self.rule_name, x['id_rule'])]
82
83 1
    def search_rules_id(self):
84 1
        rules = self._get_wanted_rules()
85 1
        notselected_rules = self._get_wanted_not_selected_rules()
86 1
        if len(notselected_rules) and not rules:
87 1
            raise ValueError(
88
                ('err- rule(s) "{}" was not selected, '
89
                 "so there are no results. The rule is"
90
                 ' "notselected" because it'
91
                 " wasn't a part of the executed profile"
92
                 " and therefore it wasn't evaluated "
93
                 "during the scan.")
94
                .format(notselected_rules[0]['id_rule']))
95 1
        elif not notselected_rules and not rules:
96 1
            raise ValueError('err- 404 rule not found!')
97
        else:
98 1
            return rules
99
100 1
    def create_dict_of_rule(self, rule_id):
101 1
        parser = XmlParser(self.source_filename)
102 1
        converter = Converter(parser.get_oval_tree(rule_id))
103 1
        return converter.to_JsTree_dict()
104
105 1
    def save_dict(self, dict_, src):
106 1
        with open(os.path.join(src, 'data.js'), "w+") as data_file:
107 1
            data_file.write("var data_json =" + str(json.dumps(
108
                dict_, sort_keys=False, indent=4) + ";"))
109
110 1
    def copy_interpreter(self, dst):
111 1
        src = self.XmlParser.get_src(self.html_interpreter)
112 1
        os.mkdir(dst)
113 1
        for item in os.listdir(src):
114 1
            s = os.path.join(src, item)
115 1
            d = os.path.join(dst, item)
116 1
            if os.path.isdir(s):
117 1
                shutil.copytree(s, d)
118
            else:
119 1
                shutil.copy2(s, d)
120
121 1
    def prepare_data(self, rules):
122 1
        try:
123 1
            out = []
124 1
            for rule in rules['rules']:
125 1
                oval_tree = self.create_dict_of_rule(rule)
126 1
                date = str(datetime.now().strftime("_%d-%m-%Y_%H:%M:%S"))
127 1
                src = os.path.join(
128
                    tempfile.gettempdir(),
129
                    'graph-of-' + rule + date)
130 1
                self.copy_interpreter(src)
131 1
                self.save_dict(oval_tree, src)
132 1
                self.open_web_browser(src)
133 1
                print('Rule "{}" done!'.format(rule))
134 1
                out.append(src)
135 1
            return out
136 1
        except Exception as error:
137 1
            raise ValueError('Rule: "{}" Error: "{}"'.format(rule, error))
138
139 1
    def open_web_browser(self, src):
140 1
        if not self.off_webbrowser:
141
            src = os.path.join(src, 'index.html')
142
            try:
143
                webbrowser.get('firefox').open_new_tab(src)
144
            except BaseException:
145
                webbrowser.open_new_tab(src)
146
147 1
    def parse_arguments(self, args):
148 1
        parser = argparse.ArgumentParser(
149
            description="Client for visualization of SCAP rule evaluation results")
150 1
        parser.add_argument(
151
            '--show-fail-rules',
152
            action="store_true",
153
            default=False,
154
            help="Show only FAIL rules")
155 1
        parser.add_argument(
156
            '--show-not-selected-rules',
157
            action="store_true",
158
            default=False,
159
            help="Show notselected rules. These rules will not be visualized.")
160 1
        parser.add_argument(
161
            '--off-web-browser',
162
            action="store_true",
163
            default=False,
164
            help="It does not start the web browser.")
165 1
        parser.add_argument(
166
            '--remove-pass-tests',
167
            action="store_true",
168
            default=False,
169
            help=(
170
                "Do not display passing tests for better orientation in"
171
                " graphs that contain a large amount of nodes.(Not implemented)"))
172 1
        parser.add_argument("source_filename", help="ARF scan file")
173 1
        parser.add_argument(
174
            "rule_id", help=(
175
                "Rule ID to be visualized. A part from the full rule ID"
176
                " a part of the ID or a regular expression can be used."
177
                " If brackets are used in the regular expression "
178
                "the regular expression must be quoted."))
179 1
        args = parser.parse_args(args)
180
181
        return args
182