From 51bbf98b50834061699bb95c49d01b3398f9a687 Mon Sep 17 00:00:00 2001
From: Jan Max Tiedemann <jan.max.tiedemann@bakdata.com>
Date: Wed, 9 Oct 2024 05:53:34 +0200
Subject: [PATCH] fix: add tests + delimiter global + removal of pycache from
 gitignore

---
 .gitignore                                 |  1 +
 actions/parse-secrets-definitions/main.py  |  9 +++++----
 actions/parse-secrets-definitions/tests.py | 17 +++++++++++++++++
 3 files changed, 23 insertions(+), 4 deletions(-)
 create mode 100644 actions/parse-secrets-definitions/tests.py

diff --git a/.gitignore b/.gitignore
index d01517ef2..b63051c05 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,4 @@
 tmp*
 auto-doc*
 ./test*
+**/__pycache__/
diff --git a/actions/parse-secrets-definitions/main.py b/actions/parse-secrets-definitions/main.py
index 5239db355..ef7e97656 100644
--- a/actions/parse-secrets-definitions/main.py
+++ b/actions/parse-secrets-definitions/main.py
@@ -1,6 +1,8 @@
 import os
 import re
 
+DELIMITER = "!!!"
+
 # CAVEAT: will only work for one project at a time
 # might be problematic if we want to inject secrets from multiple projects
 
@@ -10,7 +12,7 @@
 #  https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter
 def set_github_action_output(output_name, output_value, delim=''):
     f = open(os.path.abspath(os.environ["GITHUB_OUTPUT"]), "a")
-    f.write(f'{output_name}<<!!!\n{output_value}!!!\n') # ATTENTION: this might lead to problems if the output value contains the delimiter, which will not happen in this program but dont just copy this and expect it to work
+    f.write(f'{output_name}<<{DELIMITER}\n{output_value}{DELIMITER}\n') # ATTENTION: this might lead to problems if the output value contains the delimiter, which will not happen in this program but dont just copy this and expect it to work
     f.close()    
 
 
@@ -19,7 +21,7 @@ def set_github_action_output(output_name, output_value, delim=''):
 # if the secret would end in an underscore, remove it
 # format: SECRET_NAME:PROJECT_NAME/SECRET_NAME/VERSION
 def parse_secret(secret, project_name):
-    if "!!!" in secret: 
+    if DELIMITER in secret: 
         raise ValueError("Invalid secret definition: !!! is a reserved keyword")
     components = secret.split("/")
 
@@ -45,5 +47,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
-    # print(parse_secret("alksdjoioe4j####@!@#!1123asdlolw!!asd!!print(/1", "project"))
\ No newline at end of file
+    main()
\ No newline at end of file
diff --git a/actions/parse-secrets-definitions/tests.py b/actions/parse-secrets-definitions/tests.py
new file mode 100644
index 000000000..6b806ef95
--- /dev/null
+++ b/actions/parse-secrets-definitions/tests.py
@@ -0,0 +1,17 @@
+import unittest
+
+from main import parse_secret
+
+class TestParseSecret(unittest.TestCase):
+    def test_parse_secret(self):
+        self.assertEqual(parse_secret("secret_name", "project_name"), "SECRET_NAME:project_name/secret_name")
+        self.assertEqual(parse_secret("secret_name/version", "project_name"), "SECRET_NAME:project_name/secret_name/version")
+        self.assertEqual(parse_secret("123-456", "project_name"), "123_456:project_name/123-456")
+        self.assertEqual(parse_secret("123___123___123", "project_name"), "123_123_123:project_name/123___123___123")
+
+    def test_parse_secret_special(self):
+        # FIXME: this test is failing
+        self.assertEqual(parse_secret("123&&123()123__123*__*_123", "project_name"), "123_123_123_123:project_name/123&&123()123__123*__*_123")
+
+if __name__ == '__main__':
+    unittest.main()
\ No newline at end of file