Add options to the Project reset action

tdruez · tdruez · commit 9ac921aae78e · 2025-01-27T13:33:44.000+09:00
Signed-off-by: tdruez &lt;tdruez@nexb.com&gt;
diff --git a/scanpipe/forms.py b/scanpipe/forms.py
@@ -252,7 +252,7 @@ class BaseProjectActionForm(forms.Form):
     )
 
 
-class ArchiveProjectForm(BaseProjectActionForm):
+class ProjectArchiveForm(BaseProjectActionForm):
     remove_input = forms.BooleanField(
         label="Remove inputs",
         initial=True,
@@ -277,6 +277,31 @@ def get_action_kwargs(self):
         }
 
 
+class ProjectResetForm(BaseProjectActionForm):
+    keep_input = forms.BooleanField(
+        label="Keep inputs",
+        initial=True,
+        required=False,
+    )
+    restore_pipelines = forms.BooleanField(
+        label="Restore existing pipelines",
+        initial=False,
+        required=False,
+    )
+    execute_now = forms.BooleanField(
+        label="Execute restored pipeline(s) now",
+        initial=False,
+        required=False,
+    )
+
+    def get_action_kwargs(self):
+        return {
+            "keep_input": self.cleaned_data["keep_input"],
+            "restore_pipelines": self.cleaned_data["restore_pipelines"],
+            "execute_now": self.cleaned_data["execute_now"],
+        }
+
+
 class ProjectOutputDownloadForm(BaseProjectActionForm):
     output_format = forms.ChoiceField(
         label="Choose the output format to include in the ZIP file",
diff --git a/scanpipe/models.py b/scanpipe/models.py
@@ -637,10 +637,9 @@ def archive(self, remove_input=False, remove_codebase=False, remove_output=False
         shutil.rmtree(self.tmp_path, ignore_errors=True)
         self.setup_work_directory()
 
-        self.is_archived = True
-        self.save(update_fields=["is_archived"])
+        self.update(is_archived=True)
 
-    def delete_related_objects(self, keep_input=False):
+    def delete_related_objects(self, keep_input=False, keep_labels=False):
         """
         Delete all related object instances using the private `_raw_delete` model API.
         This bypass the objects collection, cascade deletions, and signals.
@@ -657,7 +656,8 @@ def delete_related_objects(self, keep_input=False):
         _, deleted_counter = self.discoveredpackages.all().delete()
 
         # Removes all tags from this project by deleting the UUIDTaggedItem instances.
-        self.labels.clear()
+        if not keep_labels:
+            self.labels.clear()
 
         relationships = [
             self.webhookdeliveries,
@@ -690,14 +690,25 @@ def delete(self, *args, **kwargs):
 
         return super().delete(*args, **kwargs)
 
-    def reset(self, keep_input=True):
+    def reset(self, keep_input=True, restore_pipelines=False, execute_now=False):
         """
         Reset the project by deleting all related database objects and all work
         directories except the input directory—when the `keep_input` option is True.
         """
         self._raise_if_run_in_progress()
 
-        self.delete_related_objects(keep_input=keep_input)
+        restore_pipeline_kwargs = []
+        if restore_pipelines:
+            restore_pipeline_kwargs = [
+                {
+                    "pipeline_name": run.pipeline_name,
+                    "execute_now": execute_now,
+                    "selected_groups": run.selected_groups,
+                }
+                for run in self.runs.all()
+            ]
+
+        self.delete_related_objects(keep_input=keep_input, keep_labels=True)
 
         work_directories = [
             self.codebase_path,
@@ -717,6 +728,9 @@ def reset(self, keep_input=True):
 
         self.setup_work_directory()
 
+        for pipeline_kwargs in restore_pipeline_kwargs:
+            self.add_pipeline(**pipeline_kwargs)
+
     def clone(
         self,
         clone_name,
diff --git a/scanpipe/templates/scanpipe/modals/project_reset_modal.html b/scanpipe/templates/scanpipe/modals/project_reset_modal.html
@@ -5,18 +5,36 @@
       <p class="modal-card-title">Reset this project, are you sure?</p>
       <button class="delete" aria-label="close"></button>
     </header>
-    <section class="modal-card-body">
-      <div class="notification is-danger has-text-weight-semibold">
-        This action cannot be undone.
-      </div>
-      <p class="mb-2">
-        This action will <strong>delete all related database entries and all data on disks</strong> except for the input/ directory.
-      </p>
-      <p class="mb-5">
-        Are you sure you want to do this?
-      </p>
-    </section>
     <form action="{% url 'project_reset' project.slug %}" method="post">{% csrf_token %}
+      <section class="modal-card-body">
+        <div class="notification is-danger has-text-weight-semibold">
+          This action cannot be undone.
+        </div>
+        <p class="mb-2">
+          This action will <strong>delete all related database entries and all data on disks</strong> except for the input/ directory.
+        </p>
+        <p class="mb-5">
+          Are you sure you want to do this?
+        </p>
+        <div class="field">
+          <label class="label">
+            {{ reset_form.keep_input }}
+            {{ reset_form.keep_input.label }}
+          </label>
+        </div>
+        <div class="field">
+          <label class="label">
+            {{ reset_form.restore_pipelines }}
+            {{ reset_form.restore_pipelines.label }}
+          </label>
+        </div>
+        <div class="field">
+          <label class="label">
+            {{ reset_form.execute_now }}
+            {{ reset_form.execute_now.label }}
+          </label>
+        </div>
+      </section>
       <footer class="modal-card-foot is-flex is-justify-content-space-between">
         <button class="button has-text-weight-semibold" type="reset">No, Cancel</button>
         <button class="button is-danger is-no-close" type="submit">Yes, Reset Project</button>
diff --git a/scanpipe/templates/scanpipe/modals/projects_reset_modal.html b/scanpipe/templates/scanpipe/modals/projects_reset_modal.html
@@ -6,30 +6,48 @@
       <p class="modal-card-title">Reset selected projects, are you sure?</p>
       <button class="delete" aria-label="close"></button>
     </header>
-    <section class="modal-card-body">
-      <div class="notification is-danger has-text-weight-semibold">
-        This action cannot be undone.
-      </div>
-      <p class="mb-2">
-        This action will <strong>delete all related database entries and all data on disks</strong> except for the input/ directory.
-      </p>
-      <p class="mb-5">
-        Are you sure you want to do this?
-      </p>
-      {% if page_obj.paginator.num_pages > 1 %}
-        <div class="show-on-all-checked">
-          <hr>
-          <div class="field include-all-field">
-            <label class="checkbox" for="{{ archive_form.select_across.id_for_label }}">
-              <input type="checkbox" name="{{ archive_form.select_across.name }}" id="{{ archive_form.select_across.id_for_label }}">
-              Include all {{ paginator.count|intcomma }} projects
-            </label>
-            <p class="help">{{ outputs_download_form.select_across.help_text }}</p>
-          </div>
-        </div>
-      {% endif %}
-    </section>
     <form action="{% url 'project_action' %}" method="post" id="reset-projects-form">{% csrf_token %}
+      <section class="modal-card-body">
+        <div class="notification is-danger has-text-weight-semibold">
+          This action cannot be undone.
+        </div>
+        <p class="mb-2">
+          This action will <strong>delete all related database entries and all data on disks</strong> except for the input/ directory.
+        </p>
+        <p class="mb-5">
+          Are you sure you want to do this?
+        </p>
+        <div class="field">
+          <label class="label">
+            {{ reset_form.keep_input }}
+            {{ reset_form.keep_input.label }}
+          </label>
+        </div>
+        <div class="field">
+          <label class="label">
+            {{ reset_form.restore_pipelines }}
+            {{ reset_form.restore_pipelines.label }}
+          </label>
+        </div>
+        <div class="field">
+          <label class="label">
+            {{ reset_form.execute_now }}
+            {{ reset_form.execute_now.label }}
+          </label>
+        </div>
+        {% if page_obj.paginator.num_pages > 1 %}
+          <div class="show-on-all-checked">
+            <hr>
+            <div class="field include-all-field">
+              <label class="checkbox" for="{{ reset_form.select_across.id_for_label }}">
+                <input type="checkbox" name="{{ reset_form.select_across.name }}" id="{{ reset_form.select_across.id_for_label }}">
+                Include all {{ paginator.count|intcomma }} projects
+              </label>
+              <p class="help">{{ outputs_download_form.select_across.help_text }}</p>
+            </div>
+          </div>
+        {% endif %}
+      </section>
       <input type="hidden" name="{{ action_form.url_query.name }}" value="{{ request.GET.urlencode }}">
       <input type="hidden" name="action" value="reset">
       <footer class="modal-card-foot is-flex is-justify-content-space-between">
diff --git a/scanpipe/views.py b/scanpipe/views.py
@@ -76,10 +76,11 @@
 from scanpipe.forms import AddInputsForm
 from scanpipe.forms import AddLabelsForm
 from scanpipe.forms import AddPipelineForm
-from scanpipe.forms import ArchiveProjectForm
 from scanpipe.forms import BaseProjectActionForm
 from scanpipe.forms import EditInputSourceTagForm
 from scanpipe.forms import PipelineRunStepSelectionForm
+from scanpipe.forms import ProjectArchiveForm
+from scanpipe.forms import ProjectResetForm
 from scanpipe.forms import ProjectCloneForm
 from scanpipe.forms import ProjectForm
 from scanpipe.forms import ProjectOutputDownloadForm
@@ -599,7 +600,8 @@ class ProjectListView(
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         context["action_form"] = BaseProjectActionForm()
-        context["archive_form"] = ArchiveProjectForm()
+        context["archive_form"] = ProjectArchiveForm()
+        context["reset_form"] = ProjectResetForm()
         context["outputs_download_form"] = ProjectOutputDownloadForm()
         context["report_form"] = ProjectReportForm()
         return context
@@ -856,7 +858,8 @@ def get(self, request, *args, **kwargs):
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         project = self.get_object()
-        context["archive_form"] = ArchiveProjectForm()
+        context["archive_form"] = ProjectArchiveForm()
+        context["reset_form"] = ProjectResetForm()
         context["webhook_subscriptions"] = project.webhooksubscriptions.all()
         return context
 
@@ -1136,7 +1139,7 @@ def get_context_data(self, **kwargs):
 class ProjectArchiveView(ConditionalLoginRequired, SingleObjectMixin, FormView):
     model = Project
     http_method_names = ["post"]
-    form_class = ArchiveProjectForm
+    form_class = ProjectArchiveForm
     success_url = reverse_lazy("project_list")
     success_message = 'The project "{}" has been archived.'
 
@@ -1154,20 +1157,22 @@ def form_valid(self, form):
         return response
 
 
-class ProjectResetView(ConditionalLoginRequired, generic.DeleteView):
+class ProjectResetView(ConditionalLoginRequired, SingleObjectMixin, FormView):
     model = Project
-    success_message = 'All data, except inputs, for the "{}" project have been removed.'
+    http_method_names = ["post"]
+    form_class = ProjectResetForm
+    success_url = reverse_lazy("project_list")
+    success_message = 'The project "{}" has been reset.'
 
     def form_valid(self, form):
         """Call the reset() method on the project."""
         project = self.get_object()
         try:
-            project.reset(keep_input=True)
+            project.reset(**form.get_action_kwargs())
         except RunInProgressError as error:
             messages.error(self.request, error)
-        else:
-            messages.success(self.request, self.success_message.format(project.name))
 
+        messages.success(self.request, self.success_message.format(project.name))
         return redirect(project)
 
 
@@ -1195,7 +1200,8 @@ class ProjectActionView(ConditionalLoginRequired, generic.ListView):
     model = Project
     allowed_actions = ["archive", "delete", "reset", "report", "download"]
     action_to_form_class = {
-        "archive": ArchiveProjectForm,
+        "archive": ProjectArchiveForm,
+        "reset": ProjectResetForm,
         "report": ProjectReportForm,
         "download": ProjectOutputDownloadForm,
     }
@@ -1222,7 +1228,7 @@ def post(self, request, *args, **kwargs):
         if action == "report":
             return self.xlsx_report_response(project_qs, action_form)
 
-        if action == "archive":
+        if action in ["archive", "reset"]:
             action_kwargs = action_form.get_action_kwargs()
 
         count = 0
