Change plugins enabling in report flow to checkboxes #3747

noamblitz · 2024-10-28T17:25:42Z

Changes

This PR changes the plugin tiles in the report flow to use checkboxes. This fixes the report flow because the checkboxes use a post request.

Issue link

Please add the link to the issue after "Closes".

Closes ...

Demo

QA notes

There might be regressions in the report flow because I renamed a variable that I think is unused, but I am not sure about that.

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.

ammar92

Nice work 👍 I just have a few tiny remarks, shouldn't be much work

rocky/reports/views/aggregate_report.py

ammar92 · 2024-10-29T07:38:06Z

rocky/reports/views/generate_report.py

+
+        for selected_plugin in selected_plugins:
+            try:
+                get_katalogus(self.organization.code).enable_boefje_by_id(selected_plugin)


See earlier remark about the client

ammar92 · 2024-10-29T07:42:40Z

rocky/reports/templates/forms/report_form_fields.html

@@ -18,7 +18,7 @@
    {% endfor %}
 {% endif %}
 {% for required_optional_plugin, plugins_ in plugins.items %}
-    {% for plugin in plugins_ %}<input type="hidden" name="plugin" value="{{ plugin.id }}">{% endfor %}
+    {% for plugin in plugins_ %}<input type="hidden" name="all_plugins" value="{{ plugin.id }}">{% endfor %}


Just to be sure: The views still seem to refer to the plugin query parameter, so I'm unsure if this change works. Regardless, I think plugins as a query parameter list would've been a better name

Yeah weird right. It seems that this variable is and was not used... But I'm afraid to delete it.

Co-authored-by: ammar92 <[email protected]>

stephanie0x00 · 2024-10-30T13:00:32Z

Checklist for QA:

I have checked out this branch, and successfully ran a fresh make reset.
I confirmed that there are no unintended functional regressions in this branch:
- I have managed to pass the onboarding flow
- Objects and Findings are created properly
- Tasks are created and completed properly
I confirmed that the PR's advertised feature or hotfix works as intended.
I checked the logs for errors and/or warnings and made issues where necessary

What works:

Seems to work. Couldn't find anything that breaks obviously.

What doesn't work:

n/a

Bug or feature?:

n/a

underdarknl · 2024-10-30T13:07:26Z

rocky/reports/views/aggregate_report.py

+        for selected_plugin in selected_plugins:
+            try:
+                client.enable_boefje_by_id(selected_plugin)
+            except HTTPError:


I hate that we bubble up the http errors from the client to here. Lets move that away asap, the katalogusclient already has some localized exceptions for other issues.

Rieven · 2024-10-30T13:16:27Z

rocky/reports/views/generate_report.py

+    def post(self, request, *args, **kwargs):
+        selected_plugins = request.POST.getlist("plugin", [])
+
+        client = get_katalogus(self.organization.code)
+        for selected_plugin in selected_plugins:
+            try:
+                client.enable_boefje_by_id(selected_plugin)
+            except HTTPError:
+                messages.error(
+                    request,
+                    _("An error occurred while enabling {}. The plugin is not available.").format(selected_plugin),
+                )
+                return self.post(request, *args, **kwargs)
+        return super().post(request, *args, **kwargs)
+


Can you move this post to the ReportFinalSettingsView in base.py? Then it will be implemented for aggregate and multireport

We need to make sure that the user knows that by checking the checkboxes that it means enable and continue

Hmm no I cant move it to there because these plugins are enabled only in the export step, and not taken all the way to the final step like the other settings.

And the button already says: enable and continue

rocky/reports/views/generate_report.py

noamblitz · 2024-11-12T10:36:47Z

Permission checking now works. Can be tested by:

create new org member that is client
login with that member
follow report creation flow where not all plugins are enabled
check one of the checkboxes
see that report flow continues with error message

…l-kat-coordination into fix/report-flow-plugins

Rieven · 2024-11-20T08:30:41Z

I did a QA test and this was the result of it:

WHAT WORKS

Plugins checkboxes are visible

When not checking plugins, it will continue to next page. This is the intention, for those plugins then no enabling possible.
I can fully generate a report
When there is a required report, checkboxes are default checked.

Show enabled plugins shows other plugins already checked.

What doesn't work:

I have unchecked one of the required plugins and got a permissions error. I have a superuser status.

Even though there is a permissions error it continues to configuration page.

noamblitz · 2024-11-26T12:03:31Z

Should be solved!

sonarcloud · 2024-11-26T12:09:36Z

Quality Gate failed

Failed conditions
20.0% Coverage on New Code (required ≥ 80%)
68.9% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

* main: Increase max number of PostgreSQL connections (#3889) Fix for task id as valid UUID (#3744) Add `auto_calculate_deadline` attribute to Scheduler (#3869) Ignore specific url parameters when following location headers (#3856) Let mailserver inherit l1 (#3704) Change plugins enabling in report flow to checkboxes (#3747) Fix rocky katalogus tests and delete unused fixtures (#3884) Enable/disable scheduled reports (#3871)

* main: (60 commits) Increase max number of PostgreSQL connections (#3889) Fix for task id as valid UUID (#3744) Add `auto_calculate_deadline` attribute to Scheduler (#3869) Ignore specific url parameters when following location headers (#3856) Let mailserver inherit l1 (#3704) Change plugins enabling in report flow to checkboxes (#3747) Fix rocky katalogus tests and delete unused fixtures (#3884) Enable/disable scheduled reports (#3871) optimize locking in katalogus.py, reuse available data (#3752) Updates boefje clearances and descriptions (#3863) Fixes for empty tables (#3844) Fix cron for last day of the month (#3831) Sub reports for Aggregate Report (#3852) Add start time to scheduled reports (#3809) Add configuration setting for number of octopoes workers (#3796) Limit requesting prior tasks for ranking in scheduler (#3836) Let local plugins (files) take precedence over database entries (#3858) Skip empty queues in the Rocky worker (#3860) Report types listed in a modal @ report plugins (#3718) Support a Schedule without a schedule in scheduler (#3834) ...

* main: (64 commits) Bug fix: KAT-alogus parameter is now organization member instead of organization code (#3895) Remove sigrid workflows (#3920) Updated packages (#3898) Fix mula migrations Debian package (#3919) Adds loggers to report flow (#3872) Add additional check if task already run for report scheduler (#3900) Create separate finding for Microsoft RDP port (#3882) fix: 🐛 allow boefje completion with 404 (#3893) Feature/improve rename bulk modal (#3885) Update scheduler folder structure (#3883) Translations update from Hosted Weblate (#3870) Increase max number of PostgreSQL connections (#3889) Fix for task id as valid UUID (#3744) Add `auto_calculate_deadline` attribute to Scheduler (#3869) Ignore specific url parameters when following location headers (#3856) Let mailserver inherit l1 (#3704) Change plugins enabling in report flow to checkboxes (#3747) Fix rocky katalogus tests and delete unused fixtures (#3884) Enable/disable scheduled reports (#3871) optimize locking in katalogus.py, reuse available data (#3752) ...

change plugins to checkboxes

0ddb769

noamblitz requested a review from a team as a code owner October 28, 2024 17:25

lang update

9c7503b

ammar92 reviewed Oct 29, 2024

View reviewed changes

noamblitz and others added 4 commits October 29, 2024 07:49

Update rocky/reports/views/aggregate_report.py

55e76da

Co-authored-by: ammar92 <[email protected]>

update generate_report.py

32fe327

Merge branch 'main' into fix/report-flow-plugins

0cfb16a

Merge branch 'main' into fix/report-flow-plugins

8803173

Merge branch 'main' into fix/report-flow-plugins

c06d271

underdarknl reviewed Oct 30, 2024

View reviewed changes

Rieven reviewed Oct 30, 2024

View reviewed changes

underdarknl reviewed Oct 30, 2024

View reviewed changes

rocky/reports/views/generate_report.py Show resolved Hide resolved

underdarknl added the 😸 Review/QA feedback Review/QA feedback provided label Oct 31, 2024

madelondohmen assigned noamblitz Oct 31, 2024

noamblitz and others added 2 commits November 12, 2024 11:34

check for permissions

74327ea

Merge branch 'main' into fix/report-flow-plugins

b80fde3

noamblitz added 4 commits November 12, 2024 11:37

make lang

43edb75

Merge branch 'fix/report-flow-plugins' of https://github.com/minvws/n…

9b9f04b

…l-kat-coordination into fix/report-flow-plugins

permission checking for aggregate report

eb13517

make lang

7ed66fd

noamblitz changed the title ~~Change plugins enabling in report flwo to checkboxes~~ Change plugins enabling in report flow to checkboxes Nov 13, 2024

noamblitz and others added 3 commits November 26, 2024 12:46

fix perm and redirect

0b11381

dont enable enabled plugins

1bee8b7

Merge branch 'main' into fix/report-flow-plugins

d9629b2

underdarknl approved these changes Nov 26, 2024

View reviewed changes

underdarknl merged commit 45afffb into main Nov 26, 2024
20 of 22 checks passed

underdarknl deleted the fix/report-flow-plugins branch November 26, 2024 13:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change plugins enabling in report flow to checkboxes #3747

Change plugins enabling in report flow to checkboxes #3747

noamblitz commented Oct 28, 2024 •

edited

Loading

ammar92 left a comment

ammar92 Oct 29, 2024

ammar92 Oct 29, 2024

noamblitz Oct 29, 2024

stephanie0x00 commented Oct 30, 2024

underdarknl Oct 30, 2024

Rieven Oct 30, 2024

Rieven Oct 30, 2024

noamblitz Oct 31, 2024

noamblitz commented Nov 12, 2024

Rieven commented Nov 20, 2024 •

edited

Loading

noamblitz commented Nov 26, 2024

sonarcloud bot commented Nov 26, 2024

Change plugins enabling in report flow to checkboxes #3747

Change plugins enabling in report flow to checkboxes #3747

Conversation

noamblitz commented Oct 28, 2024 • edited Loading

Changes

Issue link

Demo

QA notes

Code Checklist

Checklist for code reviewers:

Checklist for QA:

ammar92 left a comment

Choose a reason for hiding this comment

ammar92 Oct 29, 2024

Choose a reason for hiding this comment

ammar92 Oct 29, 2024

Choose a reason for hiding this comment

noamblitz Oct 29, 2024

Choose a reason for hiding this comment

stephanie0x00 commented Oct 30, 2024

Checklist for QA:

What works:

What doesn't work:

Bug or feature?:

underdarknl Oct 30, 2024

Choose a reason for hiding this comment

Rieven Oct 30, 2024

Choose a reason for hiding this comment

Rieven Oct 30, 2024

Choose a reason for hiding this comment

noamblitz Oct 31, 2024

Choose a reason for hiding this comment

noamblitz commented Nov 12, 2024

Rieven commented Nov 20, 2024 • edited Loading

What doesn't work:

noamblitz commented Nov 26, 2024

sonarcloud bot commented Nov 26, 2024

Quality Gate failed

noamblitz commented Oct 28, 2024 •

edited

Loading

Rieven commented Nov 20, 2024 •

edited

Loading