navidrome/scanner/change_detector_test.go

package scanner

import (
	"context"
	"io/ioutil"
	"os"
	"path/filepath"
	"time"

	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

var _ = Describe("changeDetector", func() {
	var testFolder string
	var scanner *changeDetector

	lastModifiedSince := time.Time{}

	BeforeEach(func() {
		testFolder, _ = ioutil.TempDir("", "navidrome_tests")
		err := os.MkdirAll(testFolder, 0777)
		if err != nil {
			panic(err)
		}
		scanner = newChangeDetector(testFolder)
	})

	It("detects changes recursively", func() {
		// Scan empty folder
		changed, deleted, err := scanner.Scan(context.TODO(), lastModifiedSince)
		Expect(err).To(BeNil())
		Expect(deleted).To(BeEmpty())
		Expect(changed).To(ConsistOf("."))

		// Add one subfolder
		lastModifiedSince = nowWithDelay()
		err = os.MkdirAll(filepath.Join(testFolder, "a"), 0777)
		if err != nil {
			panic(err)
		}
		changed, deleted, err = scanner.Scan(context.TODO(), lastModifiedSince)
		Expect(err).To(BeNil())
		Expect(deleted).To(BeEmpty())
		Expect(changed).To(ConsistOf(".", P("a")))

		// Add more subfolders
		lastModifiedSince = nowWithDelay()
		err = os.MkdirAll(filepath.Join(testFolder, "a", "b", "c"), 0777)
		if err != nil {
			panic(err)
		}
		changed, deleted, err = scanner.Scan(context.TODO(), lastModifiedSince)
		Expect(err).To(BeNil())
		Expect(deleted).To(BeEmpty())
		Expect(changed).To(ConsistOf(P("a"), P("a/b"), P("a/b/c")))

		// Scan with no changes
		lastModifiedSince = nowWithDelay()
		changed, deleted, err = scanner.Scan(context.TODO(), lastModifiedSince)
		Expect(err).To(BeNil())
		Expect(deleted).To(BeEmpty())
		Expect(changed).To(BeEmpty())

		// New file in subfolder
		lastModifiedSince = nowWithDelay()
		_, err = os.Create(filepath.Join(testFolder, "a", "b", "empty.txt"))
		if err != nil {
			panic(err)
		}
		changed, deleted, err = scanner.Scan(context.TODO(), lastModifiedSince)
		Expect(err).To(BeNil())
		Expect(deleted).To(BeEmpty())
		Expect(changed).To(ConsistOf(P("a/b")))

		// Delete file in subfolder
		lastModifiedSince = nowWithDelay()
		err = os.Remove(filepath.Join(testFolder, "a", "b", "empty.txt"))
		if err != nil {
			panic(err)
		}
		changed, deleted, err = scanner.Scan(context.TODO(), lastModifiedSince)
		Expect(err).To(BeNil())
		Expect(deleted).To(BeEmpty())
		Expect(changed).To(ConsistOf(P("a/b")))

		// Delete subfolder
		lastModifiedSince = nowWithDelay()
		err = os.Remove(filepath.Join(testFolder, "a", "b", "c"))
		if err != nil {
			panic(err)
		}
		changed, deleted, err = scanner.Scan(context.TODO(), lastModifiedSince)
		Expect(err).To(BeNil())
		Expect(deleted).To(ConsistOf(P("a/b/c")))
		Expect(changed).To(ConsistOf(P("a/b")))

		// Only returns changes after lastModifiedSince
		lastModifiedSince = nowWithDelay()
		newScanner := newChangeDetector(testFolder)
		changed, deleted, err = newScanner.Scan(context.TODO(), lastModifiedSince)
		Expect(err).To(BeNil())
		Expect(deleted).To(BeEmpty())
		Expect(changed).To(BeEmpty())
		Expect(changed).To(BeEmpty())

		f, _ := os.Create(filepath.Join(testFolder, "a", "b", "new.txt"))
		_ = f.Close()
		changed, deleted, err = newScanner.Scan(context.TODO(), lastModifiedSince)
		Expect(err).To(BeNil())
		Expect(deleted).To(BeEmpty())
		Expect(changed).To(ConsistOf(P("a/b")))
	})

	Describe("isDirOrSymlinkToDir", func() {
		It("returns true for normal dirs", func() {
			dir, _ := os.Stat("tests/fixtures")
			Expect(isDirOrSymlinkToDir("tests", dir)).To(BeTrue())
		})
		It("returns true for symlinks to dirs", func() {
			dir, _ := os.Stat("tests/fixtures/symlink2dir")
			Expect(isDirOrSymlinkToDir("tests/fixtures", dir)).To(BeTrue())
		})
		It("returns false for files", func() {
			dir, _ := os.Stat("tests/fixtures/test.mp3")
			Expect(isDirOrSymlinkToDir("tests/fixtures", dir)).To(BeFalse())
		})
		It("returns false for symlinks to files", func() {
			dir, _ := os.Stat("tests/fixtures/symlink")
			Expect(isDirOrSymlinkToDir("tests/fixtures", dir)).To(BeFalse())
		})
	})

	Describe("isDirIgnored", func() {
		baseDir := filepath.Join("tests", "fixtures")
		It("returns false for normal dirs", func() {
			dir, _ := os.Stat(filepath.Join(baseDir, "empty_folder"))
			Expect(isDirIgnored(baseDir, dir)).To(BeFalse())
		})
		It("returns true when folder contains .ndignore file", func() {
			dir, _ := os.Stat(filepath.Join(baseDir, "ignored_folder"))
			Expect(isDirIgnored(baseDir, dir)).To(BeTrue())
		})
	})
})

// I hate time-based tests....
func nowWithDelay() time.Time {
	now := time.Now()
	time.Sleep(50 * time.Millisecond)
	return now
}