feat: Zoxide tests (#1042)

- Replace all instances of 'github.com/lazysegtree/go-zoxide' imports
with 'zoxidelib' alias for consistency across codebase
- Add comprehensive zoxide UI navigation test that types "dir2" to
search and presses Enter to navigate
- Fix zoxide modal close behavior by adding m.Close() call in
handleConfirm action
- Add GetResults() method to zoxide UI component for test access
- Create defaultTestModelWithZClient() helper function for zoxide
testing

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: yorukot <107802416+yorukot@users.noreply.github.com>

Author: 3 people

.github/workflows/superfile-build-test.yml

@@ -20,9 +20,12 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
-      - name: Setup exiftool (only on linux)
+      - name: Setup dependencies (only on linux)
         if: runner.os == 'Linux'
-        run: sudo apt-get update && sudo apt-get install -y exiftool
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y exiftool
+          curl -sS https://raw.githubusercontent.com/ajeetdsouza/zoxide/main/install.sh | bash
 
       - name: Set up Go
         uses: actions/setup-go@v5

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/charmbracelet/x/ansi v0.9.3
 	github.com/fatih/color v1.18.0
 	github.com/hymkor/trash-go v0.2.0
-	github.com/lazysegtree/go-zoxide v0.0.1
+	github.com/lazysegtree/go-zoxide v0.1.0
 	github.com/lithammer/shortuuid v3.0.0+incompatible
 	github.com/muesli/termenv v0.16.0
 	github.com/reinhrst/fzf-lib v0.9.0

go.sum

@@ -143,6 +143,8 @@ github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/lazysegtree/go-zoxide v0.0.1 h1:PG8asMMqetoxXXfLGTvgzbWHVGybioeJpGm91mhbNoc=
 github.com/lazysegtree/go-zoxide v0.0.1/go.mod h1:C1K2SDM4iHkQeFVrWBiRX3tU9jpAz6BrnoHQYSiHZl0=
+github.com/lazysegtree/go-zoxide v0.1.0 h1:gL11AWS9fJDuB7FYxsh+ohf8ozMXeK31E/PC6f9jNBc=
+github.com/lazysegtree/go-zoxide v0.1.0/go.mod h1:C1K2SDM4iHkQeFVrWBiRX3tU9jpAz6BrnoHQYSiHZl0=
 github.com/lithammer/shortuuid v3.0.0+incompatible h1:NcD0xWW/MZYXEHa6ITy6kaXN5nwm/V115vj2YXfhS0w=
 github.com/lithammer/shortuuid v3.0.0+incompatible/go.mod h1:FR74pbAuElzOUuenUHTK2Tciko1/vKuIKS9dSkDrA4w=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=

gomod2nix.toml

@@ -101,8 +101,8 @@ schema = 3
     version = "v1.16.3"
     hash = "sha256-dU0OgO5afQ1z5s83Y3w8Bg0ftvg+ikWbktUACEgY3OQ="
   [mod."github.com/lazysegtree/go-zoxide"]
-    version = "v0.0.1"
-    hash = "sha256-pBZ6tOqhYe2ogHyFmP/7R4hc4yfJ7I9hk2D+gT14v4o="
+    version = "v0.1.0"
+    hash = "sha256-PKEV+zCKf/7MsFAMMctL/pFSnEsri1yS8Bzxcj1dLWE="
   [mod."github.com/lithammer/shortuuid"]
     version = "v3.0.0+incompatible"
     hash = "sha256-dD6ArCHGnpo84RBy6SI2kUjMqHS4IZU+K+DgAgmRakY="

src/internal/config_function.go

@@ -6,7 +6,7 @@ import (
 	"reflect"
 	"runtime"
 
-	"github.com/lazysegtree/go-zoxide"
+	zoxidelib "github.com/lazysegtree/go-zoxide"
 
 	"github.com/yorukot/superfile/src/internal/ui/processbar"
 	"github.com/yorukot/superfile/src/internal/ui/rendering"
@@ -25,7 +25,7 @@ import (
 
 // This is the only usecase of named returns, distinguish between multiple return values
 func initialConfig(firstFilePanelDirs []string) (toggleDotFile bool, //nolint: nonamedreturns // See above
-	toggleFooter bool, zClient *zoxide.Client) {
+	toggleFooter bool, zClient *zoxidelib.Client) {
 	// Open log stream
 	file, err := os.OpenFile(variable.LogFile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
 
@@ -73,7 +73,7 @@ func initialConfig(firstFilePanelDirs []string) (toggleDotFile bool, //nolint: n
 	}
 
 	if common.Config.ZoxideSupport {
-		zClient, err = zoxide.New()
+		zClient, err = zoxidelib.New()
 		if err != nil {
 			slog.Error("Error initializing zoxide client", "error", err)
 		}
@@ -90,27 +90,31 @@ func initialConfig(firstFilePanelDirs []string) (toggleDotFile bool, //nolint: n
 	return toggleDotFile, toggleFooter, zClient
 }
 
-func updateFirstFilePanelDirs(firstFilePanelDirs []string, cwd string, zClient *zoxide.Client) {
+func updateFirstFilePanelDirs(firstFilePanelDirs []string, cwd string, zClient *zoxidelib.Client) {
 	for i := range firstFilePanelDirs {
 		if firstFilePanelDirs[i] == "" {
 			firstFilePanelDirs[i] = common.Config.DefaultDirectory
 		}
+		originalPath := firstFilePanelDirs[i]
+		firstFilePanelDirs[i] = utils.ResolveAbsPath(cwd, firstFilePanelDirs[i])
 
-		if common.Config.ZoxideSupport && zClient != nil {
-			path, err := zClient.Query(firstFilePanelDirs[i])
-			if err == nil && path != "" {
-				firstFilePanelDirs[i] = path
-			} else {
-				slog.Error("Zoxide execution error", "path", path, "error", err)
-				firstFilePanelDirs[i] = utils.ResolveAbsPath(cwd, firstFilePanelDirs[i])
-			}
-		} else {
-			firstFilePanelDirs[i] = utils.ResolveAbsPath(cwd, firstFilePanelDirs[i])
-		}
-		// In case of unexpected path error, fallback to home dir
 		if _, err := os.Stat(firstFilePanelDirs[i]); err != nil {
 			slog.Error("cannot get stats for firstFilePanelDir", "error", err)
-			firstFilePanelDirs[i] = variable.HomeDir
+			// In case the path provided did not exist, use zoxide query
+			// else, fallback to home dir
+			if common.Config.ZoxideSupport && zClient != nil {
+				path, err := zClient.Query(originalPath)
+				slog.Error("Zoxide execution error", "path", path, "originalPath", originalPath, "error", err)
+
+				if err == nil && path != "" {
+					firstFilePanelDirs[i] = path
+				} else {
+					slog.Error("Zoxide execution error", "path", path, "originalPath", originalPath, "error", err)
+					firstFilePanelDirs[i] = variable.HomeDir
+				}
+			} else {
+				firstFilePanelDirs[i] = variable.HomeDir
+			}
 		}
 	}
 }

src/internal/model_test.go

@@ -5,8 +5,10 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"runtime"
 	"testing"
 
+	zoxidelib "github.com/lazysegtree/go-zoxide"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
@@ -245,3 +247,69 @@ func TestChooserFile(t *testing.T) {
 		})
 	}
 }
+
+func TestZoxide(t *testing.T) {
+	zoxideDataDir := t.TempDir()
+	zClient, err := zoxidelib.New(zoxidelib.WithDataDir(zoxideDataDir))
+	if err != nil {
+		if runtime.GOOS != utils.OsLinux {
+			t.Skipf("Skipping zoxide tests in non-Linux because zoxide client cannot be initialized")
+		} else {
+			t.Fatalf("zoxide initialization failed")
+		}
+	}
+
+	originalZoxideSupport := common.Config.ZoxideSupport
+	defer func() {
+		common.Config.ZoxideSupport = originalZoxideSupport
+	}()
+
+	curTestDir := filepath.Join(testDir, "TestZoxide")
+	dir1 := filepath.Join(curTestDir, "dir1")
+	dir2 := filepath.Join(curTestDir, "dir2")
+	dir3 := filepath.Join(curTestDir, "dir3")
+	utils.SetupDirectories(t, curTestDir, dir1, dir2, dir3)
+
+	t.Run("Zoxide tracking and navigation", func(t *testing.T) {
+		common.Config.ZoxideSupport = true
+		m := defaultTestModelWithZClient(zClient, dir1)
+
+		err := m.updateCurrentFilePanelDir(dir2)
+		require.NoError(t, err, "Failed to navigate to dir2")
+		assert.Equal(t, dir2, m.getFocusedFilePanel().location, "Should be in dir2 after navigation")
+
+		err = m.updateCurrentFilePanelDir(dir3)
+		require.NoError(t, err, "Failed to navigate to dir3")
+		assert.Equal(t, dir3, m.getFocusedFilePanel().location, "Should be in dir3 after navigation")
+
+		TeaUpdateWithErrCheck(m, utils.TeaRuneKeyMsg(common.Hotkeys.OpenZoxide[0]))
+		assert.True(t, m.zoxideModal.IsOpen(), "Zoxide modal should open when pressing 'z' key")
+
+		// Type "dir2" to search for it
+		for _, char := range "dir2" {
+			TeaUpdateWithErrCheck(m, utils.TeaRuneKeyMsg(string(char)))
+		}
+
+		results := m.zoxideModal.GetResults()
+		assert.GreaterOrEqual(t, len(results), 1, "Should have at least 1 directory found by zoxide UI search")
+
+		resultPaths := make([]string, len(results))
+		for i, result := range results {
+			resultPaths[i] = result.Path
+		}
+		assert.Contains(t, resultPaths, dir2, "dir2 should be found by zoxide UI search")
+
+		// Press enter to navigate to dir2
+		TeaUpdateWithErrCheck(m, utils.TeaRuneKeyMsg(common.Hotkeys.ConfirmTyping[0]))
+		assert.False(t, m.zoxideModal.IsOpen(), "Zoxide modal should close after navigation")
+		assert.Equal(t, dir2, m.getFocusedFilePanel().location, "Should navigate back to dir2 after zoxide selection")
+	})
+
+	t.Run("Zoxide disabled shows no results", func(t *testing.T) {
+		common.Config.ZoxideSupport = false
+		m := defaultTestModelWithZClient(zClient, dir1)
+
+		TeaUpdateWithErrCheck(m, utils.TeaRuneKeyMsg(common.Hotkeys.OpenZoxide[0]))
+		assert.True(t, m.zoxideModal.IsOpen(), "Zoxide modal should open even when ZoxideSupport is disabled")
+	})
+}

src/internal/test_utils.go

@@ -7,6 +7,7 @@ import (
 	"time"
 
 	tea "github.com/charmbracelet/bubbletea"
+	zoxidelib "github.com/lazysegtree/go-zoxide"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
@@ -26,6 +27,13 @@ func defaultTestModel(dirs ...string) *model {
 	return m
 }
 
+func defaultTestModelWithZClient(zClient *zoxidelib.Client, dirs ...string) *model {
+	m := defaultModelConfig(false, false, false, dirs, zClient)
+	m.disableMetatdata = true
+	_, _ = TeaUpdate(m, tea.WindowSizeMsg{Width: 2 * common.MinimumWidth, Height: 2 * common.MinimumHeight})
+	return m
+}
+
 // Helper function to setup panel mode and selection
 func setupPanelModeAndSelection(t *testing.T, m *model, useSelectMode bool, itemName string, selectedItems []string) {
 	t.Helper()

src/internal/ui/zoxide/model.go

@@ -60,6 +60,7 @@ func (m *Model) HandleUpdate(msg tea.Msg) (common.ModelAction, tea.Cmd) {
 		switch {
 		case slices.Contains(common.Hotkeys.ConfirmTyping, msg.String()):
 			action = m.handleConfirm()
+			m.Close()
 		case slices.Contains(common.Hotkeys.CancelTyping, msg.String()):
 			m.Close()
 		case slices.Contains(common.Hotkeys.ListUp, msg.String()):

src/internal/ui/zoxide/utils.go

@@ -52,3 +52,7 @@ func (m *Model) SetMaxHeight(maxHeight int) {
 	}
 	m.maxHeight = maxHeight
 }
+
+func (m *Model) GetResults() []zoxidelib.Result {
+	return m.results
+}