oval_graph.command_line_client.client.Client._check_rules_id() - Code Metrics - Inspection of "[WIP] Cli improvement" - OpenSCAP/oval-graph - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#199)

by Jan

created 2021-06-24 14:10 UTC

Client._check_rules_id() A

↳ Parent: oval_graph.command_line_client.client

Complexity

Conditions

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	5

Importance

Changes

Metric	Value
cc	5
eloc	8
nop	3
dl	0
loc	13
ccs	6
cts	6
cp	1
crap	5
rs	9.3333
c	0
b	0
f	0

import argparse
import re
import sys
from datetime import datetime

from .. import __version__

IS_INQUIRER_INSTALLED = True
try:
    from inquirer.prompt import prompt
    from inquirer.questions import Checkbox
except ImportError:
    IS_INQUIRER_INSTALLED = False


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

        self.source_filename = self.arg.source_filename
        self.rule_name = self.arg.rule_id

        self.isatty = sys.stdout.isatty()

        self.all_rules = self.arg.all
        self.show_failed_rules = False
        self.show_not_selected_rules = False
        self.show_not_tested_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 _get_rows_not_visualizable_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()

            if IS_INQUIRER_INSTALLED:
                questions = self.get_questions()
                answers = prompt(questions)
                return answers

            print(self.get_selection_rules())
            return None
        return self._get_rules()

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

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

    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 and not self.show_not_tested_rules:
            for line in self._get_rows_of_unselected_rules():
                lines.append(line)
        if not self.show_not_selected_rules and self.show_not_tested_rules:
            for line in self._get_rows_not_visualizable_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 and not self.show_not_tested_rules:
            print("\n".join(self._get_rows_of_unselected_rules()))
        if not self.show_not_selected_rules and self.show_not_tested_rules:
            print("\n".join(self._get_rows_not_visualizable_rules()))
        return self._get_list_of_matched_rules()

    def get_questions(self):
        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)]

    # 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 prepare_args_when_user_can_list_in_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.")
        parser.add_argument(
            '--show-not-tested-rules',
            action="store_true",
            default=False,
            help="Show not tested rules. These rules will not be visualized.")

    def prepare_parser(self, parser):
        parser.add_argument(
            '--version',
            action='version',
            version='%(prog)s ' + __version__)
        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."))
        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.')
        parser.add_argument(
            "source_filename",
            help=self._get_message().get('source_filename'))
        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."))


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

OpenSCAP / oval-graph

Pull Request — master (#199)

Client._check_rules_id() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like