fix: Remove duplication in tests

Author: lazysegtree

src/cmd/main.go

@@ -9,7 +9,6 @@ import (
 	"log/slog"
 	"net/http"
 	"os"
-	"runtime"
 	"time"
 
 	"github.com/yorukot/superfile/src/internal/common"
@@ -129,14 +128,9 @@ func spfAppAction(_ context.Context, c *cli.Command) error {
 
 	InitConfigFile()
 
-	hasTrash := true
-	if err := InitTrash(); err != nil {
-		hasTrash = false
-	}
-
 	firstUse := checkFirstUse()
 
-	p := tea.NewProgram(internal.InitialModel(firstFilePanelDirs, firstUse, hasTrash),
+	p := tea.NewProgram(internal.InitialModel(firstFilePanelDirs, firstUse, true),
 		tea.WithAltScreen(), tea.WithMouseCellMotion())
 	if _, err := p.Run(); err != nil {
 		utils.PrintfAndExit("Alas, there's been an error: %v", err)
@@ -192,20 +186,6 @@ func InitConfigFile() {
 	}
 }
 
-// We are initializing these, but not sure if we are ever using them
-func InitTrash() error {
-	// Create trash directories
-	if runtime.GOOS != utils.OsDarwin {
-		err := createDirectories(
-			variable.CustomTrashDirectory,
-			variable.CustomTrashDirectoryFiles,
-			variable.CustomTrashDirectoryInfo,
-		)
-		return err
-	}
-	return nil
-}
-
 // Helper functions
 // Create all dirs that does not already exists
 func createDirectories(dirs ...string) error {

src/config/fixed_variable.go

@@ -46,10 +46,7 @@ var (
 	LastDirFile = filepath.Join(SuperFileStateDir, "lastdir")
 
 	// Trash Directories
-	DarwinTrashDirectory      = filepath.Join(HomeDir, ".Trash")
-	CustomTrashDirectory      = filepath.Join(xdg.DataHome, "Trash")
-	CustomTrashDirectoryFiles = filepath.Join(xdg.DataHome, "Trash", "files")
-	CustomTrashDirectoryInfo  = filepath.Join(xdg.DataHome, "Trash", "info")
+	DarwinTrashDirectory = filepath.Join(HomeDir, ".Trash")
 )
 
 // These variables are actually not fixed, they are sometimes updated dynamically

src/internal/common/predefined_variable.go

@@ -14,6 +14,11 @@ const DateModifiedOption = "Date Modified"
 const SameRenameWarnTitle = "There is already a file or directory with that name"
 const SameRenameWarnContent = "This operation will override the existing file"
 
+const TrashWarnTitle = "Are you sure you want to move this to trash can"
+const TrashWarnContent = "This operation will move file or directory to trash can."
+const PermanentDeleteWarnTitle = "Are you sure you want to completely delete"
+const PermanentDeleteWarnContent = "This operation cannot be undone and your data will be completely lost."
+
 var (
 	MinimumHeight = 24
 	MinimumWidth  = 60

src/internal/file_operations.go

@@ -145,15 +145,15 @@ func copyFile(src, dst string, srcInfo os.FileInfo) error {
 	return nil
 }
 
-// Move file to trash can and can auto switch macos trash can or linux trash can
-func trashMacOrLinux(src string) error {
+func moveToTrash(src string) error {
 	var err error
 	switch runtime.GOOS {
 	case utils.OsDarwin:
 		err = moveElement(src, filepath.Join(variable.DarwinTrashDirectory, filepath.Base(src)))
 	case utils.OsWindows:
 		err = trash_win.Throw(src)
 	default:
+		// TODO: We should consider moving away from this package. Its not well written.
 		err = trash.Trash(src)
 	}
 	if err != nil {

src/internal/handle_file_operation_test.go

@@ -117,7 +117,7 @@ func TestCompressSelectedFiles(t *testing.T) {
 			assert.Eventually(t, func() bool {
 				_, err := os.Lstat(zipFile)
 				return err == nil
-			}, time.Second, 10*time.Millisecond)
+			}, time.Second, DefaultTestTick)
 
 			// Assert zip file exists right after compression
 			require.FileExists(t, zipFile, "Expected zip file does not exist after compression")
@@ -151,7 +151,7 @@ func TestCompressSelectedFiles(t *testing.T) {
 					}
 				}
 				return true
-			}, time.Second, 10*time.Millisecond, "Extraction of files failed Required - [%s]+%v",
+			}, time.Second, DefaultTestTick, "Extraction of files failed Required - [%s]+%v",
 				extractedDir, tt.expectedFilesAfterExtract)
 
 			require.NoError(t, os.RemoveAll(extractedDir))

src/internal/handle_file_operations.go

@@ -128,7 +128,7 @@ func deleteOperation(processBarModel *processbar.Model, items []string, useTrash
 
 	deleteFunc := os.RemoveAll
 	if useTrash {
-		deleteFunc = trashMacOrLinux
+		deleteFunc = moveToTrash
 	}
 	for _, item := range items {
 		err = deleteFunc(item)
@@ -167,14 +167,14 @@ func (m *model) getDeleteTriggerCmd(deletePermanent bool) tea.Cmd {
 	return func() tea.Msg {
 		title := "Are you sure you want to move this to trash can"
 		content := "This operation will move file or directory to trash can."
-		notifyModel := notify.New(true, title, content, notify.DeleteAction)
+		action := notify.DeleteAction
 
 		if !m.hasTrash || isExternalDiskPath(panel.location) || deletePermanent {
 			title = "Are you sure you want to completely delete"
 			content = "This operation cannot be undone and your data will be completely lost."
-			notifyModel = notify.New(true, title, content, notify.PermanentDeleteAction)
+			action = notify.PermanentDeleteAction
 		}
-		return NewNotifyModalMsg(notifyModel, reqID)
+		return NewNotifyModalMsg(notify.New(true, title, content, action), reqID)
 	}
 }
 

src/internal/model_file_operations_test.go

@@ -9,6 +9,7 @@ import (
 	"time"
 
 	tea "github.com/charmbracelet/bubbletea"
+	"github.com/rkoesters/xdg/trash"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	variable "github.com/yorukot/superfile/src/config"
@@ -48,7 +49,7 @@ func TestCopy(t *testing.T) {
 		assert.Eventually(t, func() bool {
 			_, err := os.Lstat(filepath.Join(dir2, "file1.txt"))
 			return err == nil
-		}, time.Second, 10*time.Millisecond)
+		}, time.Second, DefaultTestTick)
 
 		assert.False(t, p.getModel().copyItems.cut)
 		assert.Equal(t, file1, p.getModel().copyItems.items[0])
@@ -57,7 +58,7 @@ func TestCopy(t *testing.T) {
 		assert.Eventually(t, func() bool {
 			_, err := os.Lstat(filepath.Join(dir2, "file1(1).txt"))
 			return err == nil
-		}, time.Second, 10*time.Millisecond)
+		}, time.Second, DefaultTestTick)
 		assert.FileExists(t, filepath.Join(dir2, "file1(1).txt"))
 		//TODO: Also verify if there are only 2 items in process bar
 	})
@@ -136,7 +137,7 @@ func TestFileRename(t *testing.T) {
 			_, err1 := os.Stat(file1)
 			_, err1New := os.Stat(file1New)
 			return err1New == nil && os.IsNotExist(err1)
-		}, time.Second, 10*time.Millisecond, "File never got renamed")
+		}, time.Second, DefaultTestTick, "File never got renamed")
 	})
 
 	t.Run("Rename confirmation for same name", func(t *testing.T) {
@@ -155,7 +156,7 @@ func TestFileRename(t *testing.T) {
 			// This will result in async
 			assert.Eventually(t, func() bool {
 				return m.notifyModel.IsOpen()
-			}, time.Second, 10*time.Millisecond, "Notify modal never opened, filepanel items : %v",
+			}, time.Second, DefaultTestTick, "Notify modal never opened, filepanel items : %v",
 				m.getFocusedFilePanel().element)
 
 			assert.Equal(t, notify.New(true,
@@ -180,7 +181,7 @@ func TestFileRename(t *testing.T) {
 						string(f2Data) == "f3"
 				}
 				return err2 == nil && err3 == nil
-			}, time.Second, 10*time.Millisecond,
+			}, time.Second, DefaultTestTick,
 				"Rename should be done/not done appropriately, file : %v",
 				m.getFocusedFilePanel().element)
 		}
@@ -190,31 +191,16 @@ func TestFileRename(t *testing.T) {
 	})
 }
 
-func createDirectories(dirs ...string) error {
-	for _, dir := range dirs {
-		if err := os.MkdirAll(dir, 0755); err != nil {
-			return fmt.Errorf("failed to create directory %s: %w", dir, err)
-		}
-	}
-	return nil
-}
-
-func initTrash() error {
-	return createDirectories(
-		variable.CustomTrashDirectory,
-		variable.CustomTrashDirectoryFiles,
-		variable.CustomTrashDirectoryInfo,
-	)
-}
-
-func getTrashPath(src string) string {
-	home, _ := os.UserHomeDir()
-	src = filepath.Base(src)
+func isTrashed(fileName string) bool {
 	switch runtime.GOOS {
 	case utils.OsDarwin:
-		return filepath.Join(variable.DarwinTrashDirectory, src)
+		_, err := os.Stat(filepath.Join(variable.DarwinTrashDirectory, fileName))
+		return err == nil
+	case utils.OsLinux:
+		_, err := trash.Stat(fileName)
+		return err == nil
 	default:
-		return filepath.Join(home, ".local", "share", "Trash", "files", src)
+		return false
 	}
 }
 
@@ -226,67 +212,60 @@ func TestFileDelete(t *testing.T) {
 	setupFilesWithData(t, []byte("f1"), file1)
 	setupFilesWithData(t, []byte("f2"), file2)
 
-	t.Run("move to trash", func(t *testing.T) {
-		m := defaultTestModel(curTestDir)
-		err := initTrash()
-		if err == nil {
-			m.hasTrash = true
-		} else {
-			fmt.Println("Unable to create trash directories.")
-		}
-		p := NewTestTeaProgWithEventLoop(t, m)
-		idx := findItemIndexInPanelByLocation(m.getFocusedFilePanel(), file1)
-		require.NotEqual(t, -1, idx, "%s should be found in panel", file1)
-		m.getFocusedFilePanel().cursor = idx
-
-		p.SendKey(common.Hotkeys.DeleteItems[0])
-
-		assert.Eventually(t, func() bool {
-			return m.notifyModel.IsOpen()
-		}, time.Second, 10*time.Microsecond, "Notify model never opened")
-
-		p.Send(tea.KeyMsg{Type: tea.KeyRight})
-
-		assert.Eventually(t, func() bool {
-			_, err1 := os.Stat(file1)
-			trashFile := getTrashPath(file1)
-			_, errTrash := os.Stat(trashFile)
-			if runtime.GOOS == utils.OsWindows {
-				return err1 != nil && os.IsNotExist(err1)
-			}
-			return err1 != nil && os.IsNotExist(err1) && errTrash == nil
-		}, time.Second, 10*time.Millisecond, "File never moved to trash.")
-	})
+	testdata := []struct {
+		name            string
+		filePath        string
+		permanentDelete bool
+	}{
+		{
+			name:            "Move to trash",
+			filePath:        file1,
+			permanentDelete: false,
+		},
+	}
 
-	t.Run("move to trash", func(t *testing.T) {
-		m := defaultTestModel(curTestDir)
-		err := initTrash()
-		if err == nil {
+	for _, tt := range testdata {
+		t.Run(tt.name, func(t *testing.T) {
+			m := defaultTestModel(curTestDir)
 			m.hasTrash = true
-		} else {
-			fmt.Println("Unable to create trash directories.")
-		}
-		p := NewTestTeaProgWithEventLoop(t, m)
-		idx := findItemIndexInPanelByLocation(m.getFocusedFilePanel(), file2)
-		require.NotEqual(t, -1, idx, "%s should be found in panel", file2)
-		m.getFocusedFilePanel().cursor = idx
-
-		p.SendKey(common.Hotkeys.PermanentlyDeleteItems[0])
-
-		assert.Eventually(t, func() bool {
-			return m.notifyModel.IsOpen()
-		}, time.Second, 10*time.Microsecond, "Notify model never opened")
+			p := NewTestTeaProgWithEventLoop(t, m)
+			setFilePanelSelectedFile(t, m.getFocusedFilePanel(), tt.filePath)
+			if tt.permanentDelete {
+				p.SendKey(common.Hotkeys.PermanentlyDeleteItems[0])
+			} else {
+				p.SendKey(common.Hotkeys.DeleteItems[0])
+			}
+			assert.Eventually(t, m.notifyModel.IsOpen, DefaultTestTimeout,
+				DefaultTestTick, "Notify model never opened")
+			expectedTitle := common.TrashWarnTitle
+			expectedAction := notify.DeleteAction
+			if tt.permanentDelete {
+				expectedTitle = common.PermanentDeleteWarnTitle
+				expectedAction = notify.PermanentDeleteAction
+			}
+			assert.Equal(t, expectedTitle, m.notifyModel.GetTitle())
+			assert.Equal(t, expectedAction, m.notifyModel.GetConfirmAction())
 
-		p.Send(tea.KeyMsg{Type: tea.KeyRight})
+			p.Send(tea.KeyMsg{Type: tea.KeyEnter})
 
-		assert.Eventually(t, func() bool {
-			_, err1 := os.Stat(file2)
-			trashFile := getTrashPath(file2)
-			_, errTrash := os.Stat(trashFile)
-			if runtime.GOOS == utils.OsWindows {
-				return err1 != nil && os.IsNotExist(err1)
+			assert.Eventually(t, func() bool {
+				_, err := os.Stat(tt.filePath)
+				return err != nil && os.IsNotExist(err)
+			}, DefaultTestTimeout, DefaultTestTick, "File never removed from original location")
+
+			// Window's trash is not flexible enough for the check.
+			// Sorry windows
+			if runtime.GOOS == utils.OsDarwin || runtime.GOOS == utils.OsLinux {
+				assert.Equal(t, tt.permanentDelete, !isTrashed(filepath.Base(tt.filePath)),
+					"Existence in trash status should be expected only of not permanently deleted")
 			}
-			return err1 != nil && os.IsNotExist(err1) && errTrash != nil && os.IsNotExist(err1)
-		}, time.Second, 10*time.Millisecond, "File never moved to trash.")
-	})
+		})
+	}
+}
+
+func setFilePanelSelectedFile(t *testing.T, panel *filePanel, filePath string) {
+	t.Helper()
+	idx := findItemIndexInPanelByLocation(panel, filePath)
+	require.NotEqual(t, -1, idx, "%s should be found in panel", filePath)
+	panel.cursor = idx
 }

src/internal/test_utils.go

@@ -13,6 +13,9 @@ import (
 	"github.com/yorukot/superfile/src/internal/utils"
 )
 
+const DefaultTestTick = 10 * time.Millisecond
+const DefaultTestTimeout = time.Second
+
 var SampleDataBytes = []byte("This is sample") //nolint: gochecknoglobals // Effectively const
 
 func setupDirectories(t *testing.T, dirs ...string) {
@@ -158,7 +161,7 @@ func verifyPathNotExistsEventually(t *testing.T, path, message string) {
 	assert.Eventually(t, func() bool {
 		_, err := os.Stat(path)
 		return os.IsNotExist(err)
-	}, time.Second, 10*time.Millisecond, message)
+	}, time.Second, DefaultTestTick, message)
 }
 
 // Helper function to verify expected destination files exist
@@ -169,7 +172,7 @@ func verifyDestinationFiles(t *testing.T, targetDir string, expectedDestFiles []
 		assert.Eventually(t, func() bool {
 			_, err := os.Stat(destPath)
 			return err == nil
-		}, time.Second, 10*time.Millisecond, "%s should exist in destination", expectedFile)
+		}, time.Second, DefaultTestTick, "%s should exist in destination", expectedFile)
 	}
 }