Add write_data_as_yaml function to federatedcode pipes

Signed-off-by: Jono Yang <[email protected]>

Author: JonoYang

scanpipe/pipes/federatedcode.py

@@ -31,6 +31,7 @@
 from django.conf import settings
 
 import requests
+import saneyaml
 from git import Repo
 from packageurl import PackageURL
 
@@ -192,9 +193,7 @@ def commit_and_push_changes(
     """
     files_to_commit = [file_to_commit]
     commit_changes(
-        repo=repo,
-        files_to_commit=files_to_commit,
-        commit_message=commit_message
+        repo=repo, files_to_commit=files_to_commit, commit_message=commit_message
     )
     push_changes(
         repo=repo,
@@ -205,3 +204,14 @@ def commit_and_push_changes(
 def delete_local_clone(repo):
     """Remove local clone."""
     shutil.rmtree(repo.working_dir)
+
+
+def write_data_as_yaml(base_path, file_path, data):
+    """
+    Write the ``data`` as YAML to the ``file_path`` in the ``base_path`` root directory.
+    Create directories in the path as needed.
+    """
+    write_to = Path(base_path) / Path(file_path)
+    write_to.parent.mkdir(parents=True, exist_ok=True)
+    with open(write_to, encoding="utf-8", mode="w") as f:
+        f.write(saneyaml.dump(data))

scanpipe/tests/pipes/test_federatedcode.py

@@ -28,6 +28,7 @@
 from django.test import TestCase
 
 import git
+import saneyaml
 
 from scanpipe import models
 from scanpipe.pipes import federatedcode
@@ -77,3 +78,28 @@ def test_scanpipe_pipes_federatedcode_delete_local_clone(self):
         federatedcode.delete_local_clone(repo)
 
         self.assertEqual(False, Path(local_dir).exists())
+
+    def test_scanpipe_pipes_federatedcode_write_data_as_yaml(self):
+        # create local repo
+        local_dir = tempfile.mkdtemp()
+        repo = git.Repo.init(local_dir)
+
+        # write data
+        data = ["123", "abc", 3]
+        federatedcode.write_data_as_yaml(
+            base_path=repo.working_dir,
+            file_path="test.yml",
+            data=data,
+        )
+
+        # Check if file was written
+        test_file_path = Path(repo.working_dir) / "test.yml"
+        self.assertEqual(True, test_file_path.exists())
+        with open(test_file_path) as f:
+            contents = f.read()
+        yml = saneyaml.load(contents)
+        expected_results = ["123", "abc", "3"]
+        self.assertEqual(expected_results, yml)
+
+        # clean up
+        shutil.rmtree(repo.working_dir)