test: refactored tests to inherit from python unittest module

Author: opensaucerer

lighthouse/axios.py

@@ -49,9 +49,11 @@ def post_files(
             files = utils.read_files_for_upload(file)
             r = req.post(self.url, headers=headers, files=files)
             r.raise_for_status()
+            utils.close_files_after_upload(files)
             try:
                 return r.json()
             except Exception:
                 return r.text
         except Exception as e:
+            utils.close_files_after_upload(files)
             raise e

lighthouse/utils.py

@@ -28,7 +28,9 @@ def extract_file_name_with_source(file: str, source: str) -> str:
     return base + file.split(base)[-1]
 
 
-def read_files_for_upload(files: t.FileDict) -> List[Tuple[BufferedReader]]:
+def read_files_for_upload(
+    files: t.FileDict,
+) -> List[Tuple[str, Tuple[str, BufferedReader, str]]]:
     file_list = []
     for file in files["files"]:
         if files["is_dir"]:
@@ -54,3 +56,10 @@ def read_files_for_upload(files: t.FileDict) -> List[Tuple[BufferedReader]]:
                 ),
             )
     return file_list
+
+
+def close_files_after_upload(
+    files: List[Tuple[str, Tuple[str, BufferedReader, str]]]
+) -> None:
+    for file in files:
+        file[1][1].close()

readme.md

@@ -7,3 +7,25 @@ Lighthouse is a permanent decentralized file storage protocol that allows the ab
 ```
 pip install lighthouse.py
 ```
+
+# Testing
+
+The tests are written with inheritance from the unittest module. To run the tests, run the following command:
+
+```
+pip install requirements.txt && python -m unittest discover
+```
+
+or using nose2
+
+```
+pip install requirements.txt && python -m nose2
+```
+
+# Bundling
+
+To bundle the library, run the following command:
+
+```
+python setup.py
+```

requirements.txt

@@ -4,6 +4,7 @@ charset-normalizer==2.1.1
 click==8.1.3
 idna==3.4
 mypy-extensions==0.4.3
+nose2==0.12.0
 pathspec==0.10.1
 platformdirs==2.5.2
 requests==2.28.1

setup.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python3
+
+
+def pip_setup():
+
+    pass

tests/deploy.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python3
 
 import os
-from . import deploy as dt
 
 
 def parse_env():
@@ -16,14 +15,3 @@ def parse_env():
     except FileNotFoundError:
         print("No .env file found")
         print("Defaulting to preset environment variables...")
-
-
-def run_test():
-    """setup test environment and run tests"""
-    parse_env()
-    dt.test_deploy_file()
-    dt.test_deploy_dir()
-
-
-if __name__ == "__main__":
-    run_test()

tests/setup.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+
+import os
+import unittest
+from main import Lighthouse
+from .setup import parse_env
+
+
+class TestDeploy(unittest.TestCase):
+    def setUp(self) -> None:
+        """setup test environment"""
+        parse_env()
+
+    def test_deploy_file(self):
+        """test deploy function"""
+        l = Lighthouse(os.environ.get("LH_TOKEN", ""))
+        res = l.deploy("tests/testdir/testfile.txt")
+        self.assertNotEqual(res.get("data"), None, "data is None")
+        self.assertNotEqual(res.get("data").get("Hash"), None, "data is None")
+
+    def test_deploy_dir(self):
+        """test deploy function"""
+        l = Lighthouse(os.environ["LH_TOKEN"])
+        res = l.deploy("tests/testdir")
+        self.assertNotEqual(res.get("data"), None, "data is None")
+        self.assertIsInstance(res.get("data"), str, "data is a string")
+        self.assertIn("Hash", res.get("data"), "Hash is in data")
+
+
+if __name__ == "__main__":
+    unittest.main()