Merge branch 'document-yaml-template' into 'master'

Document yaml template

See merge request kbr4/riskletpy!11
This commit was merged in pull request #60.
This commit is contained in:
2025-02-21 14:09:09 +00:00
7 changed files with 165 additions and 68 deletions

View File

@@ -2,6 +2,7 @@ from celery import shared_task
from backend.core.models import Organization, Document, Risk, Control, DocumentRiskControl
from backend.core.utils import get_top_risk, get_controls_for_risk
from django.shortcuts import get_object_or_404, render
from .utils import send_payment_email
@shared_task
@@ -49,4 +50,7 @@ def create_document_for_organization(confirmation_email):
controls_content += "\n"
document.add_segment('body', controls_content)
document.add_segment('body', controls_content)
send_payment_email(confirmation_email)

View File

@@ -1,5 +1,6 @@
import yaml
from django.core.management.base import BaseCommand
from django.template import Template, Context
from backend.core.models import DocumentTemplate
class Command(BaseCommand):
@@ -13,7 +14,6 @@ class Command(BaseCommand):
with open(yaml_file_path, 'r') as file:
content = file.read()
yaml_data = yaml.safe_load(content)
DocumentTemplate.objects.update_or_create(
name="Default Template",

View File

@@ -2,35 +2,13 @@
{% block content %}
<div class="document-container">
<header class="document-header">
<h1>{{ organization.name }}</h1>
<div class="document-meta">
<p>Created: {{ document.created_at|date:"F j, Y" }}</p>
<p>Last modified: {{ document.modified_at|date:"F j, Y" }}</p>
</div>
</header>
<article class="document-content">
{% for segment in segments %}
{% if segment.segment_type == 'title' %}
<h1 class="document-title">{{ segment.content }}</h1>
{% elif segment.segment_type == 'subtitle' %}
<h2 class="document-subtitle">{{ segment.content }}</h2>
{% elif segment.segment_type == 'h1' %}
<h2 class="document-h1">{{ segment.content }}</h2>
{% elif segment.segment_type == 'h2' %}
<h3 class="document-h2">{{ segment.content }}</h3>
{% elif segment.segment_type == 'h3' %}
<h4 class="document-h3">{{ segment.content }}</h4>
{% elif segment.segment_type == 'quote' %}
<blockquote class="document-quote">{{ segment.content }}</blockquote>
{% else %}
<p class="document-body">{{ segment.content }}</p>
{% endif %}
{% endfor %}
</article>
</div>
{% if error %}
<p style="color: red;">{{ error }}</p>
{% endif %}
<div>
{{ rendered_html|safe }}
</div>
<style>
.document-container {
max-width: 800px;

View File

View File

@@ -0,0 +1,84 @@
from django.test import TestCase, Client
from django.urls import reverse
from uuid import uuid4
from backend.core.models import Organization, Document, Risk, Control, DocumentRiskControl, DocumentTemplate
class DocumentViewTest(TestCase):
def setUp(self):
self.client = Client()
self.organization = Organization.objects.create(
id=1,
name="Test Organization",
email="test@example.com",
employee_headcount="100-500",
annual_revenue="$1M-$10M",
critical_applications="5-10",
compliance_frameworks=["Ab", "Ba"],
industry_sector="Technology",
it_dependency=8,
data_sensitivity="High",
network_infrastructure="Cloud-based",
remote_workforce_percentage="50%",
third_party_vendor_access="10-20",
internal_software_development="Moderate",
geographic_scope="Global",
customer_base="Enterprise",
customer_type="B2B",
product_portfolio="Diverse",
supplier_base="International",
it_infrastructure=["Cloud", "On-Premise"],
intellectual_property=["Patents", "Trademarks"],
sensitive_data=["PII", "Financial Data"],
integration_level="Highly Integrated"
)
self.document = Document.objects.create(id=uuid4(), organization=self.organization)
self.risk1 = Risk.objects.create(risk_id=1, risk_name="Risk 1")
self.risk2 = Risk.objects.create(risk_id=2, risk_name="Risk 2")
self.control1 = Control.objects.create(id=1, name="Control A")
self.control2 = Control.objects.create(id=2, name="Control B")
DocumentRiskControl.objects.create(id=1, document=self.document, risk=self.risk1, control=self.control1, weight=5)
DocumentRiskControl.objects.create(id=2, document=self.document, risk=self.risk1, control=self.control2, weight=7)
DocumentRiskControl.objects.create(id=3, document=self.document, risk=self.risk2, control=self.control1, weight=8)
template_content = """
- segment_type: "h1"
content: "{{ document.organization.name }} - Risk Report"
- segment_type: "body"
content: "Document ID: {{ document.id }}"
- segment_type: "body"
content: "Created at: {{ document.created_at|date:'Y-m-d' }}"
- segment_type: "h2"
content: "Risks"
- segment_type: "body"
content: |
{% for item in risks_with_controls %}
<div class="risk">
<h3>Risk: {{ item.risk.name }}</h3>
<div class="controls">
<h4>Mitigating Controls:</h4>
{% for control in item.controls %}
<div class="control">
<span class="name">{{ control.control__name }}</span> -
<span class="weight">Weight: {{ control.weight }}</span>
</div>
{% endfor %}
</div>
</div>
{% endfor %}
"""
self.template = DocumentTemplate.objects.create(id=1, name="Default Template", content=template_content)
def test_document_view(self):
url = reverse('core:document', kwargs={'document_id': self.document.id})
response = self.client.get(url)
self.assertEqual(response.status_code, 200)
self.assertContains(response, str(self.document.id))
self.assertContains(response, self.organization.name)
self.assertContains(response, self.document.created_at.strftime('%Y-%m-%d'))
self.assertContains(response, self.risk1.risk_name)
self.assertContains(response, self.control1.name)
self.assertContains(response, "Weight: 5")

View File

@@ -1,12 +1,16 @@
import logging
import yaml
from django.shortcuts import render, redirect , get_object_or_404
from .forms import OrganizationForm
from .models import Organization,Document,Risk, DocumentTemplate
from .models import Organization,Document,Risk, DocumentTemplate,DocumentRiskControl
from backend.core.utils import get_top_risk
from django.urls import reverse
from backend.accounts.utils import send_confirmation_email, send_document_email
from django.contrib.admin.views.decorators import staff_member_required
from django.template import Template, Context
# @login_required
# def index(request):
@@ -42,15 +46,54 @@ def signup(request):
def thankyou(request):
return render(request, 'thankyou.html')
def document(request, document_id):
print(f"Document ID received: {document_id}")
doc = get_object_or_404(Document, id=document_id)
def document(request, document_id):
document = get_object_or_404(Document, id=document_id)
risks = (
DocumentRiskControl.objects
.filter(document=document)
.values('risk', 'risk__risk_name')
.distinct()
)
risks_with_controls = []
for risk_entry in risks:
risk = {
'id': risk_entry['risk'],
'name': risk_entry['risk__risk_name']
}
controls = (
DocumentRiskControl.objects
.filter(document=document, risk_id=risk['id'])
.values('control', 'control__name', 'weight')
.distinct()
)
risks_with_controls.append({
'risk': risk,
'controls': list(controls)
})
template_obj = get_object_or_404(DocumentTemplate, name="Default Template")
template_content = template_obj.content
try:
template_segments = yaml.safe_load(template_content)
except yaml.YAMLError as e:
return render(request, 'error.html', {'error_message': 'Error parsing template.'})
context = {
'document': document,
'risks_with_controls': risks_with_controls
}
rendered_content = ""
for segment in template_segments:
content = segment['content']
django_template = Template(content)
rendered_content += django_template.render(Context(context))
return render(request, 'document.html', {'rendered_html': rendered_content})
return render(request, 'document.html', {
'document': doc,
'organization': doc.organization,
'segments': doc.segments.all(),
})
@staff_member_required
def template_preview(request, name):

View File

@@ -1,37 +1,25 @@
- segment_type: "title"
content: "Document Title"
- segment_type: "subtitle"
content: "Document Subtitle"
- segment_type: "h1"
content: "Introduction"
content: "{{ document.organization.name }} - Risk Report"
- segment_type: "body"
content: "{{ dynamic_intro }}"
content: "Created at: {{ document.created_at|date:'Y-m-d' }}"
- segment_type: "h2"
content: "Section 1: Details"
content: "Risks"
- segment_type: "body"
content: |
<p>This is a static section with an embedded HTML table:</p>
<table>
<tr>
<th>Header 1</th>
<th>Header 2</th>
</tr>
<tr>
<td>Data 1</td>
<td>Data 2</td>
</tr>
</table>
- segment_type: "quote"
content: "{{ dynamic_quote }}"
- segment_type: "h3"
content: "Subsection 1.1"
- segment_type: "body"
content: "{{ dynamic_subsection }}"
{% for item in risks_with_controls %}
<div class="risk">
<h3>Risk: {{ item.risk.name }}</h3>
<div class="controls">
<h4>Mitigating Controls:</h4>
{% for control in item.controls %}
<div class="control">
<span class="name">{{ control.control__name }}</span> -
<span class="weight">Weight: {{ control.weight }}</span>
</div>
{% endfor %}
</div>
</div>
{% endfor %}