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
|
package test_helpers
import (
"fmt"
"strings"
"sync"
"github.com/onsi/ginkgo/v2/formatter"
"github.com/onsi/ginkgo/v2/internal"
. "github.com/onsi/gomega"
"github.com/onsi/gomega/types"
)
/*
RunTracker tracks invocations of functions - useful to assert orders in which nodes run
*/
type RunTracker struct {
lock *sync.Mutex
trackedRuns []string
trackedData map[string]map[string]interface{}
}
func NewRunTracker() *RunTracker {
return &RunTracker{
lock: &sync.Mutex{},
trackedData: map[string]map[string]interface{}{},
}
}
func (rt *RunTracker) Reset() {
rt.lock.Lock()
defer rt.lock.Unlock()
rt.trackedRuns = []string{}
}
func (rt *RunTracker) Run(text string) {
rt.lock.Lock()
defer rt.lock.Unlock()
rt.trackedRuns = append(rt.trackedRuns, text)
}
func (rt *RunTracker) RunWithData(text string, kv ...interface{}) {
rt.lock.Lock()
defer rt.lock.Unlock()
rt.trackedRuns = append(rt.trackedRuns, text)
data := map[string]interface{}{}
for i := 0; i < len(kv); i += 2 {
key := kv[i].(string)
value := kv[i+1]
data[key] = value
}
rt.trackedData[text] = data
}
func (rt *RunTracker) TrackedRuns() []string {
rt.lock.Lock()
defer rt.lock.Unlock()
trackedRuns := make([]string, len(rt.trackedRuns))
copy(trackedRuns, rt.trackedRuns)
return trackedRuns
}
func (rt *RunTracker) DataFor(text string) map[string]interface{} {
rt.lock.Lock()
defer rt.lock.Unlock()
return rt.trackedData[text]
}
func (rt *RunTracker) T(text string, callback ...func()) func() {
return func() {
rt.Run(text)
if len(callback) > 0 {
callback[0]()
}
}
}
func (rt *RunTracker) TSC(text string, callback ...func(internal.SpecContext)) func(internal.SpecContext) {
return func(c internal.SpecContext) {
rt.Run(text)
if len(callback) > 0 {
callback[0](c)
}
}
}
func (rt *RunTracker) C(text string, callback ...func()) func(args []string, additionalArgs []string) {
return func(args []string, additionalArgs []string) {
rt.RunWithData(text, "Args", args, "AdditionalArgs", additionalArgs)
if len(callback) > 0 {
callback[0]()
}
}
}
func HaveRun(run string) OmegaMatcher {
return WithTransform(func(rt *RunTracker) []string {
return rt.TrackedRuns()
}, ContainElement(run))
}
func HaveRunWithData(run string, kv ...interface{}) OmegaMatcher {
matchers := []types.GomegaMatcher{}
for i := 0; i < len(kv); i += 2 {
matchers = append(matchers, HaveKeyWithValue(kv[i], kv[i+1]))
}
return And(
HaveRun(run),
WithTransform(func(rt *RunTracker) map[string]interface{} {
return rt.DataFor(run)
}, And(matchers...)),
)
}
func HaveTrackedNothing() OmegaMatcher {
return WithTransform(func(rt *RunTracker) []string {
return rt.TrackedRuns()
}, BeEmpty())
}
type HaveTrackedMatcher struct {
expectedRuns []string
message string
}
func (m *HaveTrackedMatcher) Match(actual interface{}) (bool, error) {
rt, ok := actual.(*RunTracker)
if !ok {
return false, fmt.Errorf("HaveTracked() must be passed a RunTracker - got %T instead", actual)
}
actualRuns := rt.TrackedRuns()
n := len(actualRuns)
if n < len(m.expectedRuns) {
n = len(m.expectedRuns)
}
failureMessage, success := &strings.Builder{}, true
fmt.Fprintf(failureMessage, "{{/}}%10s == %-10s{{/}}\n", "Actual", "Expected")
fmt.Fprintf(failureMessage, "{{/}}========================\n{{/}}")
for i := 0; i < n; i++ {
var expected, actual string
if i < len(actualRuns) {
actual = actualRuns[i]
}
if i < len(m.expectedRuns) {
expected = m.expectedRuns[i]
}
if actual != expected {
success = false
fmt.Fprintf(failureMessage, "{{red}}%10s != %-10s{{/}}\n", actual, expected)
} else {
fmt.Fprintf(failureMessage, "{{green}}%10s == %-10s{{/}}\n", actual, expected)
}
}
m.message = failureMessage.String()
return success, nil
}
func (m *HaveTrackedMatcher) FailureMessage(actual interface{}) string {
return "Expected runs did not match tracked runs:\n" + formatter.F(m.message)
}
func (m *HaveTrackedMatcher) NegatedFailureMessage(actual interface{}) string {
return "Expected runs matched tracked runs:\n" + formatter.F(m.message)
}
func HaveTracked(runs ...string) OmegaMatcher {
return &HaveTrackedMatcher{expectedRuns: runs}
}
|