-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
TestFailureDetails.java
112 lines (99 loc) · 3.55 KB
/
TestFailureDetails.java
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
/*
* Copyright 2022 the original author or authors.
*
* 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.gradle.api.tasks.testing;
import org.gradle.api.Incubating;
import javax.annotation.Nullable;
/**
* Contains serializable structural information about a test failure.
*
* @see org.gradle.api.internal.tasks.testing.junit.result.TestFailure
* @since 7.6
*/
@Incubating
public interface TestFailureDetails {
/**
* Returns the failure message.
*
* @return the failure message
*/
@Nullable
String getMessage();
/**
* The fully-qualified name of the underlying exception type.
*
* @return the class name
*/
String getClassName();
/**
* Returns the stacktrace of the failure.
* <p>
* The instances are created on the test worker side allowing the clients not to deal with non-serializable exceptions.
*
* @return the stacktrace string
*/
String getStacktrace();
/**
* Returns true if the represented failure is recognized as an assertion failure.
*
* @return {@code true} for assertion failures
*/
boolean isAssertionFailure();
/**
* Returns true if the represented failure is recognized as a file comparison failure.
* <p>
* If this field is {@code true}, then the {@link #getExpectedContent()} and {@link #getActualContent()} methods <i>might</i> return non-null values.
*
* @since 8.3
* @return {@code true} if this failure is a file comparison failure
*/
boolean isFileComparisonFailure();
/**
* Returns the expected content of a file comparison assertion failure.
*
* @since 8.3
* @see #isFileComparisonFailure()
* @return the expected file contents or {@code null} if the test framework doesn't supply detailed information on assertion failures, or it is not a file comparison failure
*/
@Nullable
byte[] getExpectedContent();
/**
* Returns the actual content of a file comparison assertion failure.
*
* @since 8.3
* @see #isFileComparisonFailure()
* @return the expected file contents or {@code null} if the test framework doesn't supply detailed information on assertion failures, or it is not a file comparison failure
*/
@Nullable
byte[] getActualContent();
/**
* Returns a string representation of the expected value for an assertion failure.
* <p>
* If the current instance does not represent an assertion failure, or the test failure doesn't provide any information about expected and actual values then the method returns {@code null}.
*
* @return The expected value
*/
@Nullable
String getExpected();
/**
* Returns a string representation of the actual value for an assertion failure.
* <p>
* If the current instance does not represent an assertion failure, or the test failure doesn't provide any information about expected and actual values then the method returns {@code null}.
*
* @return The actual value
*/
@Nullable
String getActual();
}