refactor(tests): remove `TmpFile.Error` to centralize error checks

.golangci.yml

@@ -80,7 +80,7 @@ linters-settings:
   stylecheck:
     # Whietlist dot imports for test packages.
     dot-import-whitelist:
-      - "github.com/onsi/ginkgo"
+      - "github.com/onsi/ginkgo/v2"
       - "github.com/onsi/gomega"
       - "github.com/0xERR0R/blocky/config/migration"
       - "github.com/0xERR0R/blocky/helpertest"

cmd/root_test.go

@@ -33,8 +33,6 @@ var _ = Describe("root command", func() {
 			configPath = defaultConfigPath
 
 			tmpDir = NewTmpFolder("RootCommand")
-			Expect(tmpDir.Error).Should(Succeed())
-
 			tmpFile = tmpDir.CreateStringFile("config",
 				"upstreams:",
 				"  groups:",
@@ -49,7 +47,6 @@ var _ = Describe("root command", func() {
 				"      - ads",
 				"port: 5333",
 			)
-			Expect(tmpFile.Error).Should(Succeed())
 		})
 
 		It("should accept old env var", func() {

cmd/serve_test.go

@@ -24,7 +24,7 @@ var _ = Describe("Serve command", func() {
 	BeforeEach(func() {
 		port = helpertest.GetStringPort(basePort)
 		tmpDir = helpertest.NewTmpFolder("config")
-		Expect(tmpDir.Error).Should(Succeed())
+
 		configPath = defaultConfigPath
 	})
 
@@ -38,9 +38,10 @@ var _ = Describe("Serve command", func() {
 					"      - 1.1.1.1",
 					"ports:",
 					"  dns: "+port)
-				Expect(cfgFile.Error).Should(Succeed())
+
 				os.Setenv(configFileEnvVar, cfgFile.Path)
 				DeferCleanup(func() { os.Unsetenv(configFileEnvVar) })
+
 				initConfig()
 			})
 
@@ -84,9 +85,10 @@ var _ = Describe("Serve command", func() {
 					"      - 1.1.1.1",
 					"ports:",
 					"  dns: "+port)
-				Expect(cfgFile.Error).Should(Succeed())
+
 				os.Setenv(configFileEnvVar, cfgFile.Path)
 				DeferCleanup(func() { os.Unsetenv(configFileEnvVar) })
+
 				initConfig()
 			})
 

config/config_test.go

@@ -30,7 +30,6 @@ var _ = Describe("Config", func() {
 
 	BeforeEach(func() {
 		tmpDir = helpertest.NewTmpFolder("config")
-		Expect(tmpDir.Error).Should(Succeed())
 	})
 
 	Describe("Deprecated parameters are converted", func() {
@@ -147,14 +146,9 @@ var _ = Describe("Config", func() {
 
 	Describe("Creation of Config", func() {
 		When("Test config file will be parsed", func() {
-			var confFile *helpertest.TmpFile
-
-			BeforeEach(func() {
-				confFile = writeConfigYml(tmpDir)
-				Expect(confFile.Error).Should(Succeed())
-			})
-
 			It("should return a valid config struct", func() {
+				confFile := writeConfigYml(tmpDir)
+
 				c, err = LoadConfig(confFile.Path, true)
 				Expect(err).Should(Succeed())
 
@@ -169,8 +163,7 @@ var _ = Describe("Config", func() {
 		})
 		When("Multiple config files are used", func() {
 			BeforeEach(func() {
-				err = writeConfigDir(tmpDir)
-				Expect(err).Should(Succeed())
+				writeConfigDir(tmpDir)
 			})
 
 			It("should return a valid config struct", func() {
@@ -204,7 +197,6 @@ var _ = Describe("Config", func() {
 		When("config file is malformed", func() {
 			It("should return error", func() {
 				cfgFile := tmpDir.CreateStringFile("config.yml", "malformed_config")
-				Expect(cfgFile.Error).Should(Succeed())
 
 				c, err = LoadConfig(cfgFile.Path, true)
 				Expect(err).Should(HaveOccurred())
@@ -865,8 +857,8 @@ func writeConfigYml(tmpDir *helpertest.TmpFolder) *helpertest.TmpFile {
 	)
 }
 
-func writeConfigDir(tmpDir *helpertest.TmpFolder) error {
-	f1 := tmpDir.CreateStringFile("config1.yaml",
+func writeConfigDir(tmpDir *helpertest.TmpFolder) {
+	tmpDir.CreateStringFile("config1.yaml",
 		"upstreams:",
 		"  startVerify: false",
 		"  userAgent: testBlocky",
@@ -888,11 +880,8 @@ func writeConfigDir(tmpDir *helpertest.TmpFolder) error {
 		"    - AAAA",
 		"    - A",
 	)
-	if f1.Error != nil {
-		return f1.Error
-	}
 
-	f2 := tmpDir.CreateStringFile("config2.yaml",
+	tmpDir.CreateStringFile("config2.yaml",
 		"blocking:",
 		"  blackLists:",
 		"    ads:",
@@ -930,8 +919,6 @@ func writeConfigDir(tmpDir *helpertest.TmpFolder) error {
 		"logLevel: debug",
 		"minTlsServeVersion: 1.3",
 	)
-
-	return f2.Error
 }
 
 // Tiny helper to get a new pointer with a value.

e2e/containers.go

@@ -79,9 +79,6 @@ func createHTTPServerContainer(ctx context.Context, alias string, tmpDir *helper
 	f1 := tmpDir.CreateStringFile(filename,
 		lines...,
 	)
-	if f1.Error != nil {
-		return nil, f1.Error
-	}
 
 	const modeOwner = 700
 
@@ -160,9 +157,6 @@ func createBlockyContainer(ctx context.Context, tmpDir *helpertest.TmpFolder,
 	f1 := tmpDir.CreateStringFile("config1.yaml",
 		lines...,
 	)
-	if f1.Error != nil {
-		return nil, f1.Error
-	}
 
 	cfg, err := config.LoadConfig(f1.Path, true)
 	if err != nil {

e2e/e2e_suite_test.go

@@ -53,7 +53,6 @@ var _ = BeforeSuite(func(ctx context.Context) {
 	})
 
 	tmpDir = helpertest.NewTmpFolder("config")
-	Expect(tmpDir.Error).Should(Succeed())
 
 	SetDefaultEventuallyTimeout(5 * time.Second)
 })

helpertest/tmpdata.go

@@ -6,18 +6,17 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
 )
 
 type TmpFolder struct {
 	Path   string
-	Error  error
 	prefix string
 }
 
 type TmpFile struct {
 	Path   string
-	Error  error
 	Folder *TmpFolder
 }
 
@@ -29,14 +28,14 @@ func NewTmpFolder(prefix string) *TmpFolder {
 	}
 
 	path, err := os.MkdirTemp("", ipref)
+	Expect(err).Should(Succeed())
 
 	res := &TmpFolder{
 		Path:   path,
-		Error:  err,
 		prefix: ipref,
 	}
 
-	ginkgo.DeferCleanup(res.Clean)
+	DeferCleanup(res.Clean)
 
 	return res
 }
@@ -61,9 +60,10 @@ func (tf *TmpFolder) CreateSubFolder(name string) *TmpFolder {
 		path, err = os.MkdirTemp(tf.Path, tf.prefix)
 	}
 
+	Expect(err).Should(Succeed())
+
 	res := &TmpFolder{
 		Path:   path,
-		Error:  err,
 		prefix: tf.prefix,
 	}
 
@@ -71,100 +71,63 @@ func (tf *TmpFolder) CreateSubFolder(name string) *TmpFolder {
 }
 
 func (tf *TmpFolder) CreateEmptyFile(name string) *TmpFile {
-	f, err := tf.createFile(name)
-	if err != nil {
-		return tf.newErrorTmpFile(err)
-	}
+	f, res := tf.createFile(name)
+	defer f.Close()
 
-	return tf.checkState(f, err)
+	return res
 }
 
 func (tf *TmpFolder) CreateStringFile(name string, lines ...string) *TmpFile {
-	f, err := tf.createFile(name)
-	if err != nil {
-		return tf.newErrorTmpFile(err)
-	}
+	f, res := tf.createFile(name)
+	defer f.Close()
 
 	first := true
-
 	w := bufio.NewWriter(f)
 
 	for _, l := range lines {
 		if first {
 			first = false
 		} else {
-			_, err = w.WriteString("\n")
+			_, err := w.WriteString("\n")
+			Expect(err).Should(Succeed())
 		}
 
-		if err != nil {
-			break
-		}
-
-		_, err = w.WriteString(l)
-		if err != nil {
-			break
-		}
+		_, err := w.WriteString(l)
+		Expect(err).Should(Succeed())
 	}
 
 	w.Flush()
 
-	return tf.checkState(f, err)
+	return res
 }
 
 func (tf *TmpFolder) JoinPath(name string) string {
 	return filepath.Join(tf.Path, name)
 }
 
-func (tf *TmpFolder) CountFiles() (int, error) {
+func (tf *TmpFolder) ReadDir() []fs.DirEntry {
 	files, err := os.ReadDir(tf.Path)
-	if err != nil {
-		return 0, err
-	}
+	Expect(err).Should(Succeed())
 
-	return len(files), nil
+	return files
 }
 
-func (tf *TmpFolder) createFile(name string) (*os.File, error) {
+func (tf *TmpFolder) createFile(name string) (*os.File, *TmpFile) {
+	var (
+		f   *os.File
+		err error
+	)
+
 	if len(name) > 0 {
-		return os.Create(filepath.Join(tf.Path, name))
+		f, err = os.Create(filepath.Join(tf.Path, name))
+	} else {
+		f, err = os.CreateTemp(tf.Path, "temp")
 	}
 
-	return os.CreateTemp(tf.Path, "temp")
-}
+	Expect(err).Should(Succeed())
 
-func (tf *TmpFolder) newErrorTmpFile(err error) *TmpFile {
-	return &TmpFile{
-		Path:   "",
-		Error:  err,
+	return f, &TmpFile{
+		Path:   f.Name(),
 		Folder: tf,
 	}
 }
-
-func (tf *TmpFolder) checkState(file *os.File, ierr error) *TmpFile {
-	err := ierr
-	filepath := ""
-
-	if file != nil {
-		filepath = file.Name()
-
-		file.Close()
-
-		_, err = os.Stat(filepath)
-	}
-
-	return &TmpFile{
-		Path:   filepath,
-		Error:  err,
-		Folder: tf,
-	}
-}
-
-func (tf *TmpFile) Stat() error {
-	if tf.Error != nil {
-		return tf.Error
-	}
-
-	_, res := os.Stat(tf.Path)
-
-	return res
-}

lists/list_cache_test.go

@@ -61,20 +61,13 @@ var _ = Describe("ListCache", func() {
 		server3 = TestServer("blocked3.com\nblocked1a.com")
 
 		tmpDir = NewTmpFolder("ListCache")
-		Expect(tmpDir.Error).Should(Succeed())
 		DeferCleanup(tmpDir.Clean)
 
 		emptyFile = tmpDir.CreateStringFile("empty", "#empty file")
-		Expect(emptyFile.Error).Should(Succeed())
-
 		emptyFile = tmpDir.CreateStringFile("empty", "#empty file")
-		Expect(emptyFile.Error).Should(Succeed())
 		file1 = tmpDir.CreateStringFile("file1", "blocked1.com", "blocked1a.com")
-		Expect(file1.Error).Should(Succeed())
 		file2 = tmpDir.CreateStringFile("file2", "blocked2.com")
-		Expect(file2.Error).Should(Succeed())
 		file3 = tmpDir.CreateStringFile("file3", "blocked3.com", "blocked1a.com")
-		Expect(file3.Error).Should(Succeed())
 	})
 
 	JustBeforeEach(func() {

querylog/file_writer_test.go

@@ -25,7 +25,6 @@ var _ = Describe("FileWriter", func() {
 
 	JustBeforeEach(func() {
 		tmpDir = helpertest.NewTmpFolder("fileWriter")
-		Expect(tmpDir.Error).Should(Succeed())
 	})
 
 	Describe("CSV writer", func() {
@@ -116,21 +115,11 @@ var _ = Describe("FileWriter", func() {
 					})
 				})
 
-				Eventually(func(g Gomega) int {
-					filesCount, err := tmpDir.CountFiles()
-					g.Expect(err).Should(Succeed())
+				Expect(tmpDir.ReadDir()).Should(HaveLen(2))
 
-					return filesCount
-				}, "20s", "1s").Should(Equal(2))
+				writer.CleanUp()
 
-				go writer.CleanUp()
-
-				Eventually(func(g Gomega) int {
-					filesCount, err := tmpDir.CountFiles()
-					g.Expect(err).Should(Succeed())
-
-					return filesCount
-				}, "20s", "1s").Should(Equal(1))
+				Expect(tmpDir.ReadDir()).Should(HaveLen(1))
 			})
 		})
 	})

resolver/blocking_resolver_test.go

@@ -28,20 +28,13 @@ var (
 
 var _ = BeforeSuite(func() {
 	tmpDir = NewTmpFolder("BlockingResolver")
-	Expect(tmpDir.Error).Should(Succeed())
-
 	group1File = tmpDir.CreateStringFile("group1File", "DOMAIN1.com")
-	Expect(group1File.Error).Should(Succeed())
-
 	group2File = tmpDir.CreateStringFile("group2File", "blocked2.com")
-	Expect(group2File.Error).Should(Succeed())
-
 	defaultGroupFile = tmpDir.CreateStringFile("defaultGroupFile",
 		"blocked3.com",
 		"123.145.123.145",
 		"2001:db8:85a3:08d3::370:7344",
 		"badcnamedomain.com")
-	Expect(defaultGroupFile.Error).Should(Succeed())
 })
 
 var _ = Describe("BlockingResolver", Label("blockingResolver"), func() {

resolver/hosts_file_resolver_test.go

@@ -41,10 +41,7 @@ var _ = Describe("HostsFileResolver", func() {
 		DeferCleanup(cancelFn)
 
 		tmpDir = NewTmpFolder("HostsFileResolver")
-		Expect(tmpDir.Error).Should(Succeed())
-
 		tmpFile = writeHostFile(tmpDir)
-		Expect(tmpFile.Error).Should(Succeed())
 
 		sutConfig = config.HostsFileConfig{
 			Sources:        config.NewBytesSources(tmpFile.Path),
@@ -164,7 +161,6 @@ var _ = Describe("HostsFileResolver", func() {
 					"127.0.0.x localhost",
 					"256.0.0.1 localhost",
 				)
-				Expect(tmpFile.Error).Should(Succeed())
 
 				sutConfig.Sources = config.NewBytesSources(tmpFile.Path)
 			})

resolver/query_logging_resolver_test.go

@@ -61,7 +61,6 @@ var _ = Describe("QueryLoggingResolver", func() {
 
 		mockAnswer = new(dns.Msg)
 		tmpDir = NewTmpFolder("queryLoggingResolver")
-		Expect(tmpDir.Error).Should(Succeed())
 	})
 
 	JustBeforeEach(func() {
@@ -338,21 +337,13 @@ var _ = Describe("QueryLoggingResolver", func() {
 				dateBefore9Days := time.Now().AddDate(0, 0, -9)
 
 				f1 := tmpDir.CreateEmptyFile(fmt.Sprintf("%s-test.log", dateBefore7Days.Format("2006-01-02")))
-				Expect(f1.Error).Should(Succeed())
-
 				f2 := tmpDir.CreateEmptyFile(fmt.Sprintf("%s-test.log", dateBefore9Days.Format("2006-01-02")))
-				Expect(f2.Error).Should(Succeed())
 
 				sut.doCleanUp()
 
 				Eventually(func(g Gomega) {
-					// file 1 exist
-					g.Expect(f1.Stat()).Should(Succeed())
-
-					// file 2 was deleted
-					ierr2 := f2.Stat()
-					g.Expect(ierr2).Should(HaveOccurred())
-					g.Expect(os.IsNotExist(ierr2)).Should(BeTrue())
+					g.Expect(f1.Path).Should(BeAnExistingFile())
+					g.Expect(f2.Path).ShouldNot(BeAnExistingFile())
 				}).Should(Succeed())
 			})
 		})

server/server_test.go

@@ -93,25 +93,12 @@ var _ = BeforeSuite(func() {
 	upstreamGoogle = googleMockUpstream.Start()
 
 	tmpDir := NewTmpFolder("server")
-	Expect(tmpDir.Error).Should(Succeed())
-
 	certPem := writeCertPem(tmpDir)
-	Expect(certPem.Error).Should(Succeed())
-
 	keyPem := writeKeyPem(tmpDir)
-	Expect(keyPem.Error).Should(Succeed())
-
 	doubleclickFile := tmpDir.CreateStringFile("doubleclick.net.txt", "doubleclick.net", "doubleclick.net.cn")
-	Expect(doubleclickFile.Error).Should(Succeed())
-
 	bildFile := tmpDir.CreateStringFile("www.bild.de.txt", "www.bild.de")
-	Expect(bildFile.Error).Should(Succeed())
-
 	heiseFile := tmpDir.CreateStringFile("heise.de.txt", "heise.de")
-	Expect(heiseFile.Error).Should(Succeed())
-
 	youtubeFile := tmpDir.CreateStringFile("youtube.com.txt", "youtube.com")
-	Expect(youtubeFile.Error).Should(Succeed())
 
 	cfg := &config.Config{
 		CustomDNS: config.CustomDNS{

util/hostname_test.go

@@ -15,12 +15,11 @@ var _ = Describe("Hostname function tests", func() {
 
 		BeforeEach(func() {
 			tmpDir = helpertest.NewTmpFolder("hostname")
-			Expect(tmpDir.Error).Should(Succeed())
 		})
 
 		It("should be used", func() {
 			tmpFile := tmpDir.CreateStringFile("filetest1", "TestName ")
-			Expect(tmpFile.Error).Should(Succeed())
+
 			getHostname(tmpFile.Path)
 
 			fhn, err := os.ReadFile(tmpFile.Path)