Tool for identifying the most used components

build-scripts/profile_tool.py

@@ -5,7 +5,12 @@
 import argparse
 
 try:
-    from utils.profile_tool import command_stats, command_sub, command_most_used_rules
+    from utils.profile_tool import (
+        command_stats,
+        command_sub,
+        command_most_used_rules,
+        command_most_used_components,
+    )
 except ImportError:
     print("The ssg module could not be found.")
     print(
@@ -276,13 +281,31 @@ def parse_most_used_rules_subcommand(subparsers):
     )
 
 
+def parse_most_used_components(subparsers):
+    parser_most_used_components = subparsers.add_parser(
+        "most-used-components",
+        description=(
+            "Generates list of all components used by the rules in existing profiles."
+            " In various formats."
+        ),
+        help="Generates list of all components used by the rules in existing profiles.",
+    )
+    parser_most_used_components.add_argument(
+        "--format",
+        default="plain",
+        choices=["plain", "json", "csv"],
+        help="Which format to use for output.",
+    )
+
+
 def parse_args():
     parser = argparse.ArgumentParser(description="Profile statistics and utilities tool")
     subparsers = parser.add_subparsers(title="subcommands", dest="subcommand", required=True)
 
     parse_stats_subcommand(subparsers)
     parse_sub_subcommand(subparsers)
     parse_most_used_rules_subcommand(subparsers)
+    parse_most_used_components(subparsers)
 
     args = parser.parse_args()
 
@@ -319,6 +342,7 @@ def parse_args():
     "stats": command_stats,
     "sub": command_sub,
     "most-used-rules": command_most_used_rules,
+    "most-used-components": command_most_used_components,
 }
 
 

docs/manual/developer/05_tools_and_utilities.md

@@ -61,6 +61,16 @@ The result will be a list of rules with the number of uses in the profiles.
 The list can be generated as plain text, JSON or CVS.
 Via the `--format FORMAT` parameter.
 
+The tool can also generate a list of the most used component based on rules contained in profiles from the entire project:
+
+```bash
+    $ ./build-scripts/profile_tool.py most-used-components
+```
+
+The result will be a list of rules with the number of uses in the profiles.
+The list can be generated as plain text, JSON or CVS.
+Via the `--format FORMAT` parameter.
+
 ## Generating Controls from DISA's XCCDF Files
 
 If you want a control file for product from DISA's XCCDF files you can run the following command:

utils/profile_tool/__init__.py

@@ -1,3 +1,4 @@
 from .sub import command_sub
 from .stats import command_stats
 from .most_used_rules import command_most_used_rules
+from .most_used_components import command_most_used_components

utils/profile_tool/most_used_components.py

@@ -0,0 +1,70 @@
+import json
+import sys
+import os
+from ssg.components import Component
+from .most_used_rules import _sorted_dict_by_num_value
+
+PYTHON_2 = sys.version_info[0] < 3
+
+if not PYTHON_2:
+    from .most_used_rules import _get_profiles_for_product
+    from ..controleval import (
+        load_controls_manager,
+        get_available_products,
+    )
+
+
+def _count_components(components, rules_list, components_out):
+    for rule in rules_list:
+        component = get_component_name_by_rule_id(rule, components)
+        if component in components_out:
+            components_out[component] += 1
+        else:
+            components_out[component] = 1
+
+
+def get_component_name_by_rule_id(rule_id, components):
+    for component in components.values():
+        if rule_id in component.rules:
+            return component.name
+    return "without_component"
+
+
+def load_components(components_dir):
+    components = {}
+    for component_file in os.listdir(os.path.abspath(components_dir)):
+        component_path = os.path.join(components_dir, component_file)
+        component = Component(component_path)
+        components[component.name] = component
+    return components
+
+
+def _process_all_products_from_controls(components_out):
+    components = load_components("./components/")
+    if PYTHON_2:
+        raise Exception("This feature is not supported for python2.")
+
+    for product in get_available_products():
+        controls_manager = load_controls_manager("./controls/", product)
+        for profile in _get_profiles_for_product(controls_manager, product):
+            _count_components(components, profile.rules, components_out)
+
+
+def command_most_used_components(args):
+    components = {}
+
+    _process_all_products_from_controls(components)
+
+    sorted_components = _sorted_dict_by_num_value(components)
+
+    f_string = "{}: {}"
+
+    if args.format == "json":
+        print(json.dumps(sorted_components, indent=4))
+        return
+    elif args.format == "csv":
+        print("component_name,count_of_rules")
+        f_string = "{},{}"
+
+    for rule_id, rule_count in sorted_components.items():
+        print(f_string.format(rule_id, rule_count))

utils/profile_tool/most_used_rules.py

@@ -48,12 +48,9 @@ def _process_all_products_from_controls(rules):
             _count_rules_per_rules_list(profile.rules, rules)
 
 
-def _sorted_rules(rules):
-    sorted_rules = {
-        k: v
-        for k, v in sorted(rules.items(), key=lambda x: x[1], reverse=True)
-    }
-    return sorted_rules
+def _sorted_dict_by_num_value(dict_):
+    sorted_ = {k: v for k, v in sorted(dict_.items(), key=lambda x: x[1], reverse=True)}
+    return sorted_
 
 
 def command_most_used_rules(args):
@@ -65,7 +62,7 @@ def command_most_used_rules(args):
         for benchmark in args.BENCHMARKS:
             _count_rules_per_benchmark(benchmark, rules)
 
-    sorted_rules = _sorted_rules(rules)
+    sorted_rules = _sorted_dict_by_num_value(rules)
 
     f_string = "{}: {}"