add exectuable complete tests

Author: bckohan

django_typer/management/commands/shellcompletion.py

@@ -7,7 +7,7 @@
 It invokes typer's shell completion installation logic, but does have to patch the
 installed scripts. This is because there is only one installation for all django
 management commands, not each individual command. The completion logic here will
-failover to django's builtin autocomplete if the command in question is not a 
+failover to django's builtin autocomplete if the command in question is not a
 TyperCommand. To promote compatibility with other management command libraries or
 custom completion logic, a fallback completion function can also be specified. A
 needed refactoring here would be to provide root hooks for completion logic in django

django_typer/tests/completion_tests.py

@@ -76,13 +76,15 @@ def tearDown(self):
         self.remove()
         super().tearDown()
 
-    def verify_install(self, script=manage_script):
+    def verify_install(self, script=None):
         pass
 
-    def verify_remove(self, script=manage_script):
+    def verify_remove(self, script=None):
         pass
 
-    def install(self, script=manage_script):
+    def install(self, script=None):
+        if not script:
+            script = self.manage_script
         kwargs = {}
         if self.shell:
             kwargs["shell"] = self.shell
@@ -91,7 +93,9 @@ def install(self, script=manage_script):
         self.command.install(**kwargs)
         self.verify_install(script=script)
 
-    def remove(self, script=manage_script):
+    def remove(self, script=None):
+        if not script:
+            script = self.manage_script
         kwargs = {}
         if self.shell:
             kwargs["shell"] = self.shell
@@ -185,20 +189,49 @@ def test_shell_complete(self):
         self.install()
 
 
+class _InstalledScriptTestCase(_DefaultCompleteTestCase):
+    """
+    These shell completes use an installed script available on the path
+    instead of a script directly invoked by path. The difference may
+    seem trivial - but it is not given how most shells determine if completion
+    logic should be invoked for a given command.
+    """
+
+    MANAGE_SCRIPT_TMPL = Path(__file__).parent / "django_manage.py"
+    manage_script = "django_manage"
+    launch_script = "django_manage"
+
+    def setUp(self):
+        lines = []
+        with open(self.MANAGE_SCRIPT_TMPL, "r") as f:
+            for line in f.readlines():
+                if line.startswith("#!{{shebang}}"):
+                    line = f"#!{sys.executable}\n"
+                lines.append(line)
+        exe = Path(sys.executable).parent / self.manage_script
+        with open(exe, "w") as f:
+            for line in lines:
+                f.write(line)
+
+        # make the script executable
+        os.chmod(exe, os.stat(exe).st_mode | 0o111)
+        super().setUp()
+
+
 @pytest.mark.skipif(shutil.which("zsh") is None, reason="Z-Shell not available")
 class ZshShellTests(_DefaultCompleteTestCase, TestCase):
 
     shell = "zsh"
     directory = Path("~/.zfunc").expanduser()
 
-    def verify_install(self, script=_DefaultCompleteTestCase.manage_script):
+    def verify_install(self, script=None):
         if not script:
-            script = self.command.manage_script_name
+            script = self.manage_script
         self.assertTrue((self.directory / f"_{script}").exists())
 
-    def verify_remove(self, script=_DefaultCompleteTestCase.manage_script):
+    def verify_remove(self, script=None):
         if not script:
-            script = self.command.manage_script_name
+            script = self.manage_script
         self.assertFalse((self.directory / f"_{script}").exists())
 
 
@@ -218,17 +251,22 @@ def set_environment(self, fd):
         os.write(fd, f"source ~/.bashrc\n".encode())
         os.write(fd, f"source .venv/bin/activate\n".encode())
 
-    def verify_install(self, script=_DefaultCompleteTestCase.manage_script):
+    def verify_install(self, script=None):
         if not script:
-            script = self.command.manage_script_name
+            script = self.manage_script
         self.assertTrue((self.directory / f"{script}.sh").exists())
 
-    def verify_remove(self, script=_DefaultCompleteTestCase.manage_script):
+    def verify_remove(self, script=None):
         if not script:
-            script = self.command.manage_script_name
+            script = self.manage_script
         self.assertFalse((self.directory / f"{script}.sh").exists())
 
 
+@pytest.mark.skipif(shutil.which("bash") is None, reason="Bash not available")
+class BashExeShellTests(_InstalledScriptTestCase, TestCase):
+    pass
+
+
 @pytest.mark.skipif(shutil.which("pwsh") is None, reason="Powershell not available")
 class PowerShellTests(_DefaultCompleteTestCase, TestCase):
 
@@ -257,18 +295,18 @@ def test_shell_complete(self):
         self.install()
         self.remove()
 
-    def verify_install(self, script=_DefaultCompleteTestCase.manage_script):
+    def verify_install(self, script=None):
         if not script:
-            script = self.command.manage_script_name
+            script = self.manage_script
         self.assertTrue((self.directory / f"Microsoft.PowerShell_profile.ps1").exists())
         self.assertTrue(
             f"Register-ArgumentCompleter -Native -CommandName {script} -ScriptBlock $scriptblock"
             in (self.directory / f"Microsoft.PowerShell_profile.ps1").read_text()
         )
 
-    def verify_remove(self, script=_DefaultCompleteTestCase.manage_script):
+    def verify_remove(self, script=None):
         if not script:
-            script = self.command.manage_script_name
+            script = self.manage_script
         if (self.directory / f"Microsoft.PowerShell_profile.ps1").exists():
             contents = (
                 self.directory / f"Microsoft.PowerShell_profile.ps1"

django_typer/tests/django_manage.py

@@ -0,0 +1,21 @@
+#!{{shebang}}
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_typer.tests.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    sys.exit(main())

pyproject.toml

@@ -38,9 +38,6 @@ packages = [
 ]
 exclude = ["django_typer/tests"]
 
-[tool.poetry.scripts]
-django_complete = "django_typer.autocomplete:main"
-
 [tool.poetry.dependencies]
 python = ">=3.9,<4.0"
 Django = ">=3.2,<6.0"