feat: Added serialize method to CodebaseResource class

Signed-off-by: abanoubfarhan <[email protected]>

Author: abanoub-samy-farhan

scanpipe/models.py

@@ -2855,7 +2855,7 @@ def parent(self, codebase=None):
         """
         parent_path = self.parent_path()
         return parent_path and self.project.codebaseresources.get(path=parent_path)
-
+    
     def siblings(self, codebase=None):
         """
         Return a sequence of sibling Resource objects for this Resource
@@ -3078,6 +3078,18 @@ def as_spdx(self):
             types=self.get_spdx_types(),
         )
 
+    def serialize(self):
+        """
+        Return a mapping of represting this CodebaseResource and it's data in a form
+        that can be serialized to JSON, YAML, etc. it can be used to reconstruct 
+        the resource
+        """
+        serializable = defaultdict(dict)
+        serializable["name"] = self.name
+        serializable["type"] = self.type.value
+        if self.location:
+            serializable["location"] = self.location
+        return dict(serializable)
 
 class CodebaseRelation(
     UUIDPKModel,

scanpipe/tests/test_models.py

@@ -1917,6 +1917,24 @@ def test_scanpipe_codebase_resource_ancestors(self):
             "asgiref-3.3.0-py3-none-any.whl-extract/asgiref",
         ]
         self.assertEqual(expected, [resource.path for resource in ancestors])
+    
+    def test_scanpipe_codebase_resource_serialize(self):
+        resource1 = make_resource_file(self.project1, path="pathtoresource/resource1")
+        expected = {
+            "location": resource1.location,
+            "type": "file",
+            "name": "resource1",
+        }
+        self.assertEqual(expected, resource1.serialize())
+
+        resource2 = make_resource_directory(self.project1, path="pathtodir/resource2")
+        expected = {
+            "location": resource2.location,
+            "type": "directory",
+            "name": "resource2",
+        }
+        self.assertEqual(expected, resource2.serialize())
+
 
     def test_scanpipe_codebase_resource_children(self):
         path = "asgiref-3.3.0-py3-none-any.whl-extract"