3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 * File for the CiviCRM APIv3 job functions
31 * @package CiviCRM_APIv3
34 * @copyright CiviCRM LLC (c) 2004-2017
35 * @version $Id: Job.php 30879 2010-11-22 15:45:55Z shot $
40 * Class api_v3_JobTest
44 class api_v3_JobProcessMailingTest
extends CiviUnitTestCase
{
45 protected $_apiversion = 3;
47 public $DBResetRequired = FALSE;
48 public $_entity = 'Job';
49 public $_params = array();
53 protected $defaultSettings;
60 public function setUp() {
61 $this->cleanupMailingTest();
63 CRM_Mailing_BAO_MailingJob
::$mailsProcessed = 0; // DGW
64 $this->_groupID
= $this->groupCreate();
65 $this->_email
= 'test@test.test';
66 $this->_params
= array(
67 'subject' => 'Accidents in cars cause children',
68 'body_text' => 'BEWARE children need regular infusions of toys. Santa knows your {domain.address}. There is no {action.optOutUrl}.',
69 'name' => 'mailing name',
71 'groups' => array('include' => array($this->_groupID
)),
72 'scheduled_date' => 'now',
74 $this->defaultSettings
= array(
75 'mailings' => 1, // int, #mailings to send
76 'recipients' => 20, // int, #contacts to receive mailing
77 'workers' => 1, // int, #concurrent cron jobs
78 'iterations' => 1, // int, #times to spawn all the workers
79 'lockHold' => 0, // int, #extra seconds each cron job should hold lock
80 'mailerBatchLimit' => 0, // int, max# recipients to send in a given cron run
81 'mailerJobsMax' => 0, // int, max# concurrent jobs
82 'mailerJobSize' => 0, // int, max# recipients in each job
83 'mailThrottleTime' => 0, // int, microseconds separating messages
85 $this->_mut
= new CiviMailUtils($this, TRUE);
86 $this->callAPISuccess('mail_settings', 'get', array('api.mail_settings.create' => array('domain' => 'chaos.org')));
91 public function tearDown() {
92 //$this->_mut->clearMessages();
94 CRM_Utils_Hook
::singleton()->reset();
95 CRM_Mailing_BAO_MailingJob
::$mailsProcessed = 0; // DGW
96 //$this->cleanupMailingTest();
100 public function testBasic() {
101 $this->createContactsInGroup(10, $this->_groupID
);
102 Civi
::settings()->add(array(
103 'mailerBatchLimit' => 2,
105 $this->callAPISuccess('mailing', 'create', $this->_params
);
106 $this->_mut
->assertRecipients(array());
107 $this->callAPISuccess('job', 'process_mailing', array());
108 $this->_mut
->assertRecipients($this->getRecipients(1, 2));
112 * Test mail when in non-production environment.
115 public function testMailNonProductionRun() {
116 // Test in non-production mode.
118 'environment' => 'Staging',
120 $this->callAPISuccess('Setting', 'create', $params);
121 $this->createContactsInGroup(10, $this->_groupID
);
122 Civi
::settings()->add(array(
123 'mailerBatchLimit' => 2,
125 $this->callAPISuccess('mailing', 'create', $this->_params
);
126 $this->_mut
->assertRecipients(array());
127 $this->callAPIFailure('job', 'process_mailing', "Failure in api call for job process_mailing: Job has not been executed as it is a non-production environment.");
129 // Test with runInNonProductionEnvironment param.
130 $this->callAPISuccess('job', 'process_mailing', array('runInNonProductionEnvironment' => TRUE));
131 $this->_mut
->assertRecipients($this->getRecipients(1, 2));
133 // Test in production mode.
135 'environment' => 'Production',
137 $this->callAPISuccess('Setting', 'create', $params);
138 $this->callAPISuccess('job', 'process_mailing', array());
139 $this->_mut
->assertRecipients($this->getRecipients(1, 2));
142 public function concurrencyExamples() {
145 // Launch 3 workers, but mailerJobsMax limits us to 1 worker.
150 // FIXME: lockHold is unrealistic/unrepresentative. In reality, this situation fails because
151 // the data.* locks trample the worker.* locks. However, setting lockHold allows us to
152 // approximate the behavior of what would happen *if* the lock-implementation didn't suffer
153 // trampling effects.
155 'mailerBatchLimit' => 4,
156 'mailerJobsMax' => 1,
159 0 => 2, // 2 jobs which produce 0 messages
160 4 => 1, // 1 job which produces 4 messages
165 // Launch 3 workers, but mailerJobsMax limits us to 2 workers.
170 // FIXME: lockHold is unrealistic/unrepresentative. In reality, this situation fails because
171 // the data.* locks trample the worker.* locks. However, setting lockHold allows us to
172 // approximate the behavior of what would happen *if* the lock-implementation didn't suffer
173 // trampling effects.
175 'mailerBatchLimit' => 5,
176 'mailerJobsMax' => 2,
179 0 => 1, // 1 job which produce 0 messages
180 5 => 2, // 2 jobs which produce 5 messages
185 // Launch 3 workers and saturate them (mailerJobsMax=3)
190 'mailerBatchLimit' => 6,
191 'mailerJobsMax' => 3,
194 6 => 3, // 3 jobs which produce 6 messages
199 // Launch 4 workers and saturate them (mailerJobsMax=0)
204 'mailerBatchLimit' => 6,
205 'mailerJobsMax' => 0,
208 6 => 3, // 3 jobs which produce 6 messages
209 2 => 1, // 1 job which produces 2 messages
214 // Launch 1 worker, 3 times in a row. Deliver everything.
220 'mailerBatchLimit' => 7,
223 7 => 1, // 1 job which produces 7 messages
224 3 => 1, // 1 job which produces 3 messages
225 0 => 1, // 1 job which produces 0 messages
230 // Launch 2 worker, 3 times in a row. Deliver everything.
236 'mailerBatchLimit' => 3,
239 3 => 3, // 3 jobs which produce 3 messages
240 1 => 1, // 1 job which produces 1 messages
241 0 => 2, // 2 jobs which produce 0 messages
246 // For two mailings, launch 1 worker, 5 times in a row. Deliver everything.
253 'mailerBatchLimit' => 6,
256 // x6 => x4+x2 => x6 => x2 => x0
257 6 => 3, // 3 jobs which produce 6 messages
258 2 => 1, // 1 job which produces 2 messages
259 0 => 1, // 1 job which produces 0 messages
268 * Setup various mail configuration options (eg $mailerBatchLimit,
269 * $mailerJobMax) and spawn multiple worker threads ($workers).
270 * Allow the threads to complete. (Optionally, repeat the above
271 * process.) Finally, check to see if the right number of
272 * jobs delivered the right number of messages.
274 * @param array $settings
275 * An array of settings (eg mailerBatchLimit, workers). See comments
276 * for $this->defaultSettings.
277 * @param array $expectedTallies
278 * A listing of the number cron-runs keyed by their size.
279 * For example, array(10=>2) means that there 2 cron-runs
280 * which delivered 10 messages each.
281 * @param int $expectedTotal
282 * The total number of contacts for whom messages should have
284 * @dataProvider concurrencyExamples
286 public function testConcurrency($settings, $expectedTallies, $expectedTotal) {
287 $settings = array_merge($this->defaultSettings
, $settings);
289 $this->createContactsInGroup($settings['recipients'], $this->_groupID
);
290 Civi
::settings()->add(CRM_Utils_Array
::subset($settings, array(
296 for ($i = 0; $i < $settings['mailings']; $i++
) {
297 $this->callAPISuccess('mailing', 'create', $this->_params
);
300 $this->_mut
->assertRecipients(array());
302 $allApiResults = array();
303 for ($iterationId = 0; $iterationId < $settings['iterations']; $iterationId++
) {
304 $apiCalls = $this->createExternalAPI();
305 $apiCalls->addEnv(array('CIVICRM_CRON_HOLD' => $settings['lockHold']));
306 for ($workerId = 0; $workerId < $settings['workers']; $workerId++
) {
307 $apiCalls->addCall('job', 'process_mailing', array());
310 $this->assertEquals($settings['workers'], $apiCalls->getRunningCount());
313 $allApiResults = array_merge($allApiResults, $apiCalls->getResults());
316 $actualTallies = $this->tallyApiResults($allApiResults);
317 $this->assertEquals($expectedTallies, $actualTallies, 'API tallies should match.' . print_r(array(
318 'expectedTallies' => $expectedTallies,
319 'actualTallies' => $actualTallies,
320 'apiResults' => $allApiResults,
322 $this->_mut
->assertRecipients($this->getRecipients(1, $expectedTotal / $settings['mailings'], 'nul.example.com', $settings['mailings']));
323 $this->assertEquals(0, $apiCalls->getRunningCount());
327 * Create contacts in group.
330 * @param int $groupID
331 * @param string $domain
333 public function createContactsInGroup($count, $groupID, $domain = 'nul.example.com') {
334 for ($i = 1; $i <= $count; $i++
) {
335 $contactID = $this->individualCreate(array('first_name' => $count, 'email' => 'mail' . $i . '@' . $domain));
336 $this->callAPISuccess('group_contact', 'create', array(
337 'contact_id' => $contactID,
338 'group_id' => $groupID,
345 * Construct the list of email addresses for $count recipients.
349 * @param string $domain
350 * @param int $mailings
354 public function getRecipients($start, $count, $domain = 'nul.example.com', $mailings = 1) {
355 $recipients = array();
356 for ($m = 0; $m < $mailings; $m++
) {
357 for ($i = $start; $i < ($start +
$count); $i++
) {
358 $recipients[][0] = 'mail' . $i . '@' . $domain;
364 protected function cleanupMailingTest() {
365 $this->quickCleanup(array(
367 'civicrm_mailing_job',
368 'civicrm_mailing_spool',
369 'civicrm_mailing_group',
370 'civicrm_mailing_recipients',
371 'civicrm_mailing_event_queue',
372 'civicrm_mailing_event_bounce',
373 'civicrm_mailing_event_delivered',
375 'civicrm_group_contact',
381 * Categorize results based on (a) whether they succeeded
382 * and (b) the number of messages sent.
384 * @param array $apiResults
386 * One key 'error' for all failures.
387 * A separate key for each distinct quantity.
389 protected function tallyApiResults($apiResults) {
391 foreach ($apiResults as $apiResult) {
392 $key = !empty($apiResult['is_error']) ?
'error' : $apiResult['values']['processed'];
393 $ret[$key] = !empty($ret[$key]) ?
1 +
$ret[$key] : 1;