Some Reporting Updates (#10563)

* reports-fixes Update cover page widget to have page break after entry, use heading attribute for heading

* reports-fixes Add classes for widgets; add css for dealing with page breaks on print

* reports-fixes some addtional classes to help distinguish reporting sections

* reports-fixes additional classes on findings/endpoints for reports

* reports-fixes update report widgets to specify a widget_class instead of generating one based on title; fix wysiwyg issue, add delete button for in-use widgets

* reports-fixes for reports widgets, use "header" field for header on rendered reports, instead of "title" (excepting findings/endpoints lists, which do not accept a custom heading)

* reports-fixes add back a newline

* reports-fixes remove extra space

* report-fixes add dojo css for availability in reports

* reports-fixes undo some template/css changes, move report break stuff to report_base

* reports-fixes newline on end of file, remove changed css

* reports-fixes remove unused css from custom_html_report

* reports-fixes change "WYSIWYG Content" to "Custom Content"

* reports-fixes on finding/endpoint filter/clear, run selectpicker on returned selects so the ui (select) elements do not change suddenly

* reports-fixes work on page break changes

* reports-fixes typo in style names

* reports-fixes remove margins on page break widget

* reports-fixes add optional page break after custom content

* reports-fixes optional follwoing page break for wysiwyg

* reports-fixes first pass at removing asciidoc support

* reports-fixes more asciidoc removal updates

* reports-fixes fix wysiwyg widget options loading

* reports-fixes page break after toc

* reports-fixes linter fixes

* trigger GitHub actions

Author: dogboat

docs/content/en/usage/features.md

@@ -540,7 +540,7 @@ Custom reports, generated with the Report Builder, allow you to select specific
 5.  Vulnerable Endpoints
 6.  Page Breaks
 
-DefectDojo's reports can be generated in HTML and AsciiDoc.
+DefectDojo's reports can be generated in HTML.
 
 ## Metrics
 

dojo/forms.py

@@ -2286,15 +2286,15 @@ class ReportOptionsForm(forms.Form):
     include_executive_summary = forms.ChoiceField(choices=yes_no, label="Executive Summary")
     include_table_of_contents = forms.ChoiceField(choices=yes_no, label="Table of Contents")
     include_disclaimer = forms.ChoiceField(choices=yes_no, label="Disclaimer")
-    report_type = forms.ChoiceField(choices=(('HTML', 'HTML'), ('AsciiDoc', 'AsciiDoc')))
+    report_type = forms.ChoiceField(choices=(('HTML', 'HTML'),))
 
 
 class CustomReportOptionsForm(forms.Form):
     yes_no = (('0', 'No'), ('1', 'Yes'))
     report_name = forms.CharField(required=False, max_length=100)
     include_finding_notes = forms.ChoiceField(required=False, choices=yes_no)
     include_finding_images = forms.ChoiceField(choices=yes_no, label="Finding Images")
-    report_type = forms.ChoiceField(choices=(('HTML', 'HTML'), ('AsciiDoc', 'AsciiDoc')))
+    report_type = forms.ChoiceField(choices=(('HTML', 'HTML'),))
 
 
 class DeleteFindingForm(forms.ModelForm):

dojo/reports/views.py

@@ -28,7 +28,7 @@
 from dojo.finding.queries import get_authorized_findings
 from dojo.finding.views import BaseListFindings
 from dojo.forms import ReportOptionsForm
-from dojo.models import Dojo_User, Endpoint, Engagement, Finding, Product, Product_Type, Risk_Acceptance, Test
+from dojo.models import Dojo_User, Endpoint, Engagement, Finding, Product, Product_Type, Test
 from dojo.reports.widgets import (
     CoverPage,
     CustomReportJsonForm,
@@ -140,7 +140,7 @@ def get_selected_widgets(self, request):
             self.finding_notes = (options.include_finding_notes == '1')
             self.finding_images = (options.include_finding_images == '1')
         else:
-            self.report_format = 'AsciiDoc'
+            self.report_format = 'HTML'
             self.finding_notes = True
             self.finding_images = True
 
@@ -152,9 +152,7 @@ def get_form(self, request):
         return CustomReportJsonForm(request.POST)
 
     def get_template(self):
-        if self.report_format == 'AsciiDoc':
-            return 'dojo/custom_asciidoc_report.html',
-        elif self.report_format == 'HTML':
+        if self.report_format == 'HTML':
             return 'dojo/custom_html_report.html'
         else:
             raise PermissionDenied
@@ -277,7 +275,7 @@ def product_endpoint_report(request, pid):
     endpoints = EndpointReportFilter(request.GET, queryset=endpoints)
 
     paged_endpoints = get_page_items(request, endpoints.qs, 25)
-    report_format = request.GET.get('report_type', 'AsciiDoc')
+    report_format = request.GET.get('report_type', 'HTML')
     include_finding_notes = int(request.GET.get('include_finding_notes', 0))
     include_finding_images = int(request.GET.get('include_finding_images', 0))
     include_executive_summary = int(request.GET.get('include_executive_summary', 0))
@@ -291,65 +289,9 @@ def product_endpoint_report(request, pid):
     report_form = ReportOptionsForm()
     template = "dojo/product_endpoint_pdf_report.html"
 
-    try:
-        start_date = Finding.objects.filter(endpoints__in=endpoints.qs).order_by('date')[:1][0].date
-    except:
-        start_date = timezone.now()
-
-    end_date = timezone.now()
-
-    risk_acceptances = Risk_Acceptance.objects.filter(engagement__test__finding__endpoints__in=endpoints.qs)
-
-    accepted_findings = [finding for ra in risk_acceptances
-                         for finding in ra.accepted_findings.filter(endpoints__in=endpoints.qs)]
-
-    verified_findings = Finding.objects.filter(endpoints__in=endpoints.qs,
-                                               date__range=[start_date, end_date],
-                                               false_p=False,
-                                               verified=True,
-                                               duplicate=False,
-                                               out_of_scope=False)
-
-    open_findings = Finding.objects.filter(endpoints__in=endpoints.qs,
-                                           false_p=False,
-                                           verified=True,
-                                           duplicate=False,
-                                           out_of_scope=False,
-                                           active=True,
-                                           mitigated__isnull=True)
-
-    closed_findings = Finding.objects.filter(endpoints__in=endpoints.qs,
-                                             false_p=False,
-                                             verified=True,
-                                             duplicate=False,
-                                             out_of_scope=False,
-                                             mitigated__isnull=False)
     if generate:
         report_form = ReportOptionsForm(request.GET)
-        if report_format == 'AsciiDoc':
-            return render(request,
-                          'dojo/asciidoc_report.html',
-                          {'product_type': None,
-                           'product': product,
-                           'accepted_findings': accepted_findings,
-                           'open_findings': open_findings,
-                           'closed_findings': closed_findings,
-                           'verified_findings': verified_findings,
-                           'engagement': None,
-                           'test': None,
-                           'endpoints': endpoints.qs,
-                           'endpoint': None,
-                           'findings': None,
-                           'include_finding_notes': include_finding_notes,
-                           'include_finding_images': include_finding_images,
-                           'include_executive_summary': include_executive_summary,
-                           'include_table_of_contents': include_table_of_contents,
-                           'include_disclaimer': include_disclaimer,
-                           'disclaimer': disclaimer,
-                           'user': request.user,
-                           'title': 'Generate Report',
-                           })
-        elif report_format == 'HTML':
+        if report_format == 'HTML':
             return render(request,
                           template,
                           {'product_type': None,
@@ -413,7 +355,7 @@ def generate_report(request, obj, host_view=False):
             msg = f'Report cannot be generated for object of type {type(obj).__name__}'
             raise Exception(msg)
 
-    report_format = request.GET.get('report_type', 'AsciiDoc')
+    report_format = request.GET.get('report_type', 'HTML')
     include_finding_notes = int(request.GET.get('include_finding_notes', 0))
     include_finding_images = int(request.GET.get('include_finding_images', 0))
     include_executive_summary = int(request.GET.get('include_executive_summary', 0))
@@ -615,30 +557,7 @@ def generate_report(request, obj, host_view=False):
 
     if generate:
         report_form = ReportOptionsForm(request.GET)
-        if report_format == 'AsciiDoc':
-            return render(request,
-                          'dojo/asciidoc_report.html',
-                          {'product_type': product_type,
-                           'product': product,
-                           'engagement': engagement,
-                           'test': test,
-                           'endpoint': endpoint,
-                           'findings': findings.qs.distinct().order_by('numerical_severity'),
-                           'include_finding_notes': include_finding_notes,
-                           'include_finding_images': include_finding_images,
-                           'include_executive_summary': include_executive_summary,
-                           'include_table_of_contents': include_table_of_contents,
-                           'include_disclaimer': include_disclaimer,
-                           'disclaimer': disclaimer,
-                           'user': user,
-                           'team_name': settings.TEAM_NAME,
-                           'title': report_title,
-                           'user_id': request.user.id,
-                           'host': report_url_resolver(request),
-                           'host_view': host_view,
-                           'context': context,
-                           })
-        elif report_format == 'HTML':
+        if report_format == 'HTML':
             return render(request,
                           template,
                           {'product_type': product_type,

dojo/reports/widgets.py

@@ -51,7 +51,6 @@ class Meta:
 
 class TableOfContentsForm(forms.Form):
     heading = forms.CharField(max_length=200, required=False, initial="Table of Contents")
-    depth = forms.IntegerField(min_value=1, required=False, max_value=6, initial=4)
 
     class Meta:
         exclude = []
@@ -106,9 +105,10 @@ def render(self, name, value, attrs=None, renderer=None):
 
 
 class WYSIWYGContentForm(forms.Form):
-    heading = forms.CharField(max_length=200, required=False, initial="WYSIWYG Content")
+    heading = forms.CharField(max_length=200, required=False, initial="Custom Content")
     content = forms.CharField(required=False, widget=Div(attrs={'class': 'editor'}))
     hidden_content = forms.CharField(widget=forms.HiddenInput(), required=True)
+    page_break_after = forms.BooleanField(required=False, help_text='Include a page break after the custom content.')
 
     class Meta:
         exclude = []
@@ -120,15 +120,12 @@ def __init__(self, *args, **kwargs):
         self.title = 'Base Widget'
         self.form = None
         self.multiple = "false"
+        self.widget_class = 'widget'
 
     @abc.abstractmethod
     def get_html(self, request):
         return
 
-    @abc.abstractmethod
-    def get_asciidoc(self):
-        return
-
     @abc.abstractmethod
     def get_option_form(self):
         return
@@ -138,14 +135,12 @@ class PageBreak(Widget):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.title = 'Page Break'
+        self.widget_class = 'page-break'
         self.form = None
         self.multiple = "true"
 
     def get_html(self):
-        return mark_safe('<hr title="Page Break" class="report-page-break"/>')
-
-    def get_asciidoc(self):
-        return mark_safe('<br/><<<<br/>')
+        return mark_safe('<div class="report-page-break">Page Break</div>')
 
     def get_option_form(self):
         return mark_safe(
@@ -160,10 +155,8 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.title = 'Report Options'
         self.form = CustomReportOptionsForm()
-        self.extra_help = "Choose additional report options.  These will apply to the overall report."
-
-    def get_asciidoc(self):
-        return mark_safe('')
+        self.extra_help = "Choose additional report options. These will apply to the overall report."
+        self.widget_class = 'report-options'
 
     def get_html(self):
         return mark_safe('')
@@ -182,16 +175,12 @@ def __init__(self, *args, **kwargs):
         self.title = 'Cover Page'
         self.form = CoverPageForm()
         self.help_text = "The cover page includes a page break after its content."
+        self.widget_class = 'cover-page'
 
     def get_html(self):
-        return render_to_string("dojo/custom_html_report_cover_page.html", {"heading": self.title,
-                                                                                "sub_heading": self.sub_heading,
-                                                                                "meta_info": self.meta_info})
-
-    def get_asciidoc(self):
-        return render_to_string("dojo/custom_asciidoc_report_cover_page.html", {"heading": self.title,
-                                                                                "sub_heading": self.sub_heading,
-                                                                                "meta_info": self.meta_info})
+        return render_to_string("dojo/custom_html_report_cover_page.html", {"heading": self.heading,
+                                                                            "sub_heading": self.sub_heading,
+                                                                            "meta_info": self.meta_info})
 
     def get_option_form(self):
         html = render_to_string("dojo/report_widget.html", {"form": self.form,
@@ -205,16 +194,12 @@ class TableOfContents(Widget):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.title = 'Table Of Contents'
+        self.widget_class = 'table-of-contents'
         self.form = TableOfContentsForm()
         self.help_text = "The table of contents includes a page break after its content."
 
     def get_html(self):
-        return render_to_string("dojo/custom_html_toc.html", {"title": self.title,
-                                                                  "depth": self.depth})
-
-    def get_asciidoc(self):
-        return render_to_string("dojo/custom_asciidoc_toc.html", {"title": self.title,
-                                                                  "depth": self.depth})
+        return render_to_string("dojo/custom_html_toc.html", {"heading": self.heading})
 
     def get_option_form(self):
         html = render_to_string("dojo/report_widget.html", {"form": self.form,
@@ -227,20 +212,21 @@ def get_option_form(self):
 class WYSIWYGContent(Widget):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.title = 'WYSIWYG Content'
+        self.title = 'Custom Content'
+        self.widget_class = 'wysiwyg-content'
         self.form = WYSIWYGContentForm()
         self.multiple = 'true'
 
     def get_html(self):
-        html = render_to_string("dojo/custom_html_report_wysiwyg_content.html", {"title": self.title,
-                                                                                "content": self.content})
+        html = render_to_string(
+            "dojo/custom_html_report_wysiwyg_content.html",
+            {
+                "heading": self.heading,
+                "content": self.content,
+                "page_break_after": self.page_break_after,
+            })
         return mark_safe(html)
 
-    def get_asciidoc(self):
-        asciidoc = render_to_string("dojo/custom_asciidoc_report_wysiwyg_content.html", {"title": self.title,
-                                                                                         "content": self.content})
-        return mark_safe(asciidoc)
-
     def get_option_form(self):
         html = render_to_string("dojo/report_widget.html", {"form": self.form,
                                                             "multiple": self.multiple,
@@ -282,6 +268,7 @@ def __init__(self, *args, **kwargs):
         else:
             self.form = None
         self.multiple = 'true'
+        self.widget_class = 'finding-list'
         self.extra_help = "You can use this form to filter findings and select only the ones to be included in the " \
                           "report."
         self.title_words = get_words_for_field(Finding, 'title')
@@ -292,15 +279,6 @@ def __init__(self, *args, **kwargs):
         else:
             self.paged_findings = self.findings
 
-    def get_asciidoc(self):
-        asciidoc = render_to_string("dojo/custom_asciidoc_report_findings.html",
-                                    {"findings": self.findings.qs,
-                                     "host": self.host,
-                                     "include_finding_notes": self.finding_notes,
-                                     "include_finding_images": self.finding_images,
-                                     "user_id": self.user_id})
-        return mark_safe(asciidoc)
-
     def get_html(self):
         html = render_to_string("dojo/custom_html_report_finding_list.html",
                                 {"title": self.title,
@@ -355,6 +333,7 @@ def __init__(self, *args, **kwargs):
         self.title = 'Endpoint List'
         self.form = self.endpoints.form
         self.multiple = 'false'
+        self.widget_class = 'endpoint-list'
         if self.request is not None:
             self.paged_endpoints = get_page_items(self.request, self.endpoints.qs, 25)
         else:
@@ -373,15 +352,6 @@ def get_html(self):
                                  "user_id": self.user_id})
         return mark_safe(html)
 
-    def get_asciidoc(self):
-        asciidoc = render_to_string("dojo/custom_asciidoc_report_endpoints.html",
-                                    {"endpoints": self.endpoints.qs,
-                                     "host": self.host,
-                                     "include_finding_notes": self.finding_notes,
-                                     "include_finding_images": self.finding_images,
-                                     "user_id": self.user_id})
-        return mark_safe(asciidoc)
-
     def get_option_form(self):
         html = render_to_string('dojo/report_endpoints.html',
                                 {"endpoints": self.paged_endpoints,
@@ -441,12 +411,15 @@ def report_widget_factory(json_data=None, request=None, user=None, finding_notes
                                                                               finding_images=finding_images,
                                                                               host=host, user_id=user_id)
 
-        if list(widget.keys())[0] == 'wysiwyg-content':
+        if list(widget.keys())[0] == 'custom-content':
             wysiwyg_content = WYSIWYGContent(request=request)
-            wysiwyg_content.title = \
+            wysiwyg_content.heading = \
                 next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == 'heading'), None)['value']
             wysiwyg_content.content = \
                 next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == 'hidden_content'), None)['value']
+            wysiwyg_content.page_break_after = \
+                next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == 'page_break_after'),
+                     {'value': False})['value']
             selected_widgets[list(widget.keys())[0] + '-' + str(idx)] = wysiwyg_content
         if list(widget.keys())[0] == 'report-options':
             options = ReportOptions(request=request)
@@ -463,14 +436,12 @@ def report_widget_factory(json_data=None, request=None, user=None, finding_notes
             selected_widgets[list(widget.keys())[0]] = options
         if list(widget.keys())[0] == 'table-of-contents':
             toc = TableOfContents(request=request)
-            toc.title = next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == 'heading'), None)[
+            toc.heading = next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == 'heading'), None)[
                 'value']
-            toc.depth = next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == 'depth'), None)['value']
-            toc.depth = int(toc.depth) + 1
             selected_widgets[list(widget.keys())[0]] = toc
         if list(widget.keys())[0] == 'cover-page':
             cover_page = CoverPage(request=request)
-            cover_page.title = next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == 'heading'), None)[
+            cover_page.heading = next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == 'heading'), None)[
                 'value']
             cover_page.sub_heading = \
                 next((item for item in widget.get(list(widget.keys())[0]) if item["name"] == 'sub_heading'), None)['value']