/usr/share/gocode/src/github.com/jacobsa/ogletest/register_test_suite.go is in golang-github-jacobsa-ogletest-dev 0.0~git20150610-6.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | // Copyright 2011 Aaron Jacobs. All Rights Reserved.
// Author: aaronjjacobs@gmail.com (Aaron Jacobs)
//
// 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 ogletest
import (
"fmt"
"reflect"
"github.com/jacobsa/ogletest/srcutil"
)
// Test suites that implement this interface have special meaning to
// RegisterTestSuite.
type SetUpTestSuiteInterface interface {
// This method will be called exactly once, before the first test method is
// run. The receiver of this method will be a zero value of the test suite
// type, and is not shared with any other methods. Use this method to set up
// any necessary global state shared by all of the test methods.
SetUpTestSuite()
}
// Test suites that implement this interface have special meaning to
// RegisterTestSuite.
type TearDownTestSuiteInterface interface {
// This method will be called exactly once, after the last test method is
// run. The receiver of this method will be a zero value of the test suite
// type, and is not shared with any other methods. Use this method to clean
// up after any necessary global state shared by all of the test methods.
TearDownTestSuite()
}
// Test suites that implement this interface have special meaning to
// Register.
type SetUpInterface interface {
// This method is called before each test method is invoked, with the same
// receiver as that test method. At the time this method is invoked, the
// receiver is a zero value for the test suite type. Use this method for
// common setup code that works on data not shared across tests.
SetUp(*TestInfo)
}
// Test suites that implement this interface have special meaning to
// Register.
type TearDownInterface interface {
// This method is called after each test method is invoked, with the same
// receiver as that test method. Use this method for common cleanup code that
// works on data not shared across tests.
TearDown()
}
// RegisterTestSuite tells ogletest about a test suite containing tests that it
// should run. Any exported method on the type pointed to by the supplied
// prototype value will be treated as test methods, with the exception of the
// methods defined by the following interfaces, which when present are treated
// as described in the documentation for those interfaces:
//
// * SetUpTestSuiteInterface
// * SetUpInterface
// * TearDownInterface
// * TearDownTestSuiteInterface
//
// Each test method is invoked on a different receiver, which is initially a
// zero value of the test suite type.
//
// Example:
//
// // Some value that is needed by the tests but is expensive to compute.
// var someExpensiveThing uint
//
// type FooTest struct {
// // Path to a temporary file used by the tests. Each test gets a
// // different temporary file.
// tempFile string
// }
// func init() { ogletest.RegisterTestSuite(&FooTest{}) }
//
// func (t *FooTest) SetUpTestSuite() {
// someExpensiveThing = ComputeSomeExpensiveThing()
// }
//
// func (t *FooTest) SetUp(ti *ogletest.TestInfo) {
// t.tempFile = CreateTempFile()
// }
//
// func (t *FooTest) TearDown() {
// DeleteTempFile(t.tempFile)
// }
//
// func (t *FooTest) FrobinicatorIsSuccessfullyTweaked() {
// res := DoSomethingWithExpensiveThing(someExpensiveThing, t.tempFile)
// ExpectThat(res, Equals(true))
// }
//
func RegisterTestSuite(p interface{}) {
if p == nil {
panic("RegisterTestSuite called with nil suite.")
}
val := reflect.ValueOf(p)
typ := val.Type()
var zeroInstance reflect.Value
// We will transform to a TestSuite struct.
suite := TestSuite{}
suite.Name = typ.Elem().Name()
zeroInstance = reflect.New(typ.Elem())
if i, ok := zeroInstance.Interface().(SetUpTestSuiteInterface); ok {
suite.SetUp = func() { i.SetUpTestSuite() }
}
zeroInstance = reflect.New(typ.Elem())
if i, ok := zeroInstance.Interface().(TearDownTestSuiteInterface); ok {
suite.TearDown = func() { i.TearDownTestSuite() }
}
// Transform a list of test methods for the suite, filtering them to just the
// ones that we don't need to skip.
for _, method := range filterMethods(suite.Name, srcutil.GetMethodsInSourceOrder(typ)) {
var tf TestFunction
tf.Name = method.Name
// Create an instance to be operated on by all of the TestFunction's
// internal functions.
instance := reflect.New(typ.Elem())
// Bind the functions to the instance.
if i, ok := instance.Interface().(SetUpInterface); ok {
tf.SetUp = func(ti *TestInfo) { i.SetUp(ti) }
}
methodCopy := method
tf.Run = func() { runTestMethod(instance, methodCopy) }
if i, ok := instance.Interface().(TearDownInterface); ok {
tf.TearDown = func() { i.TearDown() }
}
// Save the TestFunction.
suite.TestFunctions = append(suite.TestFunctions, tf)
}
// Register the suite.
Register(suite)
}
func runTestMethod(suite reflect.Value, method reflect.Method) {
if method.Func.Type().NumIn() != 1 {
panic(fmt.Sprintf(
"%s: expected 1 args, actually %d.",
method.Name,
method.Func.Type().NumIn()))
}
method.Func.Call([]reflect.Value{suite})
}
func filterMethods(suiteName string, in []reflect.Method) (out []reflect.Method) {
for _, m := range in {
// Skip set up, tear down, and unexported methods.
if isSpecialMethod(m.Name) || !isExportedMethod(m.Name) {
continue
}
out = append(out, m)
}
return
}
func isSpecialMethod(name string) bool {
return (name == "SetUpTestSuite") ||
(name == "TearDownTestSuite") ||
(name == "SetUp") ||
(name == "TearDown")
}
func isExportedMethod(name string) bool {
return len(name) > 0 && name[0] >= 'A' && name[0] <= 'Z'
}
|