Add white-out file tagging to Docker pipeline

Author: VarshaUN

scanpipe/migrations/0068_codebaseresource_is_whiteout.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.1 on 2025-03-22 14:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('scanpipe', '0067_discoveredpackage_notes'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='codebaseresource',
+            name='is_whiteout',
+            field=models.BooleanField(default=False, help_text='Indicates if this resource is a white-out file in a container scan.'),
+        ),
+    ]

scanpipe/models.py

@@ -2497,6 +2497,10 @@ class FileClassifierFieldsModelMixin(models.Model):
             "manifest file."
         ),
     )
+    is_whiteout = models.BooleanField(
+        default=False,
+        help_text="Indicates if this resource is a white-out file in a container scan."
+    )
 
     class Meta:
         abstract = True
@@ -2609,16 +2613,6 @@ class Type(models.TextChoices):
     )
 
     objects = CodebaseResourceQuerySet.as_manager()
-    labels = TaggableManager(through=UUIDTaggedItem, ordering=["name"])
-
-    @staticmethod
-    def is_white_out_file(file_path):
-        return file_path.endswith(".whiteout")
-
-    def tag_white_out_files(self):
-        if self.is_white_out_file(self.path):
-            self.labels.add("white-out")
-            self.save()
 
     class Meta:
         indexes = [

scanpipe/pipelines/docker.py

@@ -36,6 +36,7 @@ def steps(cls):
             cls.find_images_os_and_distro,
             cls.collect_images_information,
             cls.collect_and_create_codebase_resources,
+            cls.tag_whiteout_files,
             cls.collect_and_create_system_packages,
             cls.flag_uninteresting_codebase_resources,
             cls.flag_empty_files,
@@ -85,3 +86,10 @@ def flag_uninteresting_codebase_resources(self):
         """Flag files that don't belong to any system package."""
         docker.flag_whiteout_codebase_resources(self.project)
         rootfs.flag_uninteresting_codebase_resources(self.project)
+
+    def tag_whiteout_files(project):
+        """Tag resources that are white-out files in the container scan."""
+        for resource in project.codebaseresources.all():
+            if resource.name.startswith(".wh."):
+               resource.is_whiteout = True
+               resource.save(update_fields=["is_whiteout"])

scanpipe/pipes/resolve.py

@@ -53,8 +53,6 @@ def resolve_manifest_resources(resource,package_registry):
     for package_data in packages:
         package_data["codebase_resources"] = [resource]
 
-        resource.tag_white_out_files()
-
     return packages