aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/gopkg.in/check.v1/run.go
blob: da8fd79872997729a8954593615a57431ddf5069 (plain) (blame)
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
package check

import (
    "bufio"
    "flag"
    "fmt"
    "os"
    "testing"
    "time"
)

// -----------------------------------------------------------------------
// Test suite registry.

var allSuites []interface{}

// Suite registers the given value as a test suite to be run. Any methods
// starting with the Test prefix in the given value will be considered as
// a test method.
func Suite(suite interface{}) interface{} {
    allSuites = append(allSuites, suite)
    return suite
}

// -----------------------------------------------------------------------
// Public running interface.

var (
    oldFilterFlag  = flag.String("gocheck.f", "", "Regular expression selecting which tests and/or suites to run")
    oldVerboseFlag = flag.Bool("gocheck.v", false, "Verbose mode")
    oldStreamFlag  = flag.Bool("gocheck.vv", false, "Super verbose mode (disables output caching)")
    oldBenchFlag   = flag.Bool("gocheck.b", false, "Run benchmarks")
    oldBenchTime   = flag.Duration("gocheck.btime", 1*time.Second, "approximate run time for each benchmark")
    oldListFlag    = flag.Bool("gocheck.list", false, "List the names of all tests that will be run")
    oldWorkFlag    = flag.Bool("gocheck.work", false, "Display and do not remove the test working directory")

    newFilterFlag  = flag.String("check.f", "", "Regular expression selecting which tests and/or suites to run")
    newVerboseFlag = flag.Bool("check.v", false, "Verbose mode")
    newStreamFlag  = flag.Bool("check.vv", false, "Super verbose mode (disables output caching)")
    newBenchFlag   = flag.Bool("check.b", false, "Run benchmarks")
    newBenchTime   = flag.Duration("check.btime", 1*time.Second, "approximate run time for each benchmark")
    newBenchMem    = flag.Bool("check.bmem", false, "Report memory benchmarks")
    newListFlag    = flag.Bool("check.list", false, "List the names of all tests that will be run")
    newWorkFlag    = flag.Bool("check.work", false, "Display and do not remove the test working directory")
)

// TestingT runs all test suites registered with the Suite function,
// printing results to stdout, and reporting any failures back to
// the "testing" package.
func TestingT(testingT *testing.T) {
    benchTime := *newBenchTime
    if benchTime == 1*time.Second {
        benchTime = *oldBenchTime
    }
    conf := &RunConf{
        Filter:        *oldFilterFlag + *newFilterFlag,
        Verbose:       *oldVerboseFlag || *newVerboseFlag,
        Stream:        *oldStreamFlag || *newStreamFlag,
        Benchmark:     *oldBenchFlag || *newBenchFlag,
        BenchmarkTime: benchTime,
        BenchmarkMem:  *newBenchMem,
        KeepWorkDir:   *oldWorkFlag || *newWorkFlag,
    }
    if *oldListFlag || *newListFlag {
        w := bufio.NewWriter(os.Stdout)
        for _, name := range ListAll(conf) {
            fmt.Fprintln(w, name)
        }
        w.Flush()
        return
    }
    result := RunAll(conf)
    println(result.String())
    if !result.Passed() {
        testingT.Fail()
    }
}

// RunAll runs all test suites registered with the Suite function, using the
// provided run configuration.
func RunAll(runConf *RunConf) *Result {
    result := Result{}
    for _, suite := range allSuites {
        result.Add(Run(suite, runConf))
    }
    return &result
}

// Run runs the provided test suite using the provided run configuration.
func Run(suite interface{}, runConf *RunConf) *Result {
    runner := newSuiteRunner(suite, runConf)
    return runner.run()
}

// ListAll returns the names of all the test functions registered with the
// Suite function that will be run with the provided run configuration.
func ListAll(runConf *RunConf) []string {
    var names []string
    for _, suite := range allSuites {
        names = append(names, List(suite, runConf)...)
    }
    return names
}

// List returns the names of the test functions in the given
// suite that will be run with the provided run configuration.
func List(suite interface{}, runConf *RunConf) []string {
    var names []string
    runner := newSuiteRunner(suite, runConf)
    for _, t := range runner.tests {
        names = append(names, t.String())
    }
    return names
}

// -----------------------------------------------------------------------
// Result methods.

func (r *Result) Add(other *Result) {
    r.Succeeded += other.Succeeded
    r.Skipped += other.Skipped
    r.Failed += other.Failed
    r.Panicked += other.Panicked
    r.FixturePanicked += other.FixturePanicked
    r.ExpectedFailures += other.ExpectedFailures
    r.Missed += other.Missed
    if r.WorkDir != "" && other.WorkDir != "" {
        r.WorkDir += ":" + other.WorkDir
    } else if other.WorkDir != "" {
        r.WorkDir = other.WorkDir
    }
}

func (r *Result) Passed() bool {
    return (r.Failed == 0 && r.Panicked == 0 &&
        r.FixturePanicked == 0 && r.Missed == 0 &&
        r.RunError == nil)
}

func (r *Result) String() string {
    if r.RunError != nil {
        return "ERROR: " + r.RunError.Error()
    }

    var value string
    if r.Failed == 0 && r.Panicked == 0 && r.FixturePanicked == 0 &&
        r.Missed == 0 {
        value = "OK: "
    } else {
        value = "OOPS: "
    }
    value += fmt.Sprintf("%d passed", r.Succeeded)
    if r.Skipped != 0 {
        value += fmt.Sprintf(", %d skipped", r.Skipped)
    }
    if r.ExpectedFailures != 0 {
        value += fmt.Sprintf(", %d expected failures", r.ExpectedFailures)
    }
    if r.Failed != 0 {
        value += fmt.Sprintf(", %d FAILED", r.Failed)
    }
    if r.Panicked != 0 {
        value += fmt.Sprintf(", %d PANICKED", r.Panicked)
    }
    if r.FixturePanicked != 0 {
        value += fmt.Sprintf(", %d FIXTURE-PANICKED", r.FixturePanicked)
    }
    if r.Missed != 0 {
        value += fmt.Sprintf(", %d MISSED", r.Missed)
    }
    if r.WorkDir != "" {
        value += "\nWORK=" + r.WorkDir
    }
    return value
}