Add coverage

.github/workflows/python-tests.yml

@@ -1,4 +1,4 @@
-name: Python application test
+name: Python application tests
 
 on:
   push:
@@ -22,4 +22,11 @@ jobs:
           make dependency
       - name: Test with pytest
         run: |
-          make testing
+          make testing
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v2
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: true

.gitignore

@@ -38,7 +38,7 @@ MANIFEST
 pip-log.txt
 pip-delete-this-directory.txt
 
-# Unit test / coverage reports
+# Unit tests / coverage reports
 htmlcov/
 .tox/
 .nox/

makefile

@@ -14,7 +14,7 @@ dependency:
 
 testing:
 	@echo "Testing code..."
-	pytest
+	pytest --cov=core --cov-report=xml tests/
 
 build:
 	@echo "Creating binary..."

requirements.txt

@@ -1,7 +1,7 @@
 pyinstaller==6.4.0
 argparse
 pyzipper==0.3.6
-pytest==8.0.2
 pydub==0.25.1
 numpy==1.26.4
-
+pytest==8.0.2
+coverage==7.4.3

test/test_encryption_core.py → tests/test_encryption_core.py

@@ -2,13 +2,13 @@
 import shutil
 
 from core.encryption_core import EncryptionCore
-from test.test_helper import audio_content_compare, binary_compare
+from tests.test_helper import audio_content_compare, binary_compare
 
 
 def test_encrypt_without_pass():
-    input_file = 'test/data/song_orig.mp3'
+    input_file = 'tests/data/song_orig.mp3'
     out_file = 'out.mp3'
-    files = ['test/data/very_secret_doc.pdf']
+    files = ['tests/data/very_secret_doc.pdf']
 
     core = EncryptionCore(
         infile=input_file,
@@ -25,9 +25,9 @@ def test_encrypt_without_pass():
 
 
 def test_encrypt_with_pass():
-    input_file = 'test/data/song_orig.mp3'
+    input_file = 'tests/data/song_orig.mp3'
     out_file = 'out.mp3'
-    files = ['test/data/very_secret_doc.pdf']
+    files = ['tests/data/very_secret_doc.pdf']
     password = 'myawesomepass'
 
     core = EncryptionCore(
@@ -46,10 +46,10 @@ def test_encrypt_with_pass():
 
 
 def test_decrypt_without_pass():
-    input_file = 'test/data/out_without_pwd.mp3'
+    input_file = 'tests/data/out_without_pwd.mp3'
     out_folder = 'db0c7f89-f931-4e51-919d-1c91375f3742'
     out_file = f'{out_folder}/very_secret_doc.pdf'
-    orig_file = 'test/data/very_secret_doc.pdf'
+    orig_file = 'tests/data/very_secret_doc.pdf'
 
     core = EncryptionCore(infile=input_file)
 
@@ -63,10 +63,10 @@ def test_decrypt_without_pass():
 
 
 def test_decrypt_with_pass():
-    input_file = 'test/data/out_with_password.mp3'
+    input_file = 'tests/data/out_with_password.mp3'
     out_folder = '55b32fdd-5daf-4a05-bb54-8c5bfd17cc18'
     out_file = f'{out_folder}/very_secret_doc.pdf'
-    orig_file = 'test/data/very_secret_doc.pdf'
+    orig_file = 'tests/data/very_secret_doc.pdf'
     password = 'myawesomepass'
 
     core = EncryptionCore(infile=input_file, passphrase=password)
@@ -81,7 +81,7 @@ def test_decrypt_with_pass():
 
 
 def test_decrypt_with_invalid_pass():
-    input_file = 'test/data/out_with_password.mp3'
+    input_file = 'tests/data/out_with_password.mp3'
     out_folder = '55b32fdd-5daf-4a05-bb54-8c5bfd17cc18'
     password = 'invalidpasswprd'
 

test/test_file_metadata.py → tests/test_file_metadata.py

@@ -4,8 +4,8 @@
 
 
 def test_file_metadata_setup():
-    filename = 'test.zip'
-    filepath = 'test/test.zip'
+    filename = 'tests.zip'
+    filepath = 'tests/tests.zip'
 
     meta = FileMetaData(filename=filename, filepath=filepath)
 
@@ -14,7 +14,7 @@ def test_file_metadata_setup():
 
 
 def test_file_metadata_setup_filename_only():
-    filename = 'test.zip'
+    filename = 'tests.zip'
     meta = FileMetaData(filename=filename)
 
     assert meta.filename == filename
@@ -23,9 +23,9 @@ def test_file_metadata_setup_filename_only():
 
 
 def test_file_metadata_setup_all_fields():
-    filename = 'test.zip'
+    filename = 'tests.zip'
     filename_json = 'test2.zip'
-    filepath = 'test/test.zip'
+    filepath = 'tests/tests.zip'
     json_data = '{"filename": "' + filename_json + '"}'
 
     meta = FileMetaData(filename=filename, filepath=filepath, json_data=json_data.encode())
@@ -74,12 +74,12 @@ def test_file_metadata_empty():
 
 
 def test_to_json_string():
-    filename = 'test.zip'
+    filename = 'tests.zip'
     meta = FileMetaData(filename=filename)
 
 
 def test_encode():
-    filename = 'test.zip'
+    filename = 'tests.zip'
     delimiter = '===='
     json_data = json.dumps({"filename": filename})
     expected = f"\n{delimiter}{json_data}{delimiter}\n".encode()
@@ -90,7 +90,7 @@ def test_encode():
 
 
 def test_is_zip():
-    filename = 'test.rar'
+    filename = 'tests.rar'
     meta = FileMetaData(filename=filename)
 
     assert not meta.is_zip()

test/test_zip_helper.py → tests/test_zip_helper.py

@@ -3,7 +3,7 @@
 import tempfile
 
 from core.zip_helper import create_tmp_zip_file, create_zip_from_paths, unzip_to_directory
-from test.test_helper import is_uuid_v4
+from tests.test_helper import is_uuid_v4
 
 
 def test_create_tmp_zip_file():
@@ -23,7 +23,7 @@ def test_create_tmp_zip_file():
 
 
 def test_zip_without_pass():
-    files = ['test/data/song_orig.mp3', 'test/data/very_secret_doc.pdf']
+    files = ['tests/data/song_orig.mp3', 'tests/data/very_secret_doc.pdf']
     arch_name = 'test_arch'
     arch_file = f'{arch_name}.zip'
     create_zip_from_paths(paths=files, output_zip_file=arch_file)
@@ -40,7 +40,7 @@ def test_zip_without_pass():
 
 
 def test_zip_with_pass_success():
-    files = ['test/data/song_orig.mp3', 'test/data/very_secret_doc.pdf']
+    files = ['tests/data/song_orig.mp3', 'tests/data/very_secret_doc.pdf']
     arch_name = 'test_arch'
     arch_file = f'{arch_name}.zip'
     password = '1234'
@@ -59,7 +59,7 @@ def test_zip_with_pass_success():
 
 
 def test_zip_with_pass_failed():
-    files = ['test/data/song_orig.mp3', 'test/data/very_secret_doc.pdf']
+    files = ['tests/data/song_orig.mp3', 'tests/data/very_secret_doc.pdf']
     arch_name = 'test_arch'
     arch_file = f'{arch_name}.zip'
     password = '1234'
@@ -77,7 +77,7 @@ def test_zip_with_pass_failed():
 
 
 def test_zip_with_pass_wrong():
-    files = ['test/data/song_orig.mp3', 'test/data/very_secret_doc.pdf']
+    files = ['tests/data/song_orig.mp3', 'tests/data/very_secret_doc.pdf']
     arch_name = 'test_arch'
     arch_file = f'{arch_name}.zip'
     password = '1234'