Merge pull request #2 from hija/tests

added basic tests

Author: hija

.github/workflows/main.yml

@@ -0,0 +1,19 @@
+name: main
+
+on:
+  push:
+    branches: [main, test-me-*]
+    tags: '*'
+  pull_request:
+
+jobs:
+  main-windows:
+    uses: asottile/workflows/.github/workflows/tox.yml@v1.6.0
+    with:
+      env: '["py38"]'
+      os: windows-latest
+  main-linux:
+    uses: asottile/workflows/.github/workflows/tox.yml@v1.6.0
+    with:
+      env: '["py38", "py39", "py310", "py311", "py312", "py313"]'
+      os: ubuntu-latest

README.md

@@ -1,3 +1,4 @@
+[![build status](https://github.com/hija/clean-dotenv/actions/workflows/main.yml/badge.svg)](https://github.com/hija/clean-dotenv/actions/workflows/main.yml)
 [![PyPI version](https://badge.fury.io/py/clean-dotenv.svg)](https://badge.fury.io/py/clean-dotenv)
 
 clean-dotenv
@@ -38,7 +39,7 @@ Consult `clean-dotenv --help` for the full set of options.
 
 Common options:
 
-- `--root path`: Defines the root path in which to look for .env files
+- `--root path`: Defines the root path in which to look for .env files. This is **not recursive**
 
 ## As a pre-commit hook
 

clean_dotenv.py

@@ -1,9 +1,10 @@
 import os
 import argparse
+from typing import Iterator
 import dotenv.main
 
 
-def clean_env(path_to_env: str):
+def _clean_env(path_to_env: str):
     # Open the .env file and remove the sensitive data
     # We rely on python-dotenv to parse the file, since we do not want to write our own parser
 
@@ -18,13 +19,19 @@ def clean_env(path_to_env: str):
             print(f"{key}=", file=example_env_f)
 
 
-def clean_dotenv_files(path_to_root: str):
+def _find_dotenv_files(path_to_root: str) -> Iterator[str]:
+    # Finds and yields .env files in the path_to_root
+    for entry in os.scandir(path_to_root):
+        if entry.name.endswith(".env") and entry.is_file():
+            # Create a cleaned .env.example file for the found .env file
+            yield entry.path
+
+
+def _main(path_to_root: str):
     # Find possible .env files
-    with os.scandir(path_to_root) as it:
-        for entry in it:
-            if entry.name.endswith(".env") and entry.is_file():
-                # Create a cleaned .env.example file for the found .env file
-                clean_env(entry.path)
+    for dotenv_file in _find_dotenv_files(path_to_root):
+        # Clean dotenv file
+        _clean_env(dotenv_file)
 
 
 def main():
@@ -38,7 +45,7 @@ def main():
         default=os.getcwd(),
     )
     args = parser.parse_args()
-    clean_dotenv_files(args.root_path)
+    _main(args.root_path)
 
 
 if __name__ == "__main__":

requirements-dev.txt

@@ -0,0 +1,4 @@
+-r requirements.txt
+pytest
+coverage
+covdefaults

tests/__init__.py

@@ -0,0 +1,85 @@
+from os import DirEntry
+from unittest.mock import MagicMock, call, mock_open, patch
+import pytest
+import clean_dotenv
+
+
+class DirEntry:
+    def __init__(self, path, is_file=True):
+        self.path = path
+        self.name = path
+        self._is_file = is_file
+
+    def path(self):  # pragma: no cover
+        return self.path
+
+    def is_file(self):
+        return self._is_file
+
+
+@patch("os.scandir")
+def test_find_dotenv_files(mock_scandir):
+    # Mock os.scandir() for files
+    mock_scandir.return_value = [
+        DirEntry(filename)
+        for filename in ["test.py", "abba", "env", "test.env", ".env"]
+    ]
+    assert list(clean_dotenv._find_dotenv_files(None)) == ["test.env", ".env"]
+
+    # Mock os.scandir() for directories
+    mock_scandir.return_value = [
+        DirEntry(filename, is_file=False)
+        for filename in ["test.py", "abba", "env", "test.env", ".env", "env"]
+    ]
+    assert list(clean_dotenv._find_dotenv_files(None)) == []
+
+
+@patch("dotenv.main.DotEnv")
+def test_clean_env_function(mock_dotenv):
+    dotenv_dict = {"KEY1": "secret_value1", "KEY2": "secret_value2"}
+    mock_dotenv.return_value.dict.return_value.items.return_value = dotenv_dict.items()
+
+    with patch("builtins.open", mock_open()) as mock_file:
+        clean_dotenv._clean_env("test.env")
+        mock_file.assert_called_with("test.env.example", "w")
+        expected_calls = [call("KEY1="), call("\n"), call("KEY2="), call("\n")]
+        mock_file.return_value.write.assert_has_calls(expected_calls)
+
+
+def test_find_dotenv_files_function():
+    with patch("os.scandir") as mock_scandir:
+        mock_scandir.return_value = [DirEntry("test.env")]
+
+        result = list(clean_dotenv._find_dotenv_files("path_to_root"))
+
+        assert result == ["test.env"]
+
+
+@patch("argparse.ArgumentParser.parse_args")
+@patch("clean_dotenv._main")
+def test_main(mock_main, mock_parse_args):
+    mock_parse_args.return_value = MagicMock(root_path="test_rpath")
+
+    clean_dotenv.main()
+
+    mock_main.assert_called_once_with("test_rpath")
+
+
+def test__main():
+    # Mock _find_dotenv_files
+    mm_find_dotenv = MagicMock(return_value=[".env", "test.env"])
+    clean_dotenv._find_dotenv_files = mm_find_dotenv
+
+    # Mock _clean_env
+    mm_clean_env = MagicMock()
+    clean_dotenv._clean_env = mm_clean_env
+
+    # Call main method
+    clean_dotenv._main("test_directory")
+
+    # Detection should be called once
+    mm_find_dotenv.assert_called_once_with("test_directory")
+
+    # The creation of new .env file should be called twice, last with "test.env"
+    assert mm_clean_env.call_count == 2
+    mm_clean_env.assert_called_with("test.env")

tests/main_test.py

@@ -0,0 +1,9 @@
+[tox]
+envlist = py,pre-commit
+
+[testenv]
+deps = -rrequirements-dev.txt
+commands =
+    coverage erase
+    coverage run -m pytest {posargs:tests}
+    coverage report