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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
|
package testingtproxy_test
import (
"os"
"runtime"
"time"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"github.com/onsi/gomega/gbytes"
"github.com/onsi/ginkgo/v2/internal"
"github.com/onsi/ginkgo/v2/internal/testingtproxy"
"github.com/onsi/ginkgo/v2/types"
)
type messagedCall struct {
message string
callerSkip []int
}
var _ = Describe("Testingtproxy", func() {
var t FullGinkgoTInterface
var failFunc func(message string, callerSkip ...int)
var skipFunc func(message string, callerSkip ...int)
var reportFunc func() types.SpecReport
var failFuncCall messagedCall
var skipFuncCall messagedCall
var offset int
var reportToReturn types.SpecReport
var buf *gbytes.Buffer
var recoverCall bool
var attachedProgressReporter func() string
var attachProgressReporterCancelCalled bool
BeforeEach(func() {
recoverCall = false
attachProgressReporterCancelCalled = false
failFuncCall = messagedCall{}
skipFuncCall = messagedCall{}
offset = 3
reportToReturn = types.SpecReport{}
failFunc = func(message string, callerSkip ...int) {
failFuncCall.message = message
failFuncCall.callerSkip = callerSkip
}
skipFunc = func(message string, callerSkip ...int) {
skipFuncCall.message = message
skipFuncCall.callerSkip = callerSkip
}
reportFunc = func() types.SpecReport {
return reportToReturn
}
ginkgoRecoverFunc := func() {
recoverCall = true
}
attachProgressReporterFunc := func(f func() string) func() {
attachedProgressReporter = f
return func() {
attachProgressReporterCancelCalled = true
}
}
buf = gbytes.NewBuffer()
t = testingtproxy.New(
internal.NewWriter(buf),
failFunc,
skipFunc,
DeferCleanup,
reportFunc,
AddReportEntry,
ginkgoRecoverFunc,
attachProgressReporterFunc,
17,
3,
5,
true,
offset)
})
Describe("Cleanup", Ordered, func() {
var didCleanupAfter bool
It("supports cleanup", func() {
Ω(didCleanupAfter).Should(BeFalse())
t.Cleanup(func() {
didCleanupAfter = true
})
})
It("ran cleanup after the last test", func() {
Ω(didCleanupAfter).Should(BeTrue())
})
})
Describe("Setenv", func() {
Context("when the environment variable does not exist", Ordered, func() {
const key = "FLOOP_FLARP_WIBBLE_BLARP"
BeforeAll(func() {
os.Unsetenv(key)
})
It("sets the environment variable", func() {
t.Setenv(key, "HELLO")
Ω(os.Getenv(key)).Should(Equal("HELLO"))
})
It("cleans up after itself", func() {
_, exists := os.LookupEnv(key)
Ω(exists).Should(BeFalse())
})
})
Context("when the environment variable does exist", Ordered, func() {
const key = "FLOOP_FLARP_WIBBLE_BLARP"
const originalValue = "HOLA"
BeforeAll(func() {
os.Setenv(key, originalValue)
})
It("sets it", func() {
t.Setenv(key, "HELLO")
Ω(os.Getenv(key)).Should(Equal("HELLO"))
})
It("cleans up after itself", func() {
Ω(os.Getenv(key)).Should(Equal("HOLA"))
})
AfterAll(func() {
os.Unsetenv(key)
})
})
})
Describe("TempDir", Ordered, func() {
var tempDirA, tempDirB string
It("creates temporary directories", func() {
tempDirA = t.TempDir()
tempDirB = t.TempDir()
Ω(tempDirA).Should(BeADirectory())
Ω(tempDirB).Should(BeADirectory())
Ω(tempDirA).ShouldNot(Equal(tempDirB))
})
It("cleans up after itself", func() {
Ω(tempDirA).ShouldNot(BeADirectory())
Ω(tempDirB).ShouldNot(BeADirectory())
})
})
It("supports Error", func() {
t.Error("a", 17)
Ω(failFuncCall.message).Should(Equal("a 17\n"))
Ω(failFuncCall.callerSkip).Should(Equal([]int{offset}))
})
It("supports Errorf", func() {
t.Errorf("%s %d!", "a", 17)
Ω(failFuncCall.message).Should(Equal("a 17!"))
Ω(failFuncCall.callerSkip).Should(Equal([]int{offset}))
})
It("supports Fail", func() {
t.Fail()
Ω(failFuncCall.message).Should(Equal("failed"))
Ω(failFuncCall.callerSkip).Should(Equal([]int{offset}))
})
It("supports FailNow", func() {
t.Fail()
Ω(failFuncCall.message).Should(Equal("failed"))
Ω(failFuncCall.callerSkip).Should(Equal([]int{offset}))
})
It("supports Fatal", func() {
t.Fatal("a", 17)
Ω(failFuncCall.message).Should(Equal("a 17\n"))
Ω(failFuncCall.callerSkip).Should(Equal([]int{offset}))
})
It("supports Fatalf", func() {
t.Fatalf("%s %d!", "a", 17)
Ω(failFuncCall.message).Should(Equal("a 17!"))
Ω(failFuncCall.callerSkip).Should(Equal([]int{offset}))
})
It("ignores Helper", func() {
cl := func() types.CodeLocation {
GinkgoT().Helper()
return types.NewCodeLocation(0)
}() // this is the expected line
_, fname, lnumber, _ := runtime.Caller(0)
Ω(cl).Should(Equal(types.CodeLocation{
FileName: fname,
LineNumber: lnumber - 1,
}))
})
It("supports Log", func() {
t.Log("a", 17)
Ω(string(buf.Contents())).Should(Equal(" a 17\n"))
})
It("supports Logf", func() {
t.Logf("%s %d!", "a", 17)
Ω(string(buf.Contents())).Should(Equal(" a 17!\n"))
})
It("supports Name", func() {
reportToReturn.ContainerHierarchyTexts = []string{"C.S."}
reportToReturn.LeafNodeText = "Lewis"
Ω(t.Name()).Should(Equal("C.S. Lewis"))
Ω(GinkgoT().Name()).Should(ContainSubstring("supports Name"))
Ω(GinkgoTB().Name()).Should(ContainSubstring("supports Name"))
})
It("ignores Parallel", func() {
GinkgoT().Parallel() //is a no-op
})
It("supports Skip", func() {
t.Skip("a", 17)
Ω(skipFuncCall.message).Should(Equal("a 17\n"))
Ω(skipFuncCall.callerSkip).Should(Equal([]int{offset}))
})
It("supports SkipNow", func() {
t.SkipNow()
Ω(skipFuncCall.message).Should(Equal("skip"))
Ω(skipFuncCall.callerSkip).Should(Equal([]int{offset}))
})
It("supports Skipf", func() {
t.Skipf("%s %d!", "a", 17)
Ω(skipFuncCall.message).Should(Equal("a 17!"))
Ω(skipFuncCall.callerSkip).Should(Equal([]int{offset}))
})
It("returns the state of the test when asked if it was skipped", func() {
reportToReturn.State = types.SpecStatePassed
Ω(t.Skipped()).Should(BeFalse())
reportToReturn.State = types.SpecStateSkipped
Ω(t.Skipped()).Should(BeTrue())
})
It("can add report entries with visibility Always", func() {
cl := types.NewCodeLocation(0)
t.AddReportEntryVisibilityAlways("hey", 3)
entry := CurrentSpecReport().ReportEntries[0]
Ω(entry.Visibility).Should(Equal(types.ReportEntryVisibilityAlways))
Ω(entry.Name).Should(Equal("hey"))
Ω(entry.GetRawValue()).Should(Equal(3))
Ω(entry.Location.FileName).Should(Equal(cl.FileName))
Ω(entry.Location.LineNumber).Should(Equal(cl.LineNumber + 1))
})
It("can add report entries with visibility FailureOrVerbose", func() {
cl := types.NewCodeLocation(0)
t.AddReportEntryVisibilityFailureOrVerbose("hey", 3)
entry := CurrentSpecReport().ReportEntries[0]
Ω(entry.Visibility).Should(Equal(types.ReportEntryVisibilityFailureOrVerbose))
Ω(entry.Name).Should(Equal("hey"))
Ω(entry.GetRawValue()).Should(Equal(3))
Ω(entry.Location.FileName).Should(Equal(cl.FileName))
Ω(entry.Location.LineNumber).Should(Equal(cl.LineNumber + 1))
})
It("can add report entries with visibility Never", func() {
cl := types.NewCodeLocation(0)
t.AddReportEntryVisibilityNever("hey", 3)
entry := CurrentSpecReport().ReportEntries[0]
Ω(entry.Visibility).Should(Equal(types.ReportEntryVisibilityNever))
Ω(entry.Name).Should(Equal("hey"))
Ω(entry.GetRawValue()).Should(Equal(3))
Ω(entry.Location.FileName).Should(Equal(cl.FileName))
Ω(entry.Location.LineNumber).Should(Equal(cl.LineNumber + 1))
})
It("can print to the GinkgoWriter", func() {
t.Print("hi", 3)
Ω(string(buf.Contents())).Should(Equal(" hi3"))
})
It("can printf to the GinkgoWriter", func() {
t.Printf("hi %d", 3)
Ω(string(buf.Contents())).Should(Equal(" hi 3"))
})
It("can println to the GinkgoWriter", func() {
t.Println("hi", 3)
Ω(string(buf.Contents())).Should(Equal(" hi 3\n"))
})
It("can provide a correctly configured Ginkgo Formatter", func() {
Ω(t.F("{{blue}}%d{{/}}", 3)).Should(Equal("3"))
})
It("can provide a correctly configured Ginkgo Formatter, with indentation", func() {
Ω(t.Fi(1, "{{blue}}%d{{/}}", 3)).Should(Equal(" 3"))
})
It("can provide a correctly configured Ginkgo Formatter, with indentation and width constraints", func() {
Ω(t.Fiw(1, 5, "{{blue}}%d{{/}} a number", 3)).Should(Equal(" 3 a\n number"))
})
It("can render the timeline of the current spec", func() {
cl := types.NewCustomCodeLocation("cl")
reportToReturn.CapturedGinkgoWriterOutput = "ABCDEFGHIJKLMNOP"
reportToReturn.SpecEvents = append(reportToReturn.SpecEvents, types.SpecEvent{
TimelineLocation: types.TimelineLocation{Offset: 5, Order: 1},
SpecEventType: types.SpecEventNodeStart,
Message: "The Test",
CodeLocation: cl,
NodeType: types.NodeTypeIt,
})
reportToReturn.SpecEvents = append(reportToReturn.SpecEvents, types.SpecEvent{
TimelineLocation: types.TimelineLocation{Offset: 10, Order: 3},
SpecEventType: types.SpecEventNodeEnd,
Message: "The Test",
CodeLocation: cl,
NodeType: types.NodeTypeIt,
Duration: time.Second,
})
reportToReturn.State = types.SpecStateFailed
reportToReturn.Failure = types.Failure{
Message: "The Failure",
FailureNodeType: types.NodeTypeIt,
Location: cl,
TimelineLocation: types.TimelineLocation{Offset: 10, Order: 2},
}
Ω(t.RenderTimeline()).Should(Equal("ABCDE\n> Enter \x1b[1m[It]\x1b[0m The Test \x1b[38;5;243m- cl @ 01/01/01 00:00:00\x1b[0m\nFGHIJ\n\x1b[38;5;9m[FAILED] The Failure\x1b[0m\n\x1b[38;5;9mIn \x1b[1m[It]\x1b[0m\x1b[38;5;9m at: \x1b[1mcl\x1b[0m \x1b[38;5;243m@ 01/01/01 00:00:00\x1b[0m\n< Exit \x1b[1m[It]\x1b[0m The Test \x1b[38;5;243m- cl @ 01/01/01 00:00:00 (1s)\x1b[0m\nKLMNOP"))
})
It("can provide GinkgoRecover", func() {
Ω(recoverCall).Should(BeFalse())
t.GinkgoRecover()
Ω(recoverCall).Should(BeTrue())
})
Describe("DeferCleanup", Ordered, func() {
var a int
It("provides access to DeferCleanup", func() {
a = 3
t.DeferCleanup(func(newA int) {
a = newA
}, 4)
})
It("provides access to DeferCleanup", func() {
Ω(a).Should(Equal(4))
})
})
It("provides the random seed", func() {
Ω(t.RandomSeed()).Should(Equal(int64(17)))
})
It("provides the parallel process", func() {
Ω(t.ParallelProcess()).Should(Equal(3))
})
It("provides the parallel total", func() {
Ω(t.ParallelTotal()).Should(Equal(5))
})
It("can attach progress reports", func() {
cancel := t.AttachProgressReporter(func() string {
return "my report"
})
Ω(attachedProgressReporter()).Should(Equal("my report"))
Ω(attachProgressReporterCancelCalled).Should(BeFalse())
cancel()
Ω(attachProgressReporterCancelCalled).Should(BeTrue())
})
})
|