3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * Class CRM_Core_CommunityMessagesTest
32 class CRM_Core_CommunityMessagesTest
extends CiviUnitTestCase
{
35 * The max difference between two times such that they should be
36 * treated as equals (expressed in seconds).
38 const APPROX_TIME_EQUALITY
= 2;
41 * @var CRM_Utils_Cache_Interface
46 * @var array list of possible web responses
48 protected static $webResponses = NULL;
53 public static function initWebResponses() {
54 if (self
::$webResponses === NULL) {
55 self
::$webResponses = array(
56 'http-error' => array(
57 CRM_Utils_HttpClient
::STATUS_DL_ERROR
,
61 CRM_Utils_HttpClient
::STATUS_OK
,
62 '<html>this is not json!</html>',
64 'invalid-ttl-document' => array(
65 CRM_Utils_HttpClient
::STATUS_OK
,
67 'ttl' => 'z', // not an integer!
68 'retry' => 'z', // not an integer!
71 'markup' => '<h1>Invalid document</h1>',
76 'first-valid-response' => array(
77 CRM_Utils_HttpClient
::STATUS_OK
,
83 'markup' => '<h1>First valid response</h1>',
88 'second-valid-response' => array(
89 CRM_Utils_HttpClient
::STATUS_OK
,
95 'markup' => '<h1>Second valid response</h1>',
100 'two-messages' => array(
101 CRM_Utils_HttpClient
::STATUS_OK
,
107 'markup' => '<h1>One</h1>',
108 'components' => array('CiviMail'),
111 'markup' => '<h1>Two</h1>',
112 'components' => array('CiviMail'),
117 'two-messages-halfbadcomp' => array(
118 CRM_Utils_HttpClient
::STATUS_OK
,
124 'markup' => '<h1>One</h1>',
125 'components' => array('NotARealComponent'),
128 'markup' => '<h1>Two</h1>',
129 'components' => array('CiviMail'),
136 return self
::$webResponses;
139 public function setUp() {
141 $this->cache
= new CRM_Utils_Cache_Arraycache(array());
142 self
::initWebResponses();
145 public function tearDown() {
147 CRM_Utils_Time
::resetTime();
151 * A list of bad web-responses; in general, whenever the downloader
152 * encounters one of these bad responses, it should ignore the
153 * document, retain the old data, and retry again later.
157 public function badWebResponses() {
158 self
::initWebResponses();
160 array(self
::$webResponses['http-error']),
161 array(self
::$webResponses['bad-json']),
162 array(self
::$webResponses['invalid-ttl-document']),
167 public function testIsEnabled() {
168 $communityMessages = new CRM_Core_CommunityMessages(
170 $this->expectNoHttpRequest()
172 $this->assertTrue($communityMessages->isEnabled());
175 public function testIsEnabled_false() {
176 $communityMessages = new CRM_Core_CommunityMessages(
178 $this->expectNoHttpRequest(),
181 $this->assertFalse($communityMessages->isEnabled());
185 * Download a document; after the set expiration period, download again.
187 public function testGetDocument_NewOK_CacheOK_UpdateOK() {
188 // first try, good response
189 CRM_Utils_Time
::setTime('2013-03-01 10:00:00');
190 $communityMessages = new CRM_Core_CommunityMessages(
192 $this->expectOneHttpRequest(self
::$webResponses['first-valid-response'])
194 $doc1 = $communityMessages->getDocument();
195 $this->assertEquals('<h1>First valid response</h1>', $doc1['messages'][0]['markup']);
196 $this->assertApproxEquals(strtotime('2013-03-01 10:10:00'), $doc1['expires'], self
::APPROX_TIME_EQUALITY
);
198 // second try, $doc1 hasn't expired yet, so still use it
199 CRM_Utils_Time
::setTime('2013-03-01 10:09:00');
200 $communityMessages = new CRM_Core_CommunityMessages(
202 $this->expectNoHttpRequest()
204 $doc2 = $communityMessages->getDocument();
205 $this->assertEquals('<h1>First valid response</h1>', $doc2['messages'][0]['markup']);
206 $this->assertApproxEquals(strtotime('2013-03-01 10:10:00'), $doc2['expires'], self
::APPROX_TIME_EQUALITY
);
208 // third try, $doc1 expired, update it
209 CRM_Utils_Time
::setTime('2013-03-01 12:00:02'); // more than 2 hours later (DEFAULT_RETRY)
210 $communityMessages = new CRM_Core_CommunityMessages(
212 $this->expectOneHttpRequest(self
::$webResponses['second-valid-response'])
214 $doc3 = $communityMessages->getDocument();
215 $this->assertEquals('<h1>Second valid response</h1>', $doc3['messages'][0]['markup']);
216 $this->assertApproxEquals(strtotime('2013-03-01 12:10:02'), $doc3['expires'], self
::APPROX_TIME_EQUALITY
);
220 * First download attempt fails (due to some bad web request).
221 * Store the NACK and retry after the default time period (DEFAULT_RETRY).
223 * @dataProvider badWebResponses
224 * @param array $badWebResponse
225 * Description of a web request that returns some kind of failure.
227 public function testGetDocument_NewFailure_CacheOK_UpdateOK($badWebResponse) {
228 $this->assertNotEmpty($badWebResponse);
230 // first try, bad response
231 CRM_Utils_Time
::setTime('2013-03-01 10:00:00');
232 $communityMessages = new CRM_Core_CommunityMessages(
234 $this->expectOneHttpRequest($badWebResponse)
236 $doc1 = $communityMessages->getDocument();
237 $this->assertEquals(array(), $doc1['messages']);
238 $this->assertTrue($doc1['expires'] > CRM_Utils_Time
::getTimeRaw());
240 // second try, $doc1 hasn't expired yet, so still use it
241 CRM_Utils_Time
::setTime('2013-03-01 10:09:00');
242 $communityMessages = new CRM_Core_CommunityMessages(
244 $this->expectNoHttpRequest()
246 $doc2 = $communityMessages->getDocument();
247 $this->assertEquals(array(), $doc2['messages']);
248 $this->assertEquals($doc1['expires'], $doc2['expires']);
250 // third try, $doc1 expired, try again, get a good response
251 CRM_Utils_Time
::setTime('2013-03-01 12:00:02'); // more than 2 hours later (DEFAULT_RETRY)
252 $communityMessages = new CRM_Core_CommunityMessages(
254 $this->expectOneHttpRequest(self
::$webResponses['first-valid-response'])
256 $doc3 = $communityMessages->getDocument();
257 $this->assertEquals('<h1>First valid response</h1>', $doc3['messages'][0]['markup']);
258 $this->assertTrue($doc3['expires'] > CRM_Utils_Time
::getTimeRaw());
262 * First download of new doc is OK.
263 * The update fails (due to some bad web response).
264 * The old data is retained in the cache.
265 * The failure eventually expires.
266 * A new update succeeds.
268 * @dataProvider badWebResponses
269 * @param array $badWebResponse
270 * Description of a web request that returns some kind of failure.
272 public function testGetDocument_NewOK_UpdateFailure_CacheOK_UpdateOK($badWebResponse) {
273 $this->assertNotEmpty($badWebResponse);
275 // first try, good response
276 CRM_Utils_Time
::setTime('2013-03-01 10:00:00');
277 $communityMessages = new CRM_Core_CommunityMessages(
279 $this->expectOneHttpRequest(self
::$webResponses['first-valid-response'])
281 $doc1 = $communityMessages->getDocument();
282 $this->assertEquals('<h1>First valid response</h1>', $doc1['messages'][0]['markup']);
283 $this->assertApproxEquals(strtotime('2013-03-01 10:10:00'), $doc1['expires'], self
::APPROX_TIME_EQUALITY
);
285 // second try, $doc1 has expired; bad response; keep old data
286 CRM_Utils_Time
::setTime('2013-03-01 12:00:02'); // more than 2 hours later (DEFAULT_RETRY)
287 $communityMessages = new CRM_Core_CommunityMessages(
289 $this->expectOneHttpRequest($badWebResponse)
291 $doc2 = $communityMessages->getDocument();
292 $this->assertEquals('<h1>First valid response</h1>', $doc2['messages'][0]['markup']);
293 $this->assertTrue($doc2['expires'] > CRM_Utils_Time
::getTimeRaw());
295 // third try, $doc2 hasn't expired yet; no request; keep old data
296 CRM_Utils_Time
::setTime('2013-03-01 12:09:00');
297 $communityMessages = new CRM_Core_CommunityMessages(
299 $this->expectNoHttpRequest()
301 $doc3 = $communityMessages->getDocument();
302 $this->assertEquals('<h1>First valid response</h1>', $doc3['messages'][0]['markup']);
303 $this->assertEquals($doc2['expires'], $doc3['expires']);
305 // fourth try, $doc2 has expired yet; new request; replace data
306 CRM_Utils_Time
::setTime('2013-03-01 12:10:02');
307 $communityMessages = new CRM_Core_CommunityMessages(
309 $this->expectOneHttpRequest(self
::$webResponses['second-valid-response'])
311 $doc4 = $communityMessages->getDocument();
312 $this->assertEquals('<h1>Second valid response</h1>', $doc4['messages'][0]['markup']);
313 $this->assertApproxEquals(strtotime('2013-03-01 12:20:02'), $doc4['expires'], self
::APPROX_TIME_EQUALITY
);
317 * Randomly pick among two options.
319 public function testPick_rand() {
320 $communityMessages = new CRM_Core_CommunityMessages(
322 $this->expectOneHttpRequest(self
::$webResponses['two-messages'])
324 $doc1 = $communityMessages->getDocument();
325 $this->assertEquals('<h1>One</h1>', $doc1['messages'][0]['markup']);
326 $this->assertEquals('<h1>Two</h1>', $doc1['messages'][1]['markup']);
328 // randomly pick many times
330 $freq = array(); // array($message => $count)
331 for ($i = 0; $i < $trials; $i++
) {
332 $message = $communityMessages->pick();
333 $freq[$message['markup']] = CRM_Utils_Array
::value($message['markup'], $freq, 0) +
1;
336 // assert the probabilities
337 $this->assertApproxEquals(0.5, $freq['<h1>One</h1>'] / $trials, 0.3);
338 $this->assertApproxEquals(0.5, $freq['<h1>Two</h1>'] / $trials, 0.3);
339 $this->assertEquals($trials, $freq['<h1>One</h1>'] +
$freq['<h1>Two</h1>']);
343 * When presented with two options using component filters, always
344 * choose the one which references an active component.
346 public function testPick_componentFilter() {
347 $communityMessages = new CRM_Core_CommunityMessages(
349 $this->expectOneHttpRequest(self
::$webResponses['two-messages-halfbadcomp'])
351 $doc1 = $communityMessages->getDocument();
352 $this->assertEquals('<h1>One</h1>', $doc1['messages'][0]['markup']);
353 $this->assertEquals('<h1>Two</h1>', $doc1['messages'][1]['markup']);
355 // randomly pick many times
357 $freq = array(); // array($message => $count)
358 for ($i = 0; $i < $trials; $i++
) {
359 $message = $communityMessages->pick();
360 $freq[$message['markup']] = CRM_Utils_Array
::value($message['markup'], $freq, 0) +
1;
363 $this->assertEquals($trials, $freq['<h1>Two</h1>']);
366 public function testEvalMarkup() {
367 $communityMessages = new CRM_Core_CommunityMessages(
369 $this->expectNoHttpRequest()
371 $this->assertEquals('cms=UnitTests cms=UnitTests', $communityMessages->evalMarkup('cms=%%uf%% cms={{uf}}'));
375 * Generate a mock HTTP client with the expectation that it is never called.
377 * @return CRM_Utils_HttpClient|PHPUnit_Framework_MockObject_MockObject
379 protected function expectNoHttpRequest() {
380 $mockFunction = $this->mockMethod
;
381 $client = $this->$mockFunction('CRM_Utils_HttpClient');
382 $client->expects($this->never())
388 * Generate a mock HTTP client with the expectation that it is called once.
392 * @return CRM_Utils_HttpClient|PHPUnit_Framework_MockObject_MockObject
394 protected function expectOneHttpRequest($response) {
395 $mockFunction = $this->mockMethod
;
396 $client = $this->$mockFunction('CRM_Utils_HttpClient');
397 $client->expects($this->once())
399 ->will($this->returnValue($response));