feat: support common test methods (#94)

Signed-off-by: Tronje Krop <[email protected]>
tkrop · Oct 20, 2024 · f23b9cf · f23b9cf
1 parent 428d035
commit f23b9cf
Show file tree

Hide file tree

Showing 6 changed files with 597 additions and 41 deletions.
diff --git a/internal/mock/common_test.go b/internal/mock/common_test.go
@@ -124,14 +124,12 @@ func methodsMockIFaceFunc(mocktest, test, mock string) []*Method {
 		}, {
 			Name: "err", Type: "error",
 		}},
-		Variadic: false,
 	}, {
 		Name: "CallC",
 		Params: []*Param{{
 			Name: "test", Type: aliasType(test, "Context"),
 		}},
-		Results:  []*Param{},
-		Variadic: false,
+		Results: []*Param{},
 	}}
 }
 
@@ -172,13 +170,25 @@ var (
 		pathTest, pathTesting, pathMock)
 
 	methodsTestTest = []*Method{{
+		Name: "Cleanup",
+		Params: []*Param{
+			{Name: "cleanup", Type: "func()"},
+		},
+		Results: []*Param{},
+	}, {
 		Name:   "Deadline",
 		Params: []*Param{},
 		Results: []*Param{
 			{Name: "deadline", Type: "time.Time"},
 			{Name: "ok", Type: "bool"},
 		},
-		Variadic: false,
+	}, {
+		Name: "Error",
+		Params: []*Param{
+			{Name: "args", Type: "[]any"},
+		},
+		Results:  []*Param{},
+		Variadic: true,
 	}, {
 		Name: "Errorf",
 		Params: []*Param{
@@ -188,10 +198,24 @@ var (
 		Results:  []*Param{},
 		Variadic: true,
 	}, {
-		Name:     "FailNow",
-		Params:   []*Param{},
+		Name:    "Fail",
+		Params:  []*Param{},
+		Results: []*Param{},
+	}, {
+		Name:    "FailNow",
+		Params:  []*Param{},
+		Results: []*Param{},
+	}, {
+		Name:    "Failed",
+		Params:  []*Param{},
+		Results: []*Param{{Type: "bool"}},
+	}, {
+		Name: "Fatal",
+		Params: []*Param{
+			{Name: "args", Type: "[]any"},
+		},
 		Results:  []*Param{},
-		Variadic: false,
+		Variadic: true,
 	}, {
 		Name: "Fatalf",
 		Params: []*Param{
@@ -201,36 +225,76 @@ var (
 		Results:  []*Param{},
 		Variadic: true,
 	}, {
-		Name:     "Helper",
-		Params:   []*Param{},
-		Results:  []*Param{},
-		Variadic: false,
+		Name:    "Helper",
+		Params:  []*Param{},
+		Results: []*Param{},
 	}, {
-		Name:     "Name",
-		Params:   []*Param{},
-		Results:  []*Param{{Type: "string"}},
-		Variadic: false,
+		Name: "Log",
+		Params: []*Param{
+			{Name: "args", Type: "[]any"},
+		},
+		Results:  []*Param{},
+		Variadic: true,
 	}, {
-		Name:     "Parallel",
-		Params:   []*Param{},
+		Name: "Logf",
+		Params: []*Param{
+			{Name: "format", Type: "string"},
+			{Name: "args", Type: "[]any"},
+		},
 		Results:  []*Param{},
-		Variadic: false,
+		Variadic: true,
+	}, {
+		Name:    "Name",
+		Params:  []*Param{},
+		Results: []*Param{{Type: "string"}},
+	}, {
+		Name:    "Parallel",
+		Params:  []*Param{},
+		Results: []*Param{},
 	}, {
 		Name: "Setenv",
 		Params: []*Param{
 			{Name: "key", Type: "string"},
 			{Name: "value", Type: "string"},
 		},
+		Results: []*Param{},
+	}, {
+		Name: "Skip",
+		Params: []*Param{
+			{Name: "args", Type: "[]any"},
+		},
+		Results:  []*Param{},
+		Variadic: true,
+	}, {
+		Name:    "SkipNow",
+		Params:  []*Param{},
+		Results: []*Param{},
+	}, {
+		Name: "Skipf",
+		Params: []*Param{
+			{Name: "format", Type: "string"},
+			{Name: "args", Type: "[]any"},
+		},
 		Results:  []*Param{},
-		Variadic: false,
+		Variadic: true,
 	}, {
-		Name:     "TempDir",
-		Params:   []*Param{},
-		Results:  []*Param{{Type: "string"}},
-		Variadic: false,
+		Name:    "Skipped",
+		Params:  []*Param{},
+		Results: []*Param{{Type: "bool"}},
+	}, {
+		Name:    "TempDir",
+		Params:  []*Param{},
+		Results: []*Param{{Type: "string"}},
 	}}
 
 	methodsTestReporter = []*Method{{
+		Name: "Error",
+		Params: []*Param{
+			{Name: "args", Type: "[]any"},
+		},
+		Results:  []*Param{},
+		Variadic: true,
+	}, {
 		Name: "Errorf",
 		Params: []*Param{
 			{Name: "format", Type: "string"},
@@ -239,10 +303,20 @@ var (
 		Results:  []*Param{},
 		Variadic: true,
 	}, {
-		Name:     "FailNow",
-		Params:   []*Param{},
+		Name:    "Fail",
+		Params:  []*Param{},
+		Results: []*Param{},
+	}, {
+		Name:    "FailNow",
+		Params:  []*Param{},
+		Results: []*Param{},
+	}, {
+		Name: "Fatal",
+		Params: []*Param{
+			{Name: "args", Type: "[]any"},
+		},
 		Results:  []*Param{},
-		Variadic: false,
+		Variadic: true,
 	}, {
 		Name: "Fatalf",
 		Params: []*Param{
@@ -252,10 +326,9 @@ var (
 		Results:  []*Param{},
 		Variadic: true,
 	}, {
-		Name:     "Panic",
-		Params:   []*Param{{Name: "arg", Type: "any"}},
-		Results:  []*Param{},
-		Variadic: false,
+		Name:    "Panic",
+		Params:  []*Param{{Name: "arg", Type: "any"}},
+		Results: []*Param{},
 	}}
 
 	methodsGoMockTestReporter = []*Method{{

diff --git a/test/caller_test.go b/test/caller_test.go
@@ -20,13 +20,28 @@ type Caller struct {
 	path string
 }
 
+// Error is the caller reporter function to capture the callers file and line
+// number of the `Error` call.
+func (c *Caller) Error(_ ...any) {
+	_, path, line, _ := runtime.Caller(1)
+	c.path = path + ":" + strconv.Itoa(line)
+}
+
 // Errorf is the caller reporter function to capture the callers file and line
 // number of the `Errorf` call.
 func (c *Caller) Errorf(_ string, _ ...any) {
 	_, path, line, _ := runtime.Caller(1)
 	c.path = path + ":" + strconv.Itoa(line)
 }
 
+// Fatal is the caller reporter function to capture the callers file and line
+// number of the `Fatal` call.
+func (c *Caller) Fatal(_ ...any) {
+	_, path, line, _ := runtime.Caller(1)
+	c.path = path + ":" + strconv.Itoa(line)
+	panic("finished") // prevents goexit.
+}
+
 // Fatalf is the caller reporter function to capture the callers file and line
 // number of the `Fatalf` call.
 func (c *Caller) Fatalf(_ string, _ ...any) {
@@ -35,6 +50,14 @@ func (c *Caller) Fatalf(_ string, _ ...any) {
 	panic("finished") // prevents goexit.
 }
 
+// Fail is the caller reporter function to capture the callers file and line
+// number of the `Fail` call.
+func (c *Caller) Fail() {
+	_, path, line, _ := runtime.Caller(1)
+	c.path = path + ":" + strconv.Itoa(line)
+	panic("finished") // prevents goexit.
+}
+
 // FailNow is the caller reporter function to capture the callers file and line
 // number of the `FailNow` call.
 func (c *Caller) FailNow() {
@@ -43,6 +66,8 @@ func (c *Caller) FailNow() {
 	panic("finished") // prevents goexit.
 }
 
+// Panic is the caller reporter function to capture the callers file and line
+// number of the `Panic` call.
 func (c *Caller) Panic(_ any) {
 	_, path, line, _ := runtime.Caller(1)
 	c.path = path + ":" + strconv.Itoa(line)
@@ -67,14 +92,26 @@ func getCaller(call func(t test.Reporter)) string {
 }
 
 var (
+	// CallerError provides the file with line number of the `Error` call.
+	CallerError = getCaller(func(t test.Reporter) {
+		t.Error("fail")
+	})
 	// CallerErrorf provides the file with line number of the `Errorf` call.
 	CallerErrorf = getCaller(func(t test.Reporter) {
 		t.Errorf("fail")
 	})
+	// CallerFatal provides the file with line number of the `Fatal` call.
+	CallerFatal = getCaller(func(t test.Reporter) {
+		t.Fatal("fail")
+	})
 	// CallerFatalf provides the file with line number of the `Fatalf` call.
 	CallerFatalf = getCaller(func(t test.Reporter) {
 		t.Fatalf("fail")
 	})
+	// CallerFail provides the file with line number of the `Fail` call.
+	CallerFail = getCaller(func(t test.Reporter) {
+		t.Fail()
+	})
 	// CallerFailNow provides the file with line number of the `FailNow` call.
 	CallerFailNow = getCaller(func(t test.Reporter) {
 		t.FailNow()
@@ -92,10 +129,17 @@ var (
 		}
 		return dir
 	}()
+	// CallerTestError provides the file with the line number of the `Error`
+	// call in the test context implementation.
+	CallerTestError = path.Join(SourceDir, "context.go:356")
+	// CallerReporterErrorf provides the file with the line number of the
+	// `Errorf` call in the test reporter/validator implementation.
+	CallerReporterError = path.Join(SourceDir, "gomock.go:60")
+
 	// CallerTestErrorf provides the file with the line number of the `Errorf`
 	// call in the test context implementation.
-	CallerTestErrorf = path.Join(SourceDir, "context.go:276")
+	CallerTestErrorf = path.Join(SourceDir, "context.go:374")
 	// CallerReporterErrorf provides the file with the line number of the
 	// `Errorf` call in the test reporter/validator implementation.
-	CallerReporterErrorf = path.Join(SourceDir, "gomock.go:61")
+	CallerReporterErrorf = path.Join(SourceDir, "gomock.go:82")
 )