/
RefSpecLike.scala
353 lines (316 loc) · 17.4 KB
/
RefSpecLike.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
/*
* 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.refspec
import org.scalatest._
import org.scalatest.exceptions._
import Suite._
import org.scalactic.Requirements._
import org.scalatest.events._
import scala.reflect.NameTransformer._
import RefSpec.equalIfRequiredCompactify
import RefSpec.isTestMethod
import StackDepthExceptionHelper.posOrElseStackDepthFun
import java.lang.reflect.{Method, Modifier, InvocationTargetException}
import org.scalactic.{source, Prettifier}
/**
* Implementation trait for class <code>RefSpec</code>, which facilitates a “behavior-driven” style of development (BDD), in which tests
* are methods, optionally nested inside singleton objects defining textual scopes.
*
* <p>
* <a href="RefSpec.html"><code>RefSpec</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>RefSpec</code>
* into some other class, you can use this trait instead, because class <code>RefSpec</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="RefSpec.html">detailed overview of <code>RefSpec</code></a>.
* </p>
*
* @author Bill Venners
*/
trait RefSpecLike extends TestSuite with Informing with Notifying with Alerting with Documenting { thisSuite =>
private final val engine = new Engine(Resources.concurrentSpecMod, "RefSpecLike")
import engine._
// Sychronized on thisSuite, only accessed from ensureScopesAndTestsRegistered
private var scopesRegistered = false
private def ensureScopesAndTestsRegistered(): Unit = {
thisSuite.synchronized {
if (!scopesRegistered) {
scopesRegistered = true
def getMethod(o: AnyRef, methodName: String) = {
o.getClass.getMethod(
simpleNameForTest(methodName),
new Array[Class[_]](0): _*
)
}
def getMethodTags(o: AnyRef, methodName: String) =
for {
a <- getMethod(o, methodName).getDeclaredAnnotations
annotationClass = a.annotationType
if annotationClass.isAnnotationPresent(classOf[TagAnnotation])
} yield annotationClass.getName
def getScopeClassName(o: AnyRef): String = {
val className = o.getClass.getName
if (className.endsWith("$"))
className
else
className + "$"
}
def isScopeMethod(o: AnyRef, m: Method): Boolean = {
val scopeMethodName = getScopeClassName(o)+ m.getName + "$"
val returnTypeName = m.getReturnType.getName
equalIfRequiredCompactify(scopeMethodName, returnTypeName)
}
def getScopeDesc(m: Method): String = {
val objName = m.getReturnType.getName
val objClassName = decode(objName.substring(0, objName.length - 1))
objClassName.substring(objClassName.lastIndexOf("$") + 1)
}
val testTags = tags
object MethodNameEncodedOrdering extends Ordering[Method] {
def compare(x: Method, y: Method): Int = {
decode(x.getName) compareTo decode(y.getName)
}
}
def register(o: AnyRef): Unit = {
val testMethods = o.getClass.getMethods.filter(isTestMethod(_)).sorted(MethodNameEncodedOrdering)
testMethods.foreach { m =>
//DOTTY-ONLY m.setAccessible(true)
val scope = isScopeMethod(o, m)
if (scope) {
val scopeDesc = getScopeDesc(m)
def scopeFun: Unit = {
try {
val scopeObj = m.invoke(o)
register(scopeObj)
}
catch {
case ite: InvocationTargetException if ite.getTargetException != null =>
throw ite.getTargetException
}
}
val scopeLocation = TopOfClass(m.getReturnType.getName)
try {
registerNestedBranch(scopeDesc, None, scopeFun, Resources.registrationAlreadyClosed, sourceFileName, "ensureScopesAndTestsRegistered", 2, 0, Some(scopeLocation), None)
}
catch {
case e: TestFailedException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideDefNotObject, Some(e), posOrElseStackDepthFun(e.position, _ => 8))
case e: TestCanceledException => throw new NotAllowedException(FailureMessages.assertionShouldBePutInsideDefNotObject, Some(e), posOrElseStackDepthFun(e.position, _ => 8))
case other: Throwable if (!Suite.anExceptionThatShouldCauseAnAbort(other)) =>
if (ScalaTestVersions.BuiltForScalaVersion == "2.12")
throw new NotAllowedException(FailureMessages.exceptionWasThrownInObject(Prettifier.default, UnquotedString(other.getClass.getName), UnquotedString(scopeDesc)), Some(other), Right((_: StackDepthException) => 9))
else if (ScalaTestVersions.BuiltForScalaVersion.startsWith("2.13"))
throw new NotAllowedException(FailureMessages.exceptionWasThrownInObject(Prettifier.default, UnquotedString(other.getClass.getName), UnquotedString(scopeDesc)), Some(other), Right((_: StackDepthException) => 7))
else
throw new NotAllowedException(FailureMessages.exceptionWasThrownInObject(Prettifier.default, UnquotedString(other.getClass.getName), UnquotedString(scopeDesc)), Some(other), Right((_: StackDepthException) => 8))
case other: Throwable => throw other
}
}
else {
val methodName = m.getName
val testName = decode(methodName)
val methodTags = getMethodTags(o, methodName)
val testFun: () => Unit = () => {
val argsArray: Array[Object] = Array.empty
try m.invoke(o, argsArray: _*)
catch {
case ite: InvocationTargetException =>
throw ite.getTargetException
}
}
val testLocation = TopOfMethod(getScopeClassName(o), m.toGenericString)
val isIgnore = testTags.get(methodName) match {
case Some(tagSet) => tagSet.contains(Suite.IgnoreTagName) || methodTags.contains(Suite.IgnoreTagName)
case None => methodTags.contains(Suite.IgnoreTagName)
}
if (isIgnore)
registerIgnoredTest(testName, Transformer(testFun), Resources.registrationAlreadyClosed, sourceFileName, "ensureScopesAndTestsRegistered", 3, 0, Some(testLocation), None, methodTags.map(new Tag(_)): _*)
else
registerTest(testName, Transformer(testFun), Resources.registrationAlreadyClosed, sourceFileName, "ensureScopesAndTestsRegistered", 2, 1, None, Some(testLocation), None, None, methodTags.map(new Tag(_)): _*)
}
}
}
register(thisSuite)
}
}
}
// TODO: Probably make this private final val sourceFileName in a singleton object so it gets compiled in rather than carried around in each instance
private[scalatest] val sourceFileName = "RefSpecLike.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>RefSpec</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>RefSpec</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
/**
* An immutable <code>Set</code> of test names. If this <code>RefSpec</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. For example, consider this <code>RefSpec</code>:
* </p>
*
* <pre class="stHighlighted">
* <span class="stReserved">import</span> org.scalatest.RefSpec
* <br/><span class="stReserved">class</span> <span class="stType">StackSpec</span> <span class="stReserved">extends</span> <span class="stType">RefSpec</span> {
* <span class="stReserved">object</span> <span class="literalIdentifier">`A Stack`</span> {
* <span class="stReserved">object</span> <span class="literalIdentifier">`(when not empty)`</span> {
* <span class="stReserved">def</span> <span class="literalIdentifier">`must allow me to pop`</span> {}
* }
* <span class="stReserved">object</span> <span class="literalIdentifier">`(when not full)`</span> {
* <span class="stReserved">def</span> <span class="literalIdentifier">`must allow me to push`</span> {}
* }
* }
* }
* </pre>
*
* <p>
* Invoking <code>testNames</code> on this <code>RefSpec</code> will yield a set that contains the following
* two test name strings:
* </p>
*
* <pre class="stExamples">
* "A Stack (when not empty) must allow me to pop"
* "A Stack (when not full) must allow me to push"
* </pre>
*/
override def testNames: Set[String] = {
ensureScopesAndTestsRegistered()
InsertionOrderSet(atomic.get.testNamesList)
}
/**
* 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 NullPointerException if any of <code>testName</code>, <code>reporter</code>, <code>stopper</code>, or <code>configMap</code>
* is <code>null</code>.
*/
protected override def runTest(testName: String, args: Args): Status = {
requireNonNull(testName, args)
ensureScopesAndTestsRegistered()
def invokeWithFixture(theTest: TestLeaf): Outcome = {
val theConfigMap = args.configMap
val testData = testDataFor(testName, theConfigMap)
withFixture(
new NoArgTest {
val name = testData.name
def apply(): Outcome = { theTest.testFun() }
val configMap = testData.configMap
val scopes = testData.scopes
val text = testData.text
val tags = testData.tags
val pos = testData.pos
}
)
}
runTestImpl(thisSuite, testName, args, true, invokeWithFixture)
}
final override def expectedTestCount(filter: Filter): Int = {
ensureScopesAndTestsRegistered()
super.expectedTestCount(filter)
}
/**
* A <code>Map</code> whose keys are <code>String</code> names of tagged tests and whose associated values are
* the <code>Set</code> of tags for the test. If this <code>RefSpec</code> contains no tags, this method returns an empty <code>Map</code>.
*
* <p>
* This trait's implementation of this method uses Java reflection to discover any Java annotations attached to its test methods. The
* fully qualified name of each unique annotation that extends <code>TagAnnotation</code> is considered a tag. This trait's
* implementation of this method, therefore, places one key/value pair into to the
* <code>Map</code> for each test for which a tag annotation is discovered through reflection.
* </p>
*
* <p>
* In addition, this trait's implementation will also auto-tag tests with class level annotations.
* For example, if you annotate <code>@Ignore</code> at the class level, all test methods in the class will be auto-annotated with
* <code>org.scalatest.Ignore</code>.
* </p>
*/
override def tags: Map[String, Set[String]] = {
ensureScopesAndTestsRegistered()
autoTagClassAnnotations(atomic.get.tagsMap, this)
}
/**
* Run zero to many of this <code>RefSpec</code>'s tests.
*
* @param testName an optional name of one test to run. If <code>None</code>, all relevant tests should be run.
* I.e., <code>None</code> acts like a wildcard that means run all relevant tests in this <code>Suite</code>.
* @param args the <code>Args</code> for this run
* @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 NullPointerException if any of the passed parameters is <code>null</code>.
* @throws IllegalArgumentException if <code>testName</code> is defined, but no test with the specified test name
* exists in this <code>Suite</code>
*/
protected override def runTests(testName: Option[String], args: Args): Status = {
ensureScopesAndTestsRegistered()
runTestsImpl(thisSuite, testName, args, info, true, runTest)
}
override def run(testName: Option[String], args: Args): Status = {
ensureScopesAndTestsRegistered()
runImpl(thisSuite, testName, args, super.run)
}
/**
* <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.refspec.RefSpec"
override def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData = createTestDataFor(testName, theConfigMap, this)
}