fix tests to run on windows, add windows CI #146

.github/workflows/test.yml

@@ -15,7 +15,7 @@ on:
 
 jobs:
 
-  test:
+  test-linux:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -82,7 +82,64 @@ jobs:
     - name: Store coverage files
       uses: actions/upload-artifact@v4
       with:
-        name: coverage-py${{ matrix.python-version }}-dj${{ matrix.django-version }}
+        name: coverage-linux-py${{ matrix.python-version }}-dj${{ matrix.django-version }}
+        path: py${{ matrix.python-version }}-dj${{ matrix.django-version }}.coverage
+
+  test-windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.13']
+        django-version:
+          - '4.2' # LTS April 2026
+          - '5.1' # December 2025
+        exclude:
+          - python-version: '3.9'
+            django-version: '5.1'
+          - python-version: '3.13'
+            django-version: '4.2'
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+    - name: Install Release Dependencies
+      run: |
+        poetry config virtualenvs.in-project true
+        poetry run pip install --upgrade pip
+        poetry install
+        poetry run pip install -U "Django~=${{ matrix.django-version }}"
+    - name: Install VIM
+      if: ${{ github.event.inputs.debug == 'true' }}
+      uses: rhysd/action-setup-vim@v1
+    - name: Setup tmate session
+      if: ${{ github.event.inputs.debug == 'true' }}
+      uses: mxschmitt/action-tmate@v3
+      with:
+        detached: true
+      timeout-minutes: 60
+    - name: Run Unit Tests
+      run: |
+        poetry run pip install colorama
+        poetry run pytest
+        poetry run pip uninstall -y rich
+        poetry run pytest --cov-append
+        poetry run pip uninstall -y colorama
+        poetry run pytest -k test_ctor_params --cov-append
+        mv .coverage py${{ matrix.python-version }}-dj${{ matrix.django-version }}.coverage
+
+    - name: Store coverage files
+      uses: actions/upload-artifact@v4
+      with:
+        name: coverage-windows-py${{ matrix.python-version }}-dj${{ matrix.django-version }}
         path: py${{ matrix.python-version }}-dj${{ matrix.django-version }}.coverage
 
   linux-shell-completion:

django_typer/completers.py

@@ -52,6 +52,8 @@
 Completer = t.Callable[[Context, Parameter, str], t.List[CompletionItem]]
 Strings = t.Union[t.Sequence[str], t.KeysView[str], t.Generator[str, None, None]]
 
+PATH_SEPARATOR = os.sep
+
 
 class ModelObjectCompleter:
     """
@@ -494,7 +496,7 @@ def exists(pth: Path) -> bool:
     completions = []
     incomplete_path = Path(incomplete)
     partial_dir = ""
-    if not exists(incomplete_path) and not incomplete.endswith(os.sep):
+    if not exists(incomplete_path) and not incomplete.endswith(PATH_SEPARATOR):
         partial_dir = incomplete_path.name
         incomplete_path = incomplete_path.parent
     elif incomplete_path.is_file() and not dir_only:
@@ -508,7 +510,7 @@ def exists(pth: Path) -> bool:
                 completions.append(
                     CompletionItem(
                         f"{to_complete}"
-                        f"{'' if not to_complete or to_complete.endswith(os.sep) else os.sep}"
+                        f"{'' if not to_complete or to_complete.endswith(PATH_SEPARATOR) else PATH_SEPARATOR}"
                         f"{child}",
                         type="dir" if (incomplete_path / child).is_dir() else "file",
                     )

django_typer/management/__init__.py

@@ -2528,6 +2528,12 @@ class write method.
             msg = str(msg)
         return super().write(msg=msg, style_func=style_func, ending=ending)
 
+    def flush(self):
+        try:
+            super().flush()
+        except ValueError:
+            pass
+
 
 class TyperCommand(BaseCommand, metaclass=TyperCommandMeta):
     """

django_typer/management/commands/shellcompletion.py

@@ -502,12 +502,18 @@ def complete(
             :width: 80
             :convert-png: latex
         """
+        from django_typer import completers
+
         os.environ[self.COMPLETE_VAR] = (
             f"complete_{shell.value}"
             if shell
             else os.environ.get(self.COMPLETE_VAR, f"complete_{self.shell.value}")
         )
         self.shell = Shells(os.environ[self.COMPLETE_VAR].partition("_")[2])
+        if self.shell in [Shells.powershell, Shells.pwsh]:
+            completers.PATH_SEPARATOR = "\\"
+        else:
+            completers.PATH_SEPARATOR = "/"
 
         completion_init()
         CompletionClass = get_completion_class(  # pylint: disable=C0103

doc/source/changelog.rst

@@ -5,6 +5,7 @@ Change Log
 v3.0.0 (202X-XX-XX)
 ===================
 
+* Implemented `Run full test suite on windows in CI <https://github.com/django-commons/django-typer/issues/146>`_
 * Fixed `Typer-style interface throws an assertion when no callback is present on a subgroup. <https://github.com/django-commons/django-typer/issues/145>`_
 * Implemented `ANSI color control sequences should optionally be scrubbed from shell completions <https://github.com/django-commons/django-typer/issues/144>`_
 * Fixed `supressed_base_arguments are still present in the Context <https://github.com/django-commons/django-typer/issues/143>`_

pyproject.toml

@@ -58,7 +58,10 @@ classifiers = [
 [tool.poetry.dependencies]
 python = ">=3.9,<4.0"
 Django = ">=3.2,<6.0"
-click = ">=8.1.0"
+
+# TODO - replace after click 8.1.8 or 8.2 release, <= 8.1.7 has terminal color bug that fails on windows
+#click = ">=8.1.8"
+click = { git = "https://github.com/pallets/click.git", branch = "main" }
 
 # typer's release history is full of breaking changes for minor versions
 # given the reliance on some of its private internals we peg the typer
@@ -102,6 +105,8 @@ graphviz = ">=0.20.3"
 sphinx-tabs = ">=3.4.5"
 furo = ">=2024.7.18"
 pluggy = ">=1.5.0"
+pywinpty = { version = ">=2.0.14", markers = "sys_platform == 'win32'" }
+pytest-timeout = ">=2.3.1"
 
 [tool.poetry.extras]
 rich = ["rich"]

tests/test_callbacks.py

@@ -6,7 +6,7 @@
 from django.test import TestCase
 
 from django_typer.management import get_command
-from tests.utils import run_command
+from tests.utils import run_command, similarity
 
 
 class CallbackTests(TestCase):
@@ -15,10 +15,15 @@ class CallbackTests(TestCase):
     def test_helps(self, top_level_only=False):
         buffer = StringIO()
         cmd = get_command(self.cmd_name, stdout=buffer, no_color=True)
-        help_output_top = run_command(self.cmd_name, "--no-color", "--help")[0]
+        help_output_top, stderr = run_command(self.cmd_name, "--no-color", "--help")[
+            0:2
+        ]
         cmd.print_help("./manage.py", self.cmd_name)
-        self.assertEqual(help_output_top.strip(), buffer.getvalue().strip())
-        self.assertIn(f"Usage: ./manage.py {self.cmd_name} [OPTIONS]", help_output_top)
+        self.assertGreaterEqual(
+            similarity(help_output_top.strip(), buffer.getvalue().strip()), 0.99
+        )
+        self.assertIn(f"Usage: ", help_output_top)
+        self.assertIn(f"manage.py {self.cmd_name} [OPTIONS]", help_output_top)
 
         if not top_level_only:
             buffer.truncate(0)
@@ -27,9 +32,10 @@ def test_helps(self, top_level_only=False):
                 self.cmd_name, "--no-color", "5", self.cmd_name, "--help"
             )[0]
             cmd.print_help("./manage.py", self.cmd_name, self.cmd_name)
-            self.assertEqual(callback_help.strip(), buffer.getvalue().strip())
+            self.assertGreaterEqual(similarity(callback_help, buffer.getvalue()), 0.99)
+            self.assertIn(f"Usage: ", callback_help)
             self.assertIn(
-                f"Usage: ./manage.py {self.cmd_name} P1 {self.cmd_name} [OPTIONS] ARG1 ARG2",
+                f"manage.py {self.cmd_name} P1 {self.cmd_name} [OPTIONS] ARG1 ARG2",
                 callback_help,
             )
 

tests/test_chaining.py

@@ -13,19 +13,26 @@ def test_command_chaining(self):
         result = run_command(
             "chain", "command1", "--option=one", "command2", "--option=two"
         )[0]
-        self.assertEqual(result, "command1\ncommand2\n['one', 'two']\n")
+        self.assertEqual(
+            result.splitlines(), "command1\ncommand2\n['one', 'two']\n".splitlines()
+        )
 
         result = run_command(
             "chain", "command2", "--option=two", "command1", "--option=one"
         )[0]
-        self.assertEqual(result, "command2\ncommand1\n['two', 'one']\n")
+        self.assertEqual(
+            result.splitlines(), "command2\ncommand1\n['two', 'one']\n".splitlines()
+        )
 
         stdout = StringIO()
         with contextlib.redirect_stdout(stdout):
             result = call_command(
                 "chain", "command2", "--option=two", "command1", "--option=one"
             )
-        self.assertEqual(stdout.getvalue(), "command2\ncommand1\n['two', 'one']\n")
+        self.assertEqual(
+            stdout.getvalue().splitlines(),
+            "command2\ncommand1\n['two', 'one']\n".splitlines(),
+        )
         self.assertEqual(result, ["two", "one"])
 
         chain = get_command("chain")

tests/test_groups.py

@@ -71,7 +71,7 @@ def test_get_help_from_incongruent_path(self):
                             result.stdout,
                             (
                                 TESTS_DIR / "apps" / "test_app" / "helps" / "groups.txt"
-                            ).read_text(),
+                            ).read_text(encoding="utf-8"),
                         ),
                         0.99,  # width inconsistences drive this number < 1
                     )
@@ -91,7 +91,6 @@ def test_get_help_from_incongruent_path(self):
         ],
     )
     def test_helps(self, app="test_app"):
-        print("test_helps")
         for cmds in [
             ("groups",),
             ("groups", "echo"),
@@ -125,11 +124,14 @@ def test_helps(self, app="test_app"):
                         hlp,
                         (
                             TESTS_DIR / "apps" / app / helps_dir / f"{cmds[-1]}.txt"
-                        ).read_text(),
+                        ).read_text(encoding="utf-8"),
                     ),
                     0.99,  # width inconsistences drive this number < 1
                 )
             except AssertionError:
+                import pdb
+
+                pdb.set_trace()
                 raise
             print(f'{app}: {" ".join(cmds)} = {sim:.2f}')
 
@@ -217,7 +219,7 @@ def test_command_line(self, settings=None):
                 ("hey! " * 5).strip(),
             )
         else:
-            self.assertIn("Usage: ./manage.py groups echo [OPTIONS] MESSAGE", result[0])
+            self.assertIn("manage.py groups echo [OPTIONS] MESSAGE", result[0])
             self.assertIn("Got unexpected extra argument (5)", result[1])
             with self.assertRaises(TypeError):
                 call_command("groups", "echo", "hey!", echoes=5)
@@ -373,7 +375,7 @@ def test_command_line(self, settings=None):
         )
         if override:
             self.assertIn(
-                "Usage: ./manage.py groups string STRING case upper [OPTIONS]",
+                "manage.py groups string STRING case upper [OPTIONS]",
                 result[0],
             )
             self.assertIn("Got unexpected extra arguments (4 9)", result[1].strip())
@@ -410,15 +412,15 @@ def test_command_line(self, settings=None):
             parse_json=False,
         )
         if override:
-            self.assertEqual(result[0], "emmatc\n")
+            self.assertEqual(result[0].strip(), "emmatc")
             self.assertEqual(
                 call_command("groups", "string", " emmatc  ", "strip"), "emmatc"
             )
             grp_cmd.string(" emmatc  ")
             self.assertEqual(grp_cmd.strip(), "emmatc")
         else:
             self.assertIn(
-                "Usage: ./manage.py groups string [OPTIONS] STRING COMMAND [ARGS]",
+                "manage.py groups string [OPTIONS] STRING COMMAND [ARGS]",
                 result[0],
             )
             self.assertIn("No such command 'strip'.", result[1])

tests/test_howto.py

@@ -5,7 +5,7 @@
 from django.test import TestCase, override_settings
 
 from django_typer.management import TyperCommand, get_command
-from tests.utils import rich_installed, run_command
+from tests.utils import rich_installed, run_command, similarity
 
 
 @override_settings(INSTALLED_APPS=["tests.apps.howto"])
@@ -94,18 +94,24 @@ def test_howto_groups(self):
         groups = get_command(self.cmd, TyperCommand, stdout=stdout, no_color=True)
 
         groups.print_help("./howto.py", "groups")
-        self.assertEqual(stdout.getvalue().strip(), self.root_help.strip())
+        self.assertGreaterEqual(
+            similarity(stdout.getvalue().strip(), self.root_help.strip()), 0.99
+        )
         stdout.truncate(0)
         stdout.seek(0)
 
         groups.print_help("./howto.py", "groups", "group1")
-        self.assertEqual(stdout.getvalue().strip(), self.group1_help.strip())
+        self.assertGreaterEqual(
+            similarity(stdout.getvalue().strip(), self.group1_help.strip()), 0.99
+        )
 
         stdout.truncate(0)
         stdout.seek(0)
 
         groups.print_help("./howto.py", "groups", "group1", "subgroup1")
-        self.assertEqual(stdout.getvalue().strip(), self.subgroup1_help.strip())
+        self.assertGreaterEqual(
+            similarity(stdout.getvalue().strip(), self.subgroup1_help.strip()), 0.99
+        )
 
         groups.group1()
         groups.group1.subgroup1()
@@ -181,7 +187,9 @@ def test_howto_default_options(self):
         groups = get_command(self.cmd, TyperCommand, stdout=stdout, no_color=True)
 
         groups.print_help("./howto.py", "default_options")
-        self.assertEqual(stdout.getvalue().strip(), self.cmd_help.strip())
+        self.assertGreaterEqual(
+            similarity(stdout.getvalue().strip(), self.cmd_help.strip()), 0.99
+        )
 
 
 class TestDefaultOptionsTyperHowto(TestDefaultOptionsHowto):