Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
8891a36e | 2 | /* |
6a488035 TO |
3 | * File for the TestMailing class |
4 | * | |
5 | * (PHP 5) | |
6 | * | |
7 | * @package CiviCRM | |
8 | * | |
9 | * This file is part of CiviCRM | |
10 | * | |
11 | * CiviCRM is free software; you can redistribute it and/or | |
12 | * modify it under the terms of the GNU Affero General Public License | |
13 | * as published by the Free Software Foundation; either version 3 of | |
14 | * the License, or (at your option) any later version. | |
15 | * | |
16 | * CiviCRM is distributed in the hope that it will be useful, | |
17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | * GNU Affero General Public License for more details. | |
20 | * | |
21 | * You should have received a copy of the GNU Affero General Public | |
22 | * License along with this program. If not, see | |
23 | * <http://www.gnu.org/licenses/>. | |
24 | */ | |
25 | ||
6a488035 TO |
26 | |
27 | /** | |
28 | * Test APIv3 civicrm_mailing_* functions | |
29 | * | |
6c6e6187 | 30 | * @package CiviCRM |
acb109b7 | 31 | * @group headless |
6a488035 TO |
32 | */ |
33 | class api_v3_MailingTest extends CiviUnitTestCase { | |
34 | protected $_groupID; | |
35 | protected $_email; | |
c43d01f3 | 36 | protected $_apiversion = 3; |
37 | protected $_params = array(); | |
e37b4b04 | 38 | protected $_entity = 'Mailing'; |
161ae41b | 39 | protected $_contactID; |
430ae6dd | 40 | |
d8e9212d TO |
41 | /** |
42 | * APIv3 result from creating an example footer | |
43 | * @var array | |
44 | */ | |
45 | protected $footer; | |
46 | ||
00be9182 | 47 | public function setUp() { |
6a488035 | 48 | parent::setUp(); |
7ada2376 | 49 | $this->useTransaction(); |
97b7d4a0 | 50 | CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW |
161ae41b | 51 | $this->_contactID = $this->individualCreate(); |
fadb804f | 52 | $this->_groupID = $this->groupCreate(); |
ef170fe0 | 53 | $this->_email = 'test@test.test'; |
c43d01f3 | 54 | $this->_params = array( |
51ae62c4 | 55 | 'subject' => 'Hello {contact.display_name}', |
b4fb9733 ML |
56 | 'body_text' => "This is {contact.display_name}.\nhttps://civicrm.org\n{domain.address}{action.optOutUrl}", |
57 | 'body_html' => "<p>This is {contact.display_name}.</p><p><a href='https://civicrm.org/'>CiviCRM.org</a></p><p>{domain.address}{action.optOutUrl}</p>", | |
c43d01f3 | 58 | 'name' => 'mailing name', |
161ae41b | 59 | 'created_id' => $this->_contactID, |
b0a31714 TO |
60 | 'header_id' => '', |
61 | 'footer_id' => '', | |
c43d01f3 | 62 | ); |
d8e9212d TO |
63 | |
64 | $this->footer = civicrm_api3('MailingComponent', 'create', array( | |
7824ac72 SL |
65 | 'name' => 'test domain footer', |
66 | 'component_type' => 'footer', | |
d8e9212d TO |
67 | 'body_html' => '<p>From {domain.address}. To opt out, go to {action.optOutUrl}.</p>', |
68 | 'body_text' => 'From {domain.address}. To opt out, go to {action.optOutUrl}.', | |
69 | )); | |
6a488035 TO |
70 | } |
71 | ||
00be9182 | 72 | public function tearDown() { |
97b7d4a0 TO |
73 | CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW |
74 | parent::tearDown(); | |
6a488035 TO |
75 | } |
76 | ||
77 | /** | |
fe482240 | 78 | * Test civicrm_mailing_create. |
6a488035 TO |
79 | */ |
80 | public function testMailerCreateSuccess() { | |
5f445749 | 81 | $result = $this->callAPIAndDocument('mailing', 'create', $this->_params + array('scheduled_date' => 'now'), __FUNCTION__, __FILE__); |
c43d01f3 | 82 | $jobs = $this->callAPISuccess('mailing_job', 'get', array('mailing_id' => $result['id'])); |
6a488035 | 83 | $this->assertEquals(1, $jobs['count']); |
ef170fe0 | 84 | unset($this->_params['created_id']); // return isn't working on this in getAndCheck so lets not check it for now |
e37b4b04 | 85 | $this->getAndCheck($this->_params, $result['id'], 'mailing'); |
6a488035 TO |
86 | } |
87 | ||
4ea375b4 | 88 | /** |
89 | * Tes that the parameter _skip_evil_bao_auto_schedule_ is respected & prevents jobs being created. | |
90 | */ | |
91 | public function testSkipAutoSchedule() { | |
92 | $this->callAPISuccess('Mailing', 'create', array_merge($this->_params, [ | |
93 | '_skip_evil_bao_auto_schedule_' => TRUE, | |
94 | 'scheduled_date' => 'now' | |
95 | ])); | |
96 | $this->callAPISuccessGetCount('Mailing', [], 1); | |
97 | $this->callAPISuccessGetCount('MailingJob', [], 0); | |
98 | } | |
99 | ||
11bb7484 | 100 | /** |
101 | * Create a completed mailing (e.g when importing from a provider). | |
102 | */ | |
103 | public function testMailerCreateCompleted() { | |
104 | $this->_params['body_html'] = 'I am completed so it does not matter if there is an opt out link since I have already been sent by another system'; | |
105 | $this->_params['is_completed'] = 1; | |
106 | $result = $this->callAPIAndDocument('mailing', 'create', $this->_params + array('scheduled_date' => 'now'), __FUNCTION__, __FILE__); | |
107 | $jobs = $this->callAPISuccess('mailing_job', 'get', array('mailing_id' => $result['id'])); | |
108 | $this->assertEquals(1, $jobs['count']); | |
109 | $this->assertEquals('Complete', $jobs['values'][$jobs['id']]['status']); | |
110 | unset($this->_params['created_id']); // return isn't working on this in getAndCheck so lets not check it for now | |
111 | $this->getAndCheck($this->_params, $result['id'], 'mailing'); | |
112 | } | |
113 | ||
c442f1b6 | 114 | /** |
115 | * Per CRM-20316 the mailing should still create without created_id (not mandatory). | |
116 | */ | |
117 | public function testMailerCreateSuccessNoCreatedID() { | |
118 | unset($this->_params['created_id']); | |
119 | $result = $this->callAPIAndDocument('mailing', 'create', $this->_params + array('scheduled_date' => 'now'), __FUNCTION__, __FILE__); | |
120 | $this->getAndCheck($this->_params, $result['id'], 'mailing'); | |
121 | } | |
122 | ||
703875d8 TO |
123 | /** |
124 | * | |
125 | */ | |
126 | public function testTemplateTypeOptions() { | |
127 | $types = $this->callAPISuccess('Mailing', 'getoptions', array('field' => 'template_type')); | |
128 | $this->assertTrue(isset($types['values']['traditional'])); | |
129 | } | |
130 | ||
6bc3944a TO |
131 | /** |
132 | * The `template_options` field should be treated a JSON object. | |
133 | * | |
134 | * This test will create, read, and update the field. | |
135 | */ | |
136 | public function testMailerCreateTemplateOptions() { | |
137 | // 1. Create mailing with template_options. | |
138 | $params = $this->_params; | |
139 | $params['template_options'] = json_encode(array('foo' => 'bar_1')); | |
140 | $createResult = $this->callAPISuccess('mailing', 'create', $params); | |
141 | $id = $createResult['id']; | |
142 | $this->assertDBQuery('{"foo":"bar_1"}', 'SELECT template_options FROM civicrm_mailing WHERE id = %1', array( | |
143 | 1 => array($id, 'Int'), | |
144 | )); | |
145 | $this->assertEquals('bar_1', $createResult['values'][$id]['template_options']['foo']); | |
146 | ||
147 | // 2. Get mailing with template_options. | |
148 | $getResult = $this->callAPISuccess('mailing', 'get', array( | |
149 | 'id' => $id, | |
150 | )); | |
151 | $this->assertEquals('bar_1', $getResult['values'][$id]['template_options']['foo']); | |
152 | $getValueResult = $this->callAPISuccess('mailing', 'getvalue', array( | |
153 | 'id' => $id, | |
154 | 'return' => 'template_options', | |
155 | )); | |
156 | $this->assertEquals('bar_1', $getValueResult['foo']); | |
157 | ||
158 | // 3. Update mailing with template_options. | |
159 | $updateResult = $this->callAPISuccess('mailing', 'create', array( | |
160 | 'id' => $id, | |
161 | 'template_options' => array('foo' => 'bar_2'), | |
162 | )); | |
163 | $this->assertDBQuery('{"foo":"bar_2"}', 'SELECT template_options FROM civicrm_mailing WHERE id = %1', array( | |
164 | 1 => array($id, 'Int'), | |
165 | )); | |
166 | $this->assertEquals('bar_2', $updateResult['values'][$id]['template_options']['foo']); | |
167 | } | |
168 | ||
21eb0c57 TO |
169 | /** |
170 | * The Mailing.create API supports magic properties "groups[include,enclude]" and "mailings[include,exclude]". | |
171 | * Make sure these work | |
172 | */ | |
173 | public function testMagicGroups_create_update() { | |
174 | // BEGIN SAMPLE DATA | |
175 | $groupIDs['a'] = $this->groupCreate(array('name' => 'Example include group', 'title' => 'Example include group')); | |
176 | $groupIDs['b'] = $this->groupCreate(array('name' => 'Example exclude group', 'title' => 'Example exclude group')); | |
92915c55 TO |
177 | $contactIDs['a'] = $this->individualCreate(array( |
178 | 'email' => 'include.me@example.org', | |
179 | 'first_name' => 'Includer', | |
5396af74 | 180 | 'last_name' => 'Person', |
92915c55 TO |
181 | )); |
182 | $contactIDs['b'] = $this->individualCreate(array( | |
183 | 'email' => 'exclude.me@example.org', | |
5396af74 | 184 | 'last_name' => 'Excluder', |
92915c55 TO |
185 | )); |
186 | $this->callAPISuccess('GroupContact', 'create', array( | |
187 | 'group_id' => $groupIDs['a'], | |
5396af74 | 188 | 'contact_id' => $contactIDs['a'], |
92915c55 TO |
189 | )); |
190 | $this->callAPISuccess('GroupContact', 'create', array( | |
191 | 'group_id' => $groupIDs['b'], | |
5396af74 | 192 | 'contact_id' => $contactIDs['b'], |
92915c55 | 193 | )); |
21eb0c57 TO |
194 | // END SAMPLE DATA |
195 | ||
196 | // ** Pass 1: Create | |
197 | $createParams = $this->_params; | |
198 | $createParams['groups']['include'] = array($groupIDs['a']); | |
199 | $createParams['groups']['exclude'] = array(); | |
200 | $createParams['mailings']['include'] = array(); | |
201 | $createParams['mailings']['exclude'] = array(); | |
5f445749 | 202 | $createParams['api.mailing_job.create'] = 1; |
21eb0c57 TO |
203 | $createResult = $this->callAPISuccess('Mailing', 'create', $createParams); |
204 | $getGroup1 = $this->callAPISuccess('MailingGroup', 'get', array('mailing_id' => $createResult['id'])); | |
205 | $getGroup1_ids = array_values(CRM_Utils_Array::collect('entity_id', $getGroup1['values'])); | |
206 | $this->assertEquals(array($groupIDs['a']), $getGroup1_ids); | |
39010e60 EM |
207 | $getRecipient1 = $this->callAPISuccess('MailingRecipients', 'get', array('mailing_id' => $createResult['id'])); |
208 | $getRecipient1_ids = array_values(CRM_Utils_Array::collect('contact_id', $getRecipient1['values'])); | |
209 | $this->assertEquals(array($contactIDs['a']), $getRecipient1_ids); | |
21eb0c57 TO |
210 | |
211 | // ** Pass 2: Update without any changes to groups[include] | |
39010e60 EM |
212 | $nullOpParams = $createParams; |
213 | $nullOpParams['id'] = $createResult['id']; | |
7575b840 | 214 | $updateParams['api.mailing_job.create'] = 1; |
39010e60 EM |
215 | unset($nullOpParams['groups']['include']); |
216 | $this->callAPISuccess('Mailing', 'create', $nullOpParams); | |
21eb0c57 TO |
217 | $getGroup2 = $this->callAPISuccess('MailingGroup', 'get', array('mailing_id' => $createResult['id'])); |
218 | $getGroup2_ids = array_values(CRM_Utils_Array::collect('entity_id', $getGroup2['values'])); | |
219 | $this->assertEquals(array($groupIDs['a']), $getGroup2_ids); | |
39010e60 EM |
220 | $getRecipient2 = $this->callAPISuccess('MailingRecipients', 'get', array('mailing_id' => $createResult['id'])); |
221 | $getRecip2_ids = array_values(CRM_Utils_Array::collect('contact_id', $getRecipient2['values'])); | |
7575b840 | 222 | $this->assertEquals(array($contactIDs['a']), $getRecip2_ids); |
21eb0c57 TO |
223 | |
224 | // ** Pass 3: Update with different groups[include] | |
225 | $updateParams = $createParams; | |
226 | $updateParams['id'] = $createResult['id']; | |
227 | $updateParams['groups']['include'] = array($groupIDs['b']); | |
7575b840 | 228 | $updateParams['api.mailing_job.create'] = 1; |
21eb0c57 TO |
229 | $this->callAPISuccess('Mailing', 'create', $updateParams); |
230 | $getGroup3 = $this->callAPISuccess('MailingGroup', 'get', array('mailing_id' => $createResult['id'])); | |
231 | $getGroup3_ids = array_values(CRM_Utils_Array::collect('entity_id', $getGroup3['values'])); | |
232 | $this->assertEquals(array($groupIDs['b']), $getGroup3_ids); | |
39010e60 EM |
233 | $getRecipient3 = $this->callAPISuccess('MailingRecipients', 'get', array('mailing_id' => $createResult['id'])); |
234 | $getRecipient3_ids = array_values(CRM_Utils_Array::collect('contact_id', $getRecipient3['values'])); | |
235 | $this->assertEquals(array($contactIDs['b']), $getRecipient3_ids); | |
21eb0c57 TO |
236 | } |
237 | ||
ef643544 | 238 | public function testMailerPreview() { |
51ae62c4 | 239 | // BEGIN SAMPLE DATA |
6c6e6187 | 240 | $contactID = $this->individualCreate(); |
ef643544 | 241 | $displayName = $this->callAPISuccess('contact', 'get', array('id' => $contactID)); |
242 | $displayName = $displayName['values'][$contactID]['display_name']; | |
51ae62c4 TO |
243 | $this->assertTrue(!empty($displayName)); |
244 | ||
245 | $params = $this->_params; | |
246 | $params['api.Mailing.preview'] = array( | |
247 | 'id' => '$value.id', | |
248 | 'contact_id' => $contactID, | |
249 | ); | |
250 | $params['options']['force_rollback'] = 1; | |
251 | // END SAMPLE DATA | |
7811a84b | 252 | |
6c6e6187 | 253 | $maxIDs = array( |
51ae62c4 TO |
254 | 'mailing' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing'), |
255 | 'job' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_job'), | |
256 | 'group' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_group'), | |
39010e60 | 257 | 'recipient' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_recipients'), |
51ae62c4 TO |
258 | ); |
259 | $result = $this->callAPISuccess('mailing', 'create', $params); | |
260 | $this->assertDBQuery($maxIDs['mailing'], 'SELECT MAX(id) FROM civicrm_mailing'); // 'Preview should not create any mailing records' | |
261 | $this->assertDBQuery($maxIDs['job'], 'SELECT MAX(id) FROM civicrm_mailing_job'); // 'Preview should not create any mailing_job record' | |
262 | $this->assertDBQuery($maxIDs['group'], 'SELECT MAX(id) FROM civicrm_mailing_group'); // 'Preview should not create any mailing_group records' | |
39010e60 | 263 | $this->assertDBQuery($maxIDs['recipient'], 'SELECT MAX(id) FROM civicrm_mailing_recipients'); // 'Preview should not create any mailing_recipient records' |
7811a84b | 264 | |
51ae62c4 TO |
265 | $previewResult = $result['values'][$result['id']]['api.Mailing.preview']; |
266 | $this->assertEquals("Hello $displayName", $previewResult['values']['subject']); | |
21b09c13 TO |
267 | $this->assertContains("This is $displayName", $previewResult['values']['body_text']); |
268 | $this->assertContains("<p>This is $displayName.</p>", $previewResult['values']['body_html']); | |
ef643544 | 269 | } |
7811a84b | 270 | |
fddd185d TO |
271 | public function testMailerPreviewRecipients() { |
272 | // BEGIN SAMPLE DATA | |
161ae41b TO |
273 | $groupIDs['inc'] = $this->groupCreate(array('name' => 'Example include group', 'title' => 'Example include group')); |
274 | $groupIDs['exc'] = $this->groupCreate(array('name' => 'Example exclude group', 'title' => 'Example exclude group')); | |
39010e60 | 275 | $contactIDs['include_me'] = $this->individualCreate(array( |
92915c55 TO |
276 | 'email' => 'include.me@example.org', |
277 | 'first_name' => 'Includer', | |
5396af74 | 278 | 'last_name' => 'Person', |
92915c55 | 279 | )); |
39010e60 | 280 | $contactIDs['exclude_me'] = $this->individualCreate(array( |
92915c55 | 281 | 'email' => 'exclude.me@example.org', |
39010e60 | 282 | 'last_name' => 'Excluder', |
92915c55 TO |
283 | )); |
284 | $this->callAPISuccess('GroupContact', 'create', array( | |
285 | 'group_id' => $groupIDs['inc'], | |
5396af74 | 286 | 'contact_id' => $contactIDs['include_me'], |
92915c55 TO |
287 | )); |
288 | $this->callAPISuccess('GroupContact', 'create', array( | |
289 | 'group_id' => $groupIDs['inc'], | |
5396af74 | 290 | 'contact_id' => $contactIDs['exclude_me'], |
92915c55 TO |
291 | )); |
292 | $this->callAPISuccess('GroupContact', 'create', array( | |
293 | 'group_id' => $groupIDs['exc'], | |
5396af74 | 294 | 'contact_id' => $contactIDs['exclude_me'], |
92915c55 | 295 | )); |
fddd185d TO |
296 | |
297 | $params = $this->_params; | |
161ae41b TO |
298 | $params['groups']['include'] = array($groupIDs['inc']); |
299 | $params['groups']['exclude'] = array($groupIDs['exc']); | |
fddd185d TO |
300 | $params['mailings']['include'] = array(); |
301 | $params['mailings']['exclude'] = array(); | |
b73e0c53 TO |
302 | $params['options']['force_rollback'] = 1; |
303 | $params['api.MailingRecipients.get'] = array( | |
304 | 'mailing_id' => '$value.id', | |
305 | 'api.contact.getvalue' => array( | |
306 | 'return' => 'display_name', | |
307 | ), | |
308 | 'api.email.getvalue' => array( | |
309 | 'return' => 'email', | |
310 | ), | |
311 | ); | |
fddd185d TO |
312 | // END SAMPLE DATA |
313 | ||
6c6e6187 | 314 | $maxIDs = array( |
fddd185d | 315 | 'mailing' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing'), |
fddd185d TO |
316 | 'group' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_group'), |
317 | ); | |
b73e0c53 | 318 | $create = $this->callAPIAndDocument('Mailing', 'create', $params, __FUNCTION__, __FILE__); |
fddd185d | 319 | $this->assertDBQuery($maxIDs['mailing'], 'SELECT MAX(id) FROM civicrm_mailing'); // 'Preview should not create any mailing records' |
fddd185d TO |
320 | $this->assertDBQuery($maxIDs['group'], 'SELECT MAX(id) FROM civicrm_mailing_group'); // 'Preview should not create any mailing_group records' |
321 | ||
b73e0c53 | 322 | $preview = $create['values'][$create['id']]['api.MailingRecipients.get']; |
fddd185d | 323 | $previewIds = array_values(CRM_Utils_Array::collect('contact_id', $preview['values'])); |
39010e60 | 324 | $this->assertEquals(array((string) $contactIDs['include_me']), $previewIds); |
b73e0c53 TO |
325 | $previewEmails = array_values(CRM_Utils_Array::collect('api.email.getvalue', $preview['values'])); |
326 | $this->assertEquals(array('include.me@example.org'), $previewEmails); | |
327 | $previewNames = array_values(CRM_Utils_Array::collect('api.contact.getvalue', $preview['values'])); | |
6c6e6187 | 328 | $this->assertTrue((bool) preg_match('/Includer Person/', $previewNames[0]), "Name 'Includer Person' should appear in '" . $previewNames[0] . '"'); |
fddd185d TO |
329 | } |
330 | ||
b20e7428 AS |
331 | public function testMailerPreviewRecipientsDeduplicate() { |
332 | // BEGIN SAMPLE DATA | |
333 | $groupIDs['grp'] = $this->groupCreate(array('name' => 'Example group', 'title' => 'Example group')); | |
334 | $contactIDs['include_me'] = $this->individualCreate(array( | |
335 | 'email' => 'include.me@example.org', | |
336 | 'first_name' => 'Includer', | |
337 | 'last_name' => 'Person', | |
338 | )); | |
339 | $contactIDs['include_me_duplicate'] = $this->individualCreate(array( | |
340 | 'email' => 'include.me@example.org', | |
341 | 'first_name' => 'IncluderDuplicate', | |
342 | 'last_name' => 'Person', | |
343 | )); | |
344 | $this->callAPISuccess('GroupContact', 'create', array( | |
345 | 'group_id' => $groupIDs['grp'], | |
346 | 'contact_id' => $contactIDs['include_me'], | |
347 | )); | |
348 | $this->callAPISuccess('GroupContact', 'create', array( | |
349 | 'group_id' => $groupIDs['grp'], | |
350 | 'contact_id' => $contactIDs['include_me_duplicate'], | |
351 | )); | |
352 | ||
353 | $params = $this->_params; | |
354 | $params['groups']['include'] = array($groupIDs['grp']); | |
355 | $params['mailings']['include'] = array(); | |
356 | $params['options']['force_rollback'] = 1; | |
357 | $params['dedupe_email'] = 1; | |
b20e7428 AS |
358 | $params['api.MailingRecipients.get'] = array( |
359 | 'mailing_id' => '$value.id', | |
360 | 'api.contact.getvalue' => array( | |
361 | 'return' => 'display_name', | |
362 | ), | |
363 | 'api.email.getvalue' => array( | |
364 | 'return' => 'email', | |
365 | ), | |
366 | ); | |
367 | // END SAMPLE DATA | |
368 | ||
3c27d467 | 369 | $create = $this->callAPISuccess('Mailing', 'create', $params); |
b20e7428 AS |
370 | |
371 | $preview = $create['values'][$create['id']]['api.MailingRecipients.get']; | |
372 | $this->assertEquals(1, $preview['count']); | |
373 | $previewEmails = array_values(CRM_Utils_Array::collect('api.email.getvalue', $preview['values'])); | |
374 | $this->assertEquals(array('include.me@example.org'), $previewEmails); | |
375 | } | |
376 | ||
39010e60 EM |
377 | /** |
378 | * | |
379 | */ | |
7ada2376 | 380 | public function testMailerSendTest_email() { |
92915c55 TO |
381 | $contactIDs['alice'] = $this->individualCreate(array( |
382 | 'email' => 'alice@example.org', | |
383 | 'first_name' => 'Alice', | |
5396af74 | 384 | 'last_name' => 'Person', |
92915c55 | 385 | )); |
7811a84b | 386 | |
ef643544 | 387 | $mail = $this->callAPISuccess('mailing', 'create', $this->_params); |
7811a84b | 388 | |
736a042c | 389 | $params = array('mailing_id' => $mail['id'], 'test_email' => 'alice@example.org', 'test_group' => NULL); |
ef643544 | 390 | $deliveredInfo = $this->callAPISuccess($this->_entity, 'send_test', $params); |
391 | $this->assertEquals(1, $deliveredInfo['count'], "in line " . __LINE__); // verify mail has been sent to user by count | |
736a042c TO |
392 | |
393 | $deliveredContacts = array_values(CRM_Utils_Array::collect('contact_id', $deliveredInfo['values'])); | |
394 | $this->assertEquals(array($contactIDs['alice']), $deliveredContacts); | |
395 | ||
396 | $deliveredEmails = array_values(CRM_Utils_Array::collect('email', $deliveredInfo['values'])); | |
397 | $this->assertEquals(array('alice@example.org'), $deliveredEmails); | |
ef643544 | 398 | } |
7811a84b | 399 | |
39010e60 EM |
400 | /** |
401 | * | |
402 | */ | |
7ada2376 TO |
403 | public function testMailerSendTest_group() { |
404 | // BEGIN SAMPLE DATA | |
161ae41b | 405 | $groupIDs['inc'] = $this->groupCreate(array('name' => 'Example include group', 'title' => 'Example include group')); |
92915c55 TO |
406 | $contactIDs['alice'] = $this->individualCreate(array( |
407 | 'email' => 'alice@example.org', | |
408 | 'first_name' => 'Alice', | |
5396af74 | 409 | 'last_name' => 'Person', |
92915c55 TO |
410 | )); |
411 | $contactIDs['bob'] = $this->individualCreate(array( | |
412 | 'email' => 'bob@example.org', | |
413 | 'first_name' => 'Bob', | |
5396af74 | 414 | 'last_name' => 'Person', |
92915c55 TO |
415 | )); |
416 | $contactIDs['carol'] = $this->individualCreate(array( | |
417 | 'email' => 'carol@example.org', | |
418 | 'first_name' => 'Carol', | |
5396af74 | 419 | 'last_name' => 'Person', |
92915c55 TO |
420 | )); |
421 | $this->callAPISuccess('GroupContact', 'create', array( | |
422 | 'group_id' => $groupIDs['inc'], | |
5396af74 | 423 | 'contact_id' => $contactIDs['alice'], |
92915c55 TO |
424 | )); |
425 | $this->callAPISuccess('GroupContact', 'create', array( | |
426 | 'group_id' => $groupIDs['inc'], | |
5396af74 | 427 | 'contact_id' => $contactIDs['bob'], |
92915c55 TO |
428 | )); |
429 | $this->callAPISuccess('GroupContact', 'create', array( | |
430 | 'group_id' => $groupIDs['inc'], | |
5396af74 | 431 | 'contact_id' => $contactIDs['carol'], |
92915c55 | 432 | )); |
7ada2376 TO |
433 | // END SAMPLE DATA |
434 | ||
435 | $mail = $this->callAPISuccess('mailing', 'create', $this->_params); | |
436 | $deliveredInfo = $this->callAPISuccess($this->_entity, 'send_test', array( | |
437 | 'mailing_id' => $mail['id'], | |
438 | 'test_email' => NULL, | |
161ae41b | 439 | 'test_group' => $groupIDs['inc'], |
7ada2376 TO |
440 | )); |
441 | $this->assertEquals(3, $deliveredInfo['count'], "in line " . __LINE__); // verify mail has been sent to user by count | |
736a042c | 442 | |
7ada2376 | 443 | $deliveredContacts = array_values(CRM_Utils_Array::collect('contact_id', $deliveredInfo['values'])); |
161ae41b | 444 | $this->assertEquals(array($contactIDs['alice'], $contactIDs['bob'], $contactIDs['carol']), $deliveredContacts); |
736a042c | 445 | |
7ada2376 TO |
446 | $deliveredEmails = array_values(CRM_Utils_Array::collect('email', $deliveredInfo['values'])); |
447 | $this->assertEquals(array('alice@example.org', 'bob@example.org', 'carol@example.org'), $deliveredEmails); | |
448 | } | |
449 | ||
ad4f6a9c EM |
450 | /** |
451 | * @return array | |
452 | */ | |
6818346a TO |
453 | public function submitProvider() { |
454 | $cases = array(); // $useLogin, $params, $expectedFailure, $expectedJobCount | |
455 | $cases[] = array( | |
456 | TRUE, //useLogin | |
d78cc635 | 457 | array(), // createParams |
6818346a TO |
458 | array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'), |
459 | FALSE, // expectedFailure | |
460 | 1, // expectedJobCount | |
461 | ); | |
462 | $cases[] = array( | |
463 | FALSE, //useLogin | |
d78cc635 | 464 | array(), // createParams |
6818346a TO |
465 | array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'), |
466 | "/Failed to determine current user/", // expectedFailure | |
467 | 0, // expectedJobCount | |
468 | ); | |
469 | $cases[] = array( | |
470 | TRUE, //useLogin | |
d78cc635 | 471 | array(), // createParams |
6818346a TO |
472 | array('scheduled_date' => '2014-12-13 10:00:00'), |
473 | FALSE, // expectedFailure | |
474 | 1, // expectedJobCount | |
475 | ); | |
476 | $cases[] = array( | |
477 | TRUE, //useLogin | |
d78cc635 | 478 | array(), // createParams |
6818346a TO |
479 | array(), |
480 | "/Missing parameter scheduled_date and.or approval_date/", // expectedFailure | |
481 | 0, // expectedJobCount | |
482 | ); | |
d78cc635 TO |
483 | $cases[] = array( |
484 | TRUE, //useLogin | |
485 | array('name' => ''), // createParams | |
486 | array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'), | |
21b09c13 | 487 | "/Mailing cannot be sent. There are missing or invalid fields \\(name\\)./", // expectedFailure |
d78cc635 TO |
488 | 0, // expectedJobCount |
489 | ); | |
21b09c13 TO |
490 | $cases[] = array( |
491 | TRUE, //useLogin | |
492 | array('body_html' => '', 'body_text' => ''), // createParams | |
493 | array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'), | |
494 | "/Mailing cannot be sent. There are missing or invalid fields \\(body\\)./", // expectedFailure | |
495 | 0, // expectedJobCount | |
496 | ); | |
497 | $cases[] = array( | |
498 | TRUE, //useLogin | |
499 | array('body_html' => 'Oops, did I leave my tokens at home?'), // createParams | |
500 | array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'), | |
501 | "/Mailing cannot be sent. There are missing or invalid fields \\(.*body_html.*optOut.*\\)./", // expectedFailure | |
502 | 0, // expectedJobCount | |
503 | ); | |
504 | $cases[] = array( | |
505 | TRUE, //useLogin | |
506 | array('body_text' => 'Oops, did I leave my tokens at home?'), // createParams | |
507 | array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'), | |
508 | "/Mailing cannot be sent. There are missing or invalid fields \\(.*body_text.*optOut.*\\)./", // expectedFailure | |
509 | 0, // expectedJobCount | |
510 | ); | |
d8e9212d TO |
511 | $cases[] = array( |
512 | TRUE, //useLogin | |
513 | array('body_text' => 'Look ma, magic tokens in the text!', 'footer_id' => '%FOOTER%'), // createParams | |
514 | array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'), | |
515 | FALSE, // expectedFailure | |
516 | 1, // expectedJobCount | |
517 | ); | |
518 | $cases[] = array( | |
519 | TRUE, //useLogin | |
520 | array('body_html' => '<p>Look ma, magic tokens in the markup!</p>', 'footer_id' => '%FOOTER%'), // createParams | |
521 | array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'), | |
522 | FALSE, // expectedFailure | |
523 | 1, // expectedJobCount | |
524 | ); | |
6818346a TO |
525 | return $cases; |
526 | } | |
527 | ||
528 | /** | |
529 | * @param bool $useLogin | |
d78cc635 TO |
530 | * @param array $createParams |
531 | * @param array $submitParams | |
6818346a TO |
532 | * @param null|string $expectedFailure |
533 | * @param int $expectedJobCount | |
534 | * @dataProvider submitProvider | |
535 | */ | |
d78cc635 | 536 | public function testMailerSubmit($useLogin, $createParams, $submitParams, $expectedFailure, $expectedJobCount) { |
6818346a TO |
537 | if ($useLogin) { |
538 | $this->createLoggedInUser(); | |
539 | } | |
540 | ||
d8e9212d TO |
541 | if (isset($createParams['footer_id']) && $createParams['footer_id'] == '%FOOTER%') { |
542 | $createParams['footer_id'] = $this->footer['id']; | |
543 | } | |
544 | ||
d78cc635 | 545 | $id = $this->createDraftMailing($createParams); |
6818346a | 546 | |
d78cc635 | 547 | $submitParams['id'] = $id; |
6818346a | 548 | if ($expectedFailure) { |
d78cc635 | 549 | $submitResult = $this->callAPIFailure('mailing', 'submit', $submitParams); |
6818346a TO |
550 | $this->assertRegExp($expectedFailure, $submitResult['error_message']); |
551 | } | |
552 | else { | |
d78cc635 | 553 | $submitResult = $this->callAPIAndDocument('mailing', 'submit', $submitParams, __FUNCTION__, __FILE__); |
6818346a TO |
554 | $this->assertTrue(is_numeric($submitResult['id'])); |
555 | $this->assertTrue(is_numeric($submitResult['values'][$id]['scheduled_id'])); | |
d78cc635 | 556 | $this->assertEquals($submitParams['scheduled_date'], $submitResult['values'][$id]['scheduled_date']); |
6818346a TO |
557 | } |
558 | $this->assertDBQuery($expectedJobCount, 'SELECT count(*) FROM civicrm_mailing_job WHERE mailing_id = %1', array( | |
21dfd5f5 | 559 | 1 => array($id, 'Integer'), |
6818346a TO |
560 | )); |
561 | } | |
562 | ||
9629f523 JP |
563 | /** |
564 | * Test unsubscribe list contains correct groups | |
565 | * when include = 'previous mailing' | |
566 | */ | |
567 | public function testUnsubscribeGroupList() { | |
568 | // Create set of groups and add a contact to both of them. | |
569 | $groupID2 = $this->groupCreate(array('name' => 'Test group 2', 'title' => 'group title 2')); | |
570 | $groupID3 = $this->groupCreate(array('name' => 'Test group 3', 'title' => 'group title 3')); | |
571 | $contactId = $this->individualCreate(); | |
572 | foreach (array($groupID2, $groupID3) as $grp) { | |
573 | $params = array( | |
574 | 'contact_id' => $contactId, | |
575 | 'group_id' => $grp, | |
576 | ); | |
577 | $this->callAPISuccess('GroupContact', 'create', $params); | |
578 | } | |
579 | ||
580 | //Send mail to groupID3 | |
581 | $mail = $this->callAPISuccess('mailing', 'create', $this->_params); | |
582 | $params = array('mailing_id' => $mail['id'], 'test_email' => NULL, 'test_group' => $groupID3); | |
583 | $this->callAPISuccess($this->_entity, 'send_test', $params); | |
584 | ||
585 | $mgParams = array( | |
586 | 'mailing_id' => $mail['id'], | |
587 | 'entity_table' => 'civicrm_group', | |
588 | 'entity_id' => $groupID3, | |
589 | 'group_type' => 'Include', | |
590 | ); | |
591 | $mailingGroup = $this->callAPISuccess('MailingGroup', 'create', $mgParams); | |
592 | ||
593 | //Include previous mail in the mailing group. | |
594 | $mail2 = $this->callAPISuccess('mailing', 'create', $this->_params); | |
595 | $params = array('mailing_id' => $mail2['id'], 'test_email' => NULL, 'test_group' => $groupID3); | |
596 | $this->callAPISuccess($this->_entity, 'send_test', $params); | |
597 | ||
598 | $mgParams = array( | |
599 | 'mailing_id' => $mail2['id'], | |
600 | 'entity_table' => 'civicrm_mailing', | |
601 | 'entity_id' => $mail['id'], | |
602 | 'group_type' => 'Include', | |
603 | ); | |
604 | $mailingGroup = $this->callAPISuccess('MailingGroup', 'create', $mgParams); | |
605 | //CRM-20431 - Delete group id that matches first mailing id. | |
606 | $this->callAPISuccess('Group', 'delete', array('id' => $this->_groupID)); | |
607 | $jobId = CRM_Core_DAO::getFieldValue('CRM_Mailing_DAO_MailingJob', $mail2['id'], 'id', 'mailing_id'); | |
608 | $hash = CRM_Core_DAO::getFieldValue('CRM_Mailing_Event_DAO_Queue', $jobId, 'hash', 'job_id'); | |
609 | $queueId = CRM_Core_DAO::getFieldValue('CRM_Mailing_Event_DAO_Queue', $jobId, 'id', 'job_id'); | |
610 | ||
611 | $group = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($jobId, $queueId, $hash, TRUE); | |
612 | //Assert only one group returns in the unsubscribe list. | |
613 | $this->assertCount(1, $group); | |
614 | $this->assertEquals($groupID3, key($group)); | |
615 | } | |
616 | ||
39010e60 EM |
617 | /** |
618 | * | |
619 | */ | |
ef643544 | 620 | public function testMailerStats() { |
621 | $result = $this->groupContactCreate($this->_groupID, 100); | |
622 | $this->assertEquals(100, $result['added']); //verify if 100 contacts are added for group | |
7811a84b | 623 | |
624 | //Create and send test mail first and change the mail job to live, | |
625 | //because stats api only works on live mail | |
ef643544 | 626 | $mail = $this->callAPISuccess('mailing', 'create', $this->_params); |
7811a84b | 627 | $params = array('mailing_id' => $mail['id'], 'test_email' => NULL, 'test_group' => $this->_groupID); |
ef643544 | 628 | $deliveredInfo = $this->callAPISuccess($this->_entity, 'send_test', $params); |
92915c55 | 629 | $deliveredIds = implode(',', array_keys($deliveredInfo['values'])); |
7811a84b | 630 | |
631 | //Change the test mail into live | |
632 | $sql = "UPDATE civicrm_mailing_job SET is_test = 0 WHERE mailing_id = {$mail['id']}"; | |
633 | CRM_Core_DAO::executeQuery($sql); | |
634 | ||
ef643544 | 635 | foreach (array('bounce', 'unsubscribe', 'opened') as $type) { |
636 | $sql = "CREATE TEMPORARY TABLE mail_{$type}_temp | |
637 | (event_queue_id int, time_stamp datetime, delivered_id int) | |
638 | SELECT event_queue_id, time_stamp, id | |
639 | FROM civicrm_mailing_event_delivered | |
640 | WHERE id IN ($deliveredIds) | |
641 | ORDER BY RAND() LIMIT 0,20;"; | |
ef643544 | 642 | CRM_Core_DAO::executeQuery($sql); |
7811a84b | 643 | |
ef643544 | 644 | $sql = "DELETE FROM civicrm_mailing_event_delivered WHERE id IN (SELECT delivered_id FROM mail_{$type}_temp);"; |
645 | CRM_Core_DAO::executeQuery($sql); | |
7811a84b | 646 | |
ef643544 | 647 | if ($type == 'unsubscribe') { |
648 | $sql = "INSERT INTO civicrm_mailing_event_{$type} (event_queue_id, time_stamp, org_unsubscribe) | |
649 | SELECT event_queue_id, time_stamp, 1 FROM mail_{$type}_temp"; | |
650 | } | |
651 | else { | |
652 | $sql = "INSERT INTO civicrm_mailing_event_{$type} (event_queue_id, time_stamp) | |
653 | SELECT event_queue_id, time_stamp FROM mail_{$type}_temp"; | |
654 | } | |
655 | CRM_Core_DAO::executeQuery($sql); | |
656 | } | |
7811a84b | 657 | |
ef643544 | 658 | $result = $this->callAPISuccess('mailing', 'stats', array('mailing_id' => $mail['id'])); |
659 | $expectedResult = array( | |
660 | 'Delivered' => 80, //since among 100 mails 20 has been bounced | |
661 | 'Bounces' => 20, | |
662 | 'Opened' => 20, | |
663 | 'Unique Clicks' => 0, | |
21dfd5f5 | 664 | 'Unsubscribers' => 20, |
ef643544 | 665 | ); |
ef643544 | 666 | $this->checkArrayEquals($expectedResult, $result['values'][$mail['id']]); |
667 | } | |
92915c55 | 668 | |
c43d01f3 | 669 | /** |
fe482240 | 670 | * Test civicrm_mailing_delete. |
c43d01f3 | 671 | */ |
672 | public function testMailerDeleteSuccess() { | |
e37b4b04 | 673 | $result = $this->callAPISuccess($this->_entity, 'create', $this->_params); |
ad4f6a9c | 674 | $this->callAPIAndDocument($this->_entity, 'delete', array('id' => $result['id']), __FUNCTION__, __FILE__); |
e37b4b04 | 675 | $this->assertAPIDeleted($this->_entity, $result['id']); |
c43d01f3 | 676 | } |
6a488035 | 677 | |
1d280e03 CW |
678 | /** |
679 | * Test Mailing.gettokens. | |
680 | */ | |
681 | public function testMailGetTokens() { | |
9950a1c9 | 682 | $description = "Demonstrates fetching tokens for one or more entities (in this case \"Contact\" and \"Mailing\"). |
1d280e03 | 683 | Optionally pass sequential=1 to have output ready-formatted for the select2 widget."; |
9950a1c9 CW |
684 | $result = $this->callAPIAndDocument($this->_entity, 'gettokens', array('entity' => array('Contact', 'Mailing')), __FUNCTION__, __FILE__, $description); |
685 | $this->assertContains('Contact Type', $result['values']); | |
686 | ||
687 | // Check that passing "sequential" correctly outputs a hierarchical array | |
688 | $result = $this->callAPISuccess($this->_entity, 'gettokens', array('entity' => 'contact', 'sequential' => 1)); | |
689 | $this->assertArrayHasKey('text', $result['values'][0]); | |
690 | $this->assertArrayHasKey('id', $result['values'][0]['children'][0]); | |
1d280e03 CW |
691 | } |
692 | ||
00dc999a TO |
693 | public function testClone() { |
694 | // BEGIN SAMPLE DATA | |
695 | $groupIDs['inc'] = $this->groupCreate(array('name' => 'Example include group', 'title' => 'Example include group')); | |
696 | $contactIDs['include_me'] = $this->individualCreate(array( | |
697 | 'email' => 'include.me@example.org', | |
698 | 'first_name' => 'Includer', | |
699 | 'last_name' => 'Person', | |
700 | )); | |
701 | $this->callAPISuccess('GroupContact', 'create', array( | |
702 | 'group_id' => $groupIDs['inc'], | |
703 | 'contact_id' => $contactIDs['include_me'], | |
704 | )); | |
705 | ||
706 | $params = $this->_params; | |
707 | $params['groups']['include'] = array($groupIDs['inc']); | |
708 | $params['groups']['exclude'] = array(); | |
709 | $params['mailings']['include'] = array(); | |
710 | $params['mailings']['exclude'] = array(); | |
711 | // END SAMPLE DATA | |
712 | ||
713 | $create = $this->callAPISuccess('Mailing', 'create', $params); | |
714 | $createId = $create['id']; | |
715 | $this->createLoggedInUser(); | |
716 | $clone = $this->callAPIAndDocument('Mailing', 'clone', array('id' => $create['id']), __FUNCTION__, __FILE__); | |
717 | $cloneId = $clone['id']; | |
718 | ||
719 | $this->assertNotEquals($createId, $cloneId, 'Create and clone should return different records'); | |
720 | $this->assertTrue(is_numeric($cloneId)); | |
721 | ||
722 | $this->assertNotEmpty($clone['values'][$cloneId]['subject']); | |
723 | $this->assertEquals($params['subject'], $clone['values'][$cloneId]['subject'], "Cloned subject should match"); | |
724 | ||
725 | // created_id is special - populated based on current user (ie the cloner). | |
726 | $this->assertNotEmpty($clone['values'][$cloneId]['created_id']); | |
727 | $this->assertNotEquals($create['values'][$createId]['created_id'], $clone['values'][$cloneId]['created_id'], 'Clone should be created by a different person'); | |
728 | ||
729 | // Target groups+mailings are special. | |
730 | $cloneGroups = $this->callAPISuccess('MailingGroup', 'get', array('mailing_id' => $cloneId, 'sequential' => 1)); | |
731 | $this->assertEquals(1, $cloneGroups['count']); | |
732 | $this->assertEquals($cloneGroups['values'][0]['group_type'], 'Include'); | |
733 | $this->assertEquals($cloneGroups['values'][0]['entity_table'], 'civicrm_group'); | |
734 | $this->assertEquals($cloneGroups['values'][0]['entity_id'], $groupIDs['inc']); | |
735 | } | |
736 | ||
6a488035 TO |
737 | //@ todo tests below here are all failure tests which are not hugely useful - need success tests |
738 | ||
739 | //------------ civicrm_mailing_event_bounce methods------------ | |
740 | ||
741 | /** | |
742 | * Test civicrm_mailing_event_bounce with wrong params. | |
e37b4b04 | 743 | * Note that tests like this are slightly better than no test but an |
744 | * api function cannot be considered supported / 'part of the api' without a | |
745 | * success test | |
6a488035 TO |
746 | */ |
747 | public function testMailerBounceWrongParams() { | |
748 | $params = array( | |
749 | 'job_id' => 'Wrong ID', | |
750 | 'event_queue_id' => 'Wrong ID', | |
751 | 'hash' => 'Wrong Hash', | |
752 | 'body' => 'Body...', | |
6a488035 TO |
753 | 'time_stamp' => '20111109212100', |
754 | ); | |
ad4f6a9c | 755 | $this->callAPIFailure('mailing_event', 'bounce', $params, |
30d44db2 | 756 | 'Queue event could not be found' |
757 | ); | |
6a488035 TO |
758 | } |
759 | ||
760 | //----------- civicrm_mailing_event_confirm methods ----------- | |
761 | ||
762 | /** | |
763 | * Test civicrm_mailing_event_confirm with wrong params. | |
e37b4b04 | 764 | * Note that tests like this are slightly better than no test but an |
765 | * api function cannot be considered supported / 'part of the api' without a | |
766 | * success test | |
6a488035 TO |
767 | */ |
768 | public function testMailerConfirmWrongParams() { | |
769 | $params = array( | |
770 | 'contact_id' => 'Wrong ID', | |
771 | 'subscribe_id' => 'Wrong ID', | |
772 | 'hash' => 'Wrong Hash', | |
773 | 'event_subscribe_id' => '123', | |
774 | 'time_stamp' => '20111111010101', | |
ef170fe0 | 775 | ); |
ad4f6a9c | 776 | $this->callAPIFailure('mailing_event', 'confirm', $params, |
4f94e3fa | 777 | 'contact_id is not a valid integer' |
e37b4b04 | 778 | ); |
6a488035 TO |
779 | } |
780 | ||
781 | //---------- civicrm_mailing_event_reply methods ----------- | |
782 | ||
783 | /** | |
784 | * Test civicrm_mailing_event_reply with wrong params. | |
e37b4b04 | 785 | * |
786 | * Note that tests like this are slightly better than no test but an | |
787 | * api function cannot be considered supported / 'part of the api' without a | |
788 | * success test | |
6a488035 TO |
789 | */ |
790 | public function testMailerReplyWrongParams() { | |
791 | $params = array( | |
792 | 'job_id' => 'Wrong ID', | |
793 | 'event_queue_id' => 'Wrong ID', | |
794 | 'hash' => 'Wrong Hash', | |
795 | 'bodyTxt' => 'Body...', | |
796 | 'replyTo' => $this->_email, | |
797 | 'time_stamp' => '20111111010101', | |
ef170fe0 | 798 | ); |
ad4f6a9c | 799 | $this->callAPIFailure('mailing_event', 'reply', $params, |
e37b4b04 | 800 | 'Queue event could not be found' |
30d44db2 | 801 | ); |
6a488035 TO |
802 | } |
803 | ||
804 | ||
805 | //----------- civicrm_mailing_event_forward methods ---------- | |
806 | ||
807 | /** | |
808 | * Test civicrm_mailing_event_forward with wrong params. | |
e37b4b04 | 809 | * Note that tests like this are slightly better than no test but an |
810 | * api function cannot be considered supported / 'part of the api' without a | |
811 | * success test | |
6a488035 TO |
812 | */ |
813 | public function testMailerForwardWrongParams() { | |
814 | $params = array( | |
815 | 'job_id' => 'Wrong ID', | |
816 | 'event_queue_id' => 'Wrong ID', | |
817 | 'hash' => 'Wrong Hash', | |
818 | 'email' => $this->_email, | |
819 | 'time_stamp' => '20111111010101', | |
ef170fe0 | 820 | ); |
ad4f6a9c | 821 | $this->callAPIFailure('mailing_event', 'forward', $params, |
e37b4b04 | 822 | 'Queue event could not be found' |
823 | ); | |
6a488035 TO |
824 | } |
825 | ||
6818346a | 826 | /** |
d78cc635 TO |
827 | * @param array $params |
828 | * Extra parameters for the draft mailing. | |
6818346a TO |
829 | * @return array|int |
830 | */ | |
d78cc635 TO |
831 | public function createDraftMailing($params = array()) { |
832 | $createParams = array_merge($this->_params, $params); | |
6818346a TO |
833 | $createResult = $this->callAPISuccess('mailing', 'create', $createParams, __FUNCTION__, __FILE__); |
834 | $this->assertTrue(is_numeric($createResult['id'])); | |
835 | $this->assertDBQuery(0, 'SELECT count(*) FROM civicrm_mailing_job WHERE mailing_id = %1', array( | |
21dfd5f5 | 836 | 1 => array($createResult['id'], 'Integer'), |
6818346a TO |
837 | )); |
838 | return $createResult['id']; | |
839 | } | |
840 | ||
b4fb9733 ML |
841 | /** |
842 | * Test to make sure that if the event queue hashes have been archived, | |
843 | * we can still have working click-trough URLs working (CRM-17959). | |
844 | */ | |
845 | public function testUrlWithMissingTrackingHash() { | |
3c27d467 | 846 | $mail = $this->callAPISuccess('mailing', 'create', $this->_params + array('scheduled_date' => 'now'), __FUNCTION__, __FILE__); |
b4fb9733 ML |
847 | $jobs = $this->callAPISuccess('mailing_job', 'get', array('mailing_id' => $mail['id'])); |
848 | $this->assertEquals(1, $jobs['count']); | |
849 | ||
850 | $params = array('mailing_id' => $mail['id'], 'test_email' => 'alice@example.org', 'test_group' => NULL); | |
851 | $deliveredInfo = $this->callAPISuccess($this->_entity, 'send_test', $params); | |
852 | ||
853 | $sql = "SELECT turl.id as url_id, turl.url, q.id as queue_id | |
854 | FROM civicrm_mailing_trackable_url as turl | |
855 | INNER JOIN civicrm_mailing_job as j ON turl.mailing_id = j.mailing_id | |
856 | INNER JOIN civicrm_mailing_event_queue q ON j.id = q.job_id | |
857 | ORDER BY turl.id DESC LIMIT 1"; | |
858 | ||
859 | $dao = CRM_Core_DAO::executeQuery($sql); | |
860 | $this->assertTrue($dao->fetch()); | |
861 | ||
862 | $url = CRM_Mailing_Event_BAO_TrackableURLOpen::track($dao->queue_id, $dao->url_id); | |
863 | $this->assertContains('https://civicrm.org', $url); | |
864 | ||
865 | // Now delete the event queue hashes and see if the tracking still works. | |
866 | CRM_Core_DAO::executeQuery('DELETE FROM civicrm_mailing_event_queue'); | |
867 | ||
868 | $url = CRM_Mailing_Event_BAO_TrackableURLOpen::track($dao->queue_id, $dao->url_id); | |
869 | $this->assertContains('https://civicrm.org', $url); | |
870 | } | |
6a488035 | 871 | |
3c70eacb | 872 | /** |
873 | * Test Trackable URL with unicode character | |
874 | */ | |
875 | public function testTrackableURLWithUnicodeSign() { | |
876 | $unicodeURL = "https://civiĆcrm.org"; | |
877 | $this->_params['body_text'] = str_replace("https://civicrm.org", $unicodeURL, $this->_params['body_text']); | |
878 | $this->_params['body_html'] = str_replace("https://civicrm.org", $unicodeURL, $this->_params['body_html']); | |
879 | ||
3c27d467 | 880 | $mail = $this->callAPISuccess('mailing', 'create', $this->_params + array('scheduled_date' => 'now')); |
3c70eacb | 881 | |
882 | $params = array('mailing_id' => $mail['id'], 'test_email' => 'alice@example.org', 'test_group' => NULL); | |
3c27d467 | 883 | $this->callAPISuccess($this->_entity, 'send_test', $params); |
3c70eacb | 884 | |
885 | $sql = "SELECT turl.id as url_id, turl.url, q.id as queue_id | |
886 | FROM civicrm_mailing_trackable_url as turl | |
887 | INNER JOIN civicrm_mailing_job as j ON turl.mailing_id = j.mailing_id | |
888 | INNER JOIN civicrm_mailing_event_queue q ON j.id = q.job_id | |
889 | ORDER BY turl.id DESC LIMIT 1"; | |
890 | ||
891 | $dao = CRM_Core_DAO::executeQuery($sql); | |
892 | $this->assertTrue($dao->fetch()); | |
893 | ||
894 | $url = CRM_Mailing_Event_BAO_TrackableURLOpen::track($dao->queue_id, $dao->url_id); | |
895 | $this->assertContains($unicodeURL, $url); | |
896 | ||
897 | // Now delete the event queue hashes and see if the tracking still works. | |
898 | CRM_Core_DAO::executeQuery('DELETE FROM civicrm_mailing_event_queue'); | |
899 | ||
900 | $url = CRM_Mailing_Event_BAO_TrackableURLOpen::track($dao->queue_id, $dao->url_id); | |
901 | $this->assertContains($unicodeURL, $url); | |
902 | } | |
903 | ||
c26f9b8c SL |
904 | /** |
905 | * CRM-20892 : Test if Mail.create API throws error on update, | |
906 | * if modified_date less then the date when the mail was last updated/created | |
907 | */ | |
908 | public function testModifiedDateMismatchOnMailingUpdate() { | |
909 | $mail = $this->callAPISuccess('mailing', 'create', $this->_params + array('modified_date' => 'now')); | |
910 | try { | |
911 | $this->callAPISuccess('mailing', 'create', $this->_params + array('id' => $mail['id'], 'modified_date' => '2 seconds ago')); | |
912 | } | |
913 | catch (Exception $e) { | |
914 | $this->assertRegExp("/Failure in api call for mailing create: Mailing has not been saved, Content maybe out of date, please refresh the page and try again/", $e->getMessage()); | |
915 | } | |
916 | } | |
917 | ||
6a488035 | 918 | } |