fix #206 fix #207

Author: bckohan

doc/source/changelog.rst

@@ -7,6 +7,8 @@ Change Log
 v3.1.0 (2024-03-31)
 ===================
 
+* Fixed `Fish shell completion fails for any script named something other than "manage" <https://github.com/django-commons/django-typer/issues/207>`_
+* Fixed `shellcompletion install fails on fish when the command resolves to a script path <https://github.com/django-commons/django-typer/issues/206>`_
 * Implemented `Add completer for settings names. <https://github.com/django-commons/django-typer/issues/203>`_
 * Fixed `Shell completion tests let failures through in CI <https://github.com/django-commons/django-typer/issues/194>`_
 * Fixed `fish completion installs should respect XDG_CONFIG_HOME <https://github.com/django-commons/django-typer/issues/193>`_

src/django_typer/templates/shell_complete/fish.fish

@@ -44,4 +44,4 @@ function __fish_{{prog_name}}_complete
     end;
 end
 
-complete -c {{ manage_script_name }} --no-files --arguments '(__fish_manage_complete)'
+complete -c {{ manage_script_name }} --no-files --arguments '(__fish_{{prog_name}}_complete)'

src/django_typer/utils.py

@@ -74,7 +74,7 @@ def get_usage_script(script: t.Optional[str] = None) -> t.Union[Path, str]:
     if (
         on_path
         and on_path.is_absolute()
-        and (on_path != cmd_pth.absolute() or not cmd_pth.is_file())
+        and (on_path == cmd_pth.absolute() or not cmd_pth.is_file())
     ):
         return cmd_pth.name
     try:

tests/shellcompletion/__init__.py

@@ -433,8 +433,8 @@ class _InstalledScriptCompleteTestCase(_CompleteTestCase):
     """
 
     MANAGE_SCRIPT_TMPL = Path(__file__).parent / "django_manage.py"
-    manage_script = "django_manage"
-    launch_script = "django_manage"
+    manage_script = "django-admin"
+    launch_script = "django-admin"
 
     @classmethod
     def setUpClass(cls):
@@ -505,7 +505,11 @@ def test_multi_install(self):
         def test_prompt_install(self, env={}, directory: t.Optional[Path] = None):
             import pexpect
 
-            env = {**dict(os.environ), **env}
+            env = {
+                **dict(os.environ),
+                "DJANGO_SETTINGS_MODULE": "tests.settings.completion",
+                **env,
+            }
 
             rex = re.compile
             expected = [
@@ -560,3 +564,76 @@ def wait_for_output(child) -> t.Tuple[int, t.Optional[str]]:
                     break
 
             self.verify_install(directory=directory)
+
+    else:
+
+        def test_prompt_install(self, env={}, directory: t.Optional[Path] = None):
+            env = {
+                **dict(os.environ),
+                "DJANGO_SETTINGS_MODULE": "tests.settings.completion",
+                **env,
+            }
+
+            rex = re.compile
+            expected_patterns = [
+                rex(r"Append the above contents to (?P<file>.*)\?"),  # 0
+                rex(r"Create (?P<file>.*) with the above contents\?"),  # 1
+                rex(r"Aborted shell completion installation."),  # 2
+                rex(rf"Installed autocompletion for {self.shell}"),  # 3
+            ]
+
+            install_command = [
+                self.manage_script,
+                "shellcompletion",
+                "--no-color",
+                "--shell",
+                self.shell,
+                "install",
+            ]
+            self.remove()
+            self.verify_remove(directory=directory)
+
+            def run_with_response(responses: t.List[str]):
+                process = subprocess.Popen(
+                    install_command,
+                    env=env,
+                    cwd=directory,
+                    stdin=subprocess.PIPE,
+                    stdout=subprocess.PIPE,
+                    stderr=subprocess.STDOUT,
+                    text=True,
+                )
+
+                output = ""
+                for response in responses:
+                    while True:
+                        line = process.stdout.readline()
+                        if not line:
+                            break
+                        output += line
+
+                        matched_index, matched_file = match_output(line)
+                        if matched_index is not None:
+                            process.stdin.write(response + "\n")
+                            process.stdin.flush()
+                            break
+
+                process.wait()
+                return output
+
+            def match_output(line: str) -> t.Tuple[t.Optional[int], t.Optional[str]]:
+                for i, pattern in enumerate(expected_patterns):
+                    match = pattern.search(line)
+                    if match:
+                        return i, match.groupdict().get("file")
+                return None, None
+
+            # Test abort sequence
+            abort_output = run_with_response(["N", "N"])
+            self.assertIn("Aborted shell completion installation.", abort_output)
+            self.verify_remove(directory=directory)
+
+            # Test install sequence
+            install_output = run_with_response(["Y", "Y"])
+            self.assertIn(f"Installed autocompletion for {self.shell}", install_output)
+            self.verify_install(directory=directory)

tests/shellcompletion/test_bash.py

@@ -2,6 +2,7 @@
 import shutil
 import sys
 from pathlib import Path
+import typing as t
 
 import pytest
 from django.test import TestCase
@@ -20,21 +21,23 @@ class BashTests(_ScriptCompleteTestCase, TestCase):
     tabs = "\t\t"
 
     environment = [
-        f"export DJANGO_SETTINGS_MODULE=tests.settings.completion",
+        "export DJANGO_SETTINGS_MODULE=tests.settings.completion",
         f"export PATH={Path(sys.executable).parent}:$PATH",
-        f"source ~/.bashrc",
+        "source ~/.bashrc",
         f"source {Path(sys.executable).absolute().parent / 'activate'}",
     ]
 
-    def verify_install(self, script=None):
+    def verify_install(self, script=None, directory: t.Optional[Path] = None):
+        directory = directory or self.directory
         if not script:
             script = self.manage_script
-        self.assertTrue((self.directory / f"{script}.sh").exists())
+        self.assertTrue((directory / f"{script}.sh").exists())
 
-    def verify_remove(self, script=None):
+    def verify_remove(self, script=None, directory: t.Optional[Path] = None):
+        directory = directory or self.directory
         if not script:
             script = self.manage_script
-        self.assertFalse((self.directory / f"{script}.sh").exists())
+        self.assertFalse((directory / f"{script}.sh").exists())
 
     @pytest.mark.rich
     @pytest.mark.no_rich

tests/shellcompletion/test_fish.py

@@ -1,6 +1,7 @@
 import shutil
 import sys
 from pathlib import Path
+import typing as t
 
 import pytest
 from django.test import TestCase
@@ -24,12 +25,14 @@ class _FishMixin:
         f"source {Path(sys.executable).absolute().parent / 'activate.fish'}",
     ]
 
-    def verify_install(self, script=None):
+    def verify_install(self, script=None, directory: t.Optional[Path] = None):
+        directory = directory or self.directory
         if not script:
             script = self.manage_script
         self.assertTrue((self.directory / f"{script}.fish").exists())
 
-    def verify_remove(self, script=None):
+    def verify_remove(self, script=None, directory: t.Optional[Path] = None):
+        directory = directory or self.directory
         if not script:
             script = self.manage_script
         self.assertFalse((self.directory / f"{script}.fish").exists())
@@ -107,6 +110,3 @@ def test_multi_install(self): ...
 
     @pytest.mark.skip(reason="TODO")
     def test_path_completion(self): ...
-
-    @pytest.mark.skip(reason="TODO")
-    def test_prompt_install(self): ...

tests/shellcompletion/test_powershell.py

@@ -2,6 +2,7 @@
 import sys
 from pathlib import Path
 import platform
+import typing as t
 
 import pytest
 from django.core.management import CommandError
@@ -34,7 +35,7 @@ def setUpClass(cls) -> None:
         cls.profile = cls.completer_class().get_user_profile()
         return super().setUpClass()
 
-    def verify_install(self, script=None):
+    def verify_install(self, script=None, directory: t.Optional[Path] = None):
         if not script:
             script = self.manage_script
         self.assertTrue(self.profile.exists())
@@ -43,7 +44,7 @@ def verify_install(self, script=None):
             in self.profile.read_text()
         )
 
-    def verify_remove(self, script=None):
+    def verify_remove(self, script=None, directory: t.Optional[Path] = None):
         if not script:
             script = self.manage_script
         if self.profile.exists():

tests/shellcompletion/test_zsh.py

@@ -27,6 +27,7 @@ class ZshTests(_ScriptCompleteTestCase, TestCase):
     ]
 
     def verify_install(self, script=None, directory: t.Optional[Path] = None):
+        directory = directory or self.directory
         if not script:
             script = self.manage_script
         self.assertTrue((directory / f"_{script}").exists())
@@ -35,12 +36,7 @@ def verify_remove(self, script=None, directory: t.Optional[Path] = None):
         directory = directory or self.directory
         if not script:
             script = self.manage_script
-        try:
-            self.assertFalse((directory / f"_{script}").exists())
-        except AssertionError:
-            import ipdb
-
-            ipdb.set_trace()
+        self.assertFalse((directory / f"_{script}").exists())
 
 
 @pytest.mark.skipif(shutil.which("zsh") is None, reason="Z-Shell not available")