utils.controleval.print_options() - Code Metrics - Inspection of "Merge pull request #8490 from Xeicker/ntp_maxpoll" - ComplianceAsCode/content - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 8e3f9b...05d38f )

unknown

created 2022-04-26 09:14 UTC

utils.controleval.print_options() A

↳ Parent: utils.controleval

Complexity

Conditions

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

#!/usr/bin/python3
import collections
import argparse
import os
import json

# NOTE: This is not to be confused with the https://pypi.org/project/ssg/
# package. The ssg package we're referencing here is actually a relative import
# within this repository. Because of this, you need to ensure
# ComplianceAsCode/content/ssg is discoverable from PYTHONPATH before you
# invoke this script.
try:
    from ssg import controls
    import ssg.products
except ModuleNotFoundError as e:
    # NOTE: Only emit this message if we're dealing with an import error for
    # ssg. Since the local ssg module imports other things, like PyYAML, we
    # don't want to emit misleading errors for legit dependencies issues if the
    # user hasn't installed PyYAML or other transitive dependencies from ssg.
    # We should revisit this if or when we decide to implement a python package
    # management strategy for the python scripts provided in this repository.
    if e.name == 'ssg':
        msg = """Unable to import local 'ssg' module.

The 'ssg' package from within this repository must be discoverable before
invoking this script. Make sure the top-level directory of the
ComplianceAsCode/content repository is available in the PYTHONPATH environment
variable (example: $ export PYTHONPATH=($pwd)).
"""
        raise RuntimeError(msg) from e
    raise


SSG_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))


def print_options(opts):
    if len(opts) > 0:
        print("Available options are:\n - " + "\n - ".join(opts))
    else:
        print("The controls file is not written appropriately.")


def validate_args(ctrlmgr, args):
    """ Validates that the appropriate args were given
        and that they're valid entries in the control manager."""

    policy = None
    try:
        policy = ctrlmgr._get_policy(args.id)
    except ValueError as e:
        print("Error: ", e)
        print_options(ctrlmgr.policies.keys())
        exit(1)

    try:
        policy.get_level_with_ancestors_sequence(args.level)
    except ValueError as e:
        print("Error: ", e)
        print_options(policy.levels_by_id.keys())
        exit(1)


def calculate_stats(ctrls):
    total = len(ctrls)
    ctrlstats = collections.defaultdict(int)
    ctrllist = collections.defaultdict(set)

    if total == 0:
        print("No controls founds with the given inputs. Maybe try another level.")
        exit(1)

    for ctrl in ctrls:
        ctrlstats[str(ctrl.status)] += 1

        ctrllist[str(ctrl.status)].add(ctrl)

    applicable = total - ctrlstats[controls.Status.NOT_APPLICABLE]
    assessed = ctrlstats[controls.Status.AUTOMATED] + ctrlstats[controls.Status.SUPPORTED] + \
        ctrlstats[controls.Status.DOCUMENTATION] + ctrlstats[controls.Status.INHERENTLY_MET] + \
        ctrlstats[controls.Status.PARTIAL]

    print("Total controls = {total}".format(total=total))
    print_specific_stat("Applicable", applicable, total)
    print_specific_stat("Assessed", assessed, applicable)
    print()
    print_specific_stat("Automated",
                        ctrlstats[controls.Status.AUTOMATED],
                        applicable)
    print_specific_stat("Manual",
                        ctrlstats[controls.Status.MANUAL],
                        applicable)
    print_specific_stat("Supported",
                        ctrlstats[controls.Status.SUPPORTED],
                        applicable)
    print_specific_stat("Documentation",
                        ctrlstats[controls.Status.DOCUMENTATION],
                        applicable)
    print_specific_stat("Inherently Met",
                        ctrlstats[controls.Status.INHERENTLY_MET],
                        applicable)
    print_specific_stat("Does Not Meet",
                        ctrlstats[controls.Status.DOES_NOT_MEET],
                        applicable)
    print_specific_stat("Partial",
                        ctrlstats[controls.Status.PARTIAL],
                        applicable)

    applicablelist = ctrls - ctrllist[controls.Status.NOT_APPLICABLE]
    assessedlist = set().union(ctrllist[controls.Status.AUTOMATED]).union(ctrllist[controls.Status.SUPPORTED])\
        .union(ctrllist[controls.Status.DOCUMENTATION]).union(ctrllist[controls.Status.INHERENTLY_MET])\
        .union(ctrllist[controls.Status.PARTIAL]).union(ctrllist[controls.Status.MANUAL])
    print("Missing:", ", ".join(sorted(str(c.id)
          for c in applicablelist - assessedlist)))


def print_specific_stat(stat, current, total):
    print("{stat} = {percent}% -- {current} / {total}".format(
        stat=stat,
        percent=round((current / total) * 100.00, 2),
        current=current,
        total=total))


def stats(ctrlmgr, args):
    validate_args(ctrlmgr, args)
    ctrls = set(ctrlmgr.get_all_controls_of_level(args.id, args.level))
    total = len(ctrls)

    if total == 0:
        print("No controls founds with the given inputs. Maybe try another level.")
        exit(1)

    if args.output_format == 'json':
        print_to_json(
            ctrls,
            args.product,
            args.id,
            args.level)
    else:
        calculate_stats(ctrls)


def print_to_json(ctrls, product, id, level):
    data = dict()
    ctrllist = collections.defaultdict(set)

    for ctrl in ctrls:
        ctrllist[str(ctrl.status)].add(ctrl)

    applicablelist = ctrls - ctrllist[controls.Status.NOT_APPLICABLE]
    assessedlist = set().union(ctrllist[controls.Status.AUTOMATED]).union(ctrllist[controls.Status.SUPPORTED])\
        .union(ctrllist[controls.Status.DOCUMENTATION]).union(ctrllist[controls.Status.INHERENTLY_MET])\
        .union(ctrllist[controls.Status.PARTIAL]).union(ctrllist[controls.Status.MANUAL])

    data["format_version"] = "v0.0.1"
    data["product_name"] = product
    data["benchmark"] = dict()
    data["benchmark"]["name"] = id
    data["benchmark"]["baseline"] = level
    data["total_controls"] = len(applicablelist)
    data["addressed_controls"] = dict()
    data["addressed_controls"]["all"] = get_id_array(ctrls)
    data["addressed_controls"]["applicable"] = get_id_array(applicablelist)
    data["addressed_controls"]["assessed"] = get_id_array(assessedlist)
    data["addressed_controls"]["inherently"] = get_id_array(
        ctrllist[controls.Status.INHERENTLY_MET])
    data["addressed_controls"]["manual"] = get_id_array(
        ctrllist[controls.Status.MANUAL])
    data["addressed_controls"]["supported"] = get_id_array(
        ctrllist[controls.Status.SUPPORTED])
    data["addressed_controls"]["automated"] = get_id_array(
        ctrllist[controls.Status.AUTOMATED])
    data["addressed_controls"]["notapplicable"] = get_id_array(
        ctrllist[controls.Status.NOT_APPLICABLE])
    data["addressed_controls"]["partial"] = get_id_array(
        ctrllist[controls.Status.PARTIAL])
    data["addressed_controls"]["pending"] = get_id_array(
        ctrllist[controls.Status.PENDING])
    data["addressed_controls"]["notassessed"] = get_id_array(
        applicablelist - assessedlist)
    print(json.dumps(data))


subcmds = dict(
    stats=stats
)


def get_id_array(ctrls):
    return [c.id for c in ctrls]


def create_parser():
    parser = argparse.ArgumentParser()
    parser.add_argument(
        "--controls-dir",
        help=("Directory that contains control files with policy controls. "
              "e.g.: ~/scap-security-guide/controls"),
        default="./controls/",
    )
    subparsers = parser.add_subparsers(dest="subcmd", required=True)
    statsparser = subparsers.add_parser(
        'stats',
        help="calculate and return the statistics for the given benchmark")
    statsparser.add_argument(
        "-i", "--id",
        help="the ID or name of the controls file in the controls/ directory",
        required=True)
    statsparser.add_argument(
        "-l", "--level",
        help="the compliance target level to analyze",
        required=True)
    statsparser.add_argument(
        "-p", "--product", help="product to check has required references")
    statsparser.add_argument(
        "-o",
        "--output-format",
        choices=['json'],
        help="The output format of the report")
    return parser


def main():
    parser = create_parser()
    args = parser.parse_args()
    product_base = os.path.join(SSG_ROOT, "products", args.product)
    product_yaml = os.path.join(product_base, "product.yml")
    env_yaml = ssg.products.load_product_yaml(product_yaml)
    controls_manager = controls.ControlsManager(
        args.controls_dir, env_yaml=env_yaml)
    controls_manager.load()
    subcmds[args.subcmd](controls_manager, args)


if __name__ == "__main__":
    main()


1			#!/usr/bin/python3
2			import collections
3			import argparse
4			import os
5			import json
6
7			# NOTE: This is not to be confused with the https://pypi.org/project/ssg/
8			# package. The ssg package we're referencing here is actually a relative import
9			# within this repository. Because of this, you need to ensure
10			# ComplianceAsCode/content/ssg is discoverable from PYTHONPATH before you
11			# invoke this script.
12			try:
13			from ssg import controls
14			import ssg.products
15			except ModuleNotFoundError as e:
16			# NOTE: Only emit this message if we're dealing with an import error for
17			# ssg. Since the local ssg module imports other things, like PyYAML, we
18			# don't want to emit misleading errors for legit dependencies issues if the
19			# user hasn't installed PyYAML or other transitive dependencies from ssg.
20			# We should revisit this if or when we decide to implement a python package
21			# management strategy for the python scripts provided in this repository.
22			if e.name == 'ssg':
23			msg = """Unable to import local 'ssg' module.
24
25			The 'ssg' package from within this repository must be discoverable before
26			invoking this script. Make sure the top-level directory of the
27			ComplianceAsCode/content repository is available in the PYTHONPATH environment
28			variable (example: $ export PYTHONPATH=($pwd)).
29			"""
30			raise RuntimeError(msg) from e
31			raise
32
33
34			SSG_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
35
36
37			def print_options(opts):
38			if len(opts) > 0:
39			print("Available options are:\n - " + "\n - ".join(opts))
40			else:
41			print("The controls file is not written appropriately.")
42
43
44			def validate_args(ctrlmgr, args):
45			""" Validates that the appropriate args were given
46			and that they're valid entries in the control manager."""
47
48			policy = None
49			try:
50			policy = ctrlmgr._get_policy(args.id)
51			except ValueError as e:
52			print("Error: ", e)
53			print_options(ctrlmgr.policies.keys())
54			exit(1)
55
56			try:
57			policy.get_level_with_ancestors_sequence(args.level)
58			except ValueError as e:
59			print("Error: ", e)
60			print_options(policy.levels_by_id.keys())
61			exit(1)
62
63
64			def calculate_stats(ctrls):
65			total = len(ctrls)
66			ctrlstats = collections.defaultdict(int)
67			ctrllist = collections.defaultdict(set)
68
69			if total == 0:
70			print("No controls founds with the given inputs. Maybe try another level.")
71			exit(1)
72
73			for ctrl in ctrls:
74			ctrlstats[str(ctrl.status)] += 1
			0 ignored issues – show Comprehensibility Best Practice introduced 2021-09-10 13:24 UTC by Report Bug Copy Issue Report The variable `str` does not seem to be defined. Loading history...
75			ctrllist[str(ctrl.status)].add(ctrl)
76
77			applicable = total - ctrlstats[controls.Status.NOT_APPLICABLE]
78			assessed = ctrlstats[controls.Status.AUTOMATED] + ctrlstats[controls.Status.SUPPORTED] + \
79			ctrlstats[controls.Status.DOCUMENTATION] + ctrlstats[controls.Status.INHERENTLY_MET] + \
80			ctrlstats[controls.Status.PARTIAL]
81
82			print("Total controls = {total}".format(total=total))
83			print_specific_stat("Applicable", applicable, total)
84			print_specific_stat("Assessed", assessed, applicable)
85			print()
86			print_specific_stat("Automated",
87			ctrlstats[controls.Status.AUTOMATED],
88			applicable)
89			print_specific_stat("Manual",
90			ctrlstats[controls.Status.MANUAL],
91			applicable)
92			print_specific_stat("Supported",
93			ctrlstats[controls.Status.SUPPORTED],
94			applicable)
95			print_specific_stat("Documentation",
96			ctrlstats[controls.Status.DOCUMENTATION],
97			applicable)
98			print_specific_stat("Inherently Met",
99			ctrlstats[controls.Status.INHERENTLY_MET],
100			applicable)
101			print_specific_stat("Does Not Meet",
102			ctrlstats[controls.Status.DOES_NOT_MEET],
103			applicable)
104			print_specific_stat("Partial",
105			ctrlstats[controls.Status.PARTIAL],
106			applicable)
107
108			applicablelist = ctrls - ctrllist[controls.Status.NOT_APPLICABLE]
109			assessedlist = set().union(ctrllist[controls.Status.AUTOMATED]).union(ctrllist[controls.Status.SUPPORTED])\
110			.union(ctrllist[controls.Status.DOCUMENTATION]).union(ctrllist[controls.Status.INHERENTLY_MET])\
111			.union(ctrllist[controls.Status.PARTIAL]).union(ctrllist[controls.Status.MANUAL])
112			print("Missing:", ", ".join(sorted(str(c.id)
113			for c in applicablelist - assessedlist)))
114
115
116			def print_specific_stat(stat, current, total):
117			print("{stat} = {percent}% -- {current} / {total}".format(
118			stat=stat,
119			percent=round((current / total) * 100.00, 2),
120			current=current,
121			total=total))
122
123
124			def stats(ctrlmgr, args):
125			validate_args(ctrlmgr, args)
126			ctrls = set(ctrlmgr.get_all_controls_of_level(args.id, args.level))
127			total = len(ctrls)
128
129			if total == 0:
130			print("No controls founds with the given inputs. Maybe try another level.")
131			exit(1)
132
133			if args.output_format == 'json':
134			print_to_json(
135			ctrls,
136			args.product,
137			args.id,
138			args.level)
139			else:
140			calculate_stats(ctrls)
141
142
143			def print_to_json(ctrls, product, id, level):
144			data = dict()
145			ctrllist = collections.defaultdict(set)
146
147			for ctrl in ctrls:
148			ctrllist[str(ctrl.status)].add(ctrl)
149
150			applicablelist = ctrls - ctrllist[controls.Status.NOT_APPLICABLE]
151			assessedlist = set().union(ctrllist[controls.Status.AUTOMATED]).union(ctrllist[controls.Status.SUPPORTED])\
152			.union(ctrllist[controls.Status.DOCUMENTATION]).union(ctrllist[controls.Status.INHERENTLY_MET])\
153			.union(ctrllist[controls.Status.PARTIAL]).union(ctrllist[controls.Status.MANUAL])
154
155			data["format_version"] = "v0.0.1"
156			data["product_name"] = product
157			data["benchmark"] = dict()
158			data["benchmark"]["name"] = id
159			data["benchmark"]["baseline"] = level
160			data["total_controls"] = len(applicablelist)
161			data["addressed_controls"] = dict()
162			data["addressed_controls"]["all"] = get_id_array(ctrls)
163			data["addressed_controls"]["applicable"] = get_id_array(applicablelist)
164			data["addressed_controls"]["assessed"] = get_id_array(assessedlist)
165			data["addressed_controls"]["inherently"] = get_id_array(
166			ctrllist[controls.Status.INHERENTLY_MET])
167			data["addressed_controls"]["manual"] = get_id_array(
168			ctrllist[controls.Status.MANUAL])
169			data["addressed_controls"]["supported"] = get_id_array(
170			ctrllist[controls.Status.SUPPORTED])
171			data["addressed_controls"]["automated"] = get_id_array(
172			ctrllist[controls.Status.AUTOMATED])
173			data["addressed_controls"]["notapplicable"] = get_id_array(
174			ctrllist[controls.Status.NOT_APPLICABLE])
175			data["addressed_controls"]["partial"] = get_id_array(
176			ctrllist[controls.Status.PARTIAL])
177			data["addressed_controls"]["pending"] = get_id_array(
178			ctrllist[controls.Status.PENDING])
179			data["addressed_controls"]["notassessed"] = get_id_array(
180			applicablelist - assessedlist)
181			print(json.dumps(data))
182
183
184			subcmds = dict(
185			stats=stats
186			)
187
188
189			def get_id_array(ctrls):
190			return [c.id for c in ctrls]
191
192
193			def create_parser():
194			parser = argparse.ArgumentParser()
195			parser.add_argument(
196			"--controls-dir",
197			help=("Directory that contains control files with policy controls. "
198			"e.g.: ~/scap-security-guide/controls"),
199			default="./controls/",
200			)
201			subparsers = parser.add_subparsers(dest="subcmd", required=True)
202			statsparser = subparsers.add_parser(
203			'stats',
204			help="calculate and return the statistics for the given benchmark")
205			statsparser.add_argument(
206			"-i", "--id",
207			help="the ID or name of the controls file in the controls/ directory",
208			required=True)
209			statsparser.add_argument(
210			"-l", "--level",
211			help="the compliance target level to analyze",
212			required=True)
213			statsparser.add_argument(
214			"-p", "--product", help="product to check has required references")
215			statsparser.add_argument(
216			"-o",
217			"--output-format",
218			choices=['json'],
219			help="The output format of the report")
220			return parser
221
222
223			def main():
224			parser = create_parser()
225			args = parser.parse_args()
226			product_base = os.path.join(SSG_ROOT, "products", args.product)
227			product_yaml = os.path.join(product_base, "product.yml")
228			env_yaml = ssg.products.load_product_yaml(product_yaml)
229			controls_manager = controls.ControlsManager(
230			args.controls_dir, env_yaml=env_yaml)
231			controls_manager.load()
232			subcmds[args.subcmd](controls_manager, args)
233
234
235			if __name__ == "__main__":
236			main()
237

ComplianceAsCode / content

Push — master ( 8e3f9b...05d38f )

utils.controleval.print_options() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like