1 | |
package org.jbehave.mojo; |
2 | |
|
3 | |
import java.io.File; |
4 | |
import java.util.List; |
5 | |
import java.util.Properties; |
6 | |
|
7 | |
import org.apache.maven.plugin.AbstractMojo; |
8 | |
import org.jbehave.core.InjectableEmbedder; |
9 | |
import org.jbehave.core.embedder.Embedder; |
10 | |
import org.jbehave.core.embedder.EmbedderClassLoader; |
11 | |
import org.jbehave.core.embedder.EmbedderControls; |
12 | |
import org.jbehave.core.embedder.EmbedderMonitor; |
13 | |
import org.jbehave.core.embedder.UnmodifiableEmbedderControls; |
14 | |
import org.jbehave.core.failures.BatchFailures; |
15 | |
import org.jbehave.core.io.StoryFinder; |
16 | |
import org.jbehave.core.junit.AnnotatedEmbedderRunner; |
17 | |
|
18 | |
|
19 | |
|
20 | |
|
21 | |
|
22 | |
|
23 | |
|
24 | 13 | public abstract class AbstractEmbedderMojo extends AbstractMojo { |
25 | |
|
26 | |
static final String TEST_SCOPE = "test"; |
27 | |
|
28 | |
|
29 | |
|
30 | |
|
31 | |
|
32 | |
|
33 | |
String sourceDirectory; |
34 | |
|
35 | |
|
36 | |
|
37 | |
|
38 | |
|
39 | |
|
40 | |
String testSourceDirectory; |
41 | |
|
42 | |
|
43 | |
|
44 | |
|
45 | |
|
46 | |
|
47 | |
String scope; |
48 | |
|
49 | |
|
50 | |
|
51 | |
|
52 | |
|
53 | |
|
54 | |
|
55 | |
List<String> includes; |
56 | |
|
57 | |
|
58 | |
|
59 | |
|
60 | |
|
61 | |
|
62 | |
|
63 | |
List<String> excludes; |
64 | |
|
65 | |
|
66 | |
|
67 | |
|
68 | |
|
69 | |
|
70 | |
|
71 | |
|
72 | |
List<String> compileClasspathElements; |
73 | |
|
74 | |
|
75 | |
|
76 | |
|
77 | |
|
78 | |
|
79 | |
|
80 | |
|
81 | |
List<String> testClasspathElements; |
82 | |
|
83 | |
|
84 | |
|
85 | |
|
86 | |
|
87 | |
|
88 | 13 | boolean skip = false; |
89 | |
|
90 | |
|
91 | |
|
92 | |
|
93 | |
|
94 | |
|
95 | 13 | boolean batch = false; |
96 | |
|
97 | |
|
98 | |
|
99 | |
|
100 | |
|
101 | |
|
102 | 13 | boolean ignoreFailureInStories = false; |
103 | |
|
104 | |
|
105 | |
|
106 | |
|
107 | |
|
108 | |
|
109 | 13 | boolean ignoreFailureInView = false; |
110 | |
|
111 | |
|
112 | |
|
113 | |
|
114 | |
|
115 | |
|
116 | 13 | boolean generateViewAfterStories = true; |
117 | |
|
118 | |
|
119 | |
|
120 | |
|
121 | |
|
122 | |
|
123 | 13 | String embedderClass = Embedder.class.getName(); |
124 | |
|
125 | |
|
126 | |
|
127 | |
|
128 | |
|
129 | |
|
130 | |
String injectableEmbedderClass; |
131 | |
|
132 | |
|
133 | |
|
134 | |
|
135 | |
|
136 | |
|
137 | 13 | protected String annotatedEmbedderRunnerClass = AnnotatedEmbedderRunner.class.getName(); |
138 | |
|
139 | |
|
140 | |
|
141 | |
|
142 | |
|
143 | |
|
144 | 13 | String storyFinderClass = StoryFinder.class.getName(); |
145 | |
|
146 | |
|
147 | |
|
148 | |
|
149 | |
|
150 | |
|
151 | |
boolean isTestScope() { |
152 | 11 | return TEST_SCOPE.equals(scope); |
153 | |
} |
154 | |
|
155 | |
String searchDirectory() { |
156 | 4 | if (isTestScope()) { |
157 | 1 | return testSourceDirectory; |
158 | |
} |
159 | 3 | return sourceDirectory; |
160 | |
} |
161 | |
|
162 | |
|
163 | |
|
164 | |
|
165 | |
|
166 | |
|
167 | |
|
168 | |
protected EmbedderClassLoader createClassLoader() { |
169 | 6 | return new EmbedderClassLoader(classpathElements()); |
170 | |
} |
171 | |
|
172 | |
List<String> classpathElements() { |
173 | 7 | List<String> classpathElements = compileClasspathElements; |
174 | 7 | if (isTestScope()) { |
175 | 1 | classpathElements = testClasspathElements; |
176 | |
} |
177 | 7 | return classpathElements; |
178 | |
} |
179 | |
|
180 | |
|
181 | |
|
182 | |
|
183 | |
|
184 | |
|
185 | |
|
186 | |
protected List<String> storyPaths() { |
187 | 1 | getLog().debug("Searching for story paths including " + includes + " and excluding " + excludes); |
188 | 1 | List<String> storyPaths = newStoryFinder().findPaths(searchDirectory(), includes, excludes); |
189 | 1 | getLog().info("Found story paths: " + storyPaths); |
190 | 1 | return storyPaths; |
191 | |
} |
192 | |
|
193 | |
|
194 | |
|
195 | |
|
196 | |
|
197 | |
|
198 | |
|
199 | |
protected List<String> classNames() { |
200 | 2 | getLog().debug("Searching for class names including " + includes + " and excluding " + excludes); |
201 | 2 | List<String> classNames = newStoryFinder().findClassNames(searchDirectory(), includes, excludes); |
202 | 2 | getLog().info("Found class names: " + classNames); |
203 | 2 | return classNames; |
204 | |
} |
205 | |
|
206 | |
|
207 | |
|
208 | |
|
209 | |
|
210 | |
|
211 | |
protected StoryFinder newStoryFinder() { |
212 | 4 | return createClassLoader().newInstance(StoryFinder.class, storyFinderClass); |
213 | |
} |
214 | |
|
215 | |
|
216 | |
|
217 | |
|
218 | |
|
219 | |
|
220 | |
|
221 | |
|
222 | |
protected Embedder newEmbedder() { |
223 | 5 | Embedder embedder = null; |
224 | 5 | EmbedderClassLoader classLoader = createClassLoader(); |
225 | 5 | if (injectableEmbedderClass != null) { |
226 | 1 | embedder = classLoader.newInstance(InjectableEmbedder.class, injectableEmbedderClass).injectedEmbedder(); |
227 | |
} else { |
228 | 4 | embedder = classLoader.newInstance(Embedder.class, embedderClass); |
229 | |
} |
230 | 5 | embedder.useEmbedderMonitor(embedderMonitor()); |
231 | 5 | embedder.useEmbedderControls(embedderControls()); |
232 | 5 | return embedder; |
233 | |
} |
234 | |
|
235 | |
protected EmbedderMonitor embedderMonitor() { |
236 | 5 | return new MavenEmbedderMonitor(); |
237 | |
} |
238 | |
|
239 | |
protected EmbedderControls embedderControls() { |
240 | 5 | return new UnmodifiableEmbedderControls(new EmbedderControls().doBatch(batch).doSkip(skip) |
241 | |
.doGenerateViewAfterStories(generateViewAfterStories).doIgnoreFailureInStories(ignoreFailureInStories) |
242 | |
.doIgnoreFailureInView(ignoreFailureInView)); |
243 | |
} |
244 | |
|
245 | 13 | protected class MavenEmbedderMonitor implements EmbedderMonitor { |
246 | |
|
247 | |
public void batchFailed(BatchFailures failures) { |
248 | 1 | getLog().warn("Failed to run batch " + failures); |
249 | 1 | } |
250 | |
|
251 | |
public void embeddableFailed(String name, Throwable cause) { |
252 | 1 | getLog().warn("Failed to run embeddable " + name, cause); |
253 | 1 | } |
254 | |
|
255 | |
public void embeddablesSkipped(List<String> classNames) { |
256 | 1 | getLog().info("Skipped embeddables " + classNames); |
257 | 1 | } |
258 | |
|
259 | |
public void runningEmbeddable(String name) { |
260 | 1 | getLog().info("Running embeddable " + name); |
261 | 1 | } |
262 | |
|
263 | |
public void runningStory(String path) { |
264 | 1 | getLog().info("Running story " + path); |
265 | 1 | } |
266 | |
|
267 | |
public void storiesSkipped(List<String> storyPaths) { |
268 | 1 | getLog().info("Skipped stories " + storyPaths); |
269 | 1 | } |
270 | |
|
271 | |
public void storyFailed(String path, Throwable cause) { |
272 | 1 | getLog().warn("Failed to run story " + path, cause); |
273 | 1 | } |
274 | |
|
275 | |
public void annotatedInstanceNotOfType(Object annotatedInstance, Class<?> type) { |
276 | 1 | getLog().warn("Annotated instance " + annotatedInstance + " not of type " + type); |
277 | 1 | } |
278 | |
|
279 | |
public void generatingStoriesView(File outputDirectory, List<String> formats, Properties viewProperties) { |
280 | 1 | getLog().info( |
281 | |
"Generating stories view in '" + outputDirectory + "' using formats '" + formats + "'" |
282 | |
+ " and view properties '" + viewProperties + "'"); |
283 | 1 | } |
284 | |
|
285 | |
public void storiesViewGenerationFailed(File outputDirectory, List<String> formats, Properties viewProperties, |
286 | |
Throwable cause) { |
287 | 1 | String message = "Failed to generate stories view in outputDirectory " + outputDirectory |
288 | |
+ " using formats " + formats + " and view properties '" + viewProperties + "'"; |
289 | 1 | getLog().warn(message, cause); |
290 | 1 | } |
291 | |
|
292 | |
public void storiesViewGenerated(int stories, int scenarios, int failedScenarios) { |
293 | 1 | getLog().info( |
294 | |
"Stories view generated with " + stories + " stories containing " + scenarios |
295 | |
+ " scenarios (of which " + failedScenarios + " failed)"); |
296 | 1 | } |
297 | |
|
298 | |
public void storiesViewNotGenerated() { |
299 | 1 | getLog().info("Stories view not generated"); |
300 | 1 | } |
301 | |
|
302 | |
@Override |
303 | |
public String toString() { |
304 | 1 | return this.getClass().getSimpleName(); |
305 | |
} |
306 | |
|
307 | |
} |
308 | |
} |