ci: Add unit tests

.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Python package
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "pypy3.9", "pypy3.10"]
+        exclude:
+          - os: macos-latest
+            python-version: "3.9"
+          - os: windows-latest
+            python-version: "3.9"
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Cache pip dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Test with pytest
+        run: |
+          pip install pytest pytest-cov
+          pytest tests/ --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html

.gitignore

@@ -161,5 +161,5 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-# demo, test folder
-!demo/**
+# testdata folder
+!tests/testdata/**

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "python.testing.pytestArgs": ["tests"],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

README.md

@@ -78,6 +78,12 @@ pip install -r requirements.txt
 python -m files_flattener.cli <directory> <output_file> [<ignore_file>]
 ```
 
+#### Run the tests
+
+```sh
+pytest tests/
+```
+
 #### Build the package
 
 Ensure `wheel` is installed:
@@ -108,10 +114,9 @@ Upload the distribution files to PyPI:
 
 ## TODO
 
+- [ ] feat: Add support for spcifying the git repository to clone and flatten.
 - [ ] refactor: Use click package to implement the CLI.
-- [ ] Add dry-run mode to preview the output before writing to the file.
-
-- [x] Use `.ignore` to exclude or include files for flattening.
+- [ ] feat: Add dry-run mode to preview the output before writing to the file.
 
 ## License
 

files_flattener/core.py

@@ -2,7 +2,7 @@
 import pathspec
 from concurrent.futures import ThreadPoolExecutor
 
-from .directory_handler import (
+from .identifier_handler import (
     DirectoryHandlerFactory,
     LocalDirectoryHandler,
     RemoteRepositoryHandler,

files_flattener/directory_handler.py → files_flattener/identifier_handler.py

@@ -3,20 +3,20 @@
 from .common import logger
 
 
-class DirectoryHandler:
+class IdentifierHandler:
     def __init__(self, identifier):
         self.identifier = identifier
 
     def prepare(self):
         raise NotImplementedError
 
 
-class LocalDirectoryHandler(DirectoryHandler):
+class LocalDirectoryHandler(IdentifierHandler):
     def prepare(self):
         self.local_directory = self.identifier
 
 
-class RemoteRepositoryHandler(DirectoryHandler):
+class RemoteRepositoryHandler(IdentifierHandler):
     def prepare(self):
         self.local_directory = tempfile.mkdtemp()
         logger.warning(

requirements.txt

@@ -3,5 +3,6 @@ colorlog
 GitPython
 
 # For development
+pytest
 twine
 wheel

tests/absimport.py

@@ -0,0 +1,4 @@
+import sys
+import os
+
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

tests/test_core.py

@@ -0,0 +1,18 @@
+import absimport  # FIRST LINE
+import pytest
+from files_flattener.core import list_files
+from files_flattener.identifier_handler import LocalDirectoryHandler
+
+
+@pytest.mark.parametrize(
+    "identifier, ignore_file, ignored",
+    [
+        ("tests/testdata/target", None, "folder1/file2.txt"),
+        ("tests/testdata/target", "tests/testdata/.ignore", "folder1/file2.txt"),
+    ],
+)
+def test_list_files(identifier, ignore_file, ignored):
+    files, handler = list_files(identifier, ignore_file)
+    assert isinstance(files, list)
+    assert isinstance(handler, LocalDirectoryHandler)
+    assert ignored not in files if ignore_file else ignored in files

tests/testdata/.ignore

@@ -0,0 +1 @@
+folder1/file2.txt