/
FixtureAnyFunSpecLike.scala
728 lines (670 loc) · 35.8 KB
/
FixtureAnyFunSpecLike.scala
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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
/*
* Copyright 2001-2014 Artima, Inc.
*
* 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 org.scalatest.funspec
import org.scalatest._
import org.scalatest.exceptions._
import org.scalactic.{source, Prettifier}
import java.util.ConcurrentModificationException
import java.util.concurrent.atomic.AtomicReference
import org.scalatest.Suite.anExceptionThatShouldCauseAnAbort
import org.scalatest.Suite.autoTagClassAnnotations
import verbs.BehaveWord
/**
* Implementation trait for class <code>FixtureAnyFunSpec</code>, which is
* a sister class to <code>org.scalatest.funspec.AnyFunSpec</code> that can pass a
* fixture object into its tests.
*
* <p>
* <a href="FixtureAnyFunSpec.html"><code>FixtureAnyFunSpec</code></a> is a class,
* not a trait, to minimize compile time given there is a slight compiler
* overhead to mixing in traits compared to extending classes. If you need
* to mix the behavior of <code>FixtureAnyFunSpec</code> into some other
* class, you can use this trait instead, because class
* <code>FixtureAnyFunSpec</code> does nothing more than extend this trait and add a nice <code>toString</code> implementation.
* </p>
*
* <p>
* See the documentation of the class for a <a href="FixtureAnyFunSpec.html">detailed
* overview of <code>FixtureAnyFunSpec</code></a>.
* </p>
*
* @author Bill Venners
*/
//SCALATESTJS-ONLY @scala.scalajs.reflect.annotation.EnableReflectiveInstantiation
//SCALATESTNATIVE-ONLY @scala.scalajs.reflect.annotation.EnableReflectiveInstantiation
trait FixtureAnyFunSpecLike extends org.scalatest.FixtureTestSuite with org.scalatest.FixtureTestRegistration with Informing with Notifying with Alerting with Documenting { thisSuite =>
private final val engine = new FixtureEngine[FixtureParam](Resources.concurrentFixtureSpecMod, "FixtureFunSpec")
import engine._
private[scalatest] val sourceFileName = "FixtureAnyFunSpecLike.scala"
/**
* Returns an <code>Informer</code> that during test execution will forward strings passed to its
* <code>apply</code> method to the current reporter. If invoked in a constructor, it
* will register the passed string for forwarding later during test execution. If invoked from inside a scope,
* it will forward the information to the current reporter immediately. If invoked from inside a test function,
* it will record the information and forward it to the current reporter only after the test completed, as <code>recordedEvents</code>
* of the test completed event, such as <code>TestSucceeded</code>. If invoked at any other time, it will print to the standard output.
* This method can be called safely by any thread.
*/
protected def info: Informer = atomicInformer.get
/**
* Returns a <code>Notifier</code> that during test execution will forward strings (and other objects) passed to its
* <code>apply</code> method to the current reporter. If invoked in a constructor, it
* will register the passed string for forwarding later during test execution. If invoked while this
* <code>FixtureAnyFunSpec</code> is being executed, such as from inside a test function, it will forward the information to
* the current reporter immediately. If invoked at any other time, it will
* print to the standard output. This method can be called safely by any thread.
*/
protected def note: Notifier = atomicNotifier.get
/**
* Returns an <code>Alerter</code> that during test execution will forward strings (and other objects) passed to its
* <code>apply</code> method to the current reporter. If invoked in a constructor, it
* will register the passed string for forwarding later during test execution. If invoked while this
* <code>FixtureAnyFunSpec</code> is being executed, such as from inside a test function, it will forward the information to
* the current reporter immediately. If invoked at any other time, it will
* print to the standard output. This method can be called safely by any thread.
*/
protected def alert: Alerter = atomicAlerter.get
/**
* Returns a <code>Documenter</code> that during test execution will forward strings passed to its
* <code>apply</code> method to the current reporter. If invoked in a constructor, it
* will register the passed string for forwarding later during test execution. If invoked from inside a scope,
* it will forward the information to the current reporter immediately. If invoked from inside a test function,
* it will record the information and forward it to the current reporter only after the test completed, as <code>recordedEvents</code>
* of the test completed event, such as <code>TestSucceeded</code>. If invoked at any other time, it will print to the standard output.
* This method can be called safely by any thread.
*/
protected def markup: Documenter = atomicDocumenter.get
private final def registerTestImpl(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */, pos: source.Position): Unit = {
// SKIP-SCALATESTJS,NATIVE-START
val stackDepthAdjustment = -2
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -5
engine.registerTest(testText, org.scalatest.fixture.Transformer(testFun), Resources.testCannotBeNestedInsideAnotherTest, sourceFileName, "registerTest", 5, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*)
}
// SKIP-DOTTY-START
final def registerTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = {
registerTestImpl(testText, testTags: _*)(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def registerTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestImpl(testText, testTags: _*)(testFun, pos) }) }
//DOTTY-ONLY }
private final def registerIgnoredTestImpl(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */, pos: source.Position): Unit = {
// SKIP-SCALATESTJS,NATIVE-START
val stackDepthAdjustment = 0
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -2
engine.registerIgnoredTest(testText, org.scalatest.fixture.Transformer(testFun), Resources.testCannotBeNestedInsideAnotherTest, sourceFileName, "registerIgnoredTest", 1, stackDepthAdjustment, None, Some(pos), testTags: _*)
}
// SKIP-DOTTY-START
final def registerIgnoredTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = {
registerIgnoredTestImpl(testText, testTags: _*)(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def registerIgnoredTest(testText: String, testTags: Tag*)(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerIgnoredTestImpl(testText, testTags: _*)(testFun, pos) }) }
//DOTTY-ONLY }
/**
* Class that, via an instance referenced from the <code>it</code> field,
* supports test (and shared test) registration in <code>FixtureAnyFunSpec</code>s.
*
* <p>
* This class supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* it(<span class="stQuotedString">"should be empty"</span>)
* ^
* </pre>
*
* <pre class="stHighlighted">
* it should behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* For more information and examples, see the <a href="FixtureAnyFunSpec.html">main documentation for <code>FixtureAnyFunSpec</code></a>.
* </p>
*/
protected final class ItWord {
class ResultOfItWordApplication(specText: String, testTags: Tag*) {
private final def applyImpl(testFun: FixtureParam => Any /* Assertion */, pos: source.Position): Unit = {
// SKIP-SCALATESTJS,NATIVE-START
val stackDepth = 3
val stackDepthAdjustment = -2
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY val stackDepth = 5
//SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -5
engine.registerTest(specText, org.scalatest.fixture.Transformer(testFun), Resources.itCannotAppearInsideAnotherItOrThey, sourceFileName, "apply", stackDepth, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*)
}
// SKIP-DOTTY-START
def apply(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = {
applyImpl(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def apply(testFun: FixtureParam => Any /* Assertion */): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => applyImpl(testFun, pos) }) }
//DOTTY-ONLY }
private final def applyImpl(testFun: () => Any /* Assertion */, pos: source.Position): Unit = {
// SKIP-SCALATESTJS,NATIVE-START
val stackDepth = 3
val stackDepthAdjustment = -2
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY val stackDepth = 5
//SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -5
engine.registerTest(specText, org.scalatest.fixture.Transformer(new org.scalatest.fixture.NoArgTestWrapper(testFun)), Resources.itCannotAppearInsideAnotherItOrThey, sourceFileName, "apply", stackDepth, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*)
}
// SKIP-DOTTY-START
def apply(testFun: () => Any /* Assertion */)(implicit pos: source.Position): Unit = {
applyImpl(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def apply(testFun: () => Any /* Assertion */): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => applyImpl(testFun, pos) }) }
//DOTTY-ONLY }
}
/**
* Register a test with the given spec text, optional tags, and test function value that takes no arguments.
* An invocation of this method is called an “example.”
*
* This method will register the test for later execution via an invocation of one of the <code>execute</code>
* methods. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for <code>testNames</code> for an example.) The resulting test name must not have been registered previously on
* this <code>FixtureAnyFunSpec</code> instance.
*
* @param specText the specification text, which will be combined with the descText of any surrounding describers
* to form the test name
* @param testTags the optional list of tags for this test
* @param testFun the test function
* @throws DuplicateTestNameException if a test with the same name has been registered previously
* @throws TestRegistrationClosedException if invoked after <code>run</code> has been invoked on this suite
* @throws NullArgumentException if <code>specText</code> or any passed test tag is <code>null</code>
*/
def apply(specText: String, testTags: Tag*): ResultOfItWordApplication =
new ResultOfItWordApplication(specText, testTags: _*)
/**
* Supports the registration of shared tests.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* it should behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* For examples of shared tests, see the <a href="../Spec.html#SharedTests">Shared tests section</a>
* in the main documentation for trait <code>FixtureAnyFunSpec</code>.
* </p>
*
* @param behaveWord the <code>BehaveWord</code>
*/
def should(behaveWord: BehaveWord) = behaveWord
/**
* Supports the registration of shared tests.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* it must behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* For examples of shared tests, see the <a href="../Spec.html#SharedTests">Shared tests section</a>
* in the main documentation for trait <code>FixtureAnyFunSpec</code>.
* </p>
*
* @param behaveWord the <code>BehaveWord</code>
*/
def must(behaveWord: BehaveWord) = behaveWord
}
/**
* Supports test (and shared test) registration in <code>FixtureAnyFunSpec</code>s.
*
* <p>
* This field supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* it(<span class="stQuotedString">"should be empty"</span>)
* ^
* </pre>
*
* <pre class="stHighlighted">
* it should behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* For more information and examples of the use of the <code>it</code> field, see
* the <a href="FixtureAnyFunSpec.html">main documentation for <code>FixtureAnyFunSpec</code></a>.
* </p>
*/
protected val it = new ItWord
/**
* Class that, via an instance referenced from the <code>they</code> field,
* supports test (and shared test) registration in <code>FixtureAnyFunSpec</code>s.
*
* <p>
* This class supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* they(<span class="stQuotedString">"should be empty"</span>)
* ^
* </pre>
*
* <pre class="stHighlighted">
* they should behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* For more information and examples, see the <a href="FixtureAnyFunSpec.html">main documentation for <code>FixtureAnyFunSpec</code></a>.
* </p>
*/
protected final class TheyWord {
class ResultOfTheyWordApplication(specText: String, testTags: Tag*)(implicit pos: source.Position) {
private final def applyImpl(testFun: FixtureParam => Any /* Assertion */, pos: source.Position): Unit = {
// SKIP-SCALATESTJS,NATIVE-START
val stackDepthAdjustment = -2
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -3
engine.registerTest(specText, org.scalatest.fixture.Transformer(testFun), Resources.theyCannotAppearInsideAnotherItOrThey, sourceFileName, "apply", 3, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*)
}
// SKIP-DOTTY-START
def apply(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = {
applyImpl(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def apply(testFun: FixtureParam => Any /* Assertion */): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => applyImpl(testFun, pos) }) }
//DOTTY-ONLY }
def applyImpl(testFun: () => Any /* Assertion */, pos: source.Position): Unit = {
// SKIP-SCALATESTJS,NATIVE-START
val stackDepthAdjustment = -2
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -3
engine.registerTest(specText, org.scalatest.fixture.Transformer(new org.scalatest.fixture.NoArgTestWrapper(testFun)), Resources.theyCannotAppearInsideAnotherItOrThey, sourceFileName, "apply", 3, stackDepthAdjustment, None, None, Some(pos), None, testTags: _*)
}
// SKIP-DOTTY-START
def apply(testFun: () => Any /* Assertion */)(implicit pos: source.Position): Unit = {
applyImpl(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def apply(testFun: () => Any /* Assertion */): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => applyImpl(testFun, pos) }) }
//DOTTY-ONLY }
}
/**
* Register a test with the given spec text, optional tags, and test function value that takes no arguments.
* An invocation of this method is called an “example.”
*
* This method will register the test for later execution via an invocation of one of the <code>execute</code>
* methods. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for <code>testNames</code> for an example.) The resulting test name must not have been registered previously on
* this <code>FixtureAnyFunSpec</code> instance.
*
* @param specText the specification text, which will be combined with the descText of any surrounding describers
* to form the test name
* @param testTags the optional list of tags for this test
* @param testFun the test function
* @throws DuplicateTestNameException if a test with the same name has been registered previously
* @throws TestRegistrationClosedException if invoked after <code>run</code> has been invoked on this suite
* @throws NullArgumentException if <code>specText</code> or any passed test tag is <code>null</code>
*/
def apply(specText: String, testTags: Tag*): ResultOfTheyWordApplication =
new ResultOfTheyWordApplication(specText, testTags: _*)
/**
* Supports the registration of shared tests.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* they should behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* For examples of shared tests, see the <a href="../Spec.html#SharedTests">Shared tests section</a>
* in the main documentation for trait <code>FixtureAnyFunSpec</code>.
* </p>
*
* @param behaveWord the <code>BehaveWord</code>
*/
def should(behaveWord: BehaveWord) = behaveWord
/**
* Supports the registration of shared tests.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* they must behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* For examples of shared tests, see the <a href="../Spec.html#SharedTests">Shared tests section</a>
* in the main documentation for trait <code>FixtureAnyFunSpec</code>.
* </p>
*
* @param behaveWord the <code>BehaveWord</code>
*/
def must(behaveWord: BehaveWord) = behaveWord
}
/**
* Supports test (and shared test) registration in <code>FixtureAnyFunSpec</code>s.
*
* <p>
* This field supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* they(<span class="stQuotedString">"should be empty"</span>)
* ^
* </pre>
*
* <pre class="stHighlighted">
* they should behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* For more information and examples of the use of the <code>it</code> field, see
* the <a href="FixtureAnyFunSpec.html">main documentation for <code>FixtureAnyFunSpec</code></a>.
* </p>
*/
protected val they = new TheyWord
class ResultOfIgnoreInvocation(specText: String, testTags: Tag*) {
private final def applyImpl(testFun: FixtureParam => Any /* Assertion */, pos: source.Position): Unit = {
// SKIP-SCALATESTJS,NATIVE-START
val stackDepth = 3
val stackDepthAdjustment = -3
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY val stackDepth = 5
//SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -6
engine.registerIgnoredTest(specText, org.scalatest.fixture.Transformer(testFun), Resources.ignoreCannotAppearInsideAnItOrAThey, sourceFileName, "apply", stackDepth, stackDepthAdjustment, None, Some(pos), testTags: _*)
}
// SKIP-DOTTY-START
def apply(testFun: FixtureParam => Any /* Assertion */)(implicit pos: source.Position): Unit = {
applyImpl(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def apply(testFun: FixtureParam => Any /* Assertion */): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => applyImpl(testFun, pos) }) }
//DOTTY-ONLY }
private final def applyImpl(testFun: () => Any /* Assertion */, pos: source.Position): Unit = {
// SKIP-SCALATESTJS,NATIVE-START
val stackDepth = 3
val stackDepthAdjustment = -3
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY val stackDepth = 5
//SCALATESTJS,NATIVE-ONLY val stackDepthAdjustment = -6
engine.registerIgnoredTest(specText, org.scalatest.fixture.Transformer(new org.scalatest.fixture.NoArgTestWrapper(testFun)), Resources.ignoreCannotAppearInsideAnItOrAThey, sourceFileName, "apply", stackDepth, stackDepthAdjustment, None, Some(pos), testTags: _*)
}
// SKIP-DOTTY-START
def apply(testFun: () => Any /* Assertion */)(implicit pos: source.Position): Unit = {
applyImpl(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def apply(testFun: () => Any /* Assertion */): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => applyImpl(testFun, pos) }) }
//DOTTY-ONLY }
}
/**
* Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments.
* This method will register the test for later ignoring via an invocation of one of the <code>execute</code>
* methods. This method exists to make it easy to ignore an existing test by changing the call to <code>it</code>
* to <code>ignore</code> without deleting or commenting out the actual test code. The test will not be executed, but a
* report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for <code>testNames</code> for an example.) The resulting test name must not have been registered previously on
* this <code>FixtureAnyFunSpec</code> instance.
*
* @param specText the specification text, which will be combined with the descText of any surrounding describers
* to form the test name
* @param testTags the optional list of tags for this test
* @param testFun the test function
* @throws DuplicateTestNameException if a test with the same name has been registered previously
* @throws TestRegistrationClosedException if invoked after <code>run</code> has been invoked on this suite
* @throws NullArgumentException if <code>specText</code> or any passed test tag is <code>null</code>
*/
protected def ignore(specText: String, testTags: Tag*): ResultOfIgnoreInvocation =
new ResultOfIgnoreInvocation(specText, testTags: _*)
/**
* Register a test to ignore, which has the given spec text and test function value that takes no arguments.
* This method will register the test for later ignoring via an invocation of one of the <code>execute</code>
* methods. This method exists to make it easy to ignore an existing test by changing the call to <code>it</code>
* to <code>ignore</code> without deleting or commenting out the actual test code. The test will not be executed, but a
* report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
* from outside in, and the passed spec text, with one space placed between each item. (See the documenation
* for <code>testNames</code> for an example.) The resulting test name must not have been registered previously on
* this <code>FixtureAnyFunSpec</code> instance.
*
* @param specText the specification text, which will be combined with the descText of any surrounding describers
* to form the test name
* @param testFun the test function
* @throws DuplicateTestNameException if a test with the same name has been registered previously
* @throws TestRegistrationClosedException if invoked after <code>run</code> has been invoked on this suite
* @throws NullArgumentException if <code>specText</code> or any passed test tag is <code>null</code>
*/
private final def describeImpl(description: String)(fun: => Unit, pos: source.Position): Unit = {
// SKIP-SCALATESTJS,NATIVE-START
val stackDepth = 4
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY val stackDepth = 6
try {
registerNestedBranch(description, None, fun, Resources.describeCannotAppearInsideAnIt, sourceFileName, "describe", stackDepth, -2, None, Some(pos))
}
catch {
case e: TestFailedException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideItOrTheyClauseNotDescribeClause, Some(e), e.position.getOrElse(pos))
case e: TestCanceledException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideItOrTheyClauseNotDescribeClause, Some(e), e.position.getOrElse(pos))
case e: DuplicateTestNameException => throw new NotAllowedException(FailureMessages.exceptionWasThrownInDescribeClause(Prettifier.default, UnquotedString(e.getClass.getName), description, e.getMessage), Some(e), e.position.getOrElse(pos))
case other: Throwable if (!Suite.anExceptionThatShouldCauseAnAbort(other)) => throw new NotAllowedException(FailureMessages.exceptionWasThrownInDescribeClause(Prettifier.default, UnquotedString(other.getClass.getName), description, other.getMessage), Some(other), pos)
case other: Throwable => throw other
}
}
/**
* Describe a “subject” being specified and tested by the passed function value. The
* passed function value may contain more describers (defined with <code>describe</code>) and/or tests
* (defined with <code>it</code>). This trait's implementation of this method will register the
* description string and immediately invoke the passed function.
*
* @param description the description text
* @param fun the function which makes up the body for the description
*/
// SKIP-DOTTY-START
protected def describe(description: String)(fun: => Unit)(implicit pos: source.Position): Unit = {
describeImpl(description)(fun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def describe(description: String)(fun: => Unit): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => describeImpl(description)(fun, pos) }) }
//DOTTY-ONLY }
/**
* A <code>Map</code> whose keys are <code>String</code> tag names to which tests in this <code>FixtureAnyFunSpec</code> belong, and values
* the <code>Set</code> of test names that belong to each tag. If this <code>FixtureAnyFunSpec</code> contains no tags, this method returns an empty <code>Map</code>.
*
* <p>
* This trait's implementation returns tags that were passed as strings contained in <code>Tag</code> objects passed to
* methods <code>test</code> and <code>ignore</code>.
* </p>
*
* <p>
* In addition, this trait's implementation will also auto-tag tests with class level annotations.
* For example, if you annotate @Ignore at the class level, all test methods in the class will be auto-annotated with @Ignore.
* </p>
*/
override def tags: Map[String, Set[String]] = autoTagClassAnnotations(atomic.get.tagsMap, this)
/**
* Run a test. This trait's implementation runs the test registered with the name specified by
* <code>testName</code>. Each test's name is a concatenation of the text of all describers surrounding a test,
* from outside in, and the test's spec text, with one space placed between each item. (See the documenation
* for <code>testNames</code> for an example.)
*
* @param testName the name of one test to execute.
* @param args the <code>Args</code> for this run
* @return a <code>Status</code> object that indicates when the test started by this method has completed, and whether or not it failed .
* @throws NullArgumentException if <code>testName</code> or <code>args</code> is <code>null</code>.
*/
protected override def runTest(testName: String, args: Args): Status = {
def invokeWithFixture(theTest: TestLeaf): Outcome = {
theTest.testFun match {
case transformer: org.scalatest.fixture.Transformer[_] =>
transformer.exceptionalTestFun match {
case wrapper: fixture.NoArgTestWrapper[_, _] =>
withFixture(new FixturelessTestFunAndConfigMap(testName, wrapper.test, args.configMap))
case fun => withFixture(new TestFunAndConfigMap(testName, fun, args.configMap))
}
case other =>
other match {
case wrapper: fixture.NoArgTestWrapper[_, _] =>
withFixture(new FixturelessTestFunAndConfigMap(testName, wrapper.test, args.configMap))
case fun => withFixture(new TestFunAndConfigMap(testName, fun, args.configMap))
}
}
}
runTestImpl(thisSuite, testName, args, true, invokeWithFixture)
}
/**
* <p>
* Run zero to many of this <code>FixtureAnyFunSpec</code>'s tests.
* </p>
*
* <p>
* This method takes a <code>testName</code> parameter that optionally specifies a test to invoke.
* If <code>testName</code> is <code>Some</code>, this trait's implementation of this method
* invokes <code>runTest</code> on this object with passed <code>args</code>.
* </p>
*
* <p>
* This method takes an <code>args</code> that contains a <code>Set</code> of tag names that should be included (<code>tagsToInclude</code>), and a <code>Set</code>
* that should be excluded (<code>tagsToExclude</code>), when deciding which of this <code>Suite</code>'s tests to execute.
* If <code>tagsToInclude</code> is empty, all tests will be executed
* except those those belonging to tags listed in the <code>tagsToExclude</code> <code>Set</code>. If <code>tagsToInclude</code> is non-empty, only tests
* belonging to tags mentioned in <code>tagsToInclude</code>, and not mentioned in <code>tagsToExclude</code>
* will be executed. However, if <code>testName</code> is <code>Some</code>, <code>tagsToInclude</code> and <code>tagsToExclude</code> are essentially ignored.
* Only if <code>testName</code> is <code>None</code> will <code>tagsToInclude</code> and <code>tagsToExclude</code> be consulted to
* determine which of the tests named in the <code>testNames</code> <code>Set</code> should be run. For more information on trait tags, see the main documentation for this trait.
* </p>
*
* <p>
* If <code>testName</code> is <code>None</code>, this trait's implementation of this method
* invokes <code>testNames</code> on this <code>Suite</code> to get a <code>Set</code> of names of tests to potentially execute.
* (A <code>testNames</code> value of <code>None</code> essentially acts as a wildcard that means all tests in
* this <code>Suite</code> that are selected by <code>tagsToInclude</code> and <code>tagsToExclude</code> should be executed.)
* For each test in the <code>testName</code> <code>Set</code>, in the order
* they appear in the iterator obtained by invoking the <code>elements</code> method on the <code>Set</code>, this trait's implementation
* of this method checks whether the test should be run based on the <code>tagsToInclude</code> and <code>tagsToExclude</code> <code>Set</code>s.
* If so, this implementation invokes <code>runTest</code> with passed <code>args</code>.
* </p>
*
* @param testName an optional name of one test to execute. If <code>None</code>, all relevant tests should be executed.
* I.e., <code>None</code> acts like a wildcard that means execute all relevant tests in this <code>FixtureAnyFunSpec</code>.
* @param args the <code>Args</code> to which results will be reported
* @return a <code>Status</code> object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
* @throws NullArgumentException if any of <code>testName</code> or <code>args</code> is <code>null</code>.
*/
protected override def runTests(testName: Option[String], args: Args): Status = {
runTestsImpl(thisSuite, testName, args, info, true, runTest)
}
/**
* An immutable <code>Set</code> of test names. If this <code>FixtureAnyFunSpec</code> contains no tests, this method returns an
* empty <code>Set</code>.
*
* <p>
* This trait's implementation of this method will return a set that contains the names of all registered tests. The set's
* iterator will return those names in the order in which the tests were registered. Each test's name is composed
* of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the
* example itself, with all components separated by a space.
* </p>
*
* @return the <code>Set</code> of test names
*/
override def testNames: Set[String] = {
InsertionOrderSet(atomic.get.testNamesList)
}
override def run(testName: Option[String], args: Args): Status = {
runImpl(thisSuite, testName, args, super.run)
}
/**
* Supports shared test registration in <code>FixtureAnyFunSpec</code>s.
*
* <p>
* This field supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* it should behave like nonFullStack(stackWithOneItem)
* ^
* </pre>
*
* <p>
* For more information and examples of the use of <cod>behave</code>, see the <a href="FixtureAnyFunSpec.html#SharedTests">Shared tests section</a>
* in the main documentation for trait <code>FixtureAnyFunSpec</code>.
* </p>
*/
protected val behave = new BehaveWord
import scala.language.implicitConversions
/**
* Implicitly converts a function that takes no parameters and results in <code>PendingStatement</code> to
* a function from <code>FixtureParam</code> to <code>Any</code>, to enable pending tests to registered as by-name parameters
* by methods that require a test function that takes a <code>FixtureParam</code>.
*
* <p>
* This method makes it possible to write pending tests as simply <code>(pending)</code>, without needing
* to write <code>(fixture => pending)</code>.
* </p>
*
* @param f a function
* @return a function of <code>FixtureParam => Any</code>
*/
protected implicit def convertPendingToFixtureFunction(f: => PendingStatement): FixtureParam => Any /* Assertion */ = {
fixture => { f; Succeeded }
}
/**
* Implicitly converts a function that takes no parameters and results in <code>Any</code> to
* a function from <code>FixtureParam</code> to <code>Any</code>, to enable no-arg tests to registered
* by methods that require a test function that takes a <code>FixtureParam</code>.
*
* @param fun a function
* @return a function of <code>FixtureParam => Any</code>
*/
/*
protected implicit def convertNoArgToFixtureFunction(fun: () => Any /* Assertion */): (FixtureParam => Any /* Assertion */) =
new NoArgTestWrapper(fun)
*/
/**
* <strong>The <code>styleName</code> lifecycle method has been deprecated and will be removed in a future version of ScalaTest.</strong>
*
* <p>This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0
* will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for <code>styleName</code>.</p>
*/
@deprecated("The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.", "3.1.0")
final override val styleName: String = "org.scalatest.fixture.FunSpec"
override def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData = createTestDataFor(testName, theConfigMap, this)
}