mirror of https://github.com/grpc/grpc-go.git
115 lines
3.0 KiB
Go
115 lines
3.0 KiB
Go
/*
|
|
*
|
|
* Copyright 2018 gRPC authors.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
*/
|
|
|
|
// Package grpctest implements testing helpers.
|
|
package grpctest
|
|
|
|
import (
|
|
"reflect"
|
|
"strings"
|
|
"sync/atomic"
|
|
"testing"
|
|
|
|
"google.golang.org/grpc/internal/leakcheck"
|
|
)
|
|
|
|
var lcFailed uint32
|
|
|
|
type errorer struct {
|
|
t *testing.T
|
|
}
|
|
|
|
func (e errorer) Errorf(format string, args ...any) {
|
|
atomic.StoreUint32(&lcFailed, 1)
|
|
e.t.Errorf(format, args...)
|
|
}
|
|
|
|
// Tester is an implementation of the x interface parameter to
|
|
// grpctest.RunSubTests with default Setup and Teardown behavior. Setup updates
|
|
// the tlogger and Teardown performs a leak check. Embed in a struct with tests
|
|
// defined to use.
|
|
type Tester struct{}
|
|
|
|
// Setup updates the tlogger.
|
|
func (Tester) Setup(t *testing.T) {
|
|
TLogger.Update(t)
|
|
}
|
|
|
|
// Teardown performs a leak check.
|
|
func (Tester) Teardown(t *testing.T) {
|
|
if atomic.LoadUint32(&lcFailed) == 1 {
|
|
return
|
|
}
|
|
leakcheck.Check(errorer{t: t})
|
|
if atomic.LoadUint32(&lcFailed) == 1 {
|
|
t.Log("Leak check disabled for future tests")
|
|
}
|
|
TLogger.EndTest(t)
|
|
}
|
|
|
|
// Interface defines Tester's methods for use in this package.
|
|
type Interface interface {
|
|
Setup(*testing.T)
|
|
Teardown(*testing.T)
|
|
}
|
|
|
|
func getTestFunc(t *testing.T, xv reflect.Value, name string) func(*testing.T) {
|
|
if m := xv.MethodByName(name); m.IsValid() {
|
|
if f, ok := m.Interface().(func(*testing.T)); ok {
|
|
return f
|
|
}
|
|
// Method exists but has the wrong type signature.
|
|
t.Fatalf("grpctest: function %v has unexpected signature (%T)", name, m.Interface())
|
|
}
|
|
return func(*testing.T) {}
|
|
}
|
|
|
|
// RunSubTests runs all "Test___" functions that are methods of x as subtests
|
|
// of the current test. Setup is run before the test function and Teardown is
|
|
// run after.
|
|
//
|
|
// For example usage, see example_test.go. Run it using:
|
|
//
|
|
// $ go test -v -run TestExample .
|
|
//
|
|
// To run a specific test/subtest:
|
|
//
|
|
// $ go test -v -run 'TestExample/^Something$' .
|
|
func RunSubTests(t *testing.T, x Interface) {
|
|
xt := reflect.TypeOf(x)
|
|
xv := reflect.ValueOf(x)
|
|
|
|
for i := 0; i < xt.NumMethod(); i++ {
|
|
methodName := xt.Method(i).Name
|
|
if !strings.HasPrefix(methodName, "Test") {
|
|
continue
|
|
}
|
|
tfunc := getTestFunc(t, xv, methodName)
|
|
t.Run(strings.TrimPrefix(methodName, "Test"), func(t *testing.T) {
|
|
// Run leakcheck in t.Cleanup() to guarantee it is run even if tfunc
|
|
// or setup uses t.Fatal().
|
|
//
|
|
// Note that a defer would run before t.Cleanup, so if a goroutine
|
|
// is closed by a test's t.Cleanup, a deferred leakcheck would fail.
|
|
t.Cleanup(func() { x.Teardown(t) })
|
|
x.Setup(t)
|
|
tfunc(t)
|
|
})
|
|
}
|
|
}
|