File: suite.go

package info (click to toggle)
golang-github-go-quicktest-qt 1.101.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 236 kB
  • sloc: makefile: 2
file content (121 lines) | stat: -rw-r--r-- 3,100 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// Licensed under the MIT license, see LICENSE file for details.

/*
Package qtsuite allows quicktest to run test suites.

A test suite is a value with one or more test methods.
For example, the following code defines a suite of test functions that starts
an HTTP server before running each test, and tears it down afterwards:

	type suite struct {
		url string
	}

	func (s *suite) Init(t *testing.T) {
		hnd := func(w http.ResponseWriter, req *http.Request) {
			fmt.Fprintf(w, "%s %s", req.Method, req.URL.Path)
		}
		srv := httptest.NewServer(http.HandlerFunc(hnd))
		t.Cleanup(srv.Close)
		s.url = srv.URL
	}

	func (s *suite) TestGet(t *testing.T) {
		t.Parallel()
		resp, err := http.Get(s.url)
		qt.Assert(t, qt.IsNil(err))
		defer resp.Body.Close()
		b, err := ioutil.ReadAll(resp.Body)
		qt.Assert(t, qt.IsNil(err))
		qt.Assert(t, qt.Equals(string(b), "GET /"))
	}

	func (s *suite) TestHead(t *testing.T) {
		t.Parallel()
		resp, err := http.Head(s.url + "/path")
		qt.Assert(t, qt.IsNil(err))
		defer resp.Body.Close()
		b, err := ioutil.ReadAll(resp.Body)
		qt.Assert(t, qt.IsNil(err))
		qt.Assert(t, qt.Equals(string(b), ""))
		qt.Assert(t, qt.Equals(resp.ContentLength, 10))
	}

The above code could be invoked from a test function like this:

	func TestHTTPMethods(t *testing.T) {
		qtsuite.Run(t, &suite{})
	}
*/
package qtsuite

import (
	"reflect"
	"strings"
	"testing"
	"unicode"
	"unicode/utf8"
)

// Run runs each test method defined on the given value as a separate
// subtest. A test is a method of the form
//
//	func (T) TestXxx(*testing.T)
//
// where Xxx does not start with a lowercase letter.
//
// If suite is a pointer, the value pointed to is copied before any
// methods are invoked on it: a new copy is made for each test. This
// means that it is OK for tests to modify fields in suite concurrently
// if desired - it's OK to call t.Parallel().
//
// If suite has a method of the form
//
//	func (T) Init(*testing.T)
//
// this method will be invoked before each test run.
func Run(t *testing.T, suite any) {
	sv := reflect.ValueOf(suite)
	st := sv.Type()
	init, hasInit := st.MethodByName("Init")
	if hasInit && !isValidMethod(init) {
		t.Fatal("wrong signature for Init, must be Init(*testing.T)")
	}
	for i := 0; i < st.NumMethod(); i++ {
		m := st.Method(i)
		if !isTestMethod(m) {
			continue
		}
		t.Run(m.Name, func(t *testing.T) {
			if !isValidMethod(m) {
				t.Fatalf("wrong signature for %s, must be %s(*testing.T)", m.Name, m.Name)
			}

			sv := sv
			if st.Kind() == reflect.Ptr {
				sv1 := reflect.New(st.Elem())
				sv1.Elem().Set(sv.Elem())
				sv = sv1
			}
			args := []reflect.Value{sv, reflect.ValueOf(t)}
			if hasInit {
				init.Func.Call(args)
			}
			m.Func.Call(args)
		})
	}
}

var tType = reflect.TypeOf((*testing.T)(nil))

func isTestMethod(m reflect.Method) bool {
	if !strings.HasPrefix(m.Name, "Test") {
		return false
	}
	r, n := utf8.DecodeRuneInString(m.Name[4:])
	return n == 0 || !unicode.IsLower(r)
}

func isValidMethod(m reflect.Method) bool {
	return m.Type.NumIn() == 2 && m.Type.NumOut() == 0 && m.Type.In(1) == tType
}