/
Cuppa.java
180 lines (161 loc) · 5.63 KB
/
Cuppa.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
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
/*
* Copyright 2015-2016 ForgeRock AS.
*
* 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.forgerock.cuppa;
import org.forgerock.cuppa.functions.HookFunction;
import org.forgerock.cuppa.functions.TestBlockFunction;
import org.forgerock.cuppa.functions.TestFunction;
import org.forgerock.cuppa.internal.TestContainer;
import org.forgerock.cuppa.model.Behaviour;
/**
* Use the methods of this class to define your tests.
*/
public final class Cuppa {
private Cuppa() {
}
/**
* Registers a described suite of tests to be run.
*
* @param description The description of the 'describe' block.
* @param function The 'describe' block.
*/
public static void describe(String description, TestBlockFunction function) {
TestContainer.INSTANCE.describe(description, function);
}
/**
* Registers a described suite of tests to be run.
*
* @param behaviour If {@link Behaviour#SKIP} then this test will be skipped.
* @param description The description of the 'describe' block.
* @param function The 'describe' block.
*/
public static void describe(Behaviour behaviour, String description, TestBlockFunction function) {
TestContainer.INSTANCE.describe(behaviour, description, function);
}
/**
* Registers a 'when' block to be run.
*
* @param description The description of the 'when' block.
* @param function The 'when' block.
*/
public static void when(String description, TestBlockFunction function) {
TestContainer.INSTANCE.when(description, function);
}
/**
* Registers a 'when' block to be run.
*
* @param behaviour If {@link Behaviour#SKIP} then this test will be skipped.
* @param description The description of the 'when' block.
* @param function The 'when' block.
*/
public static void when(Behaviour behaviour, String description, TestBlockFunction function) {
TestContainer.INSTANCE.when(behaviour, description, function);
}
/**
* Registers a 'before' block to be run.
*
* @param function The 'before' block.
*/
public static void before(HookFunction function) {
TestContainer.INSTANCE.before(function);
}
/**
* Registers a 'before' block to be run.
*
* @param description The description of the 'before' block.
* @param function The 'before' block.
*/
public static void before(String description, HookFunction function) {
TestContainer.INSTANCE.before(description, function);
}
/**
* Registers a 'after' block to be run.
*
* @param function The 'after' block.
*/
public static void after(HookFunction function) {
TestContainer.INSTANCE.after(function);
}
/**
* Registers a 'after' block to be run.
*
* @param description The description of the 'after' block.
* @param function The 'after' block.
*/
public static void after(String description, HookFunction function) {
TestContainer.INSTANCE.after(description, function);
}
/**
* Registers a 'beforeEach' block to be run.
*
* @param function The 'beforeEach' block.
*/
public static void beforeEach(HookFunction function) {
TestContainer.INSTANCE.beforeEach(function);
}
/**
* Registers a 'beforeEach' block to be run.
*
* @param description The description of the 'beforeEach' block.
* @param function The 'beforeEach' block.
*/
public static void beforeEach(String description, HookFunction function) {
TestContainer.INSTANCE.beforeEach(description, function);
}
/**
* Registers a 'afterEach' block to be run.
*
* @param function The 'afterEach' block.
*/
public static void afterEach(HookFunction function) {
TestContainer.INSTANCE.afterEach(function);
}
/**
* Registers a 'afterEach' block to be run.
*
* @param description The description of the 'afterEach' block.
* @param function The 'afterEach' block.
*/
public static void afterEach(String description, HookFunction function) {
TestContainer.INSTANCE.afterEach(description, function);
}
/**
* Registers a test function to be run.
*
* @param description The description of the test function.
* @param function The test function.
*/
public static void it(String description, TestFunction function) {
TestContainer.INSTANCE.it(description, function);
}
/**
* Registers a test function to be run.
*
* @param behaviour If {@link Behaviour#SKIP} then this test will be skipped.
* @param description The description of the test function.
* @param function The test function.
*/
public static void it(Behaviour behaviour, String description, TestFunction function) {
TestContainer.INSTANCE.it(behaviour, description, function);
}
/**
* Registers a pending test function that has yet to be implemented.
*
* @param description The description of the test function.
*/
public static void it(String description) {
TestContainer.INSTANCE.it(description);
}
}