Files
rengine/reports/sections/changes/section.py
T
Yogesh OjhaandClaude Opus 5 724ebd42bb feat(reports): a section declares its role, its order and what it asks at generate time
Choosing what a report contains required editing a template. That is the wrong
place for a decision made per report, and the scan launch flow already
established the alternative: a saved configuration seeds the run, the run may
depart from it, and the saved configuration is never touched.

Three declarations put sections on the same footing as stages. SectionRole
separates the content a reader asked for from the furniture around it, so a
picker can offer twenty-one choices and include the cover, the contents and the
reference matter without being asked. Section.order fixes the reading order,
which until now was however the directories happened to sort — the executive
summary came after attack paths because "a" precedes "e". Section.launch_fields
names the settings worth surfacing when the report is generated rather than
only in the builder, mirroring Stage.launch_fields; the findings section
declares its severities, its detail depth, its roll-up and its asset cap.

The estimate had to become honest for any of this to be worth showing. It
counted every finding in the scan whatever the section filtered to, so dropping
three severities moved nothing. It now counts through the same severity filter
the section applies and prices each tier separately, from the real per-severity
issue counts rather than an assumed split: 28 pages against 26 rendered for a
full template, 10 against 9 for critical and high alone.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AW5pitnosX8LEFEYxH8gFS
2026-09-06 17:14:01 +05:30

59 lines
2.0 KiB
Python

from __future__ import annotations
from reports.base import RenderContext, Section
from reports.config import SectionConfig, flag, limit
from shared.definitions.reports import SectionGroup
from shared.definitions.surface import SURFACE_LABELS, SURFACE_NOUN
class ChangesConfig(SectionConfig):
list_added: bool = flag(True, title="List what appeared")
list_gone: bool = flag(True, title="List what went away")
max_items: int = limit(
20, title="Items listed per dimension", minimum=1, maximum=200
)
show_new_findings: bool = flag(
True, title="Highlight findings this run reported first"
)
class ChangesSection(Section):
name = "changes"
title = "What changed"
description = "The difference against the previous run. Nothing is reported as new on a first run."
group = SectionGroup.SUMMARY.value
order = 50
config_model = ChangesConfig
def build(self, ctx: RenderContext, cfg: ChangesConfig) -> dict | None:
if ctx.data.previous_scan is None:
return {"first_run": True, "rows": [], "new_findings": []}
rows = [
{
"label": SURFACE_LABELS[line.dimension],
"noun": SURFACE_NOUN[line.dimension][1],
"added": line.added,
"gone": line.gone,
"added_sample": line.added_sample[: cfg.max_items]
if cfg.list_added
else [],
"gone_sample": line.gone_sample[: cfg.max_items]
if cfg.list_gone
else [],
}
for line in ctx.brief.changes
]
new_findings = (
[f for f in ctx.data.findings if f.is_new][:25]
if cfg.show_new_findings
else []
)
if not rows and not new_findings:
return None
return {
"first_run": False,
"rows": rows,
"new_findings": new_findings,
"previous": ctx.data.previous_scan,
}