Add a "Run Pipeline" button in the Pipeline modal of the Project deta…

…ils view #84

Signed-off-by: Thomas Druez <tdruez@nexb.com>

CHANGELOG.rst

@@ -3,10 +3,13 @@
 
 ### v1.1.0 (unreleased)
 
+- Add a "Run Pipeline" button in the Pipeline modal of the Project details view
+  https://github.com/nexB/scancode.io/issues/84
+
 - Upgrade scancode-toolkit to version 21.2.9
 
 - Allow to start the pipeline run immediately on addition in the `add_pipeline` action
-  of the Project API endpoint.
+  of the Project API endpoint
   https://github.com/nexB/scancode.io/issues/92
 
 - Rename the pipes.outputs module to pipes.output for consistency

scanpipe/forms.py

@@ -43,6 +43,7 @@ class ProjectForm(forms.ModelForm):
     )
     run_pipeline = forms.BooleanField(
         label="Run the selected pipeline",
+        initial=True,
         required=False,
     )
 

scanpipe/models.py

@@ -25,7 +25,6 @@
 import traceback
 import uuid
 from contextlib import suppress
-from datetime import datetime
 from pathlib import Path
 
 from django.core import checks
@@ -34,6 +33,7 @@
 from django.db import transaction
 from django.db.models import Q
 from django.forms import model_to_dict
+from django.urls import reverse
 from django.utils import timezone
 from django.utils.functional import cached_property
 from django.utils.translation import gettext_lazy as _
@@ -375,6 +375,9 @@ def add_error(self, error, model, details=None):
             traceback="".join(traceback.format_tb(error.__traceback__)),
         )
 
+    def get_absolute_url(self):
+        return reverse("project_detail", args=[self.uuid])
+
     @cached_property
     def resource_count(self):
         return self.codebaseresources.count()

scanpipe/templates/scanpipe/includes/breadcrumb.html

@@ -4,7 +4,7 @@
       <li class="is-active"><a href="#" aria-current="page">Projects</a></li>
     {% elif current %}
       <li><a href="{% url 'project_list' %}">Projects</a></li>
-      <li><a href="{% url 'project_detail' project.uuid %}">{{ project.name }}</a></li>
+      <li><a href="{{ project.get_absolute_url }}">{{ project.name }}</a></li>
       <li class="is-active"><a href="#" aria-current="page">{{ current }}</a></li>
     {% else %}
       <li><a href="{% url 'project_list' %}">Projects</a></li>

scanpipe/templates/scanpipe/includes/project_list_table.html

@@ -14,7 +14,7 @@
   {% for project in projects %}
     <tr>
       <th>
-        <a href="{% url 'project_detail' project.uuid %}">{{ project }}</a>
+        <a href="{{ project.get_absolute_url }}">{{ project }}</a>
       </th>
       <td>
         {% if project.package_count %}

scanpipe/templates/scanpipe/includes/run_modal.html

@@ -16,6 +16,12 @@
             {% include "scanpipe/includes/run_status_tag.html" with run=run only %}
           </div>
         </div>
+        {% if not run.task_start_date %}
+          <a href="{% url 'project_run_pipeline' project.uuid run.uuid %}" class="has-text-weight-bold">
+            <i class="fas fa-play-circle"></i>
+            Run Pipeline
+          </a>
+        {% endif %}
         {% if run.task_exitcode %}
           <div class="control">
             <div class="tags has-addons">

scanpipe/templates/scanpipe/project_detail.html

@@ -10,6 +10,7 @@
 {% block content %}
   <div class="container is-max-desktop">
     {% include 'scanpipe/includes/navbar_header.html' %}
+    <div class="mx-5 mb-2">{% include 'scanpipe/includes/messages.html' %}</div>
 
     <section class="mx-5 mb-3">
       {% include 'scanpipe/includes/breadcrumb.html' %}
@@ -100,7 +101,7 @@
                 {% include "scanpipe/includes/run_status_tag.html" with run=run only %}
                 <span class="ml-2">{{ run.pipeline_basename }}</span>
               </a>
-              {% include "scanpipe/includes/run_modal.html" with run=run only %}
+              {% include "scanpipe/includes/run_modal.html" with project=project run=run only %}
             {% endfor %}
             <div class="panel-block">
               <button class="button is-link is-outlined is-fullwidth" disabled>

scanpipe/urls.py

@@ -55,6 +55,11 @@
         views.ProjectResultsView.as_view(),
         name="project_results",
     ),
+    path(
+        "project/<uuid:uuid>/run_pipeline/<uuid:run_uuid>/",
+        views.run_pipeline_view,
+        name="project_run_pipeline",
+    ),
     path(
         "project/add/",
         views.ProjectCreateView.as_view(),

scanpipe/views.py

@@ -26,6 +26,7 @@
 from django.http import FileResponse
 from django.http import Http404
 from django.shortcuts import get_object_or_404
+from django.shortcuts import redirect
 from django.urls import reverse_lazy
 from django.views import generic
 
@@ -41,6 +42,7 @@
 from scanpipe.models import DiscoveredPackage
 from scanpipe.models import Project
 from scanpipe.models import ProjectError
+from scanpipe.models import Run
 from scanpipe.pipes import codebase
 from scanpipe.pipes import output
 
@@ -196,6 +198,18 @@ def get_context_data(self, **kwargs):
         return context
 
 
+def run_pipeline_view(request, uuid, run_uuid):
+    project = get_object_or_404(Project, uuid=uuid)
+    run = get_object_or_404(Run, uuid=run_uuid, project=project)
+
+    if run.task_start_date:
+        raise Http404("Pipeline already started.")
+
+    run.run_pipeline_task_async()
+    messages.success(request, f'Pipeline "{run.pipeline}" run started.')
+    return redirect(project)
+
+
 def project_results_json_response(project, as_attachment=False):
     """
     Return the results as JSON compatible with ScanCode data format.