Merge pull request #27 from Cian911/cian911/updates-2024

Cian911 · web-flow · commit bf133d7e51b6 · 2024-08-18T22:23:07.000+01:00
chore: update dependencies and test latest version of fsnotify
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -27,7 +27,7 @@ jobs:
       - name: Go Setup
         uses: actions/setup-go@v2
         with:
-          go-version: 1.17
+          go-version: 1.23
       - name: Run Release
         uses: goreleaser/goreleaser-action@v2
         with:
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -22,7 +22,7 @@ jobs:
     - name: Setup
       uses: actions/setup-go@v2
       with:
-        go-version: '~1.17'
+        go-version: '~1.23'
     - name: Install Dependencies
       run: |
         go install github.com/rakyll/gotest@latest
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -1,3 +1,4 @@
+version: 2
 before:
   hooks:
     - go mod download
@@ -42,12 +43,6 @@ dockers:
 archives:
 -
   id: switchboard
-  replacements:
-    darwin: Darwin
-    linux: Linux
-    windows: Windows
-    386: i386
-    amd64: x86_64
 checksum:
   name_template: 'checksums.txt'
 snapshot:
@@ -78,11 +73,6 @@ changelog:
       order: 999
 nfpms:
 -
-  replacements:
-    amd64: 64-bit
-    386: 32-bit
-    darwin: macOS
-    linux: linux
   vendor: Cian911
   formats:
     - deb
@@ -91,16 +81,16 @@ nfpms:
 brews:
   -
     goarm: 6
-    tap:
+    repository:
       owner: Cian911
       name: homebrew-switchboard
-    folder: Formula
+    directory: Formula
     commit_author:
       name: Cian911
       email: cian@ciangallagher.net
-    homepage: https://github.com/Cian911/switchboard
+    homepage: "https://github.com/Cian911/switchboard"
     description: |
-      TBD
+      Automated file organisation and routing for all your machines.
 
 artifactories:
   - name: swb
diff --git a/event/event.go b/event/event.go
@@ -12,9 +12,9 @@ import (
 )
 
 var validOperations = map[string]bool{
-	"CREATE": true,
-	"WRITE":  true,
-  "CLOSEWRITE": true,
+	"CREATE":      true,
+	"WRITE":       true,
+	"CLOSE_WRITE": true,
 }
 
 // Event is a struct that holds the information for a file event
diff --git a/event/event_test.go b/event/event_test.go
@@ -3,7 +3,6 @@ package event
 import (
 	"errors"
 	"fmt"
-	"io/ioutil"
 	"log"
 	"os"
 	"testing"
@@ -98,8 +97,7 @@ func TestEvent(t *testing.T) {
 
 func eventSetup(t *testing.T) *Event {
 	path := t.TempDir()
-	_, err := ioutil.TempFile(path, file)
-
+	_, err := os.CreateTemp(path, file)
 	if err != nil {
 		t.Fatalf("Unable to create temp file: %v", err)
 	}
diff --git a/go.mod b/go.mod
@@ -1,28 +1,32 @@
 module github.com/cian911/switchboard
 
-go 1.17
+go 1.23
 
 require (
-	github.com/fsnotify/fsnotify v1.5.1
-	github.com/spf13/cobra v0.0.5
-	github.com/spf13/viper v1.10.0
+	github.com/fsnotify/fsnotify v1.7.0
+	github.com/spf13/cobra v1.8.1
+	github.com/spf13/viper v1.19.0
 )
 
 require (
 	github.com/hashicorp/hcl v1.0.0 // indirect
-	github.com/inconshreveable/mousetrap v1.0.0 // indirect
-	github.com/magiconair/properties v1.8.5 // indirect
-	github.com/mitchellh/mapstructure v1.4.3 // indirect
-	github.com/pelletier/go-toml v1.9.4 // indirect
-	github.com/spf13/afero v1.6.0 // indirect
-	github.com/spf13/cast v1.4.1 // indirect
-	github.com/spf13/jwalterweatherman v1.1.0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/sagikazarmark/locafero v0.6.0 // indirect
+	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
+	github.com/sourcegraph/conc v0.3.0 // indirect
+	github.com/spf13/afero v1.11.0 // indirect
+	github.com/spf13/cast v1.7.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/subosito/gotenv v1.2.0 // indirect
-	golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
-	golang.org/x/text v0.3.8 // indirect
-	gopkg.in/ini.v1 v1.66.2 // indirect
-	gopkg.in/yaml.v2 v2.4.0 // indirect
+	github.com/subosito/gotenv v1.6.0 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	golang.org/x/exp v0.0.0-20240808152545-0cdaa3abc0fa // indirect
+	golang.org/x/sys v0.24.0 // indirect
+	golang.org/x/text v0.17.0 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
 
-replace github.com/fsnotify/fsnotify v1.5.1 => github.com/Cian911/fsnotify v1.5.2-0.20220220230351-4d6a6a3b3090
+replace github.com/fsnotify/fsnotify v1.7.0 => github.com/cian911/fsnotify v1.7.5
diff --git a/go.sum b/go.sum
diff --git a/utils/utils.go b/utils/utils.go
@@ -1,7 +1,6 @@
 package utils
 
 import (
-	"io/ioutil"
 	"log"
 	"os"
 	"path/filepath"
@@ -61,7 +60,7 @@ func ValidateFileExt(ext string) bool {
 // im_a_dir -> true
 // sample.txt -> false
 func ScanFilesInDir(path string) (map[string]bool, error) {
-	files, err := ioutil.ReadDir(path)
+	files, err := os.ReadDir(path)
 	if err != nil {
 		return nil, err
 	}
diff --git a/utils/utils_test.go b/utils/utils_test.go
@@ -98,7 +98,6 @@ func TestUtils(t *testing.T) {
 
 		for _, tt := range tests {
 			got, err := ScanFilesInDir(tempDir)
-
 			if err != nil {
 				t.Fatalf("Could not scan files in dir: %v", err)
 			}
@@ -165,8 +164,7 @@ func setupTempDir(name string, t *testing.T) string {
 }
 
 func setupTempFile(name, dir string, t *testing.T) *os.File {
-	file, err := ioutil.TempFile(dir, name)
-
+	file, err := os.CreateTemp(dir, name)
 	if err != nil {
 		t.Fatalf("Unable to create temp file: %v", err)
 	}
diff --git a/watcher/helpers.go b/watcher/helpers.go
@@ -1,7 +1,7 @@
 package watcher
 
 import (
-	"io/ioutil"
+	"os"
 	"testing"
 	"time"
 
@@ -21,8 +21,7 @@ var (
 // TestEventSetup sets up a new event for testing purposes
 func TestEventSetup(t *testing.T) *event.Event {
 	path := t.TempDir()
-	_, err := ioutil.TempFile(path, HelperFile)
-
+	_, err := os.CreateTemp(path, HelperFile)
 	if err != nil {
 		t.Fatalf("Unable to create temp file: %v", err)
 	}
@@ -38,7 +37,7 @@ func TestEventSetup(t *testing.T) *event.Event {
 }
 
 // TestSimulateMultipleEvents takes a list of operations as args
-// ["CREATE", "WRITE", "CLOSEWRITE"]
+// ["CREATE", "WRITE", "CLOSE_WRITE"]
 // and returns them as a list of events
 func TestSimulateMultipleEvents(operationList []string, t *testing.T) []event.Event {
 	eventList := []event.Event{}
diff --git a/watcher/watcher.go b/watcher/watcher.go
@@ -11,9 +11,10 @@ import (
 	"regexp"
 	"time"
 
+	"github.com/fsnotify/fsnotify"
+
 	"github.com/cian911/switchboard/event"
 	"github.com/cian911/switchboard/utils"
-	"github.com/fsnotify/fsnotify"
 )
 
 // Producer interface for the watcher
@@ -109,7 +110,6 @@ func (pc *PathConsumer) Process(e *event.Event) {
 // ProcessDirEvent takes an event and scans files ext
 func (pc *PathConsumer) ProcessDirEvent(e *event.Event) {
 	files, err := utils.ScanFilesInDir(e.Path)
-
 	if err != nil {
 		log.Fatalf("Unable to scan files in dir event: error: %v, path: %s", err, e.Path)
 	}
@@ -118,7 +118,6 @@ func (pc *PathConsumer) ProcessDirEvent(e *event.Event) {
 		if utils.ExtractFileExt(file) == pc.Ext {
 			ev := event.New(file, e.Path, e.Destination, pc.Ext)
 			err = ev.Move(ev.Path, "/"+file)
-
 			if err != nil {
 				log.Printf("Unable to move file: %s from path: %s to dest: %s: %v", file, ev.Path, ev.Destination, err)
 			}
@@ -222,5 +221,4 @@ func validateRegexEventMatch(pc *PathConsumer, event *event.Event) bool {
 
 	log.Println("Regex did not match")
 	return false
-
 }
diff --git a/watcher/watcher_linux.go b/watcher/watcher_linux.go
@@ -11,9 +11,10 @@ import (
 	"regexp"
 	"time"
 
+	"github.com/fsnotify/fsnotify"
+
 	"github.com/cian911/switchboard/event"
 	"github.com/cian911/switchboard/utils"
-	"github.com/fsnotify/fsnotify"
 )
 
 // Monitor for IN_CLOSE_WRITE events on these file exts
@@ -115,7 +116,6 @@ func (pc *PathConsumer) Process(e *event.Event) {
 // ProcessDirEvent takes an event and scans files ext
 func (pc *PathConsumer) ProcessDirEvent(e *event.Event) {
 	files, err := utils.ScanFilesInDir(e.Path)
-
 	if err != nil {
 		log.Fatalf("Unable to scan files in dir event: error: %v, path: %s", err, e.Path)
 	}
@@ -124,7 +124,6 @@ func (pc *PathConsumer) ProcessDirEvent(e *event.Event) {
 		if utils.ExtractFileExt(file) == pc.Ext {
 			ev := event.New(file, e.Path, e.Destination, pc.Ext)
 			err = ev.Move(ev.Path, "/"+file)
-
 			if err != nil {
 				log.Printf("Unable to move file: %s from path: %s to dest: %s: %v", file, ev.Path, ev.Destination, err)
 			}
@@ -187,13 +186,13 @@ func (pw *PathWatcher) Observe(pollInterval int) {
 			case event := <-watcher.Events:
 				if event.Op.String() == "CREATE" && utils.IsDir(event.Name) {
 					watcher.Add(event.Name)
-				} else if event.Op.String() == "CLOSEWRITE" {
+				} else if event.Op.String() == "CLOSE_WRITE" {
 					ev := newEvent(event.Name, event.Op.String())
 
 					if specialWatchedFileExts[ev.Ext] {
 						// If the file is in the special file list
 						// add it to the queue and wait for it to be finished
-						log.Println("Adding CLOSEWRITE event to queue.")
+						log.Println("Adding CLOSE_WRITE event to queue.")
 						pw.Queue.Add(*ev)
 					} else {
 						// Otherwise process the event immediatly
@@ -225,7 +224,6 @@ func validateRegexEventMatch(pc *PathConsumer, event *event.Event) bool {
 
 	log.Println("Regex did not match")
 	return false
-
 }
 
 // Notify consumers of an event
diff --git a/watcher/watcher_linux_test.go b/watcher/watcher_linux_test.go
@@ -12,7 +12,7 @@ import (
 )
 
 func TestObserve(t *testing.T) {
-	t.Run("CLOSEWRITE", func(t *testing.T) {
+	t.Run("CLOSE_WRITE", func(t *testing.T) {
 		HelperPath = t.TempDir()
 		HelperDestination = t.TempDir()
 		HelperExt = ".txt"
@@ -34,7 +34,7 @@ func TestObserve(t *testing.T) {
 		files, _ := utils.ScanFilesInDir(HelperDestination)
 
 		if len(files) != 1 {
-			t.Errorf("CLOSEWRITE event was not processed - want: %d, got: %d", 1, len(files))
+			t.Errorf("CLOSE_WRITE event was not processed - want: %d, got: %d", 1, len(files))
 		}
 	})
 
@@ -60,6 +60,5 @@ func TestObserve(t *testing.T) {
 	})
 
 	t.Run("WRITE", func(t *testing.T) {
-
 	})
 }
diff --git a/watcher/watcher_test.go b/watcher/watcher_test.go
@@ -2,7 +2,6 @@ package watcher
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"testing"
 	"time"
@@ -52,7 +51,6 @@ func TestWatcher(t *testing.T) {
 	})
 
 	t.Run("It processes a new dir event", func(t *testing.T) {
-
 		ev := eventSetup(t)
 		ev.Path = t.TempDir()
 		ev.File = utils.ExtractFileExt(ev.Path)
@@ -135,8 +133,7 @@ func setup(p, d, e, rp string) (Producer, Consumer) {
 
 func eventSetup(t *testing.T) *event.Event {
 	path := t.TempDir()
-	_, err := ioutil.TempFile(path, file)
-
+	_, err := os.CreateTemp(path, file)
 	if err != nil {
 		t.Fatalf("Unable to create temp file: %v", err)
 	}
@@ -152,7 +149,7 @@ func eventSetup(t *testing.T) *event.Event {
 }
 
 func createTempFile(path, ext string, t *testing.T) *os.File {
-	file, err := ioutil.TempFile(path, fmt.Sprintf("*%s", ext))
+	file, err := os.CreateTemp(path, fmt.Sprintf("*%s", ext))
 	if err != nil {
 		t.Fatalf("Could not create temp file: %v", err)
 	}

Original file line number	Diff line number	Diff line change
`@@ -12,9 +12,9 @@ import (`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`var validOperations = map[string]bool{`
`15`		`- "CREATE": true,`
`16`		`- "WRITE": true,`
`17`		`- "CLOSEWRITE": true,`
	`15`	`+ "CREATE": true,`
	`16`	`+ "WRITE": true,`
	`17`	`+ "CLOSE_WRITE": true,`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`// Event is a struct that holds the information for a file event`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,6 @@ func TestUtils(t *testing.T) {`
`98`	`98`
`99`	`99`	`for _, tt := range tests {`
`100`	`100`	`got, err := ScanFilesInDir(tempDir)`
`101`		`-`
`102`	`101`	`if err != nil {`
`103`	`102`	`t.Fatalf("Could not scan files in dir: %v", err)`
`104`	`103`	`}`
`@@ -165,8 +164,7 @@ func setupTempDir(name string, t *testing.T) string {`
`165`	`164`	`}`
`166`	`165`
`167`	`166`	`func setupTempFile(name, dir string, t testing.T) os.File {`
`168`		`- file, err := ioutil.TempFile(dir, name)`
`169`		`-`
	`167`	`+ file, err := os.CreateTemp(dir, name)`
`170`	`168`	`if err != nil {`
`171`	`169`	`t.Fatalf("Unable to create temp file: %v", err)`
`172`	`170`	`}`