add fish completion tests

Author: bckohan

Diff for: .github/workflows/test.yml

@@ -96,6 +96,10 @@ jobs:
         poetry run pip install --upgrade pip
         poetry install
         poetry run pip install -U "Django~=${{ matrix.django-version }}"
+    - name: Install Fish shell
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y fish
     - name: Run Unit Tests
       run: |
         poetry run pytest django_typer/tests/completion_tests.py
@@ -154,6 +158,9 @@ jobs:
         touch ~/.bashrc
         echo "\n[[ -r "$(brew --prefix)/etc/profile.d/bash_completion.sh" ]] && . "$(brew --prefix)/etc/profile.d/bash_completion.sh" || true" >> ~/.bash_profile
         source ~/.bashrc
+    - name: Install Fish shell
+      run: |
+        brew install fish
     - name: Install Poetry
       uses: snok/install-poetry@v1
       with:

Diff for: django_typer/management/commands/shellcompletion.py

@@ -366,25 +366,23 @@ def remove(
                 Shells.bash: Path("~/.bashrc").expanduser(),
                 Shells.zsh: Path("~/.zshrc").expanduser(),
             }.get(self.shell, None)
-            assert (
-                rc_file and rc_file.is_file()
-            ), f"No rc file {rc_file} found for shell {self.shell}"
-            edited = []
-            with open(rc_file, "rt", encoding="utf-8") as rc:
-                for line in rc.readlines():
-                    if (
-                        self.shell is Shells.bash
-                        and line.strip() == f"source {installed_path}"
-                    ):
-                        continue
-                    edited.append(line)
-            # remove empty lines from the end of the file, the typer install scripts add
-            # extra newlines
-            while edited and not edited[-1].strip():
-                edited.pop()
-            edited.append("")  # add one back on
-            with open(rc_file, "wt", encoding="utf-8") as rc:
-                rc.writelines(edited)
+            if rc_file and rc_file.is_file():
+                edited = []
+                with open(rc_file, "rt", encoding="utf-8") as rc:
+                    for line in rc.readlines():
+                        if (
+                            self.shell is Shells.bash
+                            and line.strip() == f"source {installed_path}"
+                        ):
+                            continue
+                        edited.append(line)
+                # remove empty lines from the end of the file, the typer install scripts add
+                # extra newlines
+                while edited and not edited[-1].strip():
+                    edited.pop()
+                edited.append("")  # add one back on
+                with open(rc_file, "wt", encoding="utf-8") as rc:
+                    rc.writelines(edited)
 
         self.stdout = stdout
         self.stdout.write(

Diff for: django_typer/tests/completion_tests.py

@@ -267,6 +267,41 @@ class BashExeShellTests(_InstalledScriptTestCase, TestCase):
     pass
 
 
+@pytest.mark.skipif(shutil.which("fish") is None, reason="Fish not available")
+class _FishShellTests(_DefaultCompleteTestCase, TestCase):
+    """
+    TODO this test is currently disabled because fish completion installation does
+    not seem to work for scripts not on the path.
+    """
+
+    shell = "fish"
+    directory = Path("~/.config/fish/completions").expanduser()
+
+    def set_environment(self, fd):
+        # super().set_environment(fd)
+        os.write(fd, f"export PATH={Path(sys.executable).parent}:$PATH\n".encode())
+        os.write(
+            fd,
+            f'export DJANGO_SETTINGS_MODULE={os.environ["DJANGO_SETTINGS_MODULE"]}\n'.encode(),
+        )
+        os.write(fd, f"source .venv/bin/activate\n".encode())
+
+    def verify_install(self, script=None):
+        if not script:
+            script = self.manage_script
+        self.assertTrue((self.directory / f"{script}.fish").exists())
+
+    def verify_remove(self, script=None):
+        if not script:
+            script = self.manage_script
+        self.assertFalse((self.directory / f"{script}.fish").exists())
+
+
+@pytest.mark.skipif(shutil.which("fish") is None, reason="Fish not available")
+class FishExeShellTests(_InstalledScriptTestCase, TestCase):
+    pass
+
+
 @pytest.mark.skipif(shutil.which("pwsh") is None, reason="Powershell not available")
 class PowerShellTests(_DefaultCompleteTestCase, TestCase):