oval_graph.command_line_client.client.Client._get_message() - Code Metrics - Inspection of "[WIP] Tests for command arf-to-report" - OpenSCAP/oval-graph - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#160)

by Jan

created 2021-03-24 19:13 UTC

Client._get_message() A

↳ Parent: oval_graph.command_line_client.client

Complexity

Conditions

Size

Total Lines	5
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	5
nop	0
dl	0
loc	5
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

import argparse

import re
import sys
from datetime import datetime

from .. import __version__


class Client():

    def __init__(self, args):
        self.arg = self.parse_arguments(args)

        self.source_filename = self.arg.source_filename
        self.rule_name = None
        if hasattr(self.arg, 'rule_id'):
            self.rule_name = self.arg.rule_id

        self.isatty = sys.stdout.isatty()

        self.all_rules = None
        if hasattr(self.arg, 'all'):
            self.all_rules = self.arg.all
        self.show_failed_rules = False
        self.show_not_selected_rules = False

    @staticmethod
    def _get_message():
        return {
            'description': '',
            'source_filename': '',
        }

    @staticmethod
    def _get_date():
        return str(datetime.now().strftime("-%d_%m_%Y-%H_%M_%S"))

    # Functions for selection of rules

    def search_rules_id(self):
        """
        Function retunes array of all matched IDs of rules in selected file.
        """
        raise NotImplementedError

    def get_only_fail_rule(self, rules):
        """
        Function processes array of matched IDs of rules in selected file.
        Function retunes array of failed matched IDs of rules in selected file.
        """
        raise NotImplementedError

    def _get_rows_of_unselected_rules(self):
        """
        Function retunes array of rows where is not selected IDs of rules in selected file.
        """
        raise NotImplementedError

    def run_gui_and_return_answers(self):

        if self.isatty:
            if self.all_rules:
                return self._get_rules()

            try:
                import inquirer

                return inquirer.prompt(self.get_questions())
            except ImportError:
                print(self.get_selection_rules())
            return None
        return self._get_rules()

    def _get_rules(self):
        if self.show_failed_rules:
            return {'rules': self.get_only_fail_rule(self.search_rules_id())}
        return {'rules': self.search_rules_id()}

    def _get_list_of_matched_rules(self):
        if self.show_failed_rules:
            return self.get_only_fail_rule(self.search_rules_id())
        return self.search_rules_id()

    def _get_list_of_lines(self):
        lines = ['== The Rule ID regular expressions ==']
        for rule in self._get_list_of_matched_rules():
            lines.append("^" + rule + "$")
        if self.show_not_selected_rules:
            for line in self._get_rows_of_unselected_rules():
                lines.append(line)
        lines.append(
            "Interactive rule selection is not available,"
            " because inquirer is not installed."
            " Copy id of the rule you want to visualize and"
            " paste it into a command with regular"
            " expression characters(^$).\n"
            "Alternatively, use the --all or --all-in-one arguments.")
        return lines

    def get_selection_rules(self):

        return "\n".join(self._get_list_of_lines())

    def _get_choices(self):
        if self.show_not_selected_rules:
            print("\n".join(self._get_rows_of_unselected_rules()))
        return self._get_list_of_matched_rules()

    def get_questions(self):

        from inquirer.questions import Checkbox as checkbox

        choices = self._get_choices()
        questions = [
            checkbox(
                'rules',
                message=(
                    "= The Rules IDs = (move - UP and DOWN arrows,"
                    " select - SPACE or LEFT and RIGHT arrows, submit - ENTER)"),
                choices=choices,
            ),
        ]
        return questions

    def _get_wanted_rules(self, rules):
        return [
            x for x in rules if re.search(
                self.rule_name, x)]

    def _check_rules_id(self, rules, notselected_rules):
        if notselected_rules and not rules:
            raise ValueError(
                ('Rule(s) "{}" was not selected, '
                 "so there are no results. The rule is"
                 ' "notselected" because it'
                 " wasn't a part of the executed profile"
                 " and therefore it wasn't evaluated "
                 "during the scan.")
                .format(notselected_rules))
        if not notselected_rules and not rules:
            raise ValueError('404 rule "{}" not found!'.format(self.rule_name))
        return rules

    # Function for setting arguments

    def parse_arguments(self, args):

        parser = argparse.ArgumentParser(
            prog='oval-graph',
            description=self._get_message().get('description'))
        self.prepare_parser(parser)
        if args is None:
            return parser.parse_args()
        return parser.parse_args(args)

    @staticmethod
    def args_for_editing_list_of_rules(parser):

        parser.add_argument(
            '--show-failed-rules',
            action="store_true",
            default=False,
            help="Show only FAILED rules")
        parser.add_argument(
            '--show-not-selected-rules',
            action="store_true",
            default=False,
            help="Show notselected rules. These rules will not be visualized.")

    @staticmethod
    def args_all_and_hide_passing_test(parser):

        parser.add_argument(
            '-a',
            '--all',
            action="store_true",
            default=False,
            help="Process all matched rules.")
        parser.add_argument(
            '--hide-passing-tests',
            action="store_true",
            default=False,
            help=(
                "Do not display passing tests for better orientation in"
                " graphs that contain a large amount of nodes."))

    def arg_source_file(self, parser):

        parser.add_argument(
            "source_filename",
            help=self._get_message().get('source_filename'))

    @staticmethod
    def arg_rule_id(parser):

        parser.add_argument(
            "rule_id", help=(
                "Rule ID to be visualized. A part from the full rule ID"
                " a part of the ID or a regular expression can be used."
                " If brackets are used in the regular expression "
                "the regular expression must be quoted."))

    @staticmethod
    def args_basic_functions(parser):

        parser.add_argument(
            '--version',
            action='version',
            version='%(prog)s ' + __version__)
        parser.add_argument(
            '-v',
            '--verbose',
            action="store_true",
            default=False,
            help="Displays details about the results of the running command.")
        parser.add_argument(
            '-o',
            '--output',
            action="store",
            default=None,
            help='The file where to save output.')

    def prepare_parser(self, parser):

        self.args_basic_functions(parser)
        self.args_all_and_hide_passing_test(parser)
        self.arg_source_file(parser)
        self.arg_rule_id(parser)


1	1	import argparse
		0 ignored issues – show introduced 2020-12-20 23:54 UTC by Report Bug Copy Issue Report Missing module docstring Loading history...
2	1	import re
3	1	import sys
4	1	from datetime import datetime
5
6	1	from .. import __version__
7
8
9	1	class Client():
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing class docstring Loading history...
10	1	def __init__(self, args):
11	1	self.arg = self.parse_arguments(args)
12
13	1	self.source_filename = self.arg.source_filename
14	1	self.rule_name = None
15	1	if hasattr(self.arg, 'rule_id'):
16	1	self.rule_name = self.arg.rule_id
17
18	1	self.isatty = sys.stdout.isatty()
19
20	1	self.all_rules = None
21	1	if hasattr(self.arg, 'all'):
22	1	self.all_rules = self.arg.all
23	1	self.show_failed_rules = False
24	1	self.show_not_selected_rules = False
25
26	1	@staticmethod
27		def _get_message():
28	1	return {
29		'description': '',
30		'source_filename': '',
31		}
32
33	1	@staticmethod
34		def _get_date():
35	1	return str(datetime.now().strftime("-%d_%m_%Y-%H_%M_%S"))
36
37		# Functions for selection of rules
38
39	1	def search_rules_id(self):
40		"""
41		Function retunes array of all matched IDs of rules in selected file.
42		"""
43	1	raise NotImplementedError
44
45	1	def get_only_fail_rule(self, rules):
46		"""
47		Function processes array of matched IDs of rules in selected file.
48		Function retunes array of failed matched IDs of rules in selected file.
49		"""
50	1	raise NotImplementedError
51
52	1	def _get_rows_of_unselected_rules(self):
53		"""
54		Function retunes array of rows where is not selected IDs of rules in selected file.
55		"""
56	1	raise NotImplementedError
57
58	1	def run_gui_and_return_answers(self):
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
59	1	if self.isatty:
60	1	if self.all_rules:
61	1	return self._get_rules()
62
63	1	try:
64	1	import inquirer
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Import outside toplevel (inquirer) Loading history...
65	1	return inquirer.prompt(self.get_questions())
66	1	except ImportError:
67	1	print(self.get_selection_rules())
68	1	return None
69	1	return self._get_rules()
70
71	1	def _get_rules(self):
72	1	if self.show_failed_rules:
73	1	return {'rules': self.get_only_fail_rule(self.search_rules_id())}
74	1	return {'rules': self.search_rules_id()}
75
76	1	def _get_list_of_matched_rules(self):
77	1	if self.show_failed_rules:
78	1	return self.get_only_fail_rule(self.search_rules_id())
79	1	return self.search_rules_id()
80
81	1	def _get_list_of_lines(self):
82	1	lines = ['== The Rule ID regular expressions ==']
83	1	for rule in self._get_list_of_matched_rules():
84	1	lines.append("^" + rule + "$")
85	1	if self.show_not_selected_rules:
86	1	for line in self._get_rows_of_unselected_rules():
87	1	lines.append(line)
88	1	lines.append(
89		"Interactive rule selection is not available,"
90		" because inquirer is not installed."
91		" Copy id of the rule you want to visualize and"
92		" paste it into a command with regular"
93		" expression characters(^$).\n"
94		"Alternatively, use the --all or --all-in-one arguments.")
95	1	return lines
96
97	1	def get_selection_rules(self):
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
98	1	return "\n".join(self._get_list_of_lines())
99
100	1	def _get_choices(self):
101	1	if self.show_not_selected_rules:
102	1	print("\n".join(self._get_rows_of_unselected_rules()))
103	1	return self._get_list_of_matched_rules()
104
105	1	def get_questions(self):
		0 ignored issues – show introduced 2020-12-20 23:54 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
106	1	from inquirer.questions import Checkbox as checkbox
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Import outside toplevel (inquirer.questions.Checkbox) Loading history...
107	1	choices = self._get_choices()
108	1	questions = [
109		checkbox(
110		'rules',
111		message=(
112		"= The Rules IDs = (move - UP and DOWN arrows,"
113		" select - SPACE or LEFT and RIGHT arrows, submit - ENTER)"),
114		choices=choices,
115		),
116		]
117	1	return questions
118
119	1	def _get_wanted_rules(self, rules):
120	1	return [
121		x for x in rules if re.search(
122		self.rule_name, x)]
123
124	1	def _check_rules_id(self, rules, notselected_rules):
125	1	if notselected_rules and not rules:
126	1	raise ValueError(
127		('Rule(s) "{}" was not selected, '
128		"so there are no results. The rule is"
129		' "notselected" because it'
130		" wasn't a part of the executed profile"
131		" and therefore it wasn't evaluated "
132		"during the scan.")
133		.format(notselected_rules))
134	1	if not notselected_rules and not rules:
135	1	raise ValueError('404 rule "{}" not found!'.format(self.rule_name))
136	1	return rules
137
138		# Function for setting arguments
139
140	1	def parse_arguments(self, args):
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
141	1	parser = argparse.ArgumentParser(
142		prog='oval-graph',
143		description=self._get_message().get('description'))
144	1	self.prepare_parser(parser)
145	1	if args is None:
146		return parser.parse_args()
147	1	return parser.parse_args(args)
148
149	1	@staticmethod
150		def args_for_editing_list_of_rules(parser):
		0 ignored issues – show introduced 2020-12-17 11:40 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
151	1	parser.add_argument(
152		'--show-failed-rules',
153		action="store_true",
154		default=False,
155		help="Show only FAILED rules")
156	1	parser.add_argument(
157		'--show-not-selected-rules',
158		action="store_true",
159		default=False,
160		help="Show notselected rules. These rules will not be visualized.")
161
162	1	@staticmethod
163		def args_all_and_hide_passing_test(parser):
		0 ignored issues – show introduced 2021-02-12 15:05 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
164	1	parser.add_argument(
165		'-a',
166		'--all',
167		action="store_true",
168		default=False,
169		help="Process all matched rules.")
170	1	parser.add_argument(
171		'--hide-passing-tests',
172		action="store_true",
173		default=False,
174		help=(
175		"Do not display passing tests for better orientation in"
176		" graphs that contain a large amount of nodes."))
177
178	1	def arg_source_file(self, parser):
		0 ignored issues – show introduced 2021-02-16 21:24 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
179	1	parser.add_argument(
180		"source_filename",
181		help=self._get_message().get('source_filename'))
182
183	1	@staticmethod
184		def arg_rule_id(parser):
		0 ignored issues – show introduced 2021-02-16 21:24 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
185	1	parser.add_argument(
186		"rule_id", help=(
187		"Rule ID to be visualized. A part from the full rule ID"
188		" a part of the ID or a regular expression can be used."
189		" If brackets are used in the regular expression "
190		"the regular expression must be quoted."))
191
192	1	@staticmethod
193		def args_basic_functions(parser):
		0 ignored issues – show introduced 2021-02-16 21:24 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
194	1	parser.add_argument(
195		'--version',
196		action='version',
197		version='%(prog)s ' + __version__)
198	1	parser.add_argument(
199		'-v',
200		'--verbose',
201		action="store_true",
202		default=False,
203		help="Displays details about the results of the running command.")
204	1	parser.add_argument(
205		'-o',
206		'--output',
207		action="store",
208		default=None,
209		help='The file where to save output.')
210
211	1	def prepare_parser(self, parser):
		0 ignored issues – show introduced 2021-02-24 17:28 UTC by Report Bug Copy Issue Report Missing function or method docstring Loading history...
212	1	self.args_basic_functions(parser)
213	1	self.args_all_and_hide_passing_test(parser)
214	1	self.arg_source_file(parser)
215		self.arg_rule_id(parser)
216

OpenSCAP / oval-graph

Pull Request — master (#160)

Client._get_message() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like