Add config parse tests and --help passthrough

README.md

@@ -45,11 +45,13 @@ In this case, you can modify your `~/.local/share/2rm/config.yml` file to always
 You can specify what directories are soft-deleted anb hard-deleted by using the `~/.local/share/2rm/config.yml` file.
 
 ```yml
+# ~/.local/share/2rm/config.yml
+
 # defaults to /tmp/2rm/ if not specified
 # in the config file
 # any files that are soft deleted will be
 # backed up in the `backups` directory
-backups: /tmp/2rm
+backups: /tmp/2rm/
 hard:
     - node_modules/
     - target/
@@ -59,5 +61,5 @@ hard:
 # regardless of it they are configured
 # for a hard delete
 soft:
-    - *.bak
+    - "*.bak"
 ```

makefile

@@ -6,6 +6,9 @@ build:
 	mkdir -p $(OUT_DIR)
 	go build -o $(OUT_DIR)/2rm ./src/main.go
 
+test:
+	go test ./src/...
+
 clean:
 	rm -rf $(OUT_DIR)
 

src/commands/commands_test.go

@@ -0,0 +1,7 @@
+package commands
+
+import "testing"
+
+func TestCommandsEcho(t *testing.T) {
+	Execute("echo 'Hello World'")
+}

src/config/parse.go

@@ -11,6 +11,13 @@ import (
 func ParseConfig(path string) models.Config {
 	parsedConfig := models.Config{}
 
+	_, err := os.Stat(path)
+	if os.IsNotExist(err) {
+		// if the config file does not exist, we want to return an empty config
+		// this will act as a default config
+		return parsedConfig
+	}
+
 	content, err := os.ReadFile(path)
 	if err != nil {
 		log.Fatal(err)

src/config/parse_test.go

@@ -0,0 +1,73 @@
+package config
+
+import (
+	"hudson-newey/2rm/src/models"
+	"path/filepath"
+	"reflect"
+	"testing"
+)
+
+func assertConfig(t *testing.T, configPath string, expectedConfig models.Config) {
+	testConfigDir := "../../tests/assets/configs/"
+	absolutePath, err := filepath.Abs(testConfigDir + configPath)
+	if err != nil {
+		t.Errorf("Failed to get absolute path")
+	}
+
+	realizedConfig := ParseConfig(absolutePath)
+
+	if !reflect.DeepEqual(expectedConfig, realizedConfig) {
+		t.Errorf("Expected %v but got %v", expectedConfig, realizedConfig)
+	}
+}
+
+func TestParsingConfig(t *testing.T) {
+	expectedConfig := models.Config{
+		Backups: "/tmp/2rm/",
+		Hard: []string{
+			"node_modules/",
+			"target/",
+			".angular/",
+			".next/",
+		},
+		Soft: []string{
+			"*.bak",
+		},
+	}
+
+	assertConfig(t, "valid.yml", expectedConfig)
+}
+
+// this test asserts that we can parse a partial config
+// we do not have to check every combination of partial configs
+// because that would result in a massive explosion of tests
+// that would not provide much value
+func TestOnlyHardConfig(t *testing.T) {
+	expectedConfig := models.Config{
+		Hard: []string{
+			"node_modules/",
+			"target/",
+			".angular/",
+			".next/",
+		},
+	}
+
+	assertConfig(t, "only_hard.yml", expectedConfig)
+}
+
+func TestOnlyBackups(t *testing.T) {
+	expectedConfig := models.Config{
+		Backups: "/tmp/2rm/",
+	}
+	assertConfig(t, "only_backups.yml", expectedConfig)
+}
+
+func TestParsingEmptyConfig(t *testing.T) {
+	expectedConfig := models.Config{}
+	assertConfig(t, "empty.yml", expectedConfig)
+}
+
+func TestParsingConfigWithMissingFile(t *testing.T) {
+	expectedConfig := models.Config{}
+	assertConfig(t, "missing.yml", expectedConfig)
+}

src/models/config_test.go

@@ -0,0 +1,55 @@
+package models
+
+import "testing"
+
+func TestShouldHardDelete(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestShouldHardDeleteFalse(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestShouldHardDeleteEmpty(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestShouldSoftDelete(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestShouldSoftDeleteFalse(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestShouldSoftDeleteEmpty(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestSoftDeleteDir(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestSoftDeleteDirDefault(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestMatchesPatternFile(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestMatchesPatternDirectory(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestMatchesPatternGlobPostfix(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestMatchesPatternGlobPrefix(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}
+
+func TestMatchesAbsolutePath(t *testing.T) {
+	t.Fatal("This test needs to be implemented!")
+}

src/patches/rm.go

@@ -26,6 +26,12 @@ func RmPatch(arguments []string, config models.Config) {
 		removeDangerousArguments(arguments),
 	)
 
+	if shouldPassthrough(actionedArgs) {
+		command := "rm " + strings.Join(actionedArgs, " ")
+		commands.Execute(command)
+		return
+	}
+
 	filePaths := extractFilePaths(actionedArgs)
 	extractedArguments := extractArguments(actionedArgs)
 
@@ -55,6 +61,20 @@ func RmPatch(arguments []string, config models.Config) {
 	}
 }
 
+// sometimes we want to pass through the arguments to the original rm command
+// e.g. when executing --help or --version
+func shouldPassthrough(arguments []string) bool {
+	passthroughArguments := []string{"--help", "--version"}
+
+	for _, arg := range arguments {
+		if util.InArray(passthroughArguments, arg) {
+			return true
+		}
+	}
+
+	return false
+}
+
 func removeUnNeededArguments(arguments []string) []string {
 	unNeededArguments := []string{"-r", HARD_DELETE_CLA, SOFT_DELETE_CLA, SILENT_CLA}
 	returnedArguments := []string{}

src/patches/rm_test.go

@@ -0,0 +1 @@
+package patches

src/util/util.go

@@ -1,12 +1,11 @@
 package util
 
 func InArray[T comparable](arr []T, query T) bool {
-	for _, value := range(arr) {
-		if (value == query) {
+	for _, value := range arr {
+		if value == query {
 			return true
 		}
 	}
 
 	return false
 }
-

src/util/util_test.go

@@ -0,0 +1,21 @@
+package util
+
+import "testing"
+
+func TestInArrayTrue(t *testing.T) {
+	expectedResult := true
+	realizedResult := InArray([]int{1, 2, 3}, 1)
+
+	if realizedResult != expectedResult {
+		t.Fatalf("Expected %v but got %v", expectedResult, realizedResult)
+	}
+}
+
+func TestInArrayFalse(t *testing.T) {
+	expectedResult := false
+	realizedResult := InArray([]int{1, 2, 3}, 4)
+
+	if realizedResult != expectedResult {
+		t.Fatalf("Expected %v but got %v", expectedResult, realizedResult)
+	}
+}

tests/assets/configs/only_backups.yml

@@ -0,0 +1 @@
+backups: /tmp/2rm/

tests/assets/configs/only_hard.yml

@@ -0,0 +1,5 @@
+hard:
+    - node_modules/
+    - target/
+    - .angular/
+    - .next/

tests/assets/configs/readme.txt

@@ -0,0 +1 @@
+This directory contains the configs that we use in tests

tests/assets/configs/valid.yml

@@ -0,0 +1,8 @@
+backups: /tmp/2rm/
+hard:
+    - node_modules/
+    - target/
+    - .angular/
+    - .next/
+soft:
+    - "*.bak"