minor fixes and adjustments following review feedback

Signed-off-by: Aayush Kumar <[email protected]>

Author: aayushkdev

scanpipe/migrations/0073_codebaseresource_parent_path_and_more.py

@@ -13,7 +13,7 @@ class Migration(migrations.Migration):
         migrations.AddField(
             model_name='codebaseresource',
             name='parent_path',
-            field=models.CharField(blank=True, help_text='Path of the immediate parent directory of a resource. For top level resources the value is set to None', max_length=2000, null=True),
+            field=models.CharField(blank=True, help_text='The path of the resource\'s parent directory. Set to None for top-level (root) resources. Used to efficiently retrieve a directory\'s contents.', max_length=2000, null=True),
         ),
         migrations.AddIndex(
             model_name='codebaseresource',

scanpipe/models.py

@@ -2691,8 +2691,9 @@ class CodebaseResource(
         null=True,
         blank=True,
         help_text=_(
-            "Path of the immediate parent directory of a resource. "
-            "For top level resources the value is set to None"
+            "The path of the resource's parent directory. "
+            "Set to None for top-level (root) resources. "
+            "Used to efficiently retrieve a directory's contents."
         ),
     )
 
@@ -2798,7 +2799,7 @@ def __str__(self):
 
     def save(self, *args, **kwargs):
         if self.path and not self.parent_path:
-            self.parent_path = parent_directory(str(self.path), with_trail=False)
+            self.parent_path = self.parent_directory()
         super().save(*args, **kwargs)
 
     @property
@@ -2868,7 +2869,8 @@ def get_path_segments_with_subpath(self):
 
     def parent_directory(self):
         """Return the parent path for this CodebaseResource or None."""
-        return parent_directory(self.path, with_trail=False)
+        parent_path = parent_directory(str(self.path), with_trail=False)
+        return None if parent_path == "" else parent_path
 
     def has_parent(self):
         """

scanpipe/pipes/rootfs.py

@@ -139,8 +139,9 @@ def get_res(parent, fname):
             rootfs_path=rootfs_path,
         )
 
+    # Explicitly yields the root directory as a resource when `with_dir` is True
     if with_dir:
-        rootfs_path = pipes.normalize_path("")
+        rootfs_path = "/"
         yield Resource(
             location=location,
             rootfs_path=rootfs_path,

scanpipe/tests/test_models.py

@@ -1596,7 +1596,7 @@ def test_scanpipe_codebase_resource_model_compliance_alert_update_fields(self):
     def test_scanpipe_codebase_root_parent_path(self):
         resource1 = self.project1.codebaseresources.create(path="file")
 
-        self.assertEqual("", resource1.parent_path)
+        self.assertIsNone(resource1.parent_path)
 
     def test_scanpipe_codebase_regular_parent_path(self):
         resource2 = self.project1.codebaseresources.create(path="dir1/dir2/file")

scanpipe/tests/test_pipelines.py

@@ -877,7 +877,7 @@ def test_scanpipe_scan_codebase_creates_top_level_paths(self):
         expected_top_level_paths = ["is-npm-1.0.0.tgz", "is-npm-1.0.0.tgz-extract"]
 
         top_level_resources = project1.codebaseresources.filter(parent_path=None)
-        top_level_paths = [res.path for res in top_level_resources]
+        top_level_paths = [resource.path for resource in top_level_resources]
 
         self.assertListEqual(top_level_paths, expected_top_level_paths)
 
@@ -903,14 +903,14 @@ def test_scanpipe_scan_codebase_creates_parent_path_field(self):
         ]
 
         top_level_resources = project1.codebaseresources.filter(parent_path=None)
-        top_level_paths = [res.path for res in top_level_resources]
+        top_level_paths = [resource.path for resource in top_level_resources]
 
         self.assertListEqual(top_level_paths, expected_top_level_paths)
 
         nested_resources = project1.codebaseresources.filter(
             parent_path="is-npm-1.0.0.tgz-extract/package"
         )
-        nested_paths = [res.path for res in nested_resources]
+        nested_paths = [resource.path for resource in nested_resources]
 
         self.assertListEqual(nested_paths, expected_nested_paths)