File: synchronized_suite_nodes_test.go

package info (click to toggle)
golang-github-onsi-ginkgo-v2 2.15.0-1~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 4,112 kB
  • sloc: javascript: 59; sh: 14; makefile: 7
file content (355 lines) | stat: -rw-r--r-- 12,936 bytes parent folder | download | duplicates (2)
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
package internal_integration_test

import (
	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/ginkgo/v2/internal/test_helpers"
	"github.com/onsi/ginkgo/v2/types"
	. "github.com/onsi/gomega"
	"github.com/onsi/gomega/gbytes"
)

var _ = Describe("Synchronized Suite Nodes", func() {
	var failInBeforeSuiteProc1, failInBeforeSuiteAllProcs, failInAfterSuiteAllProcs, failInAfterSuiteProc1 bool
	var fixture func()

	BeforeEach(func() {
		failInBeforeSuiteProc1, failInBeforeSuiteAllProcs, failInAfterSuiteAllProcs, failInAfterSuiteProc1 = false, false, false, false
		fixture = func() {
			SynchronizedBeforeSuite(func() []byte {
				outputInterceptor.AppendInterceptedOutput("before-suite-proc-1")
				rt.Run("before-suite-proc-1")
				if failInBeforeSuiteProc1 {
					F("fail-in-before-suite-proc-1", cl)
				}
				return []byte("hey there")
			}, func(data []byte) {
				outputInterceptor.AppendInterceptedOutput("before-suite-all-procs")
				rt.RunWithData("before-suite-all-procs", "data", string(data))
				if failInBeforeSuiteAllProcs {
					F("fail-in-before-suite-all-procs", cl)
				}
			})
			It("test", rt.T("test"))
			SynchronizedAfterSuite(func() {
				outputInterceptor.AppendInterceptedOutput("after-suite-all-procs")
				rt.Run("after-suite-all-procs")
				if failInAfterSuiteAllProcs {
					F("fail-in-after-suite-all-procs", cl)
				}
			}, func() {
				outputInterceptor.AppendInterceptedOutput("after-suite-proc-1")
				rt.Run("after-suite-proc-1")
				if failInAfterSuiteProc1 {
					F("fail-in-after-suite-proc-1", cl)
				}
			})
		}
	})

	Describe("when running in series", func() {
		BeforeEach(func() {
			conf.ParallelTotal = 1
			conf.ParallelProcess = 1
		})

		Describe("happy path", func() {
			BeforeEach(func() {
				success, _ := RunFixture("happy-path", fixture)
				Ω(success).Should(BeTrue())
			})

			It("runs all the functions", func() {
				Ω(rt).Should(HaveTracked(
					"before-suite-proc-1", "before-suite-all-procs",
					"test",
					"after-suite-all-procs", "after-suite-proc-1",
				))
			})

			It("reports on the SynchronizedBeforeSuite and SynchronizedAfterSuite as having passed", func() {
				befReports := reporter.Did.WithLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)
				Ω(befReports).Should(HaveLen(1))
				Ω(befReports[0]).Should(HavePassed())

				aftReports := reporter.Did.WithLeafNodeType(types.NodeTypeSynchronizedAfterSuite)
				Ω(aftReports).Should(HaveLen(1))
				Ω(aftReports[0]).Should(HavePassed())
			})

			It("passes data between the two SynchronizedBeforeSuite functions", func() {
				Ω(rt).Should(HaveRunWithData("before-suite-all-procs", "data", "hey there"))
			})
		})

		Describe("when the SynchronizedBeforeSuite proc1 function fails", func() {
			BeforeEach(func() {
				failInBeforeSuiteProc1 = true
				success, _ := RunFixture("fail in SynchronizedBeforeSuite proc1", fixture)
				Ω(success).Should(BeFalse())
			})

			It("doesn't run the allProcs function or any of the tests", func() {
				Ω(rt).Should(HaveTracked(
					"before-suite-proc-1",
					"after-suite-all-procs", "after-suite-proc-1",
				))
			})

			It("reports on the SynchronizedBeforeSuite and SynchronizedAfterSuite correctly", func() {
				Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HaveFailed("fail-in-before-suite-proc-1"))
				Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedAfterSuite)).Should(HavePassed())
			})
		})

		Describe("when the SynchronizedBeforeSuite allProcs function fails", func() {
			BeforeEach(func() {
				failInBeforeSuiteAllProcs = true
				success, _ := RunFixture("fail in SynchronizedBeforeSuite allProcs", fixture)
				Ω(success).Should(BeFalse())
			})

			It("doesn't run the tests", func() {
				Ω(rt).Should(HaveTracked(
					"before-suite-proc-1", "before-suite-all-procs",
					"after-suite-all-procs", "after-suite-proc-1",
				))
				Ω(rt).Should(HaveRunWithData("before-suite-all-procs", "data", "hey there"))
			})

			It("reports on the SynchronizedBeforeSuite and SynchronizedAfterSuite correctly", func() {
				Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HaveFailed("fail-in-before-suite-all-procs"))
				Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedAfterSuite)).Should(HavePassed())
			})
		})

		Describe("when the SynchronizedAfterSuite allProcs function fails", func() {
			BeforeEach(func() {
				failInAfterSuiteAllProcs = true
				success, _ := RunFixture("fail in SynchronizedAfterSuite allProcs", fixture)
				Ω(success).Should(BeFalse())
			})

			It("nonetheless runs the proc-1 function", func() {
				Ω(rt).Should(HaveTracked(
					"before-suite-proc-1", "before-suite-all-procs",
					"test",
					"after-suite-all-procs", "after-suite-proc-1",
				))
				Ω(rt).Should(HaveRunWithData("before-suite-all-procs", "data", "hey there"))
			})

			It("reports on the SynchronizedBeforeSuite and SynchronizedAfterSuite correctly", func() {
				Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HavePassed())
				Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedAfterSuite)).Should(HaveFailed("fail-in-after-suite-all-procs"))
			})
		})

		Describe("when the SynchronizedAfterSuite proc1 function fails", func() {
			BeforeEach(func() {
				failInAfterSuiteProc1 = true
				success, _ := RunFixture("fail in SynchronizedAfterSuite proc1", fixture)
				Ω(success).Should(BeFalse())
			})

			It("will have run everything", func() {
				Ω(rt).Should(HaveTracked(
					"before-suite-proc-1", "before-suite-all-procs",
					"test",
					"after-suite-all-procs", "after-suite-proc-1",
				))
				Ω(rt).Should(HaveRunWithData("before-suite-all-procs", "data", "hey there"))
			})

			It("reports on the SynchronizedBeforeSuite and SynchronizedAfterSuite correctly", func() {
				Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HavePassed())
				Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedAfterSuite)).Should(HaveFailed("fail-in-after-suite-proc-1"))
			})
		})
	})

	Describe("when running in parallel", func() {
		var serverOutputBuffer *gbytes.Buffer

		BeforeEach(func() {
			SetUpForParallel(2)
			serverOutputBuffer = gbytes.NewBuffer()
			server.SetOutputDestination(serverOutputBuffer)
		})

		Describe("when running as proc 1", func() {
			BeforeEach(func() {
				conf.ParallelProcess = 1
			})

			Describe("happy path", func() {
				BeforeEach(func() {
					close(exitChannels[2]) //trigger proc 2 exiting so the proc1 after suite runs
					success, _ := RunFixture("happy-path", fixture)
					Ω(success).Should(BeTrue())
				})

				It("runs all the functions", func() {
					Ω(rt).Should(HaveTracked(
						"before-suite-proc-1", "before-suite-all-procs",
						"test",
						"after-suite-all-procs", "after-suite-proc-1",
					))
				})

				It("reports on the SynchronizedBeforeSuite and SynchronizedAfterSuite as having passed", func() {
					Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HavePassed())
					Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedAfterSuite)).Should(HavePassed())
				})

				It("passes data between the two SynchronizedBeforeSuite functions and up to the server", func() {
					Ω(rt).Should(HaveRunWithData("before-suite-all-procs", "data", "hey there"))
					state, data, err := client.BlockUntilSynchronizedBeforeSuiteData()
					Ω(state).Should(Equal(types.SpecStatePassed))
					Ω(data).Should(Equal([]byte("hey there")))
					Ω(err).ShouldNot(HaveOccurred())
				})

				It("emits the output of the proc-1 BeforeSuite function and the proc-1 AfterSuite function", func() {
					Ω(string(serverOutputBuffer.Contents())).Should(Equal("before-suite-proc-1after-suite-proc-1"))
					Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HavePassed(CapturedStdOutput("before-suite-proc-1before-suite-all-procs")))
					Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedAfterSuite)).Should(HavePassed(CapturedStdOutput("after-suite-all-procsafter-suite-proc-1")))
				})
			})

			Describe("when the BeforeSuite proc1 function fails", func() {
				BeforeEach(func() {
					close(exitChannels[2]) //trigger proc 2 exiting so the proc1 after suite runs
					failInBeforeSuiteProc1 = true
					success, _ := RunFixture("happy-path", fixture)
					Ω(success).Should(BeFalse())
				})

				It("tells the server", func() {
					state, data, err := client.BlockUntilSynchronizedBeforeSuiteData()
					Ω(state).Should(Equal(types.SpecStateFailed))
					Ω(data).Should(BeNil())
					Ω(err).ShouldNot(HaveOccurred())
				})
			})

			Describe("waiting for all procs to finish before running the AfterSuite proc 1 function", func() {
				It("waits for the server to give it the all clear", func() {
					done := make(chan interface{})
					go func() {
						defer GinkgoRecover()
						success, _ := RunFixture("happy-path", fixture)
						Ω(success).Should(BeTrue())
						close(done)
					}()
					Consistently(done).ShouldNot(BeClosed())
					close(exitChannels[2])
					Eventually(done).Should(BeClosed())
				})
			})
		})

		Describe("when running as another proc", func() {
			BeforeEach(func() {
				conf.ParallelProcess = 2
			})

			Describe("happy path", func() {
				BeforeEach(func() {
					client.PostSynchronizedBeforeSuiteCompleted(types.SpecStatePassed, []byte("hola hola"))
					success, _ := RunFixture("happy-path", fixture)
					Ω(success).Should(BeTrue())
				})

				It("runs all the all-procs functions", func() {
					Ω(rt).Should(HaveTracked(
						"before-suite-all-procs",
						"test",
						"after-suite-all-procs",
					))
				})

				It("reports on the SynchronizedBeforeSuite and SynchronizedAfterSuite as having passed", func() {
					Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HavePassed())
					Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedAfterSuite)).Should(HavePassed())
				})

				It("gets data for the SynchronizedBeforeSuite all procs function from the server", func() {
					Ω(rt).Should(HaveRunWithData("before-suite-all-procs", "data", "hola hola"))
				})
			})

			Describe("waiting for the data from proc 1", func() {
				It("waits for the server to give it the data", func() {
					done := make(chan interface{})
					go func() {
						defer GinkgoRecover()
						success, _ := RunFixture("happy-path", fixture)
						Ω(success).Should(BeTrue())
						close(done)
					}()
					Consistently(done).ShouldNot(BeClosed())
					client.PostSynchronizedBeforeSuiteCompleted(types.SpecStatePassed, []byte("hola hola"))
					Eventually(done).Should(BeClosed())
					Ω(rt).Should(HaveRunWithData("before-suite-all-procs", "data", "hola hola"))
				})
			})

			Describe("when proc 1 fails the SynchronizedBeforeSuite proc1 function", func() {
				It("fails and only runs the after suite", func() {
					done := make(chan interface{})
					go func() {
						defer GinkgoRecover()
						success, _ := RunFixture("happy-path", fixture)
						Ω(success).Should(BeFalse())
						close(done)
					}()
					Consistently(done).ShouldNot(BeClosed())
					client.PostSynchronizedBeforeSuiteCompleted(types.SpecStateFailed, nil)
					Eventually(done).Should(BeClosed())

					Ω(rt).Should(HaveTracked("after-suite-all-procs"))

					Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HaveFailed(types.GinkgoErrors.SynchronizedBeforeSuiteFailedOnProc1().Error()))
				})
			})

			Describe("when the proc1 SynchronizedBeforeSuite function Skips()", func() {
				It("fails and only runs the after suite", func() {
					done := make(chan interface{})
					go func() {
						defer GinkgoRecover()
						success, _ := RunFixture("happy-path", fixture)
						Ω(success).Should(BeTrue())
						close(done)
					}()
					Consistently(done).ShouldNot(BeClosed())
					client.PostSynchronizedBeforeSuiteCompleted(types.SpecStateSkipped, nil)
					Eventually(done).Should(BeClosed())

					Ω(rt).Should(HaveTracked("after-suite-all-procs"))

					Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HaveBeenSkipped())
				})
			})

			Describe("when proc 1 disappears before the proc 1 function returns", func() {
				It("fails and only runs the after suite", func() {
					done := make(chan interface{})
					go func() {
						defer GinkgoRecover()
						success, _ := RunFixture("happy-path", fixture)
						Ω(success).Should(BeFalse())
						close(done)
					}()
					Consistently(done).ShouldNot(BeClosed())
					close(exitChannels[1])
					Eventually(done).Should(BeClosed())

					Ω(rt).Should(HaveTracked("after-suite-all-procs"))

					Ω(reporter.Did.FindByLeafNodeType(types.NodeTypeSynchronizedBeforeSuite)).Should(HaveFailed(types.GinkgoErrors.SynchronizedBeforeSuiteDisappearedOnProc1().Error()))
				})
			})
		})
	})
})