Simplify tests by using T.TempDir (#1186)

alexandear · web-flow · commit 6dbb0c5af531 · 2023-05-30T07:24:59.000-05:00
diff --git a/report/csv_test.go b/report/csv_test.go
@@ -1,6 +1,7 @@
 package report
 
 import (
+	"bytes"
 	"os"
 	"path/filepath"
 	"strings"
@@ -45,42 +46,35 @@ func TestWriteCSV(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		tmpfile, err := os.Create(filepath.Join(tmpPath, test.testReportName+".csv"))
+		tmpfile, err := os.Create(filepath.Join(t.TempDir(), test.testReportName+".csv"))
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		err = writeCsv(test.findings, tmpfile)
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		got, err := os.ReadFile(tmpfile.Name())
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		if test.wantEmpty {
 			if len(got) > 0 {
 				t.Errorf("Expected empty file, got %s", got)
 			}
-			os.Remove(tmpfile.Name())
 			continue
 		}
 		want, err := os.ReadFile(test.expected)
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 
-		if string(got) != string(want) {
+		if !bytes.Equal(got, want) {
 			err = os.WriteFile(strings.Replace(test.expected, ".csv", ".got.csv", 1), got, 0644)
 			if err != nil {
 				t.Error(err)
 			}
 			t.Errorf("got %s, want %s", string(got), string(want))
 		}
-
-		os.Remove(tmpfile.Name())
 	}
 }
diff --git a/report/json_test.go b/report/json_test.go
@@ -1,6 +1,7 @@
 package report
 
 import (
+	"bytes"
 	"os"
 	"path/filepath"
 	"strings"
@@ -46,44 +47,35 @@ func TestWriteJSON(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		// create tmp file using os.TempDir()
-		tmpfile, err := os.Create(filepath.Join(tmpPath, test.testReportName+".json"))
+		tmpfile, err := os.Create(filepath.Join(t.TempDir(), test.testReportName+".json"))
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		err = writeJson(test.findings, tmpfile)
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		got, err := os.ReadFile(tmpfile.Name())
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		if test.wantEmpty {
 			if len(got) > 0 {
-				os.Remove(tmpfile.Name())
 				t.Errorf("Expected empty file, got %s", got)
 			}
-			os.Remove(tmpfile.Name())
 			continue
 		}
 		want, err := os.ReadFile(test.expected)
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 
-		if string(got) != string(want) {
+		if !bytes.Equal(got, want) {
 			err = os.WriteFile(strings.Replace(test.expected, ".json", ".got.json", 1), got, 0644)
 			if err != nil {
 				t.Error(err)
 			}
 			t.Errorf("got %s, want %s", string(got), string(want))
 		}
-
-		os.Remove(tmpfile.Name())
 	}
 }
diff --git a/report/report_test.go b/report/report_test.go
@@ -11,7 +11,6 @@ import (
 
 const (
 	expectPath = "../testdata/expected/"
-	tmpPath    = "../testdata/tmp"
 )
 
 func TestReport(t *testing.T) {
@@ -80,22 +79,18 @@ func TestReport(t *testing.T) {
 	}
 
 	for i, test := range tests {
-		tmpfile, err := os.Create(filepath.Join(tmpPath, strconv.Itoa(i)+test.ext))
+		tmpfile, err := os.Create(filepath.Join(t.TempDir(), strconv.Itoa(i)+test.ext))
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		err = Write(test.findings, config.Config{}, test.ext, tmpfile.Name())
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		got, err := os.ReadFile(tmpfile.Name())
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
-		os.Remove(tmpfile.Name())
 
 		if len(got) == 0 && !test.wantEmpty {
 			t.Errorf("got empty file with extension " + test.ext)
diff --git a/report/sarif_test.go b/report/sarif_test.go
@@ -1,6 +1,7 @@
 package report
 
 import (
+	"bytes"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -48,10 +49,8 @@ func TestWriteSarif(t *testing.T) {
 	}
 
 	for _, test := range tests {
-		// create tmp file using os.TempDir()
-		tmpfile, err := os.Create(filepath.Join(tmpPath, test.testReportName+".json"))
+		tmpfile, err := os.Create(filepath.Join(t.TempDir(), test.testReportName+".json"))
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		viper.Reset()
@@ -76,36 +75,30 @@ func TestWriteSarif(t *testing.T) {
 		err = writeSarif(cfg, test.findings, tmpfile)
 		fmt.Println(cfg)
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		got, err := os.ReadFile(tmpfile.Name())
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 		if test.wantEmpty {
 			if len(got) > 0 {
-				os.Remove(tmpfile.Name())
 				t.Errorf("Expected empty file, got %s", got)
 			}
-			os.Remove(tmpfile.Name())
 			continue
 		}
 		want, err := os.ReadFile(test.expected)
 		if err != nil {
-			os.Remove(tmpfile.Name())
 			t.Error(err)
 		}
 
-		if string(got) != string(want) {
+		if !bytes.Equal(got, want) {
 			err = os.WriteFile(strings.Replace(test.expected, ".sarif", ".got.sarif", 1), got, 0644)
 			if err != nil {
 				t.Error(err)
 			}
 			t.Errorf("got %s, want %s", string(got), string(want))
 		}
 
-		os.Remove(tmpfile.Name())
 	}
 }
diff --git a/testdata/tmp/note.txt b/testdata/tmp/note.txt

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package report`
`2`	`2`
`3`	`3`	`import (`
	`4`	`+ "bytes"`
`4`	`5`	`"os"`
`5`	`6`	`"path/filepath"`
`6`	`7`	`"strings"`
`@@ -45,42 +46,35 @@ func TestWriteCSV(t *testing.T) {`
`45`	`46`	`}`
`46`	`47`
`47`	`48`	`for _, test := range tests {`
`48`		`- tmpfile, err := os.Create(filepath.Join(tmpPath, test.testReportName+".csv"))`
	`49`	`+ tmpfile, err := os.Create(filepath.Join(t.TempDir(), test.testReportName+".csv"))`
`49`	`50`	`if err != nil {`
`50`		`- os.Remove(tmpfile.Name())`
`51`	`51`	`t.Error(err)`
`52`	`52`	`}`
`53`	`53`	`err = writeCsv(test.findings, tmpfile)`
`54`	`54`	`if err != nil {`
`55`		`- os.Remove(tmpfile.Name())`
`56`	`55`	`t.Error(err)`
`57`	`56`	`}`
`58`	`57`	`got, err := os.ReadFile(tmpfile.Name())`
`59`	`58`	`if err != nil {`
`60`		`- os.Remove(tmpfile.Name())`
`61`	`59`	`t.Error(err)`
`62`	`60`	`}`
`63`	`61`	`if test.wantEmpty {`
`64`	`62`	`if len(got) > 0 {`
`65`	`63`	`t.Errorf("Expected empty file, got %s", got)`
`66`	`64`	`}`
`67`		`- os.Remove(tmpfile.Name())`
`68`	`65`	`continue`
`69`	`66`	`}`
`70`	`67`	`want, err := os.ReadFile(test.expected)`
`71`	`68`	`if err != nil {`
`72`		`- os.Remove(tmpfile.Name())`
`73`	`69`	`t.Error(err)`
`74`	`70`	`}`
`75`	`71`
`76`		`- if string(got) != string(want) {`
	`72`	`+ if !bytes.Equal(got, want) {`
`77`	`73`	`err = os.WriteFile(strings.Replace(test.expected, ".csv", ".got.csv", 1), got, 0644)`
`78`	`74`	`if err != nil {`
`79`	`75`	`t.Error(err)`
`80`	`76`	`}`
`81`	`77`	`t.Errorf("got %s, want %s", string(got), string(want))`
`82`	`78`	`}`
`83`		`-`
`84`		`- os.Remove(tmpfile.Name())`
`85`	`79`	`}`
`86`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,6 @@ import (`
`11`	`11`
`12`	`12`	`const (`
`13`	`13`	`expectPath = "../testdata/expected/"`
`14`		`- tmpPath = "../testdata/tmp"`
`15`	`14`	`)`
`16`	`15`
`17`	`16`	`func TestReport(t *testing.T) {`
`@@ -80,22 +79,18 @@ func TestReport(t *testing.T) {`
`80`	`79`	`}`
`81`	`80`
`82`	`81`	`for i, test := range tests {`
`83`		`- tmpfile, err := os.Create(filepath.Join(tmpPath, strconv.Itoa(i)+test.ext))`
	`82`	`+ tmpfile, err := os.Create(filepath.Join(t.TempDir(), strconv.Itoa(i)+test.ext))`
`84`	`83`	`if err != nil {`
`85`		`- os.Remove(tmpfile.Name())`
`86`	`84`	`t.Error(err)`
`87`	`85`	`}`
`88`	`86`	`err = Write(test.findings, config.Config{}, test.ext, tmpfile.Name())`
`89`	`87`	`if err != nil {`
`90`		`- os.Remove(tmpfile.Name())`
`91`	`88`	`t.Error(err)`
`92`	`89`	`}`
`93`	`90`	`got, err := os.ReadFile(tmpfile.Name())`
`94`	`91`	`if err != nil {`
`95`		`- os.Remove(tmpfile.Name())`
`96`	`92`	`t.Error(err)`
`97`	`93`	`}`
`98`		`- os.Remove(tmpfile.Name())`
`99`	`94`
`100`	`95`	`if len(got) == 0 && !test.wantEmpty {`
`101`	`96`	`t.Errorf("got empty file with extension " + test.ext)`