Delete Report Schedules

rocky/reports/templates/report_overview/scheduled_reports_table.html

@@ -127,6 +127,9 @@ <h5>{% translate "Recent reports" %}</h5>
                                             <a class="button ghost"
                                                href="{% ooi_url "ooi_edit" schedule.recipe organization.code %}"><span aria-hidden="true" class="icon ti-edit action-button"></span>{% translate "Edit report recipe" %}</a>
                                         {% endif %}
+                                        {% include "report_schedules/delete_recipe_modal.html" with schedule_id=schedule.schedule_id recipe_id=schedule.recipe.primary_key %}
+
+                                        <a class="button ghost destructive" href="#delete-recipe-modal">{% translate "Delete" %}</a>
                                     </div>
                                 </div>
                             </td>

rocky/reports/templates/report_schedules/delete_recipe_modal.html

@@ -0,0 +1,28 @@
+{% load i18n %}
+
+{% component 'modal' size='dialog-small' modal_id='delete-recipe-modal' %}
+{% fill 'header' %}{% translate "Delete report recipe" %}{% endfill %}
+{% fill 'content' %}
+<p>
+    {% blocktranslate %}
+        Deleting this report recipe means it will be permanently deleted.
+        It will not be possible anymore to see or enable the schedule.
+        You will find previously generated reports in the report history tab.
+  {% endblocktranslate %}
+</p>
+<form id="delete-form" class="inline" method="post">
+    {% csrf_token %}
+    <input type="hidden" name="schedule_id" value="{{ schedule_id }}" />
+    <input type="hidden" name="report_recipe" value="{{ recipe_id }}" />
+</form>
+{% endfill %}
+{% fill "footer_buttons" %}
+<button type="submit"
+        form="delete-form"
+        class="destructive"
+        name="action"
+        value="delete">{% translate "Delete report recipe" %}</button>
+<button class="ghost close-modal-button">{% translate "Cancel" %}</button>
+{% endfill %}
+{% endcomponent %}
+{% component_css_dependencies %}

rocky/reports/views/report_overview.py

@@ -92,6 +92,25 @@ def get_queryset(self) -> list[dict[str, Any]]:
 
         return recipes
 
+    def post(self, request, *args, **kwargs):
+        recipe_pk = request.POST.get("report_recipe", "")
+        schedule_id = request.POST.get("schedule_id", "")
+
+        if recipe_pk and schedule_id:
+            self.delete_report_schedule(schedule_id)
+            try:
+                self.octopoes_api_connector.delete(
+                    Reference.from_str(f"{recipe_pk}"), valid_time=datetime.now(timezone.utc)
+                )
+                messages.success(self.request, _("Recipe '{}' deleted successfully").format(recipe_pk))
+            except ObjectNotFoundException:
+                messages.error(self.request, _("Recipe not found."))
+
+        else:
+            messages.error(self.request, _("No schedule or recipe selected"))
+
+        return redirect(reverse("scheduled_reports", kwargs={"organization_code": self.organization.code}))
+
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         context["total_report_schedules"] = len(self.object_list)

rocky/rocky/locale/django.pot

@@ -9,7 +9,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-02-13 15:25+0000\n"
+"POT-Creation-Date: 2025-02-25 14:59+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -587,6 +587,7 @@ msgstr ""
 #: katalogus/templates/confirmation_clone_settings.html
 #: katalogus/templates/plugin_settings_delete.html
 #: reports/templates/report_overview/modal_partials/enable_disable_schedule_modal.html
+#: reports/templates/report_schedules/delete_recipe_modal.html
 #: rocky/templates/oois/ooi_delete.html
 #: rocky/templates/oois/ooi_mute_finding.html
 #: rocky/templates/organizations/organization_edit.html
@@ -1389,6 +1390,7 @@ msgstr ""
 #: katalogus/views/plugin_settings_delete.py
 #: reports/templates/report_overview/modal_partials/delete_modal.html
 #: reports/templates/report_overview/report_history_table.html
+#: reports/templates/report_overview/scheduled_reports_table.html
 #: rocky/templates/admin/delete_confirmation.html rocky/views/ooi_delete.py
 msgid "Delete"
 msgstr ""
@@ -4380,6 +4382,20 @@ msgstr ""
 msgid "Input Object"
 msgstr ""
 
+#: reports/templates/report_schedules/delete_recipe_modal.html
+msgid "Delete report recipe"
+msgstr ""
+
+#: reports/templates/report_schedules/delete_recipe_modal.html
+msgid ""
+"\n"
+"        Deleting this report recipe means it will be permanently deleted.\n"
+"        It will not be possible anymore to see or enable the schedule.\n"
+"        You will find previously generated reports in the report history "
+"tab.\n"
+"  "
+msgstr ""
+
 #: reports/templates/summary/report_asset_overview.html
 msgid ""
 "The objects listed in the table below were used to generate this report. For "
@@ -4500,6 +4516,18 @@ msgstr ""
 msgid "View report"
 msgstr ""
 
+#: reports/views/report_overview.py
+msgid "Recipe '{}' deleted successfully"
+msgstr ""
+
+#: reports/views/report_overview.py
+msgid "Recipe not found."
+msgstr ""
+
+#: reports/views/report_overview.py
+msgid "No schedule or recipe selected"
+msgstr ""
+
 #: reports/views/report_overview.py
 msgid "Schedule {}"
 msgstr ""

rocky/rocky/views/scheduler.py

@@ -138,6 +138,12 @@ def create_report_schedule(self, report_recipe: ReportRecipe, deadline_at: datet
         except SchedulerError as error:
             return messages.error(self.request, error.message)
 
+    def delete_report_schedule(self, schedule_id: str) -> None:
+        try:
+            self.scheduler_client.delete_schedule(schedule_id)
+        except SchedulerError as error:
+            return messages.error(self.request, error.message)
+
     def edit_report_schedule(self, schedule_id: str, params):
         self.scheduler_client.patch_schedule(schedule_id=schedule_id, params=params)
 

rocky/tests/conftest.py

@@ -44,7 +44,7 @@
 from octopoes.models.tree import ReferenceTree
 from octopoes.models.types import OOIType
 from rocky.health import ServiceHealth
-from rocky.scheduler import PaginatedTasksResponse, ReportTask, Task, TaskStatus
+from rocky.scheduler import PaginatedTasksResponse, ReportTask, ScheduleResponse, Task, TaskStatus
 
 LANG_LIST = [code for code, _ in settings.LANGUAGES]
 
@@ -1872,3 +1872,58 @@ def reports_task_list():
             ),
         ],
     )
+
+
+@pytest.fixture
+def scheduled_report_recipe():
+    return ReportRecipe(
+        object_type="ReportRecipe",
+        scan_profile=EmptyScanProfile(
+            scan_profile_type="empty",
+            reference=Reference("ReportRecipe|3fed7d00-6261-4ad1-b08f-9b91434aa41e"),
+            level=ScanLevel.L0,
+            user_id=None,
+        ),
+        user_id=None,
+        primary_key="ReportRecipe|3fed7d00-6261-4ad1-b08f-9b91434aa41e",
+        recipe_id=UUID("3fed7d00-6261-4ad1-b08f-9b91434aa41e"),
+        report_name_format="${report_type} for ${oois_count} objects",
+        input_recipe={"input_oois": ["Hostname|internet|mispo.es"]},
+        report_type="concatenated-report",
+        asset_report_types=[
+            "dns-report",
+            "findings-report",
+            "ipv6-report",
+            "mail-report",
+            "name-server-report",
+            "open-ports-report",
+            "rpki-report",
+            "safe-connections-report",
+            "systems-report",
+            "vulnerability-report",
+            "web-system-report",
+        ],
+        cron_expression=None,
+    )
+
+
+@pytest.fixture
+def scheduled_reports_list():
+    return [
+        ScheduleResponse(
+            id=UUID("7706ebc1-b24b-44fb-a7b3-9a44d80b2644"),
+            scheduler_id="report",
+            organisation="test",
+            hash="bb5708d2f82e11cc5cda3aef54190f2e",
+            data={
+                "type": "report",
+                "organisation_id": "_rieven",
+                "report_recipe_id": "3fed7d00-6261-4ad1-b08f-9b91434aa41e",
+            },
+            enabled=True,
+            schedule=None,
+            deadline_at=None,
+            created_at=datetime(2025, 2, 12, 16, 1, 19, 951925),
+            modified_at=datetime(2025, 2, 12, 16, 1, 19, 951925),
+        )
+    ]

rocky/tests/reports/test_report_schedules.py

@@ -0,0 +1,79 @@
+from reports.views.report_overview import ScheduledReportsView
+
+from octopoes.models.exception import ObjectNotFoundException
+from rocky.scheduler import SchedulerError
+from tests.conftest import setup_request
+
+
+def test_delete_schedule(
+    rf, client_member, mock_organization_view_octopoes, mock_scheduler, scheduled_report_recipe, scheduled_reports_list
+):
+    mock_scheduler.get_scheduled_reports.return_value = scheduled_reports_list
+    mock_organization_view_octopoes().get.return_value = scheduled_report_recipe
+
+    schedule_id = scheduled_reports_list[0].id
+    recipe_id = "ReportRecipe|" + scheduled_reports_list[0].data["report_recipe_id"]
+
+    request = setup_request(
+        rf.post("scheduled_reports", {"report_recipe": recipe_id, "schedule_id": schedule_id}), client_member.user
+    )
+
+    response = ScheduledReportsView.as_view()(request, organization_code=client_member.organization.code)
+
+    assert response.status_code == 302
+    assert list(request._messages)[0].message == f"Recipe '{recipe_id}' deleted successfully"
+
+
+def test_delete_schedule_no_recipe(
+    rf, client_member, mock_organization_view_octopoes, mock_scheduler, scheduled_report_recipe, scheduled_reports_list
+):
+    mock_scheduler.get_scheduled_reports.return_value = scheduled_reports_list
+    mock_organization_view_octopoes().get.return_value = scheduled_report_recipe
+
+    schedule_id = scheduled_reports_list[0].id
+
+    request = setup_request(
+        rf.post("scheduled_reports", {"report_recipe": "", "schedule_id": schedule_id}), client_member.user
+    )
+
+    response = ScheduledReportsView.as_view()(request, organization_code=client_member.organization.code)
+
+    assert response.status_code == 302
+    assert list(request._messages)[0].message == "No schedule or recipe selected"
+
+
+def test_delete_schedule_object_not_found(
+    rf, client_member, mock_organization_view_octopoes, mock_scheduler, scheduled_report_recipe, scheduled_reports_list
+):
+    mock_scheduler.get_scheduled_reports.side_effect = scheduled_reports_list
+    mock_organization_view_octopoes().get.return_value = scheduled_report_recipe
+    mock_organization_view_octopoes().delete.side_effect = ObjectNotFoundException("Not found")
+
+    request = setup_request(
+        rf.post("scheduled_reports", {"report_recipe": "recipeNone", "schedule_id": "ScheduleNone"}), client_member.user
+    )
+
+    response = ScheduledReportsView.as_view()(request, organization_code=client_member.organization.code)
+
+    assert response.status_code == 302
+    assert list(request._messages)[0].message == "Recipe not found."
+
+
+def test_delete_schedule_schedule_not_found(
+    rf, client_member, mock_organization_view_octopoes, mock_scheduler, scheduled_report_recipe, scheduled_reports_list
+):
+    mock_scheduler.get_scheduled_reports.side_effect = scheduled_reports_list
+    mock_organization_view_octopoes().get.return_value = scheduled_report_recipe
+    mock_scheduler.delete_schedule.side_effect = SchedulerError
+
+    request = setup_request(
+        rf.post("scheduled_reports", {"report_recipe": "recipeNone", "schedule_id": "ScheduleNone"}), client_member.user
+    )
+
+    response = ScheduledReportsView.as_view()(request, organization_code=client_member.organization.code)
+
+    assert response.status_code == 302
+    assert (
+        list(request._messages)[0].message
+        == "The Scheduler has an unexpected error. Check the Scheduler logs for further details."
+    )