🔧 Melhorando qualidade do codigo

- [Test] - Cobertura de test para as funções do arquivo utils.py
- [Codacy] Corrigindo as 3 issues de possível falha de segurança no codigo

Author: AyslanBatista

encryptdef/__main__.py

@@ -3,4 +3,5 @@
 from encryptdef.cli import main
 
 if __name__ == "__main__":
-    main()
+    # Passando um contexto vazio
+    main(ctx=None)

encryptdef/cli.py

@@ -1,7 +1,7 @@
 """Módulo responsável por todos os comandos CLI"""
 
 from importlib.metadata import version
-from typing import Any, List, Optional
+from typing import List, Optional
 
 import rich_click as click
 
@@ -21,7 +21,7 @@
 @click.group(invoke_without_command=True)
 @click.version_option(version("encryptdef"))
 @click.pass_context
-def main(ctx: Any) -> None:
+def main(ctx: Optional[click.Context] = None) -> None:
     """Encryptdef
 
     Ferramenta de linha de comando em Python para encriptar e desencriptar
@@ -40,6 +40,9 @@ def main(ctx: Any) -> None:
     > **Mantenha a chave de encriptação em segredo e não a perca. Sem a chave
     correta, não será possível desencriptar os dados ou arquivos.**
     """
+    if ctx is None:
+        ctx = click.Context(main)
+
     if ctx.invoked_subcommand is None:
         core.interactive_mode()
 

encryptdef/interactive_interface.py

@@ -15,6 +15,7 @@
     TEMPLATE_INFO,
     TEMPLATE_LOGO,
 )
+from encryptdef.utils import clear_console
 
 
 def print_template_logo(info: bool = False) -> None:
@@ -24,7 +25,7 @@ def print_template_logo(info: bool = False) -> None:
     Args:
         info (bool): Se True, imprime também as informações da ferramenta.
     """
-    os.system("clear")
+    clear_console()
     console.print(TEMPLATE_LOGO)
 
     if info:
@@ -70,7 +71,7 @@ def validate_and_get_input(prompts: List[str]) -> List[str]:
             return inputs
 
         except ValueError as e:
-            os.system("clear")
+            clear_console()
             print_template_logo()
             print_and_record_log(str(e), "error")
 
@@ -102,7 +103,7 @@ def print_request_menu(menu: str) -> int:
             return int(choice)
 
         except ValueError as e:
-            os.system("clear")
+            clear_console()
             print_template_logo(info=True)
             print_and_record_log(str(e), "error")
 

encryptdef/utils.py

@@ -2,6 +2,7 @@
 
 import os
 import re
+import subprocess
 from typing import List
 
 from encryptdef.template import TEMPLATE_IS_DIRECTORY
@@ -85,3 +86,11 @@ def write_file(new_file_path: str, processed_lines: List[str]) -> None:
     """
     with open(new_file_path, "w", encoding="utf-8") as file_a:
         file_a.writelines(processed_lines)
+
+
+def clear_console():
+    """Limpa o console de forma segura."""
+    if os.name == "posix":
+        subprocess.run(["clear"], check=False)
+    elif os.name == "nt":
+        subprocess.run(["cls"], shell=True, check=False)

tests/test_assigning_a_name_file.py

@@ -0,0 +1,23 @@
+""" Modulo para testar a função assigning_a_name_file em utils.py"""
+
+from encryptdef.utils import assigning_a_name_file
+
+
+def test_assigning_a_name_file_absolute():
+    """Test function assigning_a_name_file"""
+    file = "/tmp/test/file-test-123.txt"
+    name = "encrypt-"
+    expected_result = "/tmp/test/encrypt-file-test-123.txt"
+
+    result = assigning_a_name_file(file, name)
+    assert result == expected_result
+
+
+def test_assigning_a_name_file_relative():
+    """Test function assigning_a_name_file"""
+    file = "-123-file-test.txt"
+    name = "decrypt-"
+    expected_result = "decrypt--123-file-test.txt"
+
+    result = assigning_a_name_file(file, name)
+    assert result == expected_result

tests/test_clear_console.py

@@ -0,0 +1,23 @@
+""" Modulo para testar a função clear_console em utils.py"""
+
+from unittest import mock
+
+from encryptdef.utils import clear_console
+
+
+@mock.patch("subprocess.run")  # Substitui subprocess.run por um mock
+def test_clear_console_posix(mock_run):
+    """Test function clear_console"""
+    with mock.patch("os.name", "posix"):
+        clear_console()
+
+    # Verifica se subprocess.run foi chamado com ["cls"] e check=False
+    mock_run.assert_called_once_with(["clear"], check=False)
+
+
+@mock.patch("subprocess.run")
+def test_clear_console_nt(mock_run):
+    """Test function clear_console"""
+    with mock.patch("os.name", "nt"):
+        clear_console()
+    mock_run.assert_called_once_with(["cls"], shell=True, check=False)

tests/test_get_new_file_path.py

@@ -2,17 +2,34 @@
 
 import os
 
+import pytest
+
 from encryptdef.utils import get_new_file_path
 
 
 def test_get_new_file_path_positive():
     """Test function get_new_file_path"""
+    current_dir = os.getcwd()
     file = "file_test.txt"
     new_file = "encrypt_file_test.txt"
-    current_dir = os.getcwd()
+    expected_path = os.path.join(current_dir, new_file)
+
     file_path = get_new_file_path(file, new_file, current_dir)
+    assert file_path == expected_path
+
+
+def test_get_new_file_path_is_directory_error():
+    """Test function get_new_file_path"""
+    current_dir = os.getcwd()
+    directoty = "new_directory"
+    directoty_path = os.path.join(current_dir, directoty)
+    os.mkdir(directoty_path)
+
+    with pytest.raises(IsADirectoryError):
+        get_new_file_path(directoty_path, "new_test.txt", current_dir)
 
-    assert file_path == os.path.join(os.getcwd(), new_file)
+    with pytest.raises(IsADirectoryError):
+        get_new_file_path("test.txt", directoty_path, current_dir)
 
 
 def test_get_new_file_path_positive_exact_file_path():
@@ -22,6 +39,6 @@ def test_get_new_file_path_positive_exact_file_path():
 
     current_dir = os.getcwd()
     new_file_path = os.path.join(current_dir, new_file)
-    file_path_get = get_new_file_path(file, new_file_path, current_dir)
 
-    assert file_path_get == new_file_path
+    new_file_path_get = get_new_file_path(file, new_file_path, current_dir)
+    assert new_file_path_get == new_file_path