chore: add support for thelper (#2184)

Author: remyleone

.golangci.yml

@@ -40,10 +40,14 @@ linters:
     - nolintlint # Reports ill-formed or insufficient nolint directives [fast: true, auto-fix: false]
     - nosprintfhostport # Checks for misuse of Sprintf to construct a host with port in a URL. [fast: true, auto-fix: false]
     - perfsprint # Checks that fmt.Sprintf can be replaced with a faster alternative. [fast: false, auto-fix: false]
+    - prealloc # Finds slice declarations that could potentially be pre-allocated [fast: true, auto-fix: false]
     - rowserrcheck # checks whether Err of rows is checked successfully [fast: false, auto-fix: false]
     - sloglint # ensure consistent code style when using log/slog [fast: false, auto-fix: false]
     - sqlclosecheck # Checks that sql.Rows and sql.Stmt are closed. [fast: false, auto-fix: false]
     - staticcheck #(megacheck): Staticcheck is a go vet on steroids, applying a ton of static analysis checks [fast: false, auto-fix: false]
+    - tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17 [fast: false, auto-fix: false]
+    - testifylint # Checks usage of github.com/stretchr/testify. [fast: false, auto-fix: false]
+    - thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers [fast: false, auto-fix: false]
     - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code [fast: false, auto-fix: false]
     - unconvert # Remove unnecessary type conversions [fast: false, auto-fix: false]
     - unused #(megacheck): Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false]

api/instance/v1/image_utils_test.go

@@ -33,6 +33,7 @@ func TestWaitForImage(t *testing.T) {
 // createImage cis a helper that create an image.
 // It return the newly created image and a cleanup function
 func createImage(t *testing.T, instanceAPI *API, imageName string) (*Image, func()) {
+	t.Helper()
 	serverRes, err := instanceAPI.CreateServer(&CreateServerRequest{
 		CommercialType: "DEV1-M",
 		Image:          "ubuntu_focal",

api/instance/v1/security_group_utils_test.go

@@ -69,6 +69,7 @@ func TestAPI_UpdateSecurityGroupRule(t *testing.T) {
 	instanceAPI := NewAPI(client)
 
 	bootstrap := func(t *testing.T) (*SecurityGroup, *SecurityGroupRule, func()) {
+		t.Helper()
 		createSecurityGroupResponse, err := instanceAPI.CreateSecurityGroup(&CreateSecurityGroupRequest{
 			Name:                  "name",
 			Description:           "description",

api/instance/v1/snapshot_utils_test.go

@@ -33,6 +33,7 @@ func TestWaitForSnapshot(t *testing.T) {
 // createSnapshot is a helper that create an snapshot.
 // It returns the newly created snapshot and a cleanup function
 func createSnapshot(t *testing.T, instanceAPI *API, snapshotName string) (*Snapshot, func()) {
+	t.Helper()
 	serverRes, err := instanceAPI.CreateServer(&CreateServerRequest{
 		CommercialType: "DEV1-M",
 		Image:          "ubuntu_focal",

internal/testhelpers/test_helpers.go

@@ -10,6 +10,7 @@ import (
 
 // Assert fails the test if the condition is false.
 func Assert(tb testing.TB, condition bool, msg string, v ...interface{}) {
+	tb.Helper()
 	if !condition {
 		_, file, line, _ := runtime.Caller(1)
 		fmt.Printf("\033[31m%s:%d: "+msg+"\033[39m\n\n", append([]interface{}{filepath.Base(file), line}, v...)...)
@@ -19,6 +20,7 @@ func Assert(tb testing.TB, condition bool, msg string, v ...interface{}) {
 
 // AssertNoError fails the test if an err is not nil.
 func AssertNoError(tb testing.TB, err error) {
+	tb.Helper()
 	if err != nil {
 		_, file, line, _ := runtime.Caller(1)
 		fmt.Printf("\033[31m%s:%d: unexpected error: %s\033[39m\n\n", filepath.Base(file), line, err.Error())
@@ -28,6 +30,7 @@ func AssertNoError(tb testing.TB, err error) {
 
 // Equals fails the test if exp is not equal to act.
 func Equals(tb testing.TB, exp, act interface{}) {
+	tb.Helper()
 	if !reflect.DeepEqual(exp, act) {
 		_, file, line, _ := runtime.Caller(1)
 		fmt.Printf("\033[31m%s:%d:\n\n\texp: %#v\n\n\tgot: %#v\033[39m\n\n", filepath.Base(file), line, exp, act)

logger/logger_test.go

@@ -65,6 +65,7 @@ func TestEnableDebugMode(t *testing.T) {
 }
 
 func testThings(t *testing.T, expectedEvents []string, actualOutput string) {
+	t.Helper()
 	lines := strings.Split(actualOutput, "\n")
 	for i, line := range lines[:len(lines)-1] { // last line is always empty
 		tmp := strings.Split(line, " ")

scw/config_test.go

@@ -508,6 +508,7 @@ func TestMergeProfiles(t *testing.T) {
 }
 
 func initEnv(t *testing.T) string {
+	t.Helper()
 	dir, err := os.MkdirTemp("", "home")
 	if err != nil {
 		t.Fatal(err)
@@ -516,12 +517,14 @@ func initEnv(t *testing.T) string {
 }
 
 func cleanEnv(t *testing.T, files map[string]string, homeDir string) {
+	t.Helper()
 	for path := range files {
 		testhelpers.AssertNoError(t, os.RemoveAll(filepath.Join(homeDir, path)))
 	}
 }
 
 func setEnv(t *testing.T, env, files map[string]string, homeDir string) {
+	t.Helper()
 	os.Clearenv()
 	for key, value := range env {
 		value = strings.ReplaceAll(value, "{HOME}", homeDir)
@@ -537,6 +540,7 @@ func setEnv(t *testing.T, env, files map[string]string, homeDir string) {
 
 // function taken from https://golang.org/src/os/env_test.go
 func resetEnv(t *testing.T, origEnv []string, homeDir string) {
+	t.Helper()
 	testhelpers.AssertNoError(t, os.RemoveAll(homeDir))
 	for _, pair := range origEnv {
 		// Environment variables on Windows can begin with =
@@ -572,6 +576,7 @@ func TestConfig_ConfigFile(t *testing.T) {
 
 	run := func(c *testCase) func(t *testing.T) {
 		return func(t *testing.T) {
+			t.Helper()
 			config, err := c.config.HumanConfig()
 			testhelpers.AssertNoError(t, err)
 			testhelpers.Equals(t, c.result, config)

scw/custom_types_test.go

@@ -340,6 +340,7 @@ func TestFile_UnmarshalJSON(t *testing.T) {
 
 	run := func(c *testCase) func(t *testing.T) {
 		return func(t *testing.T) {
+			t.Helper()
 			f := File{}
 			err := json.Unmarshal([]byte(c.json), &f)
 			testhelpers.AssertNoError(t, err)

scw/errors_test.go

@@ -36,6 +36,7 @@ func TestNonStandardError(t *testing.T) {
 
 	run := func(c *testCase) func(t *testing.T) {
 		return func(t *testing.T) {
+			t.Helper()
 			res := &http.Response{
 				Status:     c.resStatus,
 				StatusCode: c.resStatusCode,