tests

Author: ethanndickson

completion/all.go

@@ -16,6 +16,7 @@ import (
 type Shell interface {
 	Name() string
 	InstallPath() (string, error)
+	UsesOwnFile() bool
 	WriteCompletion(io.Writer) error
 }
 
@@ -102,13 +103,31 @@ func generateCompletion(
 func InstallShellCompletion(shell Shell) error {
 	path, err := shell.InstallPath()
 	if err != nil {
-		return fmt.Errorf("get install path: %w", err)
+		return fmt.Errorf("failed to get install path: %w", err)
 	}
-	f, err := os.OpenFile(path, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o644)
+
+	err = os.MkdirAll(filepath.Dir(path), 0o755)
 	if err != nil {
-		return fmt.Errorf("create and append to file: %w", err)
+		return fmt.Errorf("failed to create directories: %w", err)
+	}
+
+	if shell.UsesOwnFile() {
+		err := os.WriteFile(path, nil, 0o644)
+		if err != nil {
+			return fmt.Errorf("failed to create or truncate file: %w", err)
+		}
+	}
+
+	f, err := os.OpenFile(path, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0o644)
+	if err != nil {
+		return fmt.Errorf("failed to open file for appending: %w", err)
 	}
 	defer f.Close()
 
-	return shell.WriteCompletion(f)
+	err = shell.WriteCompletion(f)
+	if err != nil {
+		return fmt.Errorf("failed to write completion script: %w", err)
+	}
+
+	return nil
 }

completion/bash.go

@@ -23,6 +23,11 @@ func (b *bash) Name() string {
 	return "bash"
 }
 
+// UsesOwnFile implements Shell.
+func (b *bash) UsesOwnFile() bool {
+	return false
+}
+
 // InstallPath implements Shell.
 func (b *bash) InstallPath() (string, error) {
 	homeDir, err := home.Dir()
@@ -41,6 +46,7 @@ func (b *bash) WriteCompletion(w io.Writer) error {
 }
 
 const bashCompletionTemplate = `
+
 # === BEGIN {{.Name}} COMPLETION ===
 _generate_{{.Name}}_completions() {
     # Capture the line excluding the command, and everything after the current word
@@ -60,4 +66,5 @@ _generate_{{.Name}}_completions() {
 # Setup Bash to use the function for completions for '{{.Name}}'
 complete -F _generate_{{.Name}}_completions {{.Name}}
 # === END {{.Name}} COMPLETION ===
+
 `

completion/fish.go

@@ -18,6 +18,11 @@ func Fish(goos string, programName string) Shell {
 	return &fish{goos: goos, programName: programName}
 }
 
+// UsesOwnFile implements Shell.
+func (f *fish) UsesOwnFile() bool {
+	return true
+}
+
 // Name implements Shell.
 func (f *fish) Name() string {
 	return "fish"

completion/powershell.go

@@ -3,6 +3,7 @@ package completion
 import (
 	"io"
 	"os/exec"
+	"strings"
 )
 
 type powershell struct {
@@ -19,6 +20,11 @@ func Powershell(goos string, programName string) Shell {
 	return &powershell{goos: goos, programName: programName}
 }
 
+// UsesOwnFile implements Shell.
+func (p *powershell) UsesOwnFile() bool {
+	return false
+}
+
 // InstallPath implements Shell.
 func (p *powershell) InstallPath() (string, error) {
 	var (
@@ -34,7 +40,7 @@ func (p *powershell) InstallPath() (string, error) {
 	if err != nil {
 		return "", err
 	}
-	return string(path), nil
+	return strings.TrimSpace(string(path)), nil
 }
 
 // WriteCompletion implements Shell.
@@ -45,6 +51,7 @@ func (p *powershell) WriteCompletion(w io.Writer) error {
 var _ Shell = &powershell{}
 
 const pshCompletionTemplate = `
+
 # === BEGIN {{.Name}} COMPLETION ===
 # Escaping output sourced from:
 # https://github.com/spf13/cobra/blob/e94f6d0dd9a5e5738dca6bce03c4b1207ffbc0ec/powershell_completions.go#L47
@@ -83,4 +90,5 @@ $_{{.Name}}_completions = {
 }
 Register-ArgumentCompleter -CommandName {{.Name}} -ScriptBlock $_{{.Name}}_completions
 # === END {{.Name}} COMPLETION ===
+
 `

completion/zsh.go

@@ -23,6 +23,11 @@ func (z *zsh) Name() string {
 	return "zsh"
 }
 
+// UsesOwnFile implements Shell.
+func (z *zsh) UsesOwnFile() bool {
+	return false
+}
+
 // InstallPath implements Shell.
 func (z *zsh) InstallPath() (string, error) {
 	homeDir, err := home.Dir()
@@ -38,6 +43,7 @@ func (z *zsh) WriteCompletion(w io.Writer) error {
 }
 
 const zshCompletionTemplate = `
+
 # === BEGIN {{.Name}} COMPLETION ===
 _{{.Name}}_completions() {
 	local -a args completions
@@ -47,4 +53,5 @@ _{{.Name}}_completions() {
 }
 compdef _{{.Name}}_completions {{.Name}}
 # === END {{.Name}} COMPLETION ===
+
 `

completion_test.go

@@ -2,11 +2,14 @@ package serpent_test
 
 import (
 	"fmt"
+	"io"
 	"os"
+	"path/filepath"
 	"strings"
 	"testing"
 
 	serpent "github.com/coder/serpent"
+	"github.com/coder/serpent/completion"
 	"github.com/stretchr/testify/require"
 )
 
@@ -231,3 +234,67 @@ func TestFileCompletion(t *testing.T) {
 		})
 	}
 }
+
+func TestCompletionInstall(t *testing.T) {
+	t.Parallel()
+
+	t.Run("InstallingAppend", func(t *testing.T) {
+		dir := t.TempDir()
+		path := filepath.Join(dir, "fake.sh")
+		f, err := os.Create(path)
+		require.NoError(t, err)
+		f.Write([]byte("FAKE_SCRIPT"))
+		f.Close()
+
+		shell := &fakeShell{baseInstallDir: dir, useOwn: false}
+		err = completion.InstallShellCompletion(shell)
+		require.NoError(t, err)
+		contents, err := os.ReadFile(path)
+		require.NoError(t, err)
+		require.Equal(t, "FAKE_SCRIPTFAKE_COMPLETION", string(contents))
+	})
+
+	t.Run("InstallReplace", func(t *testing.T) {
+		dir := t.TempDir()
+		path := filepath.Join(dir, "fake.sh")
+		f, err := os.Create(path)
+		require.NoError(t, err)
+		f.Write([]byte("FAKE_SCRIPT"))
+		f.Close()
+
+		shell := &fakeShell{baseInstallDir: dir, useOwn: true}
+		err = completion.InstallShellCompletion(shell)
+		require.NoError(t, err)
+		contents, err := os.ReadFile(path)
+		require.NoError(t, err)
+		require.Equal(t, "FAKE_COMPLETION", string(contents))
+	})
+}
+
+type fakeShell struct {
+	baseInstallDir string
+	useOwn         bool
+}
+
+var _ completion.Shell = &fakeShell{}
+
+// InstallPath implements completion.Shell.
+func (f *fakeShell) InstallPath() (string, error) {
+	return filepath.Join(f.baseInstallDir, "fake.sh"), nil
+}
+
+// Name implements completion.Shell.
+func (f *fakeShell) Name() string {
+	return "fake"
+}
+
+// UsesOwnFile implements completion.Shell.
+func (f *fakeShell) UsesOwnFile() bool {
+	return f.useOwn
+}
+
+// WriteCompletion implements completion.Shell.
+func (f *fakeShell) WriteCompletion(w io.Writer) error {
+	_, err := w.Write([]byte("FAKE_COMPLETION"))
+	return err
+}