Findings dashboard for all organizations #4007

madelondohmen · 2025-01-07T08:10:49Z

Changes

This PR adds dashboards to OpenKAT.

In the frontend we've only added the Findings Dashboard to the Crisis Room of all organizations, but the backend is already ready to add all kinds of dashboards to both Crisis Rooms.

This PR adds:

DashboardData model
Automatically add a findings dashboard to a new organization
- Including a ReportRecipe, based on a recipe_seeder
- This ReportRecipe makes sure the Findings Dashboard is updated regularly
Use "make dashboard" to add dashboards to all existing organizations
Findings Report in Aggregate Report
Findings Report visible in Multi Report
Make template of Findings Report more generic
Only show the 5 most recent reports that have been generated when expanding the Scheduled Reports table

Issue link

Closes #3881

Demo

Opname.2025-01-07.102915.mp4

Aggregate Report:

QA notes

New organization

Create a new organization. Creating a new organization would automatically add this organization to the Findings Dashboard (which is shown in the Crisis Room for all organizations). Besides this, on the Scheduled Reports page there should be a ReportRecipe called "Crisis Room Aggregate Report". This should also create a report, which can be seen on the Report History page (this may take a minute). After the report has been created, the results of the report should be visible on the Crisis Room for all organizations. Please make sure that these two matches.

Existing organizations

Existing organizations also need their own dashboard. This can be done by using the command "make dashboard" in rocky. Please check if this adds the existing organizations to the Findings Dashboard (which is shown in the Crisis Room for all organizations).

Findings Report

The Findings Report should work as expected. Also, it should be possible to create a Aggregate and Multi Findings Report. Please check if this work as expected.

Code Checklist

All the commits in this PR are properly PGP-signed and verified.
This PR only contains functionality relevant to the issue.
I have written unit tests for the changes or fixes I made.
I have checked the documentation and made changes where necessary.
I have performed a self-review of my code and refactored it to the best of my abilities.

Tickets have been created for newly discovered issues.
For any non-trivial functionality, I have added integration and/or end-to-end tests.
I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.

Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

…minvws/nl-kat-coordination into feature/findings-dashboard-for-all-orgs

…ture/findings-dashboard-for-all-orgs

…hub.com/minvws/nl-kat-coordination into feature/findings-dashboard-for-all-orgs

…minvws/nl-kat-coordination into feature/findings-dashboard-for-all-orgs

Rieven · 2025-01-14T11:46:00Z

Newly added organisations don't show up on the crisis room page (thus an organisation created after completing the onboarding).

You have to run make dashboards again after adding the new organization. What we did before is that when a new organization is added the dashboard will be created, but just after creating a new dashboard no objects are added yet, the schedule will create empty reports with 0 objects. Then it came to be that the user decides when to create the dashboard.

For already existing organization it will update it:

Rieven · 2025-01-14T11:49:24Z

Running 'make dashboards' doesn't show the dashboards for the organisations (for a clean install on this PR with 2 already added organisations). (Corresponding logs are below)

Running make dashboards does not ensure that findings data is available for the organization. The recipe and schedule for every hour must have also input objects to generate findings when creating the findings report through the scheduler. We show only findings data that is available for the organization.

sonarqubecloud · 2025-01-14T12:12:15Z

Quality Gate failed

Failed conditions
67.4% Coverage on New Code (required ≥ 80%)
8.5% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

…feature/findings-dashboard-for-all-orgs01~

Rieven · 2025-02-18T10:24:39Z

Newly added organisations don't show up on the crisis room page (thus an organisation created after completing the onboarding).

You have to run make dashboards again after adding the new organization. What we did before is that when a new organization is added the dashboard will be created, but just after creating a new dashboard no objects are added yet, the schedule will create empty reports with 0 objects. Then it came to be that the user decides when to create the dashboard.

For already existing organization it will update it:

I have edited this, that both are possible. When a new org is added it creats the dashboard, and also when you already have orgs you can run the command. make dashboards to generate dashboards for existing orgs.

…ture/findings-dashboard-for-all-orgs

sonarqubecloud · 2025-02-26T17:09:03Z

Quality Gate failed

Failed conditions
77.2% Coverage on New Code (required ≥ 80%)
7.7% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

underdarknl · 2025-02-27T08:20:16Z

rocky/crisis_room/migrations/0001_initial.py

+                (
+                    "dashboard",
+                    models.ForeignKey(
+                        null=True, on_delete=django.db.models.deletion.SET_NULL, to="crisis_room.dashboard"


This can probably be a cascade, where the dashboarddata gets deleted when the dashboard gets deleted. Not just set to null. Null values are not needed.

I thought that the data can still exist after deleting the dashboard. So they can delete the dashboard and asign the data to another dashboard? i don't know if this was the intention. I see a possibility to re-asign data to another dashboard.

underdarknl · 2025-02-27T08:22:29Z

rocky/crisis_room/models.py

+
+
+class DashboardData(models.Model):
+    dashboard = models.ForeignKey(Dashboard, on_delete=models.SET_NULL, null=True)


null is not allowed. On_delete from a dashboard, the dashboardData should also be deleted. so cascade.

rocky/crisis_room/models.py

underdarknl · 2025-02-27T08:28:19Z

rocky/crisis_room/templates/crisis_room.html

+{% block content %}
+    {% include "header.html" %}
+
+    <main id="main-content" tabindex="-1" class="crisisroom">


Why is there a tabindex on these?

underdarknl · 2025-02-27T08:36:52Z

rocky/rocky/templates/organizations/organization_crisis_room.html

@@ -9,6 +9,7 @@
    <main id="main-content">
        <section>
            <div>
+                {{ member }}


debugging? I dont see it defined anywhere in the contexts?

underdarknl · 2025-02-27T08:37:25Z

rocky/rocky/templates/organizations/organization_crisis_room.html

@@ -25,6 +26,7 @@ <h1>{% translate "Crisis room" %} {{ organization.name }} @ {{ observed_at|date:
                <p>
                    {% translate "An overview of the top 10 most severe findings OpenKAT found. Check the detail section for additional severity information." %}
                </p>
+                {{ recipe_form_fields }}


underdarknl · 2025-02-27T08:39:06Z

rocky/tools/templatetags/ooi_extra.py

+
+@register.filter
+def get_first_seen(occurrences: dict) -> datetime:
+    first_seen_list = [datetime.fromisoformat(occurrence["first_seen"]) for occurrence in occurrences]


Lets do a min on the occurences first, and Then transform to a date. thats cheaper. Also, we we have the occurrences sorted by the database, we can just take the first or last, and use that instead of looping.

underdarknl · 2025-02-27T08:42:24Z

rocky/reports/templates/partials/report_findings_table.html

+                                                <td>
+                                                    <a href="{% ooi_url 'ooi_detail' occurrence.finding.ooi organization.code %}">{{ occurrence.finding.ooi|human_readable }}</a>
+                                                </td>
+                                                <td>{{ occurrence.first_seen|get_datetime }}</td>


There's also a template function to print '2 days ago', which we can use in conjunction with a title tag to add the 'raw utc' date for power users.

See for example: https://github.com/minvws/nl-kat-coordination/blob/d72a54acb2779591c009d6f8a97fe392ea20f215/rocky/rocky/templates/oois/ooi_detail_origins_observations.html#L49C32-L49C187

oeeh we can use that indeed, let me check

Co-authored-by: Jan Klopper <[email protected]>

Rieven and others added 30 commits November 25, 2024 17:51

Report recipe for all orgs

8aa5814

Create Findings Aggregate Report

fe1c88a

add model and signal

e8269b2

Merge branch 'feature/findings-dashboard-for-all-orgs' of github.com:…

f82cbfd

…minvws/nl-kat-coordination into feature/findings-dashboard-for-all-orgs

Merge branch 'main' of github.com:minvws/nl-kat-coordination into fea…

b3308bb

…ture/findings-dashboard-for-all-orgs

check pk instead of id

7c410a2

Fixes for organization Dashboard

ee9eb65

fix get findings from bytes

1567bfa

return 1 finding

92ff8a5

Update templates and aggregate report

6ee322c

Fix merge conflict

1114a10

Fixes in templates

1ec80c1

fix scheduler is ready

6b717e4

Fix logic

a1ca8d9

Fix aggregate summary

eac10c7

Merge branch 'feature/findings-dashboard-for-all-orgs' of https://git…

683033e

…hub.com/minvws/nl-kat-coordination into feature/findings-dashboard-for-all-orgs

Fix occurrences count

5e636fe

Add sorting to reports to get latest report

80d8e94

fix none findings for orgs

bfc5a7d

Merge branch 'feature/findings-dashboard-for-all-orgs' of github.com:…

ef0b5c2

…minvws/nl-kat-coordination into feature/findings-dashboard-for-all-orgs

Update templates

4f43a9d

Fix merge conflict

98b1598

Changes in templates

c7db309

Add findings org summary and show datetime

68d75ef

change models and data

47e1f00

Merge branch 'feature/findings-dashboard-for-all-orgs' of github.com:…

1a50e80

…minvws/nl-kat-coordination into feature/findings-dashboard-for-all-orgs

More table fixes

929fcb5

fixes models, views, templates

85ed236

Merge branch 'feature/findings-dashboard-for-all-orgs' of github.com:…

09adcc5

…minvws/nl-kat-coordination into feature/findings-dashboard-for-all-orgs

Create Multi Report Findings Report

4083062

check if dashboard is updated or created

247074e

underdarknl added this to the OpenKAT v1.19 milestone Jan 27, 2025

madelondohmen and others added 8 commits February 10, 2025 11:13

Merge branch 'main' into feature/findings-dashboard-for-all-orgs

7e212e4

Fixes after report refactoring

78b5a7c

Create dashboard automatically after creating organization

b1f6188

Template fixes

62c2d99

Add pending and unknown to severity table

fa12fde

Fix typo

97a61ce

00~Merge branch 'main' of github.com:minvws/nl-kat-coordination into …

1694880

…feature/findings-dashboard-for-all-orgs01~

fix lang

68ec10b

Rieven added 6 commits February 19, 2025 11:43

fix some tests

4b6dc3a

Merge branch 'main' of github.com:minvws/nl-kat-coordination into fea…

d9e1053

…ture/findings-dashboard-for-all-orgs

fix test

707c94c

Merge branch 'main' into feature/findings-dashboard-for-all-orgs

ebd743c

fix itest

dff9b68

fix precommit

8be813b

underdarknl reviewed Feb 27, 2025

View reviewed changes

rocky/crisis_room/models.py Outdated Show resolved Hide resolved

underdarknl reviewed Feb 27, 2025

View reviewed changes

Update rocky/crisis_room/models.py

5586b3e

Co-authored-by: Jan Klopper <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Findings dashboard for all organizations #4007

Findings dashboard for all organizations #4007

madelondohmen commented Jan 7, 2025 •

edited

Loading

Rieven commented Jan 14, 2025 •

edited

Loading

Rieven commented Jan 14, 2025 •

edited

Loading

sonarqubecloud bot commented Jan 14, 2025

Rieven commented Feb 18, 2025

sonarqubecloud bot commented Feb 26, 2025

underdarknl Feb 27, 2025

Rieven Feb 27, 2025

underdarknl Feb 27, 2025

underdarknl Feb 27, 2025

underdarknl Feb 27, 2025

underdarknl Feb 27, 2025

underdarknl Feb 27, 2025

underdarknl Feb 27, 2025

Rieven Feb 27, 2025



		class DashboardData(models.Model):
		dashboard = models.ForeignKey(Dashboard, on_delete=models.SET_NULL, null=True)

Findings dashboard for all organizations #4007

Are you sure you want to change the base?

Findings dashboard for all organizations #4007

Conversation

madelondohmen commented Jan 7, 2025 • edited Loading

Changes

Issue link

Demo

QA notes

New organization

Existing organizations

Findings Report

Code Checklist

Checklist for code reviewers:

Checklist for QA:

Rieven commented Jan 14, 2025 • edited Loading

Rieven commented Jan 14, 2025 • edited Loading

sonarqubecloud bot commented Jan 14, 2025

Quality Gate failed

Rieven commented Feb 18, 2025

sonarqubecloud bot commented Feb 26, 2025

Quality Gate failed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

madelondohmen commented Jan 7, 2025 •

edited

Loading

Rieven commented Jan 14, 2025 •

edited

Loading

Rieven commented Jan 14, 2025 •

edited

Loading