1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
12 |
|
|
13 |
|
|
14 |
|
|
15 |
|
|
16 |
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
|
package org.xwiki.watchlist.internal.notification; |
21 |
|
|
22 |
|
import java.util.ArrayList; |
23 |
|
import java.util.HashMap; |
24 |
|
import java.util.List; |
25 |
|
import java.util.Map; |
26 |
|
|
27 |
|
import javax.mail.Address; |
28 |
|
import javax.mail.internet.InternetAddress; |
29 |
|
|
30 |
|
import org.junit.Before; |
31 |
|
import org.junit.Rule; |
32 |
|
import org.junit.Test; |
33 |
|
import org.xwiki.context.Execution; |
34 |
|
import org.xwiki.context.ExecutionContext; |
35 |
|
import org.xwiki.model.reference.DocumentReference; |
36 |
|
import org.xwiki.model.reference.DocumentReferenceResolver; |
37 |
|
import org.xwiki.model.reference.WikiReference; |
38 |
|
import org.xwiki.test.mockito.MockitoComponentManagerRule; |
39 |
|
import org.xwiki.watchlist.internal.WatchListEventMatcher; |
40 |
|
import org.xwiki.watchlist.internal.api.WatchListEvent; |
41 |
|
import org.xwiki.watchlist.internal.job.WatchListJob; |
42 |
|
|
43 |
|
import com.xpn.xwiki.XWiki; |
44 |
|
import com.xpn.xwiki.XWikiContext; |
45 |
|
import com.xpn.xwiki.doc.XWikiDocument; |
46 |
|
import com.xpn.xwiki.objects.BaseObject; |
47 |
|
|
48 |
|
import static org.junit.Assert.assertEquals; |
49 |
|
import static org.junit.Assert.assertNull; |
50 |
|
import static org.mockito.Mockito.mock; |
51 |
|
import static org.mockito.Mockito.when; |
52 |
|
|
53 |
|
|
54 |
|
@link |
55 |
|
|
56 |
|
@version |
57 |
|
@since |
58 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (151) |
Complexity: 13 |
Complexity Density: 0.09 |
|
59 |
|
public class WatchListMessageDataExtractorTest |
60 |
|
{ |
61 |
|
@Rule |
62 |
|
public final MockitoComponentManagerRule mocker = new MockitoComponentManagerRule(); |
63 |
|
|
64 |
|
List<WatchListEvent> events; |
65 |
|
|
66 |
|
List<DocumentReference> subscribers; |
67 |
|
|
68 |
|
Map<String, Object> parameters; |
69 |
|
|
70 |
|
Map<String, Object> factoryParameters; |
71 |
|
|
72 |
|
WatchListEventMatcher mockEventMatcher; |
73 |
|
|
74 |
|
Execution mockExecution; |
75 |
|
|
76 |
|
DocumentReferenceResolver<String> mockExplicitDocumentReferenceResolver; |
77 |
|
|
78 |
|
WatchListMessageDataExtractor extractor; |
79 |
|
|
80 |
|
XWikiDocument mockDocument; |
81 |
|
|
82 |
|
BaseObject mockUserObject; |
83 |
|
|
84 |
|
XWiki mockWiki; |
85 |
|
|
86 |
|
XWikiContext mockContext; |
87 |
|
|
88 |
|
ExecutionContext mockExecutionContext; |
89 |
|
|
90 |
|
DocumentReference testSubscriberReference; |
91 |
|
|
92 |
|
String testSubscriberStringReference; |
93 |
|
|
94 |
|
List<WatchListEvent> testMatchingEvents; |
95 |
|
|
96 |
|
String testFirstName; |
97 |
|
|
98 |
|
String testLastName; |
99 |
|
|
100 |
|
String testEmail; |
101 |
|
|
102 |
|
DocumentReference testTemplateReference; |
103 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (28) |
Complexity: 1 |
Complexity Density: 0.04 |
|
104 |
10 |
@Before... |
105 |
|
public void setup() throws Exception |
106 |
|
{ |
107 |
10 |
events = new ArrayList<>(); |
108 |
10 |
subscribers = new ArrayList<>(); |
109 |
10 |
EventsAndSubscribersSource source = new EventsAndSubscribersSource(events, subscribers); |
110 |
|
|
111 |
10 |
parameters = new HashMap<>(); |
112 |
10 |
factoryParameters = new HashMap<>(); |
113 |
10 |
parameters.put(WatchListEventMimeMessageFactory.PARAMETERS_PARAMETER, factoryParameters); |
114 |
|
|
115 |
10 |
mockEventMatcher = mocker.registerMockComponent(WatchListEventMatcher.class); |
116 |
|
|
117 |
10 |
mockExecution = mocker.registerMockComponent(Execution.class); |
118 |
|
|
119 |
10 |
mockExplicitDocumentReferenceResolver = |
120 |
|
mocker.registerMockComponent(DocumentReferenceResolver.TYPE_STRING, "explicit"); |
121 |
|
|
122 |
10 |
extractor = |
123 |
|
new WatchListMessageDataExtractor(source, parameters, mockEventMatcher, mockExecution, |
124 |
|
mockExplicitDocumentReferenceResolver); |
125 |
|
|
126 |
|
|
127 |
10 |
mockDocument = mock(XWikiDocument.class); |
128 |
10 |
mockUserObject = mock(BaseObject.class); |
129 |
|
|
130 |
|
|
131 |
10 |
mockWiki = mock(XWiki.class); |
132 |
|
|
133 |
10 |
mockContext = mock(XWikiContext.class); |
134 |
10 |
when(mockContext.getWiki()).thenReturn(mockWiki); |
135 |
|
|
136 |
10 |
mockExecutionContext = mocker.registerMockComponent(ExecutionContext.class); |
137 |
10 |
when(mockExecution.getContext()).thenReturn(mockExecutionContext); |
138 |
10 |
when(mockExecutionContext.getProperty(XWikiContext.EXECUTIONCONTEXT_KEY)).thenReturn(mockContext); |
139 |
|
|
140 |
|
|
141 |
10 |
testSubscriberReference = new DocumentReference("wiki", "XWiki", "User"); |
142 |
|
|
143 |
10 |
testSubscriberStringReference = "wiki:XWiki.User"; |
144 |
10 |
when(mockDocument.getPrefixedFullName()).thenReturn(testSubscriberStringReference); |
145 |
|
|
146 |
|
|
147 |
10 |
testMatchingEvents = new ArrayList<>(); |
148 |
10 |
WatchListEvent matchingEvent = mock(WatchListEvent.class); |
149 |
10 |
testMatchingEvents.add(matchingEvent); |
150 |
|
|
151 |
10 |
when(mockEventMatcher.getMatchingVisibleEvents(events, testSubscriberStringReference)).thenReturn( |
152 |
|
testMatchingEvents); |
153 |
|
|
154 |
|
|
155 |
10 |
testFirstName = "U"; |
156 |
10 |
testLastName = "ser"; |
157 |
10 |
testEmail = "e@ma.il"; |
158 |
|
|
159 |
|
} |
160 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (3) |
Complexity: 1 |
Complexity Density: 0.33 |
1PASS
|
|
161 |
1 |
@Test... |
162 |
|
public void noMatchingEvents() throws Exception |
163 |
|
{ |
164 |
|
|
165 |
1 |
testMatchingEvents.clear(); |
166 |
|
|
167 |
|
|
168 |
1 |
WatchListMessageData result = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
169 |
|
|
170 |
|
|
171 |
1 |
assertNull(result); |
172 |
|
} |
173 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (4) |
Complexity: 1 |
Complexity Density: 0.25 |
1PASS
|
|
174 |
1 |
@Test... |
175 |
|
public void noEmailSet() throws Exception |
176 |
|
{ |
177 |
|
|
178 |
1 |
testEmail = null; |
179 |
1 |
setUpUserObject(); |
180 |
|
|
181 |
|
|
182 |
1 |
WatchListMessageData result = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
183 |
|
|
184 |
|
|
185 |
1 |
assertNull(result); |
186 |
|
} |
187 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (4) |
Complexity: 1 |
Complexity Density: 0.25 |
1PASS
|
|
188 |
1 |
@Test... |
189 |
|
public void invalidEmailSet() throws Exception |
190 |
|
{ |
191 |
|
|
192 |
|
|
193 |
|
|
194 |
1 |
testEmail = "@#$%^&*("; |
195 |
1 |
setUpUserObject(); |
196 |
|
|
197 |
|
|
198 |
1 |
WatchListMessageData result = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
199 |
|
|
200 |
|
|
201 |
1 |
assertNull(result); |
202 |
|
} |
203 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (10) |
Complexity: 1 |
Complexity Density: 0.1 |
1PASS
|
|
204 |
1 |
@Test... |
205 |
|
public void duplicateEmail() throws Exception |
206 |
|
{ |
207 |
|
|
208 |
1 |
setUpUserObject(); |
209 |
|
|
210 |
|
|
211 |
1 |
String templateStringReference = "xwiki:Some.Template"; |
212 |
1 |
parameters.put(WatchListEventMimeMessageFactory.TEMPLATE_PARAMETER, templateStringReference); |
213 |
|
|
214 |
1 |
DocumentReference templateReference = new DocumentReference("xwiki", "Some", "Template"); |
215 |
1 |
when(mockExplicitDocumentReferenceResolver.resolve(templateStringReference)).thenReturn(templateReference); |
216 |
|
|
217 |
1 |
testTemplateReference = templateReference; |
218 |
|
|
219 |
|
|
220 |
1 |
WatchListMessageData result1 = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
221 |
1 |
WatchListMessageData result2 = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
222 |
|
|
223 |
|
|
224 |
1 |
assertResult(result1); |
225 |
1 |
assertNull(result2); |
226 |
|
} |
227 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (8) |
Complexity: 1 |
Complexity Density: 0.12 |
1PASS
|
|
228 |
1 |
@Test... |
229 |
|
public void absoluteTemplate() throws Exception |
230 |
|
{ |
231 |
|
|
232 |
1 |
setUpUserObject(); |
233 |
|
|
234 |
|
|
235 |
1 |
String templateStringReference = "xwiki:Some.Template"; |
236 |
1 |
parameters.put(WatchListEventMimeMessageFactory.TEMPLATE_PARAMETER, templateStringReference); |
237 |
|
|
238 |
1 |
DocumentReference templateReference = new DocumentReference("xwiki", "Some", "Template"); |
239 |
1 |
when(mockExplicitDocumentReferenceResolver.resolve(templateStringReference)).thenReturn(templateReference); |
240 |
|
|
241 |
1 |
testTemplateReference = templateReference; |
242 |
|
|
243 |
|
|
244 |
1 |
WatchListMessageData result = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
245 |
|
|
246 |
|
|
247 |
1 |
assertResult(result); |
248 |
|
} |
249 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (9) |
Complexity: 1 |
Complexity Density: 0.11 |
1PASS
|
|
250 |
1 |
@Test... |
251 |
|
public void relativeTemplateUserWiki() throws Exception |
252 |
|
{ |
253 |
|
|
254 |
1 |
setUpUserObject(); |
255 |
|
|
256 |
|
|
257 |
1 |
String templateStringReference = "Some.Template"; |
258 |
1 |
parameters.put(WatchListEventMimeMessageFactory.TEMPLATE_PARAMETER, templateStringReference); |
259 |
|
|
260 |
1 |
DocumentReference userWikiTemplateReference = new DocumentReference("wiki", "Some", "Template"); |
261 |
1 |
when( |
262 |
|
mockExplicitDocumentReferenceResolver.resolve(templateStringReference, |
263 |
|
testSubscriberReference.getWikiReference())).thenReturn(userWikiTemplateReference); |
264 |
|
|
265 |
1 |
when(mockWiki.exists(userWikiTemplateReference, mockContext)).thenReturn(true); |
266 |
|
|
267 |
1 |
testTemplateReference = userWikiTemplateReference; |
268 |
|
|
269 |
|
|
270 |
1 |
WatchListMessageData result = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
271 |
|
|
272 |
|
|
273 |
1 |
assertResult(result); |
274 |
|
} |
275 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (15) |
Complexity: 1 |
Complexity Density: 0.07 |
1PASS
|
|
276 |
1 |
@Test... |
277 |
|
public void relativeTemplateContextWiki() throws Exception |
278 |
|
{ |
279 |
|
|
280 |
1 |
setUpUserObject(); |
281 |
|
|
282 |
|
|
283 |
1 |
String templateStringReference = "Some.Template"; |
284 |
1 |
parameters.put(WatchListEventMimeMessageFactory.TEMPLATE_PARAMETER, templateStringReference); |
285 |
|
|
286 |
1 |
DocumentReference userWikiTemplateReference = new DocumentReference("wiki", "Some", "Template"); |
287 |
1 |
when( |
288 |
|
mockExplicitDocumentReferenceResolver.resolve(templateStringReference, |
289 |
|
testSubscriberReference.getWikiReference())).thenReturn(userWikiTemplateReference); |
290 |
|
|
291 |
1 |
when(mockWiki.exists(userWikiTemplateReference, mockContext)).thenReturn(false); |
292 |
|
|
293 |
1 |
String currentWikiId = "xwiki"; |
294 |
1 |
when(mockContext.getWikiId()).thenReturn(currentWikiId); |
295 |
1 |
WikiReference currentWikiReference = new WikiReference(currentWikiId); |
296 |
|
|
297 |
1 |
DocumentReference currentWikiTemplateReference = new DocumentReference(currentWikiId, "Some", "Template"); |
298 |
1 |
when(mockExplicitDocumentReferenceResolver.resolve(templateStringReference, currentWikiReference)).thenReturn( |
299 |
|
currentWikiTemplateReference); |
300 |
|
|
301 |
1 |
when(mockWiki.exists(currentWikiTemplateReference, mockContext)).thenReturn(true); |
302 |
|
|
303 |
1 |
testTemplateReference = currentWikiTemplateReference; |
304 |
|
|
305 |
|
|
306 |
1 |
WatchListMessageData result = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
307 |
|
|
308 |
|
|
309 |
1 |
assertResult(result); |
310 |
|
} |
311 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (18) |
Complexity: 1 |
Complexity Density: 0.06 |
1PASS
|
|
312 |
1 |
@Test... |
313 |
|
public void relativeTemplateDefaultTemplateContextWiki() throws Exception |
314 |
|
{ |
315 |
|
|
316 |
1 |
setUpUserObject(); |
317 |
|
|
318 |
|
|
319 |
1 |
String templateStringReference = "Some.Template"; |
320 |
1 |
parameters.put(WatchListEventMimeMessageFactory.TEMPLATE_PARAMETER, templateStringReference); |
321 |
|
|
322 |
1 |
DocumentReference userWikiTemplateReference = new DocumentReference("wiki", "Some", "Template"); |
323 |
1 |
when( |
324 |
|
mockExplicitDocumentReferenceResolver.resolve(templateStringReference, |
325 |
|
testSubscriberReference.getWikiReference())).thenReturn(userWikiTemplateReference); |
326 |
|
|
327 |
1 |
when(mockWiki.exists(userWikiTemplateReference, mockContext)).thenReturn(false); |
328 |
|
|
329 |
1 |
String currentWikiId = "xwiki"; |
330 |
1 |
when(mockContext.getWikiId()).thenReturn(currentWikiId); |
331 |
1 |
WikiReference currentWikiReference = new WikiReference(currentWikiId); |
332 |
|
|
333 |
1 |
DocumentReference currentWikiTemplateReference = new DocumentReference(currentWikiId, "Some", "Template"); |
334 |
1 |
when(mockExplicitDocumentReferenceResolver.resolve(templateStringReference, currentWikiReference)).thenReturn( |
335 |
|
currentWikiTemplateReference); |
336 |
|
|
337 |
1 |
when(mockWiki.exists(currentWikiTemplateReference, mockContext)).thenReturn(false); |
338 |
|
|
339 |
1 |
DocumentReference defaultCurrentWikiTemplateReference = |
340 |
|
new DocumentReference(currentWikiId, "Some", "Template"); |
341 |
1 |
when(mockExplicitDocumentReferenceResolver.resolve(WatchListJob.DEFAULT_EMAIL_TEMPLATE, currentWikiReference)) |
342 |
|
.thenReturn(defaultCurrentWikiTemplateReference); |
343 |
|
|
344 |
1 |
when(mockWiki.exists(defaultCurrentWikiTemplateReference, mockContext)).thenReturn(true); |
345 |
|
|
346 |
1 |
testTemplateReference = defaultCurrentWikiTemplateReference; |
347 |
|
|
348 |
|
|
349 |
1 |
WatchListMessageData result = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
350 |
|
|
351 |
|
|
352 |
1 |
assertResult(result); |
353 |
|
} |
354 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (23) |
Complexity: 1 |
Complexity Density: 0.04 |
1PASS
|
|
355 |
1 |
@Test... |
356 |
|
public void relativeTemplateDefaultTemplateMainWiki() throws Exception |
357 |
|
{ |
358 |
|
|
359 |
1 |
setUpUserObject(); |
360 |
|
|
361 |
|
|
362 |
1 |
String templateStringReference = "Some.Template"; |
363 |
1 |
parameters.put(WatchListEventMimeMessageFactory.TEMPLATE_PARAMETER, templateStringReference); |
364 |
|
|
365 |
1 |
DocumentReference userWikiTemplateReference = |
366 |
|
new DocumentReference(testSubscriberReference.getWikiReference().getName(), "Some", "Template"); |
367 |
1 |
when( |
368 |
|
mockExplicitDocumentReferenceResolver.resolve(templateStringReference, |
369 |
|
testSubscriberReference.getWikiReference())).thenReturn(userWikiTemplateReference); |
370 |
|
|
371 |
1 |
when(mockWiki.exists(userWikiTemplateReference, mockContext)).thenReturn(false); |
372 |
|
|
373 |
1 |
String currentWikiId = "someWiki"; |
374 |
1 |
when(mockContext.getWikiId()).thenReturn(currentWikiId); |
375 |
1 |
WikiReference currentWikiReference = new WikiReference(currentWikiId); |
376 |
|
|
377 |
1 |
DocumentReference currentWikiTemplateReference = new DocumentReference(currentWikiId, "Some", "Template"); |
378 |
1 |
when(mockExplicitDocumentReferenceResolver.resolve(templateStringReference, currentWikiReference)).thenReturn( |
379 |
|
currentWikiTemplateReference); |
380 |
|
|
381 |
1 |
when(mockWiki.exists(currentWikiTemplateReference, mockContext)).thenReturn(false); |
382 |
|
|
383 |
1 |
DocumentReference defaultCurrentWikiTemplateReference = |
384 |
|
new DocumentReference(currentWikiId, "XWiki", "WatchListMessage"); |
385 |
1 |
when(mockExplicitDocumentReferenceResolver.resolve(WatchListJob.DEFAULT_EMAIL_TEMPLATE, currentWikiReference)) |
386 |
|
.thenReturn(defaultCurrentWikiTemplateReference); |
387 |
|
|
388 |
1 |
when(mockWiki.exists(defaultCurrentWikiTemplateReference, mockContext)).thenReturn(false); |
389 |
|
|
390 |
1 |
String mainWikiId = "xwiki"; |
391 |
1 |
when(mockContext.getMainXWiki()).thenReturn(mainWikiId); |
392 |
1 |
WikiReference mainWikiReference = new WikiReference(mainWikiId); |
393 |
|
|
394 |
1 |
DocumentReference defaultMainWikiTemplateReference = |
395 |
|
new DocumentReference(mainWikiId, "XWiki", "WatchListMessage"); |
396 |
1 |
when(mockExplicitDocumentReferenceResolver.resolve(WatchListJob.DEFAULT_EMAIL_TEMPLATE, mainWikiReference)) |
397 |
|
.thenReturn(defaultMainWikiTemplateReference); |
398 |
|
|
399 |
1 |
testTemplateReference = defaultMainWikiTemplateReference; |
400 |
|
|
401 |
|
|
402 |
1 |
WatchListMessageData result = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
403 |
|
|
404 |
|
|
405 |
1 |
assertResult(result); |
406 |
|
} |
407 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (6) |
Complexity: 1 |
Complexity Density: 0.17 |
1PASS
|
|
408 |
1 |
@Test... |
409 |
|
public void skipContextUser() throws Exception |
410 |
|
{ |
411 |
|
|
412 |
1 |
parameters.put(WatchListEventMimeMessageFactory.SKIP_CONTEXT_USER_PARAMETER, true); |
413 |
|
|
414 |
|
|
415 |
1 |
EventsAndSubscribersSource source = new EventsAndSubscribersSource(events, subscribers); |
416 |
1 |
extractor = |
417 |
|
new WatchListMessageDataExtractor(source, parameters, mockEventMatcher, mockExecution, |
418 |
|
mockExplicitDocumentReferenceResolver); |
419 |
|
|
420 |
|
|
421 |
1 |
when(mockContext.getUserReference()).thenReturn(testSubscriberReference); |
422 |
|
|
423 |
|
|
424 |
1 |
WatchListMessageData result = extractor.extract(testSubscriberReference, mockDocument, mockUserObject); |
425 |
|
|
426 |
|
|
427 |
1 |
assertNull(result); |
428 |
|
} |
429 |
|
|
430 |
|
|
431 |
|
|
432 |
|
|
433 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (3) |
Complexity: 1 |
Complexity Density: 0.33 |
|
434 |
8 |
private void setUpUserObject()... |
435 |
|
{ |
436 |
8 |
when(mockUserObject.getStringValue("first_name")).thenReturn(testFirstName); |
437 |
8 |
when(mockUserObject.getStringValue("last_name")).thenReturn(testLastName); |
438 |
8 |
when(mockUserObject.getStringValue("email")).thenReturn(testEmail); |
439 |
|
} |
440 |
|
|
|
|
| 100% |
Uncovered Elements: 0 (7) |
Complexity: 1 |
Complexity Density: 0.14 |
|
441 |
6 |
private void assertResult(WatchListMessageData result) throws Exception... |
442 |
|
{ |
443 |
6 |
assertEquals(testSubscriberReference, result.getUserReference()); |
444 |
|
|
445 |
6 |
Address address = InternetAddress.parse(testEmail)[0]; |
446 |
6 |
assertEquals(address, result.getAddress()); |
447 |
6 |
assertEquals(testFirstName, result.getFirstName()); |
448 |
6 |
assertEquals(testLastName, result.getLastName()); |
449 |
6 |
assertEquals(testMatchingEvents, result.getEvents()); |
450 |
6 |
assertEquals(testTemplateReference, result.getTemplateReference()); |
451 |
|
} |
452 |
|
} |