/
AsyncWordSpecLike.scala
1337 lines (1256 loc) · 61.7 KB
/
AsyncWordSpecLike.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
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2001-2013 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.wordspec
import org.scalactic.{source, Prettifier}
import org.scalatest._
import scala.concurrent.Future
import Suite.autoTagClassAnnotations
import org.scalatest.exceptions._
import org.scalatest.verbs.{CanVerb, ResultOfAfterWordApplication, ShouldVerb, BehaveWord,
MustVerb, StringVerbBlockRegistration, SubjectWithAfterWordRegistration}
import scala.util.Try
/**
* Implementation trait for class <code>AsyncWordSpec</code>, which facilitates a “behavior-driven” style of development (BDD), in which tests
* are combined with text that specifies the behavior the tests verify.
*
* <p>
* <a href="AsyncWordSpec.html"><code>AsyncWordSpec</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>AsyncWordSpec</code>
* into some other class, you can use this trait instead, because class <code>AsyncWordSpec</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="AsyncWordSpec.html">detailed overview of <code>AsyncWordSpec</code></a>.
* </p>
*
* @author Bill Venners
*/
//SCALATESTJS-ONLY @scala.scalajs.reflect.annotation.EnableReflectiveInstantiation
//SCALATESTNATIVE-ONLY @scala.scalanative.reflect.annotation.EnableReflectiveInstantiation
trait AsyncWordSpecLike extends AsyncTestSuite with AsyncTestRegistration with ShouldVerb with MustVerb with CanVerb with Informing with Notifying with Alerting with Documenting { thisSuite =>
private[scalatest] def transformPendingToOutcome(testFun: () => PendingStatement): () => AsyncTestHolder =
() => {
PastAsyncTestHolder(
try { testFun(); Succeeded }
catch {
case ex: TestCanceledException => Canceled(ex)
case _: TestPendingException => Pending
case tfe: TestFailedException => Failed(tfe)
case ex: Throwable if !Suite.anExceptionThatShouldCauseAnAbort(ex) => Failed(ex)
}
)
}
private final val engine = new AsyncEngine(Resources.concurrentWordSpecMod, "WordSpecLike")
import engine._
/**
* 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 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>AsyncWordSpec</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 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>AsyncWordSpec</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 registerAsyncTestImpl(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion], pos: source.Position): Unit = {
engine.registerAsyncTest(testText, transformToOutcome(testFun), Resources.testCannotBeNestedInsideAnotherTest, None, None, pos, testTags: _*)
}
// SKIP-DOTTY-START
final def registerAsyncTest(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerAsyncTestImpl(testText, testTags: _*)(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def registerAsyncTest(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion])(implicit pos: source.Position): Unit = { // Note: we can't remove the implicit pos here because it is the signature of registerTest in TestRegistration.
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerAsyncTestImpl(testText, testTags: _*)(testFun, pos) }) }
//DOTTY-ONLY }
private final def registerIgnoredAsyncTestImpl(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion], pos: source.Position): Unit = {
engine.registerIgnoredAsyncTest(testText, transformToOutcome(testFun), Resources.testCannotBeNestedInsideAnotherTest, None, pos, testTags: _*)
}
// SKIP-DOTTY-START
final def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerIgnoredAsyncTestImpl(testText, testTags: _*)(testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def registerIgnoredAsyncTest(testText: String, testTags: Tag*)(testFun: => Future[compatible.Assertion])(implicit pos: source.Position): Unit = { // Note: we can't remove the implicit pos here because it is the signature of registerTest in TestRegistration.
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => engine.registerIgnoredAsyncTest(testText, transformToOutcome(testFun), Resources.testCannotBeNestedInsideAnotherTest, None, pos, testTags: _*) }) }
//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>AsyncWordSpec</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 methodName Caller's methodName
* @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 def registerTestToRun(specText: String, testTags: List[Tag], methodName: String, testFun: () => Future[compatible.Assertion], pos: source.Position): Unit = {
def transformToOutcomeParam: Future[compatible.Assertion] = testFun()
engine.registerAsyncTest(specText, transformToOutcome(transformToOutcomeParam), Resources.inCannotAppearInsideAnotherIn, None, None, pos, testTags: _*)
}
private def registerPendingTestToRun(specText: String, testTags: List[Tag], methodName: String, testFun: () => PendingStatement, pos: source.Position): Unit = {
engine.registerAsyncTest(specText, transformPendingToOutcome(testFun), Resources.inCannotAppearInsideAnotherIn, None, None, pos, testTags: _*)
}
/**
* 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>AsyncWordSpec</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 methodName Caller's methodName
* @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 def registerTestToIgnore(specText: String, testTags: List[Tag], methodName: String, testFun: () => Future[compatible.Assertion], pos: source.Position): Unit = {
def transformToOutcomeParam: Future[compatible.Assertion] = testFun()
engine.registerIgnoredAsyncTest(specText, transformToOutcome(transformToOutcomeParam), Resources.ignoreCannotAppearInsideAnIn, None, pos, testTags: _*)
}
private def registerPendingTestToIgnore(specText: String, testTags: List[Tag], methodName: String, testFun: () => PendingStatement, pos: source.Position): Unit = {
engine.registerIgnoredAsyncTest(specText, transformPendingToOutcome(testFun), Resources.ignoreCannotAppearInsideAnIn, None, pos, testTags: _*)
}
private def exceptionWasThrownInClauseMessageFun(verb: String, className: UnquotedString, description: String, errorMessage: String): String =
verb match {
case "when" => FailureMessages.exceptionWasThrownInWhenClause(Prettifier.default, className, description, errorMessage)
case "which" => FailureMessages.exceptionWasThrownInWhichClause(Prettifier.default, className, description, errorMessage)
case "that" => FailureMessages.exceptionWasThrownInThatClause(Prettifier.default, className, description, errorMessage)
case "should" => FailureMessages.exceptionWasThrownInShouldClause(Prettifier.default, className, description, errorMessage)
case "must" => FailureMessages.exceptionWasThrownInMustClause(Prettifier.default, className, description, errorMessage)
case "can" => FailureMessages.exceptionWasThrownInCanClause(Prettifier.default, className, description, errorMessage)
}
private def registerBranch(description: String, childPrefix: Option[String], verb: String, pos: source.Position, fun: () => Unit): Unit = {
def registrationClosedMessageFun: String =
verb match {
case "should" => Resources.shouldCannotAppearInsideAnIn
case "when" => Resources.whenCannotAppearInsideAnIn
case "which" => Resources.whichCannotAppearInsideAnIn
case "that" => Resources.thatCannotAppearInsideAnIn
case "must" => Resources.mustCannotAppearInsideAnIn
case "can" => Resources.canCannotAppearInsideAnIn
}
try {
registerNestedBranch(description, childPrefix, fun(), registrationClosedMessageFun, None, pos)
}
catch {
case e: TestFailedException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideItOrTheyClauseNotShouldMustWhenThatWhichOrCanClause, Some(e), e.position.getOrElse(pos))
case e: TestCanceledException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideItOrTheyClauseNotShouldMustWhenThatWhichOrCanClause, Some(e), e.position.getOrElse(pos))
case nae: NotAllowedException => throw nae
case trce: TestRegistrationClosedException => throw trce
case e: DuplicateTestNameException => throw new NotAllowedException(exceptionWasThrownInClauseMessageFun(verb, UnquotedString(e.getClass.getName), description, e.getMessage), Some(e), e.position.getOrElse(pos))
case other: Throwable if (!Suite.anExceptionThatShouldCauseAnAbort(other)) => throw new NotAllowedException(exceptionWasThrownInClauseMessageFun(verb, UnquotedString(other.getClass.getName), if (description.endsWith(" " + verb)) description.substring(0, description.length - (" " + verb).length) else description, other.getMessage), Some(other), pos)
case other: Throwable => throw other
}
}
private def registerShorthandBranch(childPrefix: Option[String], notAllowMessage: => String, methodName:String, stackDepth: Int, adjustment: Int, pos: source.Position, fun: () => Unit): Unit = {
// Shorthand syntax only allow at top level, and only after "..." when, "..." should/can/must, or it should/can/must
if (engine.currentBranchIsTrunk) {
val currentBranch = engine.atomic.get.currentBranch
// headOption because subNodes are in reverse order
currentBranch.subNodes.headOption match {
case Some(last) =>
last match {
case DescriptionBranch(_, descriptionText, _, _) =>
def registrationClosedMessageFun: String =
methodName match {
case "when" => Resources.whenCannotAppearInsideAnIn
case "which" => Resources.whichCannotAppearInsideAnIn
case "that" => Resources.thatCannotAppearInsideAnIn
case "should" => Resources.shouldCannotAppearInsideAnIn
case "must" => Resources.mustCannotAppearInsideAnIn
case "can" => Resources.canCannotAppearInsideAnIn
}
try {
registerNestedBranch(descriptionText, childPrefix, fun(), registrationClosedMessageFun, None, pos)
}
catch {
case e: TestFailedException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideItOrTheyClauseNotShouldMustWhenThatWhichOrCanClause, Some(e), e.position.getOrElse(pos))
case e: TestCanceledException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideItOrTheyClauseNotShouldMustWhenThatWhichOrCanClause, Some(e), e.position.getOrElse(pos))
case nae: NotAllowedException => throw nae
case trce: TestRegistrationClosedException => throw trce
case e: DuplicateTestNameException => throw new NotAllowedException(exceptionWasThrownInClauseMessageFun(methodName, UnquotedString(e.getClass.getName), descriptionText, e.getMessage), Some(e), e.position.getOrElse(pos))
case other: Throwable if (!Suite.anExceptionThatShouldCauseAnAbort(other)) => throw new NotAllowedException(exceptionWasThrownInClauseMessageFun(methodName, UnquotedString(other.getClass.getName), if (descriptionText.endsWith(" " + methodName)) descriptionText.substring(0, descriptionText.length - (" " + methodName).length) else descriptionText, other.getMessage), Some(other), pos)
case other: Throwable => throw other
}
case _ =>
throw new NotAllowedException(notAllowMessage, None, pos)
}
case None =>
throw new NotAllowedException(notAllowMessage, None, pos)
}
}
else
throw new NotAllowedException(notAllowMessage, None, pos)
}
/**
* Class that supports the registration of tagged tests.
*
* <p>
* Instances of this class are returned by the <code>taggedAs</code> method of
* class <code>WordSpecStringWrapper</code>.
* </p>
*
* @author Bill Venners
*/
protected final class ResultOfTaggedAsInvocationOnString(specText: String, tags: List[Tag]) {
/**
* Supports tagged test registration.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"complain on peek"</span> taggedAs(<span class="stType">SlowTest</span>) in { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def in(testFun: => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerTestToRun(specText, tags, "in", () => testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def in(testFun: => Future[compatible.Assertion]): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestToRun(specText, tags, "in", () => testFun, pos) }) }
//DOTTY-ONLY }
/**
* Supports registration of tagged, pending tests.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"complain on peek"</span> taggedAs(<span class="stType">SlowTest</span>) is (pending)
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def is(testFun: => PendingStatement)(implicit pos: source.Position): Unit = {
registerPendingTestToRun(specText, tags, "is", () => testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def is(testFun: => PendingStatement): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerPendingTestToRun(specText, tags, "is", () => testFun, pos) }) }
//DOTTY-ONLY }
/**
* Supports registration of tagged, ignored tests.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"complain on peek"</span> taggedAs(<span class="stType">SlowTest</span>) ignore { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def ignore(testFun: => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerTestToIgnore(specText, tags, "ignore", () => testFun, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def ignore(testFun: => Future[compatible.Assertion]) = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestToIgnore(specText, tags, "ignore", () => testFun, pos) }) }
//DOTTY-ONLY }
}
/**
* A class that via an implicit conversion (named <code>convertToWordSpecStringWrapper</code>) enables
* methods <code>when</code>, <code>which</code>, <code>in</code>, <code>is</code>, <code>taggedAs</code>
* and <code>ignore</code> to be invoked on <code>String</code>s.
*
* <p>
* This class provides much of the syntax for <code>AsyncWordSpec</code>, however, it does not add
* the verb methods (<code>should</code>, <code>must</code>, and <code>can</code>) to <code>String</code>.
* Instead, these are added via the <code>ShouldVerb</code>, <code>MustVerb</code>, and <code>CanVerb</code>
* traits, which <code>AsyncWordSpec</code> mixes in, to avoid a conflict with implicit conversions provided
* in <code>Matchers</code> and <code>MustMatchers</code>.
* </p>
*
* @author Bill Venners
*/
protected final class WordSpecStringWrapper(string: String) {
/**
* Supports test registration.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"complain on peek"</span> in { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def in(f: => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerTestToRun(string, List(), "in", () => f, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def in(f: => Future[compatible.Assertion]): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestToRun(string, List(), "in", () => f, pos) }) }
//DOTTY-ONLY }
/**
* Supports ignored test registration.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"complain on peek"</span> ignore { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def ignore(f: => Future[compatible.Assertion])(implicit pos: source.Position): Unit = {
registerTestToIgnore(string, List(), "ignore", () => f, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def ignore(f: => Future[compatible.Assertion]): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerTestToIgnore(string, List(), "ignore", () => f, pos) }) }
//DOTTY-ONLY }
/**
* Supports pending test registration.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"complain on peek"</span> is (pending)
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def is(f: => PendingStatement)(implicit pos: source.Position): Unit = {
registerPendingTestToRun(string, List(), "is", () => f, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def is(f: => PendingStatement): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerPendingTestToRun(string, List(), "is", () => f, pos) }) }
//DOTTY-ONLY }
/**
* Supports tagged test registration.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"complain on peek"</span> taggedAs(<span class="stType">SlowTest</span>) in { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
val tagList = firstTestTag :: otherTestTags.toList
new ResultOfTaggedAsInvocationOnString(string, tagList)
}
/**
* Registers a <code>when</code> clause.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"A Stack"</span> when { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def when(f: => Unit)(implicit pos: source.Position): Unit = {
registerBranch(string, Some("when"), "when", pos, () => f)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def when(f: => Unit)(implicit pos: source.Position): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string, Some("when"), "when", pos, () => f) }) }
//DOTTY-ONLY }
/**
* Registers a <code>when</code> clause that is followed by an <em>after word</em>.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stReserved">val</span> theUser = afterWord(<span class="stQuotedString">"the user"</span>)
* <br/><span class="stQuotedString">"A Stack"</span> when theUser { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def when(resultOfAfterWordApplication: ResultOfAfterWordApplication)(implicit pos: source.Position): Unit = {
registerBranch(string, Some("when " + resultOfAfterWordApplication.text), "when", pos, resultOfAfterWordApplication.f)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def when(resultOfAfterWordApplication: ResultOfAfterWordApplication): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string, Some("when " + resultOfAfterWordApplication.text), "when", pos, resultOfAfterWordApplication.f) }) }
//DOTTY-ONLY }
/**
* Registers a <code>that</code> clause.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"a rerun button"</span> that {
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def that(f: => Unit)(implicit pos: source.Position): Unit = {
registerBranch(string.trim + " that", None, "that", pos, () => f)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def that(f: => Unit): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string.trim + " that", None, "that", pos, () => f) }) }
//DOTTY-ONLY }
/**
* Registers a <code>which</code> clause.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"a rerun button,"</span> which {
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def which(f: => Unit)(implicit pos: source.Position): Unit = {
registerBranch(string.trim + " which", None, "which", pos, () => f)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def which(f: => Unit): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string.trim + " which", None, "which", pos, () => f) }) }
//DOTTY-ONLY }
/**
* Registers a <code>that</code> clause that is followed by an <em>after word</em>.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stReserved">def</span> is = afterWord(<span class="stQuotedString">"is"</span>)
* <br/><span class="stQuotedString">"a rerun button"</span> that is {
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def that(resultOfAfterWordApplication: ResultOfAfterWordApplication)(implicit pos: source.Position): Unit = {
registerBranch(string.trim + " that " + resultOfAfterWordApplication.text.trim, None, "that", pos, resultOfAfterWordApplication.f)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def that(resultOfAfterWordApplication: ResultOfAfterWordApplication): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string.trim + " that " + resultOfAfterWordApplication.text.trim, None, "that", pos, resultOfAfterWordApplication.f) }) }
//DOTTY-ONLY }
/**
* Registers a <code>which</code> clause that is followed by an <em>after word</em>.
*
* <p>
* For example, this method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stReserved">def</span> is = afterWord(<span class="stQuotedString">"is"</span>)
* <br/><span class="stQuotedString">"a rerun button,"</span> which is {
* ^
* </pre>
*
* <p>
* For more information and examples of this method's use, see the <a href="AnyWordSpec.html">main documentation</a> for trait <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def which(resultOfAfterWordApplication: ResultOfAfterWordApplication)(implicit pos: source.Position): Unit = {
registerBranch(string.trim + " which " + resultOfAfterWordApplication.text.trim, None, "which", pos, resultOfAfterWordApplication.f)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def which(resultOfAfterWordApplication: ResultOfAfterWordApplication): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => registerBranch(string.trim + " which " + resultOfAfterWordApplication.text.trim, None, "which", pos, resultOfAfterWordApplication.f) }) }
//DOTTY-ONLY }
}
/**
* Class whose instances are <em>after word</em>s, which can be used to reduce text duplication.
*
* <p>
* If you are repeating a word or phrase at the beginning of each string inside
* a block, you can "move the word or phrase" out of the block with an after word.
* You create an after word by passing the repeated word or phrase to the <code>afterWord</code> method.
* Once created, you can place the after word after <code>when</code>, a verb
* (<code>should</code>, <code>must</code>, or <code>can</code>), or
* <code>which</code>. (You can't place one after <code>in</code> or <code>is</code>, the
* words that introduce a test.) Here's an example that has after words used in all three
* places:
* </p>
*
* <pre class="stHighlighted">
* <span class="stReserved">import</span> org.scalatest._
* <br/><span class="stReserved">class</span> <span class="stType">ScalaTestGUISpec</span> <span class="stReserved">extends</span> <span class="stType">wordspec.AnyWordSpec</span> {
* <br/> <span class="stReserved">def</span> theUser = afterWord(<span class="stQuotedString">"the user"</span>)
* <span class="stReserved">def</span> display = afterWord(<span class="stQuotedString">"display"</span>)
* <span class="stReserved">def</span> is = afterWord(<span class="stQuotedString">"is"</span>)
* <br/> <span class="stQuotedString">"The ScalaTest GUI"</span> when theUser {
* <span class="stQuotedString">"clicks on an event report in the list box"</span> should display {
* <span class="stQuotedString">"a blue background in the clicked-on row in the list box"</span> in {}
* <span class="stQuotedString">"the details for the event in the details area"</span> in {}
* <span class="stQuotedString">"a rerun button"</span> which is {
* <span class="stQuotedString">"enabled if the clicked-on event is rerunnable"</span> in {}
* <span class="stQuotedString">"disabled if the clicked-on event is not rerunnable"</span> in {}
* }
* }
* }
* }
* </pre>
*
* <p>
* Running the previous <code>AnyWordSpec</code> in the Scala interpreter would yield:
* </p>
*
* <pre class="stREPL">
* scala> (new ScalaTestGUISpec).execute()
* <span class="stGreen">The ScalaTest GUI (when the user clicks on an event report in the list box)
* - should display a blue background in the clicked-on row in the list box
* - should display the details for the event in the details area
* - should display a rerun button that is enabled if the clicked-on event is rerunnable
* - should display a rerun button that is disabled if the clicked-on event is not rerunnable</span>
* </pre>
*/
protected final class AfterWord(text: String) {
/**
* Supports the use of <em>after words</em>.
*
* <p>
* This method transforms a block of code into a <code>ResultOfAfterWordApplication</code>, which
* is accepted by <code>when</code>, <code>should</code>, <code>must</code>, <code>can</code>, and <code>which</code>
* methods. For more information, see the <a href="AnyWordSpec.html#AfterWords">main documentation</code></a> for trait <code>AnyWordSpec</code>.
* </p>
*/
def apply(f: => Unit) = new ResultOfAfterWordApplication(text, () => f)
}
/**
* Creates an <em>after word</em> that an be used to reduce text duplication.
*
* <p>
* If you are repeating a word or phrase at the beginning of each string inside
* a block, you can "move the word or phrase" out of the block with an after word.
* You create an after word by passing the repeated word or phrase to the <code>afterWord</code> method.
* Once created, you can place the after word after <code>when</code>, a verb
* (<code>should</code>, <code>must</code>, or <code>can</code>), or
* <code>which</code>. (You can't place one after <code>in</code> or <code>is</code>, the
* words that introduce a test.) Here's an example that has after words used in all three
* places:
* </p>
*
* <pre class="stHighlighted">
* <span class="stReserved">import</span> org.scalatest._
* <br/><span class="stReserved">class</span> <span class="stType">ScalaTestGUISpec</span> <span class="stReserved">extends</span> <span class="stType">wordspec.AnyWordSpec</span> {
* <br/> <span class="stReserved">def</span> theUser = afterWord(<span class="stQuotedString">"the user"</span>)
* <span class="stReserved">def</span> display = afterWord(<span class="stQuotedString">"display"</span>)
* <span class="stReserved">def</span> is = afterWord(<span class="stQuotedString">"is"</span>)
* <br/> <span class="stQuotedString">"The ScalaTest GUI"</span> when theUser {
* <span class="stQuotedString">"clicks on an event report in the list box"</span> should display {
* <span class="stQuotedString">"a blue background in the clicked-on row in the list box"</span> in {}
* <span class="stQuotedString">"the details for the event in the details area"</span> in {}
* <span class="stQuotedString">"a rerun button"</span> which is {
* <span class="stQuotedString">"enabled if the clicked-on event is rerunnable"</span> in {}
* <span class="stQuotedString">"disabled if the clicked-on event is not rerunnable"</span> in {}
* }
* }
* }
* }
* </pre>
*
* <p>
* Running the previous <code>AnyWordSpec</code> in the Scala interpreter would yield:
* </p>
*
* <pre class="stREPL">
* scala> (new ScalaTestGUISpec).execute()
* <span class="stGreen">The ScalaTest GUI (when the user clicks on an event report in the list box)
* - should display a blue background in the clicked-on row in the list box
* - should display the details for the event in the details area
* - should display a rerun button that is enabled if the clicked-on event is rerunnable
* - should display a rerun button that is disabled if the clicked-on event is not rerunnable</span>
* </pre>
*/
protected def afterWord(text: String) = new AfterWord(text)
// SKIP-SCALATESTJS,NATIVE-START
private[scalatest] val stackDepth = 3
// SKIP-SCALATESTJS,NATIVE-END
//SCALATESTJS,NATIVE-ONLY private[scalatest] val stackDepth: Int = 10
/**
* Class that supports shorthand scope registration via the instance referenced from <code>AnyWordSpecLike</code>'s <code>it</code> field.
*
* <p>
* This class enables syntax such as the following test registration:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"A Stack"</span> when { ... }
* <br/>it should { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of the use of the <code>it</code> field, see the main documentation
* for <code>AnyWordSpec</code>.
* </p>
*/
protected final class ItWord {
private final def shouldImpl(right: => Unit, pos: source.Position): Unit = {
registerShorthandBranch(Some("should"), Resources.itMustAppearAfterTopLevelSubject, "should", stackDepth, -2, pos, () => right)
}
/**
* Supports the registration of scope with <code>should</code> in a <code>AnyWordSpecLike</code>.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"A Stack"</span> when { ... }
* <br/>it should { ... }
* ^
* </pre>
*
* <p>
* For examples of scope registration, see the <a href="AnyWordSpec.html">main documentation</a>
* for <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def should(right: => Unit)(implicit pos: source.Position): Unit = {
shouldImpl(right, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def should(right: => Unit): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => shouldImpl(right, pos) }) }
//DOTTY-ONLY }
private final def mustImpl(right: => Unit, pos: source.Position): Unit = {
registerShorthandBranch(Some("must"), Resources.itMustAppearAfterTopLevelSubject, "must", stackDepth, -2, pos, () => right)
}
/**
* Supports the registration of scope with <code>must</code> in a <code>AsyncWordSpecLike</code>.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"A Stack"</span> when { ... }
* <br/>it must { ... }
* ^
* </pre>
*
* <p>
* For examples of scope registration, see the <a href="AnyWordSpec.html">main documentation</a>
* for <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def must(right: => Unit)(implicit pos: source.Position): Unit = {
mustImpl(right, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def must(right: => Unit): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => mustImpl(right, pos) }) }
//DOTTY-ONLY }
private final def canImpl(right: => Unit, pos: source.Position): Unit = {
registerShorthandBranch(Some("can"), Resources.itMustAppearAfterTopLevelSubject, "can", stackDepth, -2, pos, () => right)
}
/**
* Supports the registration of scope with <code>can</code> in a <code>AsyncWordSpecLike</code>.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"A Stack"</span> when { ... }
* <br/>it can { ... }
* ^
* </pre>
*
* <p>
* For examples of scope registration, see the <a href="AnyWordSpec.html">main documentation</a>
* for <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def can(right: => Unit)(implicit pos: source.Position): Unit = {
canImpl(right, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def can(right: => Unit): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => canImpl(right, pos) }) }
//DOTTY-ONLY }
private final def whenImpl(right: => Unit, pos: source.Position): Unit = {
registerShorthandBranch(Some("when"), Resources.itMustAppearAfterTopLevelSubject, "when", stackDepth, -2, pos, () => right)
}
/**
* Supports the registration of scope with <code>when</code> in a <code>AsyncWordSpecLike</code>.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"A Stack"</span> should { ... }
* <br/>it when { ... }
* ^
* </pre>
*
* <p>
* For examples of scope registration, see the <a href="AnyWordSpec.html">main documentation</a>
* for <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def when(right: => Unit)(implicit pos: source.Position): Unit = {
whenImpl(right, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def when(right: => Unit): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => whenImpl(right, pos) }) }
//DOTTY-ONLY }
}
/**
* Supports shorthand scope registration in <code>AsyncWordSpecLike</code>s.
*
* <p>
* This field enables syntax such as the following test registration:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"A Stack"</span> when { ... }
* <br/>it should { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of the use of the <code>it</code> field, see the main documentation
* for <code>AnyWordSpec</code>.
* </p>
*/
protected val it = new ItWord
/**
* Class that supports shorthand scope registration via the instance referenced from <code>AsyncWordSpecLike</code>'s <code>they</code> field.
*
* <p>
* This class enables syntax such as the following test registration:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"Basketball players"</span> when { ... }
* <br/>they should { ... }
* ^
* </pre>
*
* <p>
* For more information and examples of the use of the <code>they</code> field, see the main documentation
* for <code>AnyWordSpec</code>.
* </p>
*/
protected final class TheyWord {
private final def shouldImpl(right: => Unit, pos: source.Position): Unit = {
registerShorthandBranch(Some("should"), Resources.theyMustAppearAfterTopLevelSubject, "should", stackDepth, -2, pos, () => right)
}
/**
* Supports the registration of scope with <code>should</code> in a <code>AsyncWordSpecLike</code>.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"Basketball players"</span> when { ... }
* <br/>they should { ... }
* ^
* </pre>
*
* <p>
* For examples of scope registration, see the <a href="AnyWordSpec.html">main documentation</a>
* for <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def should(right: => Unit)(implicit pos: source.Position): Unit = {
shouldImpl(right, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def should(right: => Unit): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => shouldImpl(right, pos) }) }
//DOTTY-ONLY }
private final def mustImpl(right: => Unit, pos: source.Position): Unit = {
registerShorthandBranch(Some("must"), Resources.theyMustAppearAfterTopLevelSubject, "must", stackDepth, -2, pos, () => right)
}
/**
* Supports the registration of scope with <code>must</code> in a <code>AsyncWordSpecLike</code>.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"Basketball players"</span> when { ... }
* <br/>they must { ... }
* ^
* </pre>
*
* <p>
* For examples of scope registration, see the <a href="AnyWordSpec.html">main documentation</a>
* for <code>AnyWordSpec</code>.
* </p>
*/
// SKIP-DOTTY-START
def must(right: => Unit)(implicit pos: source.Position): Unit = {
mustImpl(right, pos)
}
// SKIP-DOTTY-END
//DOTTY-ONLY inline def must(right: => Unit): Unit = {
//DOTTY-ONLY ${ source.Position.withPosition[Unit]('{(pos: source.Position) => mustImpl(right, pos) }) }
//DOTTY-ONLY }
private final def canImpl(right: => Unit, pos: source.Position): Unit = {
registerShorthandBranch(Some("can"), Resources.theyMustAppearAfterTopLevelSubject, "can", stackDepth, -2, pos, () => right)
}
/**
* Supports the registration of scope with <code>can</code> in a <code>AsyncWordSpecLike</code>.
*
* <p>
* This method supports syntax such as the following:
* </p>
*
* <pre class="stHighlighted">
* <span class="stQuotedString">"Basketball players"</span> when { ... }
* <br/>they can { ... }
* ^
* </pre>
*
* <p>