Add start date to report schedule #3701

madelondohmen · 2024-10-17T16:13:36Z

Changes

This PR adds the start date input to the Report Schedule section on the Export Setup page in the report flow.
This allows a user to select the start date of the scheduled report.

It also changes the text “This field is required” to “(Required)” because it was not compliant with the designs. The changes are applied to all forms in KAT.

Issue link

Closes #2779

Demo

QA notes

Create a new report and select "Yes, repeat"
Select a date
After creating a recipe, check if the selected date is visible in the table on the Scheduled Reports page

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.

rocky/reports/templates/partials/export_report_settings.html

underdarknl · 2024-10-21T08:03:08Z

rocky/rocky/views/scheduler.py

@@ -97,13 +97,13 @@ def get_report_schedule_form_start_date_choice(self):
        return self.report_schedule_form_start_date_choice(self.request.POST)

    def get_report_schedule_form_start_date(self):


Is this supposed t be on the scheduler view? Its report related right? Maybe this should be on the repor or on a reportView mixin? The same for the following 4 methods.

This comes from another PR (#3597). @Rieven, can you answer this question?

Besided this, I'm not sure if we need to fix this in this PR. Might be better to create a new one.

Yes, I put this in the SchedulerView, but maybe it is better to move it to the BaseReportView. The idea was that the "schedule" is part of the Scheduler as you enter a start date and recurrence which needs form validation from the scheduler side if for example the schedule did not start or Scheduler throws a ConnectionError. The other part is that if we need a scheduler elsewhere where we implement the same start date and recurrence we have it already in place in the SchedulerView.

rocky/rocky/templates/partials/form/field_input.html

…ithub.com/minvws/nl-kat-coordination into feature/add-start-date-to-report-schedule

ammar92

No remarks

…ithub.com/minvws/nl-kat-coordination into feature/add-start-date-to-report-schedule

noamblitz · 2024-10-24T10:59:28Z

QA checklist for PR's

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:

Start date is added to table

What doesn't work:

Regression on add ooi?

Bug or feature?:

Scheduled a report with start date today, the report was scheduled for 24 oct, midnight. I expect that to be coming night, and not previous night, report was created though. That signals to me that the start date is not correctly passed or something like that?

madelondohmen · 2024-10-25T08:26:16Z

Bug or feature?:

Scheduled a report with start date today, the report was scheduled for 24 oct, midnight. I expect that to be coming night, and not previous night, report was created though. That signals to me that the start date is not correctly passed or something like that?

That's what you'd expect, right? If you want to schedule it for today, then it should be scheduled for 25-10-2024 00:00, not for the next day (26-10-2024 00:00). Otherwise you should select the 26th.

Maybe @HeleenSG has a thought about this: from the user's perspective, what whould you expect to happen?

madelondohmen · 2024-10-28T08:43:16Z

@noamblitz the forms with "(Required)" should be fixed now

…ithub.com/minvws/nl-kat-coordination into feature/add-start-date-to-report-schedule

stephanie0x00 · 2024-10-28T10:30:06Z

Created a new ticket to discuss the timestamping issue as mentioned above: #3738.

This PR has been tested and it works for now, thus can be merged.

sonarqubecloud · 2024-10-28T10:37:25Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
90.6% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

* main: Fix reports with organization tags (#3790) Update README.rst - Fix guidelines URLs (#3789) Exclude Report from ooi list (#3768) Update `croniter` (#3767) Fixes for dropdowns (#3732) Fix scheduled Aggregate Report naming (#3748) Make systemctl call for kat-rocky-worker conditional (#3782) Fix vulnerability chapters in Aggregate table of content (#3780) Fix auth token middleware with wrong format header (#3755) Add rocky REST API for report recipes (#3746) Add exception handling to the rest api (#3708) Refactor Multi Report to comply to the new report flow (#3705) Fix report names for scheduled reports (#3726) Fix Multi Report recursion error (#3714) Bump waitress from 3.0.0 to 3.0.1 in /octopoes (#3760) Docs/add muted findings (#3699) Edit report recipe (#3690) Add start date to report schedule (#3701) Add REST API to list report and download pdf report (#3689) Fixes in Report Overview (#3707)

madelondohmen added 2 commits October 17, 2024 13:16

Add start_date to report export setup page

44e8642

Update styling of 'required' in label tags

b52c7f8

madelondohmen self-assigned this Oct 17, 2024

madelondohmen requested a review from a team as a code owner October 17, 2024 16:13

madelondohmen and others added 3 commits October 17, 2024 18:23

Fix test

3f0a3c1

Update translations

12f8b22

Merge branch 'main' into feature/add-start-date-to-report-schedule

635713c

underdarknl reviewed Oct 21, 2024

View reviewed changes

rocky/reports/templates/partials/export_report_settings.html Outdated Show resolved Hide resolved

underdarknl reviewed Oct 21, 2024

View reviewed changes

rocky/rocky/templates/partials/form/field_input.html Outdated Show resolved Hide resolved

madelondohmen added 4 commits October 21, 2024 15:25

Fix redundant code

4f3916d

Change span to label

dacf941

Merge branch 'feature/add-start-date-to-report-schedule' of https://g…

6851634

…ithub.com/minvws/nl-kat-coordination into feature/add-start-date-to-report-schedule

Small fix

d721933

ammar92 previously approved these changes Oct 22, 2024

View reviewed changes

madelondohmen and others added 3 commits October 23, 2024 19:28

Merge branch 'main' into feature/add-start-date-to-report-schedule

c838019

Add tests

b438070

Merge branch 'feature/add-start-date-to-report-schedule' of https://g…

51dae98

…ithub.com/minvws/nl-kat-coordination into feature/add-start-date-to-report-schedule

madelondohmen dismissed ammar92’s stale review via 51dae98 October 24, 2024 07:37

Update test

60f76ed

ammar92 previously approved these changes Oct 24, 2024

View reviewed changes

Remove horizontal-view from forms

902c310

madelondohmen dismissed ammar92’s stale review via 902c310 October 28, 2024 08:42

madelondohmen and others added 4 commits October 28, 2024 09:43

Merge branch 'main' into feature/add-start-date-to-report-schedule

7e5922a

Merge branch 'main' into feature/add-start-date-to-report-schedule

fd3b1d4

Remove legend for better readability

2c11157

Merge branch 'feature/add-start-date-to-report-schedule' of https://g…

6e3b060

…ithub.com/minvws/nl-kat-coordination into feature/add-start-date-to-report-schedule

stephanie0x00 mentioned this pull request Oct 28, 2024

Timestamp of scheduled reports #3738

Closed

Merge branch 'main' into feature/add-start-date-to-report-schedule

117bf91

underdarknl approved these changes Oct 28, 2024

View reviewed changes

underdarknl merged commit 75de529 into main Oct 28, 2024
22 checks passed

underdarknl deleted the feature/add-start-date-to-report-schedule branch October 28, 2024 11:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add start date to report schedule #3701

Add start date to report schedule #3701

madelondohmen commented Oct 17, 2024 •

edited

Loading

underdarknl Oct 21, 2024

madelondohmen Oct 21, 2024

Rieven Oct 22, 2024 •

edited

Loading

ammar92 left a comment

noamblitz commented Oct 24, 2024 •

edited

Loading

madelondohmen commented Oct 25, 2024

Bug or feature?:

madelondohmen commented Oct 28, 2024

stephanie0x00 commented Oct 28, 2024

sonarqubecloud bot commented Oct 28, 2024

		@@ -97,13 +97,13 @@ def get_report_schedule_form_start_date_choice(self):
		return self.report_schedule_form_start_date_choice(self.request.POST)

		def get_report_schedule_form_start_date(self):

Add start date to report schedule #3701

Add start date to report schedule #3701

Conversation

madelondohmen commented Oct 17, 2024 • edited Loading

Changes

Issue link

Demo

QA notes

Code Checklist

Checklist for code reviewers:

Checklist for QA:

underdarknl Oct 21, 2024

Choose a reason for hiding this comment

madelondohmen Oct 21, 2024

Choose a reason for hiding this comment

Rieven Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

ammar92 left a comment

Choose a reason for hiding this comment

noamblitz commented Oct 24, 2024 • edited Loading

Checklist for QA:

What works:

What doesn't work:

Bug or feature?:

madelondohmen commented Oct 25, 2024

Bug or feature?:

madelondohmen commented Oct 28, 2024

stephanie0x00 commented Oct 28, 2024

sonarqubecloud bot commented Oct 28, 2024

Quality Gate passed

madelondohmen commented Oct 17, 2024 •

edited

Loading

Rieven Oct 22, 2024 •

edited

Loading

noamblitz commented Oct 24, 2024 •

edited

Loading