first draft to simplify report generation

frontend/src/components/dialogs/ReportTemplateCreateDialog.vue

@@ -1,24 +1,22 @@
 <script>
-import AdminService from '@/service/AdminService'
-
+import AdminService from '@/service/AdminService';
 
 export default {
-    name: "ReportTemplateCreateDialog",
-    emits: ["object-created"],
+    name: 'ReportTemplateCreateDialog',
+    emits: ['object-created'],
     data() {
         return {
             visible: false,
             model: {
                 name: null,
-                path: null,
                 status: null
             },
             statusChoices: [
-                { title: "Active", value: "Active" },
-                { title: "Draft", value: "Draft" },
-                { title: "Deactivated", value: "Deactivated" }
+                { title: 'Active', value: 'Active' },
+                { title: 'Draft', value: 'Draft' },
+                { title: 'Deactivated', value: 'Deactivated' }
             ],
-            service: new AdminService(),
+            service: new AdminService()
         };
     },
     methods: {
@@ -33,20 +31,20 @@ export default {
                 name: this.model.name,
                 status: this.model.status,
                 path: this.model.path
-            }
+            };
             this.service.createReportTemplate(this.$api, data).then((response) => {
                 this.$toast.add({
-                    severity: "success",
-                    summary: "Report template Created!",
+                    severity: 'success',
+                    summary: 'Report template Created!',
                     life: 3000,
-                    detail: "Report template created successfully!"
+                    detail: 'Report template created successfully!'
                 });
-                this.$emit("object-created", response.data);
+                this.$emit('object-created', response.data);
                 this.visible = false;
             });
-        },
-    },
-}
+        }
+    }
+};
 </script>
 
 <template>
@@ -57,10 +55,6 @@ export default {
             <label for="name">Name</label>
             <InputText id="name" v-model="model.name"></InputText>
         </div>
-        <div class="flex flex-column gap-2">
-            <label for="first_name">Path</label>
-            <InputText id="path" v-model="model.path"></InputText>
-        </div>
         <div class="flex flex-column gap-2">
             <label for="status">Status</label>
             <Dropdown v-model="model.status" optionLabel="title" :options="statusChoices" optionValue="value"></Dropdown>
@@ -71,4 +65,4 @@ export default {
             <Button label="Save" @click="create" icon="pi pi-check" class="p-button-outlined"></Button>
         </template>
     </Dialog>
-</template>
+</template>

frontend/src/components/dialogs/ReportTemplateUpdateDialog.vue

@@ -1,24 +1,23 @@
 <script>
-import AdminService from '@/service/AdminService'
-
+import AdminService from '@/service/AdminService';
 
 export default {
-    name: "ReportTemplateUpdateDialog",
+    name: 'ReportTemplateUpdateDialog',
     props: {
         template: {
             required: true
         }
     },
-    emits: ["object-updated"],
+    emits: ['object-updated'],
     data() {
         return {
             visible: false,
             model: this.user,
             service: new AdminService(),
             statusChoices: [
-                { title: "Active", value: "Active" },
-                { title: "Draft", value: "Draft" },
-                { title: "Deactivated", value: "Deactivated" }
+                { title: 'Active', value: 'Active' },
+                { title: 'Draft', value: 'Draft' },
+                { title: 'Deactivated', value: 'Deactivated' }
             ]
         };
     },
@@ -32,14 +31,13 @@ export default {
         patch() {
             let data = {
                 name: this.model.name,
-                path: this.model.path,
                 status: this.model.status
-            }
+            };
             this.service.patchReportTemplate(this.$api, this.template.pk, data).then(() => {
-                this.$emit("object-updated", this.model);
+                this.$emit('object-updated', this.model);
                 this.visible = false;
             });
-        },
+        }
     },
     watch: {
         template: {
@@ -49,23 +47,18 @@ export default {
                 this.model = value;
             }
         }
-    },
-}
+    }
+};
 </script>
 
 <template>
     <Button icon="fa fa-pen-to-square" size="small" @click="open" outlined></Button>
 
     <Dialog header="Update Report Template" v-model:visible="visible" :modal="true" :style="{ width: '70vw' }">
-
         <div class="flex flex-column gap-2">
             <label for="name">Name</label>
             <InputText id="name" v-model="model.name"></InputText>
         </div>
-        <div class="flex flex-column gap-2">
-            <label for="first_name">Path</label>
-            <InputText id="path" v-model="model.path"></InputText>
-        </div>
         <div class="flex flex-column gap-2">
             <label for="status">Status</label>
             <Dropdown v-model="model.status" optionLabel="title" :options="statusChoices" optionValue="value"></Dropdown>

frontend/src/views/pages/admin/ReportTemplateList.vue

@@ -91,9 +91,8 @@ export default {
         <div class="col-12">
             <Card>
                 <template #content>
-                    <DataTable paginator dataKey rowHover :rows="pagination.limit" :value="items" lazy filterDisplay="menu" :totalRecords="totalRecords" :loading="loading" @page="onPage" responsiveLayout="scroll" @filter="onFilter" @sort="onSort">
+                    <DataTable paginator rowHover :rows="pagination.limit" :value="items" lazy filterDisplay="menu" :totalRecords="totalRecords" :loading="loading" @page="onPage" responsiveLayout="scroll" @filter="onFilter" @sort="onSort">
                         <Column field="name" header="Name"></Column>
-                        <Column field="path" header="Path"></Column>
                         <Column field="status" header="Status"></Column>
                         <Column header="Actions">
                             <template #body="slotProps">

frontend/src/views/pages/projects/findings/FindingDetail.vue

@@ -135,7 +135,7 @@ export default {
             this.findingService
                 .downloadAsPDF(this.$api, this.projectId, this.findingId)
                 .then((response) => {
-                    const filename = 'finding_' + this.finding.internal_id + '.pdf';
+                    const filename = 'finding-' + this.finding.unique_id.toLowerCase() + '.pdf';
                     this.forceFileDownload(response, filename);
                 })
                 .finally(() => {

server/advisories/tests/test_advisory_export_tasks.py

@@ -1,7 +1,7 @@
 from rest_framework.test import APITestCase
 from django_q.tasks import async_task, result
 from backend import models
-from backend.tasks.finding_export import export_advisory, export_advisory_markdown
+from backend.tasks.reporting import export_advisory, export_advisory_markdown
 from pecoret.core.test import PeCoReTTestCaseMixin
 
 

server/advisories/viewsets/advisory.py

@@ -1,5 +1,4 @@
 from django.http.response import HttpResponse
-from django.conf import settings
 from rest_framework.decorators import action
 from backend.models.advisory import Advisory, Roles
 from advisories.serializers.advisory import (
@@ -9,8 +8,7 @@
     AdvisoryDownloadSerializer
 )
 from advisories.serializers.timeline import AdvisoryTimelineSerializer
-from backend.models import ReportTemplate
-from backend.tasks.finding_export import export_advisory, export_advisory_markdown
+from backend.tasks.reporting import export_advisory, export_advisory_markdown
 from advisories.serializers.advisory_management import (
     AdvisoryAdvisoryManagementSerializer, AdvisoryManagementUpdateSerializer
 )

server/backend/apps.py

@@ -10,9 +10,6 @@ class BackendConfig(AppConfig):
     def ready(self):
         # keep it here instead of the recommended pecoret.__init__
         # otherwise gunicorn will fail to load because settings module is not yet ready
-        # pylint: disable=unused-import
-        # pylint: disable=import-outside-toplevel
-        import pecoret.schema
         # patch translation
         from pecoret.core.reporting.translation import patch_django_translation
         patch_django_translation()

server/backend/migrations/0041_remove_reporttemplate_path_alter_reporttemplate_name.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.0 on 2024-01-09 05:07
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('backend', '0040_remove_finding_authenticated_test'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='reporttemplate',
+            name='path',
+        ),
+        migrations.AlterField(
+            model_name='reporttemplate',
+            name='name',
+            field=models.CharField(max_length=64, unique=True, validators=[django.core.validators.RegexValidator('^[\\w\\_]*$')]),
+        ),
+    ]

server/backend/models/report_templates.py

@@ -1,7 +1,8 @@
-from pathlib import Path
 from django.db import models
 from django.dispatch import receiver
+from django.core.validators import RegexValidator
 from django.core.exceptions import PermissionDenied, ValidationError
+from django.conf import settings
 
 
 class ReportTemplateStatus(models.IntegerChoices):
@@ -21,8 +22,7 @@ class ReportTemplate(models.Model):
     date_updated = models.DateTimeField(auto_now=True)
     status = models.PositiveSmallIntegerField(choices=ReportTemplateStatus.choices,
                                               default=ReportTemplateStatus.ACTIVE)
-    name = models.CharField(max_length=64, unique=True)
-    path = models.CharField(max_length=128)
+    name = models.CharField(max_length=64, unique=True, validators=[RegexValidator(r'^[\w\_]*$')])
 
     def __str__(self):
         return self.name
@@ -45,9 +45,10 @@ def template_path(self):
         """the path of the ``templates`` subdirectory of the report template.
 
         Returns:
-            str: path of the ``templates`` directory containing the jinja2 templates. 
+            str: path of the ``templates`` directory containing the jinja2 templates.
         """
-        return str(Path(self.path) / "templates/")
+        path = f'{self.name}/templates'
+        return str(path)
 
     class Meta:
         ordering = ["-date_created", "name"]

server/backend/models/reports/report.py

@@ -8,14 +8,18 @@ class ReportVariant(models.IntegerChoices):
     PENTEST_EXCEL = 2, "Pentest Excel"
 
     @property
-    def variant_report_class_name(self):
+    def to_plugin_method(self):
         """required to receive the required class of the variant
 
         Returns:
             str: class name (e.g. PentestPDFReport)
         """
-        class_name = self._label_.replace(" ", "")
-        return f"{class_name}Report"
+        mappers = {
+            'Pentest PDF': 'export_project_pdf_report',
+            'Vulnerability CSV': 'export_vulnerability_csv',
+            'Pentest Excel': 'export_project_excel'
+        }
+        return mappers[self._label_]
 
 
 class ReportQuerySet(models.QuerySet):

server/backend/serializers/report_templates.py

@@ -19,5 +19,4 @@ class Meta:
         fields = ReportTemplateMinimalSerializer.Meta.fields + [
             "date_created",
             "date_updated",
-            "path",
         ]

server/backend/tasks/reporting.py

@@ -1,14 +1,39 @@
+from pecoret.reporting.report_plugin import ReportPluginLoader
 from backend.models.reports.report_release import ReportRelease
 from backend.models.reports.report import ReportVariant
-from pecoret.core.reporting.loader import RenderableLoader
 
 
 def create_report_document_task(report_document_pk):
     report_document = ReportRelease.objects.get(pk=report_document_pk)
     # get the report variant (e.g. Pentest PDF)
     report_variant = ReportVariant(report_document.report.variant)
-    loader = RenderableLoader(report_template=report_document.report.template)
-    # pylint: disable=invalid-name
-    RenderableReport = loader.load_template_class_for_variant(report_variant)
-    result = RenderableReport(loader.report_template, report_document).generate()
+    plugin_loader = ReportPluginLoader(report_document.report.template)
+    plugin = plugin_loader.load_plugin_from_report_template(report_variant.to_plugin_method)
+    result, content_type, extension = getattr(plugin, report_variant.to_plugin_method)(report_document)
+    report_document.compiled_source = result
+    report_document.content_type = content_type
+    report_document.file_extension = extension
+    report_document.save()
     return result
+
+
+def export_single_finding(finding, template):
+    plugin_loader = ReportPluginLoader(template)
+    plugin = plugin_loader.load_plugin_from_report_template('export_single_finding')
+    result, content_type, extension = plugin.export_single_finding(finding)
+    return result
+
+
+def export_advisory(advisory, template):
+    plugin_loader = ReportPluginLoader(template)
+    plugin = plugin_loader.load_plugin_from_report_template('export_advisory_pdf')
+    result, content_type, extension = plugin.export_advisory_pdf(advisory)
+    return result
+
+
+def export_advisory_markdown(advisory, template):
+    plugin_loader = ReportPluginLoader(template)
+    plugin = plugin_loader.load_plugin_from_report_template('export_advisory_markdown')
+    result, content_type, extension = plugin.export_advisory_markdown(advisory)
+    return result
+

server/backend/tests/test_report_generation.py

@@ -3,7 +3,7 @@
 from backend import models
 from backend.models.reports.report_release import ReleaseType
 from backend.tasks.reporting import create_report_document_task
-from backend.tasks.finding_export import export_single_finding
+from backend.tasks.reporting import export_single_finding
 from pecoret.core.test import PeCoReTTestCaseMixin
 
 

server/backend/viewsets/findings.py

@@ -10,7 +10,7 @@
     FindingAsAdvisorySerializer,
 )
 from backend.filters.finding import FindingFilter
-from backend.tasks.finding_export import export_single_finding
+from backend.tasks.reporting import export_single_finding
 from backend.models.advisory import Advisory
 from pecoret.core.viewsets import PeCoReTModelViewSet
 from pecoret.core import permissions