/
Payloads.scala
92 lines (89 loc) · 3.75 KB
/
Payloads.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
/*
* 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
/**
* Trait facilitating the inclusion of a payload in a thrown ScalaTest exception.
*
* <p>
* This trait includes a <code>withPayload</code> construct
* that enables a payload object (or modified
* payload object) to be included as the payload of a thrown exception.
*
* <p>
* Many ScalaTest events include an optional "payload" field that can be used
* to pass information to a custom reporter. This trait facilitates such customization,
* by making it easy to insert a payload into a thrown exception, such as a <code>TestFailedException</code>.
* The thrown exception must mix in <code>Payload</code>.
* ScalaTest looks for trait <code>Payload</code> and fires any payloads it finds in the relevant ScalaTest event
* stimulated by the exception, such as a <a href="events/TestFailed.html"><code>TestFailed</code></a> event stimulated by a <a href="exceptions/TestFailedException.html"><code>TestFailedException</code></a>.
* Here's an example in which a GUI snapshot is included as a payload when a test fails:
* </p>
*
* <pre class="stHighlighted">
* withPayload(generateGUISnapshot()) {
* <span class="stLiteral">1</span> + <span class="stLiteral">1</span> should === (<span class="stLiteral">3</span>)
* }
* </pre>
*
* @author Bill Venners
*/
trait Payloads {
/**
* Executes the block of code passed as the second parameter, and, if it
* completes abruptly with a <code>ModifiablePayload</code> exception,
* replaces the current payload contained in the exception, if any, with the one passed
* as the first parameter.
*
* <p>
* This method allows you to insert a payload into a thrown <code>Payload</code> exception (such as
* a <code>TestFailedException</code>), so that payload can be included in events fired to a custom reporter
* that can make use of the payload.
* Here's an example in which a GUI snapshot is included as a payload when a test fails:
* </p>
*
* <pre class="stHighlighted">
* withPayload(generateGUISnapshot()) {
* <span class="stLiteral">1</span> + <span class="stLiteral">1</span> should === (<span class="stLiteral">3</span>)
* }
* </pre>
*
*/
def withPayload[T](payload: => Any)(fun: => T): T = {
try {
val outcome: T = fun
outcome match {
case Failed(e: org.scalatest.exceptions.ModifiablePayload[_]) if payload != null =>
Failed(e.modifyPayload((currentPayload: Option[Any]) => Some(payload))).asInstanceOf[T]
case Canceled(e: org.scalatest.exceptions.ModifiablePayload[_]) if payload != null =>
Canceled(e.modifyPayload((currentPayload: Option[Any]) => Some(payload))).asInstanceOf[T]
case _ => outcome
}
}
catch {
case e: org.scalatest.exceptions.ModifiablePayload[_] with Throwable =>
if (payload != null)
throw e.modifyPayload((currentPayload: Option[Any]) => Some(payload))
else
throw e
}
}
}
/**
* Companion object that facilitates the importing of <code>Payloads</code> members as
* an alternative to mixing it in. One use case is to import <code>Payloads</code>
* members so you can use them in the Scala interpreter.
*/
object Payloads extends Payloads