utils.count_oval_objects

Complexity

Total Complexity

30

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

5 Functions

Rating	Name	Duplication	Size	Complexity
A	parse_args()	0	4	1
A	print_stats()	0	8	3
F	find_oval_objects()	0	43	16
B	main()	0	36	7
A	load_xml()	0	11	3

#!/usr/bin/env python2

'''
count_oval_objects.py

Shows OVAL objects used by XCCDF rules.

Author: Jan Cerny <jcerny@redhat.com>
'''

import argparse
import xml.etree.ElementTree as ET
import sys
import os.path

oval_files = dict()
xccdf_dir = None


def parse_args():
    parser = argparse.ArgumentParser(description="Show OVAL objects used by XCCDF rules.")
    parser.add_argument("xccdf_file", help="Path to the XCCDF file to parse")
    return parser.parse_args()


def load_xml(file_name):
    ''' Loads XML files to memory and parses it into element tree '''
    try:
        it = ET.iterparse(file_name)
        for _, el in it:
            el.tag = el.tag.split('}', 1)[1]  # strip all namespaces
        root = it.root
        return root
    except:
        sys.stderr.write("Error while loading file " + file_name + ".\n")
        exit(-1)


def find_oval_objects(oval_refs):
    ''' Finds OVAL objects according to definitions ID '''
    tests = []
    object_refs = []
    objects = []

    # find tests in definitions
    for def_id, oval_file in oval_refs:
        if oval_file not in oval_files:

The variable oval_files does not seem to be defined.

            oval_file_path = os.path.join(xccdf_dir, oval_file)
            oval_files[oval_file] = load_xml(oval_file_path)
        oval_root = oval_files[oval_file]
        definition = None
        for d in oval_root.findall(".//definition"):
            if d.attrib.get('id') == def_id:
                definition = d
                break
        if definition is not None:
            for criterion in definition.findall(".//criterion"):
                test_ref = criterion.attrib["test_ref"]
                tests.append(test_ref)

    # find references to objects in tests
    for test in tests:
        test_element = None
        for t in oval_root.findall("tests/*"):

The variable oval_root does not seem to be defined in case the for loop on line 46 is not entered. Are you sure this can never be the case?

            if t.attrib.get('id') == test:
                test_element = t
                break
        if test_element is not None:
            for object_element in test_element.findall(".//*"):
                if 'object_ref' in object_element.attrib:
                    object_ref = object_element.attrib['object_ref']
                    object_refs.append(object_ref)

    # find objects
    for r in object_refs:
        for obj in oval_root.findall("objects/*"):
            if obj.attrib.get('id') == r:
                objects.append(obj.tag)
                break

    return set(objects)


def print_stats(stats):
    ''' Print statistic of most used objects in input'''
    print("")
    print("Count of used OVAL objects:")
    print("=" * 50)
    stats = stats.items()
    for key, value in reversed(sorted(stats, key=lambda obj: obj[1])):
        print(key.ljust(40) + str(value).rjust(10))


def main():
    stats = {}
    global xccdf_dir

    args = parse_args()
    xccdf_file_name = args.xccdf_file
    xccdf_root = load_xml(xccdf_file_name)
    xccdf_dir = os.path.dirname(xccdf_file_name)

    for rule in xccdf_root.findall(".//Rule"):
        rule_id = rule.attrib['id']
        oval_refs = []
        for ref in rule.findall(".//check-content-ref"):

            # Skip remotely referenced OVAL checks since they won't have the
            # 'name' attribute set (just 'href' would be set in that case)
            try:
                oval_name = ref.attrib['name']
            except KeyError:
                if 'href' in ref.attrib:
                    print("\nInfo: Skipping remotely referenced OVAL:")
                    continue
                else:
                    print("\nError: Invalid OVAL check detected! Exiting..")
                    sys.exit(1)

            oval_file = ref.attrib['href']
            oval_refs.append((oval_name, oval_file))
        if oval_refs:
            objects = find_oval_objects(oval_refs)
            print(rule_id + ": " + ", ".join(objects))
            for o in objects:
                stats[o] = stats.get(o, 0) + 1
        else:
            print(rule_id + ":")
    print_stats(stats)


if __name__ == "__main__":
    main()