openscap_report.report_generators.html

Complexity

Total Complexity

12

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Test Coverage

Coverage

93.1%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	HTMLReportGenerator.set_css_for_list()	0	5	1
A	HTMLReportGenerator.generate_report()	0	7	2
A	HTMLReportGenerator.include_file_in_base64()	0	13	4
A	HTMLReportGenerator.__init__()	0	9	1
A	HTMLReportGenerator.get_selected_rules()	0	9	4

# Copyright 2022, Red Hat, Inc.
# SPDX-License-Identifier: LGPL-2.1-or-later

import base64
import logging
import re
from io import BytesIO
from pathlib import Path

from jinja2 import Environment, FileSystemLoader

try:
    from jinja2 import pass_context
except ImportError:
    from jinja2 import contextfunction as pass_context

from markupsafe import Markup

from ..scap_results_parser.data_structures import Rule
from .exceptions import FilterNotSupportDataStructureException
from .report_generator import ReportGenerator


class HTMLReportGenerator(ReportGenerator):
    def __init__(self, parser):  # pylint: disable=W0231
        self.report = parser.parse_report()
        self.file_loader = FileSystemLoader(str(Path(__file__).parent / "templates"))
        self.env = Environment(loader=self.file_loader)
        self.env.globals['include_file_in_base64'] = self.include_file_in_base64
        self.env.filters['set_css_for_list'] = self.set_css_for_list
        self.env.filters['get_selected_rules'] = self.get_selected_rules
        self.env.trim_blocks = True
        self.env.lstrip_blocks = True

    def generate_report(self, debug_setting):
        template = self.env.get_template("template_report.html")
        html_report = template.render(report=self.report, debug_setting=debug_setting)
        if debug_setting.no_minify:
            return BytesIO(html_report.encode())
        minified_html_report = re.sub(r'>\s+<', '><', html_report)
        return BytesIO(minified_html_report.encode())

    @staticmethod
    @pass_context
    def include_file_in_base64(context, relative_path):
        real_path = Path(context.environment.loader.searchpath[0]) / relative_path
        if "RedHat" in relative_path:
            real_path = Path(relative_path)
        if not real_path.exists():
            logging.warning("Please, install font: %s", real_path.name)
            return Markup("NO-FONT-DATA")
        base64_data = None
        with open(real_path, "rb") as file_data:
            base64_data = (base64.b64encode(file_data.read())).decode('utf-8')
        return Markup(base64_data)

    @staticmethod
    def set_css_for_list(data):
        out = data.replace("<ul>", "<ul class=\"pf-c-list\">")
        out = out.replace("<ol>", "<ol class=\"pf-c-list\">")
        return out

    @staticmethod
    def get_selected_rules(data):
        out = []
        for rule_id, rule in data.items():
            if not isinstance(rule, Rule):
                raise FilterNotSupportDataStructureException
            if rule.result != "notselected":
                out.append((rule_id, rule))
        return out