Display pipeline description in UI

Signed-off-by: Keshav Priyadarshi <[email protected]>

Author: keshav-space

vulnerabilities/api_v2.py

@@ -686,7 +686,9 @@ class Meta:
             "url",
             "pipeline_id",
             "is_active",
+            "live_logging",
             "run_interval",
+            "execution_timeout",
             "created_date",
             "schedule_work_id",
             "next_run_date",
@@ -705,17 +707,33 @@ def get_latest_run(self, schedule):
 class PipelineScheduleCreateSerializer(serializers.ModelSerializer):
     class Meta:
         model = PipelineSchedule
-        fields = ["pipeline_id", "is_active", "run_interval"]
+        fields = [
+            "pipeline_id",
+            "is_active",
+            "run_interval",
+            "live_logging",
+            "execution_timeout",
+        ]
         extra_kwargs = {
             field: {"initial": PipelineSchedule._meta.get_field(field).get_default()}
-            for field in ["is_active", "run_interval"]
+            for field in [
+                "is_active",
+                "run_interval",
+                "live_logging",
+                "execution_timeout",
+            ]
         }
 
 
 class PipelineScheduleUpdateSerializer(serializers.ModelSerializer):
     class Meta:
         model = PipelineSchedule
-        fields = ["is_active", "run_interval"]
+        fields = [
+            "is_active",
+            "run_interval",
+            "live_logging",
+            "execution_timeout",
+        ]
 
 
 class PipelineScheduleV2ViewSet(CreateListRetrieveUpdateViewSet):

vulnerabilities/models.py

@@ -2124,8 +2124,8 @@ class PipelineSchedule(models.Model):
         db_index=True,
         default=True,
         help_text=(
-            "When set to True (Yes), this Pipeline is active. "
-            "When set to False (No), this Pipeline is inactive and not run."
+            "When set to True, this Pipeline is active. "
+            "When set to False, this Pipeline is inactive and not run."
         ),
     )
 

vulnerabilities/pipelines/compute_package_risk.py

@@ -17,11 +17,9 @@
 
 
 class ComputePackageRiskPipeline(VulnerableCodePipeline):
-    """
-    Compute risk score for packages.
+    """Compute risk score for packages."""
 
-    See https://github.com/aboutcode-org/vulnerablecode/issues/1543
-    """
+    # See https://github.com/aboutcode-org/vulnerablecode/issues/1543
 
     pipeline_id = "compute_package_risk"
     license_expression = None

vulnerabilities/pipelines/enhance_with_exploitdb.py

@@ -26,7 +26,7 @@
 
 class ExploitDBImproverPipeline(VulnerableCodePipeline):
     """
-    ExploitDB Improver Pipeline: Fetch ExploitDB data, iterate over it to find the vulnerability with
+    Fetch ExploitDB data, iterate over it to find the vulnerability with
     the specified alias, and create or update the ref and ref-type accordingly.
     """
 

vulnerabilities/pipelines/enhance_with_kev.py

@@ -20,7 +20,7 @@
 
 class VulnerabilityKevPipeline(VulnerableCodePipeline):
     """
-    Known Exploited Vulnerabilities Pipeline: Retrieve KEV data, iterate through it to identify vulnerabilities
+    Retrieve KEV data, iterate through it to identify vulnerabilities
     by their associated aliases, and create or update the corresponding Exploit instances.
     """
 

vulnerabilities/pipelines/enhance_with_metasploit.py

@@ -22,7 +22,7 @@
 
 class MetasploitImproverPipeline(VulnerableCodePipeline):
     """
-    Metasploit Exploits Pipeline: Retrieve Metasploit data, iterate through it to identify vulnerabilities
+    Retrieve Metasploit data, iterate through it to identify vulnerabilities
     by their associated aliases, and create or update the corresponding Exploit instances.
     """
 

vulnerabilities/templates/pipeline_run_list.html

@@ -38,6 +38,15 @@
       <h1>{{ pipeline_name }} Runs</h1>
       <hr />
     </div>
+
+    {% if pipeline_description %}
+      <div class="notification is-info is-light">
+        <p class="is-size-5 has-text-grey-dark has-text-centered">
+          {{ pipeline_description }}
+        </p>
+      </div>
+    {% endif %}
+
     <div class="box">
       <table class="table is-striped  is-hoverable is-fullwidth">
         <thead>

vulnerabilities/tests/test_models.py

@@ -689,7 +689,8 @@ def test_pipelineschedule_status(self):
         self.assertEqual(self.schedule1.status, "running")
 
     def test_pipelineschedule_latest_run_date(self):
-        self.assertEqual(self.schedule1.latest_run_date, self.run2.created_date)
+        self.run2.set_run_started()
+        self.assertEqual(self.schedule1.latest_run_date, self.run2.run_start_date)
 
     def test_pipelineschedule_all_runs(self):
         self.assertEqual(self.schedule1.all_runs.count(), 2)

vulnerabilities/views.py

@@ -389,6 +389,7 @@ def get_context_data(self, **kwargs):
             pipeline_id=self.kwargs["pipeline_id"],
         )
         context["pipeline_name"] = pipeline.pipeline_class.__name__
+        context["pipeline_description"] = pipeline.description
         return context