/**
* Test APIv3 civicrm_mailing_* functions
*
- * @package CiviCRM
+ * @package CiviCRM
*/
class api_v3_MailingTest extends CiviUnitTestCase {
protected $_groupID;
protected $_apiversion = 3;
protected $_params = array();
protected $_entity = 'Mailing';
+ protected $_contactID;
-
- /**
- * @return array
- */
- function get_info() {
- return array(
- 'name' => 'Mailer',
- 'description' => 'Test all Mailer methods.',
- 'group' => 'CiviCRM API Tests',
- );
- }
-
- function setUp() {
+ public function setUp() {
parent::setUp();
+ $this->useTransaction();
+ CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
+ $this->_contactID = $this->individualCreate();
$this->_groupID = $this->groupCreate();
$this->_email = 'test@test.test';
$this->_params = array(
- 'subject' => 'maild',
- 'body_text' => 'bdkfhdskfhduew',
+ 'subject' => 'Hello {contact.display_name}',
+ 'body_text' => "This is {contact.display_name}",
+ 'body_html' => "<p>This is {contact.display_name}</p>",
'name' => 'mailing name',
- 'created_id' => 1,
+ 'created_id' => $this->_contactID,
);
}
- function tearDown() {
- $this->groupDelete($this->_groupID);
+ public function tearDown() {
+ CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
+ parent::tearDown();
}
/**
$this->getAndCheck($this->_params, $result['id'], 'mailing');
}
+ /**
+ * The Mailing.create API supports magic properties "groups[include,enclude]" and "mailings[include,exclude]".
+ * Make sure these work
+ */
+ public function testMagicGroups_create_update() {
+ // BEGIN SAMPLE DATA
+ $groupIDs['a'] = $this->groupCreate(array('name' => 'Example include group', 'title' => 'Example include group'));
+ $groupIDs['b'] = $this->groupCreate(array('name' => 'Example exclude group', 'title' => 'Example exclude group'));
+ $contactIDs['a'] = $this->individualCreate(array(
+ 'email' => 'include.me@example.org',
+ 'first_name' => 'Includer',
+ 'last_name' => 'Person'
+ ));
+ $contactIDs['b'] = $this->individualCreate(array(
+ 'email' => 'exclude.me@example.org',
+ 'last_name' => 'Excluder'
+ ));
+ $this->callAPISuccess('GroupContact', 'create', array(
+ 'group_id' => $groupIDs['a'],
+ 'contact_id' => $contactIDs['a']
+ ));
+ $this->callAPISuccess('GroupContact', 'create', array(
+ 'group_id' => $groupIDs['b'],
+ 'contact_id' => $contactIDs['b']
+ ));
+ // END SAMPLE DATA
+
+ // ** Pass 1: Create
+ $createParams = $this->_params;
+ $createParams['groups']['include'] = array($groupIDs['a']);
+ $createParams['groups']['exclude'] = array();
+ $createParams['mailings']['include'] = array();
+ $createParams['mailings']['exclude'] = array();
+ $createResult = $this->callAPISuccess('Mailing', 'create', $createParams);
+ $getGroup1 = $this->callAPISuccess('MailingGroup', 'get', array('mailing_id' => $createResult['id']));
+ $getGroup1_ids = array_values(CRM_Utils_Array::collect('entity_id', $getGroup1['values']));
+ $this->assertEquals(array($groupIDs['a']), $getGroup1_ids);
+ $getRecip1 = $this->callAPISuccess('MailingRecipients', 'get', array('mailing_id' => $createResult['id']));
+ $getRecip1_ids = array_values(CRM_Utils_Array::collect('contact_id', $getRecip1['values']));
+ $this->assertEquals(array($contactIDs['a']), $getRecip1_ids);
+
+ // ** Pass 2: Update without any changes to groups[include]
+ $nullopParams = $createParams;
+ $nullopParams['id'] = $createResult['id'];
+ $updateParams['api.mailing_job.create'] = 1;
+ unset($nullopParams['groups']['include']);
+ $this->callAPISuccess('Mailing', 'create', $nullopParams);
+ $getGroup2 = $this->callAPISuccess('MailingGroup', 'get', array('mailing_id' => $createResult['id']));
+ $getGroup2_ids = array_values(CRM_Utils_Array::collect('entity_id', $getGroup2['values']));
+ $this->assertEquals(array($groupIDs['a']), $getGroup2_ids);
+ $getRecip2 = $this->callAPISuccess('MailingRecipients', 'get', array('mailing_id' => $createResult['id']));
+ $getRecip2_ids = array_values(CRM_Utils_Array::collect('contact_id', $getRecip2['values']));
+ $this->assertEquals(array($contactIDs['a']), $getRecip2_ids);
+
+ // ** Pass 3: Update with different groups[include]
+ $updateParams = $createParams;
+ $updateParams['id'] = $createResult['id'];
+ $updateParams['groups']['include'] = array($groupIDs['b']);
+ $updateParams['api.mailing_job.create'] = 1;
+ $this->callAPISuccess('Mailing', 'create', $updateParams);
+ $getGroup3 = $this->callAPISuccess('MailingGroup', 'get', array('mailing_id' => $createResult['id']));
+ $getGroup3_ids = array_values(CRM_Utils_Array::collect('entity_id', $getGroup3['values']));
+ $this->assertEquals(array($groupIDs['b']), $getGroup3_ids);
+ $getRecip3 = $this->callAPISuccess('MailingRecipients', 'get', array('mailing_id' => $createResult['id']));
+ $getRecip3_ids = array_values(CRM_Utils_Array::collect('contact_id', $getRecip3['values']));
+ $this->assertEquals(array($contactIDs['b']), $getRecip3_ids);
+ }
+
+ public function testMailerPreview() {
+ // BEGIN SAMPLE DATA
+ $contactID = $this->individualCreate();
+ $displayName = $this->callAPISuccess('contact', 'get', array('id' => $contactID));
+ $displayName = $displayName['values'][$contactID]['display_name'];
+ $this->assertTrue(!empty($displayName));
+
+ $params = $this->_params;
+ $params['api.Mailing.preview'] = array(
+ 'id' => '$value.id',
+ 'contact_id' => $contactID,
+ );
+ $params['options']['force_rollback'] = 1;
+ // END SAMPLE DATA
+
+ $maxIDs = array(
+ 'mailing' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing'),
+ 'job' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_job'),
+ 'group' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_group'),
+ 'recip' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_recipients'),
+ );
+ $result = $this->callAPISuccess('mailing', 'create', $params);
+ $this->assertDBQuery($maxIDs['mailing'], 'SELECT MAX(id) FROM civicrm_mailing'); // 'Preview should not create any mailing records'
+ $this->assertDBQuery($maxIDs['job'], 'SELECT MAX(id) FROM civicrm_mailing_job'); // 'Preview should not create any mailing_job record'
+ $this->assertDBQuery($maxIDs['group'], 'SELECT MAX(id) FROM civicrm_mailing_group'); // 'Preview should not create any mailing_group records'
+ $this->assertDBQuery($maxIDs['recip'], 'SELECT MAX(id) FROM civicrm_mailing_recipients'); // 'Preview should not create any mailing_recipient records'
+
+ $previewResult = $result['values'][$result['id']]['api.Mailing.preview'];
+ $this->assertEquals("Hello $displayName", $previewResult['values']['subject']);
+ $this->assertEquals("This is $displayName", $previewResult['values']['body_text']);
+ $this->assertContains("<p>This is $displayName</p>", $previewResult['values']['body_html']);
+ }
+
+ public function testMailerPreviewRecipients() {
+ // BEGIN SAMPLE DATA
+ $groupIDs['inc'] = $this->groupCreate(array('name' => 'Example include group', 'title' => 'Example include group'));
+ $groupIDs['exc'] = $this->groupCreate(array('name' => 'Example exclude group', 'title' => 'Example exclude group'));
+ $contactIDs['includeme'] = $this->individualCreate(array(
+ 'email' => 'include.me@example.org',
+ 'first_name' => 'Includer',
+ 'last_name' => 'Person'
+ ));
+ $contactIDs['excludeme'] = $this->individualCreate(array(
+ 'email' => 'exclude.me@example.org',
+ 'last_name' => 'Excluder',
+ ));
+ $this->callAPISuccess('GroupContact', 'create', array(
+ 'group_id' => $groupIDs['inc'],
+ 'contact_id' => $contactIDs['includeme']
+ ));
+ $this->callAPISuccess('GroupContact', 'create', array(
+ 'group_id' => $groupIDs['inc'],
+ 'contact_id' => $contactIDs['excludeme']
+ ));
+ $this->callAPISuccess('GroupContact', 'create', array(
+ 'group_id' => $groupIDs['exc'],
+ 'contact_id' => $contactIDs['excludeme']
+ ));
+
+ $params = $this->_params;
+ $params['groups']['include'] = array($groupIDs['inc']);
+ $params['groups']['exclude'] = array($groupIDs['exc']);
+ $params['mailings']['include'] = array();
+ $params['mailings']['exclude'] = array();
+ $params['options']['force_rollback'] = 1;
+ $params['api.MailingRecipients.get'] = array(
+ 'mailing_id' => '$value.id',
+ 'api.contact.getvalue' => array(
+ 'return' => 'display_name',
+ ),
+ 'api.email.getvalue' => array(
+ 'return' => 'email',
+ ),
+ );
+ // END SAMPLE DATA
+
+ $maxIDs = array(
+ 'mailing' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing'),
+ 'job' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_job'),
+ 'group' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_group'),
+ );
+ $create = $this->callAPIAndDocument('Mailing', 'create', $params, __FUNCTION__, __FILE__);
+ $this->assertDBQuery($maxIDs['mailing'], 'SELECT MAX(id) FROM civicrm_mailing'); // 'Preview should not create any mailing records'
+ $this->assertDBQuery($maxIDs['job'], 'SELECT MAX(id) FROM civicrm_mailing_job'); // 'Preview should not create any mailing_job record'
+ $this->assertDBQuery($maxIDs['group'], 'SELECT MAX(id) FROM civicrm_mailing_group'); // 'Preview should not create any mailing_group records'
+
+ $preview = $create['values'][$create['id']]['api.MailingRecipients.get'];
+ $previewIds = array_values(CRM_Utils_Array::collect('contact_id', $preview['values']));
+ $this->assertEquals(array((string) $contactIDs['includeme']), $previewIds);
+ $previewEmails = array_values(CRM_Utils_Array::collect('api.email.getvalue', $preview['values']));
+ $this->assertEquals(array('include.me@example.org'), $previewEmails);
+ $previewNames = array_values(CRM_Utils_Array::collect('api.contact.getvalue', $preview['values']));
+ $this->assertTrue((bool) preg_match('/Includer Person/', $previewNames[0]), "Name 'Includer Person' should appear in '" . $previewNames[0] . '"');
+ }
+
+ public function testMailerSendTest_email() {
+ $contactIDs['alice'] = $this->individualCreate(array(
+ 'email' => 'alice@example.org',
+ 'first_name' => 'Alice',
+ 'last_name' => 'Person'
+ ));
+
+ $mail = $this->callAPISuccess('mailing', 'create', $this->_params);
+
+ $params = array('mailing_id' => $mail['id'], 'test_email' => 'alice@example.org', 'test_group' => NULL);
+ $deliveredInfo = $this->callAPISuccess($this->_entity, 'send_test', $params);
+ $this->assertEquals(1, $deliveredInfo['count'], "in line " . __LINE__); // verify mail has been sent to user by count
+
+ $deliveredContacts = array_values(CRM_Utils_Array::collect('contact_id', $deliveredInfo['values']));
+ $this->assertEquals(array($contactIDs['alice']), $deliveredContacts);
+
+ $deliveredEmails = array_values(CRM_Utils_Array::collect('email', $deliveredInfo['values']));
+ $this->assertEquals(array('alice@example.org'), $deliveredEmails);
+ }
+
+ public function testMailerSendTest_group() {
+ // BEGIN SAMPLE DATA
+ $groupIDs['inc'] = $this->groupCreate(array('name' => 'Example include group', 'title' => 'Example include group'));
+ $contactIDs['alice'] = $this->individualCreate(array(
+ 'email' => 'alice@example.org',
+ 'first_name' => 'Alice',
+ 'last_name' => 'Person'
+ ));
+ $contactIDs['bob'] = $this->individualCreate(array(
+ 'email' => 'bob@example.org',
+ 'first_name' => 'Bob',
+ 'last_name' => 'Person'
+ ));
+ $contactIDs['carol'] = $this->individualCreate(array(
+ 'email' => 'carol@example.org',
+ 'first_name' => 'Carol',
+ 'last_name' => 'Person'
+ ));
+ $this->callAPISuccess('GroupContact', 'create', array(
+ 'group_id' => $groupIDs['inc'],
+ 'contact_id' => $contactIDs['alice']
+ ));
+ $this->callAPISuccess('GroupContact', 'create', array(
+ 'group_id' => $groupIDs['inc'],
+ 'contact_id' => $contactIDs['bob']
+ ));
+ $this->callAPISuccess('GroupContact', 'create', array(
+ 'group_id' => $groupIDs['inc'],
+ 'contact_id' => $contactIDs['carol']
+ ));
+ // END SAMPLE DATA
+
+ $mail = $this->callAPISuccess('mailing', 'create', $this->_params);
+ $deliveredInfo = $this->callAPISuccess($this->_entity, 'send_test', array(
+ 'mailing_id' => $mail['id'],
+ 'test_email' => NULL,
+ 'test_group' => $groupIDs['inc'],
+ ));
+ $this->assertEquals(3, $deliveredInfo['count'], "in line " . __LINE__); // verify mail has been sent to user by count
+
+ $deliveredContacts = array_values(CRM_Utils_Array::collect('contact_id', $deliveredInfo['values']));
+ $this->assertEquals(array($contactIDs['alice'], $contactIDs['bob'], $contactIDs['carol']), $deliveredContacts);
+
+ $deliveredEmails = array_values(CRM_Utils_Array::collect('email', $deliveredInfo['values']));
+ $this->assertEquals(array('alice@example.org', 'bob@example.org', 'carol@example.org'), $deliveredEmails);
+ }
+
+ /**
+ * @return array
+ */
+ public function submitProvider() {
+ $cases = array(); // $useLogin, $params, $expectedFailure, $expectedJobCount
+ $cases[] = array(
+ TRUE, //useLogin
+ array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'),
+ FALSE, // expectedFailure
+ 1, // expectedJobCount
+ );
+ $cases[] = array(
+ FALSE, //useLogin
+ array('scheduled_date' => '2014-12-13 10:00:00', 'approval_date' => '2014-12-13 00:00:00'),
+ "/Failed to determine current user/", // expectedFailure
+ 0, // expectedJobCount
+ );
+ $cases[] = array(
+ TRUE, //useLogin
+ array('scheduled_date' => '2014-12-13 10:00:00'),
+ FALSE, // expectedFailure
+ 1, // expectedJobCount
+ );
+ $cases[] = array(
+ TRUE, //useLogin
+ array(),
+ "/Missing parameter scheduled_date and.or approval_date/", // expectedFailure
+ 0, // expectedJobCount
+ );
+ return $cases;
+ }
+
+ /**
+ * @param bool $useLogin
+ * @param array $params
+ * @param null|string $expectedFailure
+ * @param int $expectedJobCount
+ * @dataProvider submitProvider
+ */
+ public function testMailerSubmit($useLogin, $params, $expectedFailure, $expectedJobCount) {
+ if ($useLogin) {
+ $this->createLoggedInUser();
+ }
+
+ $id = $this->createDraftMailing();
+
+ $params['id'] = $id;
+ if ($expectedFailure) {
+ $submitResult = $this->callAPIFailure('mailing', 'submit', $params);
+ $this->assertRegExp($expectedFailure, $submitResult['error_message']);
+ }
+ else {
+ $submitResult = $this->callAPIAndDocument('mailing', 'submit', $params, __FUNCTION__, __FILE__);
+ $this->assertTrue(is_numeric($submitResult['id']));
+ $this->assertTrue(is_numeric($submitResult['values'][$id]['scheduled_id']));
+ $this->assertEquals($params['scheduled_date'], $submitResult['values'][$id]['scheduled_date']);
+ }
+ $this->assertDBQuery($expectedJobCount, 'SELECT count(*) FROM civicrm_mailing_job WHERE mailing_id = %1', array(
+ 1 => array($id, 'Integer'),
+ ));
+ }
+
+ public function testMailerStats() {
+ $result = $this->groupContactCreate($this->_groupID, 100);
+ $this->assertEquals(100, $result['added']); //verify if 100 contacts are added for group
+
+ //Create and send test mail first and change the mail job to live,
+ //because stats api only works on live mail
+ $mail = $this->callAPISuccess('mailing', 'create', $this->_params);
+ $params = array('mailing_id' => $mail['id'], 'test_email' => NULL, 'test_group' => $this->_groupID);
+ $deliveredInfo = $this->callAPISuccess($this->_entity, 'send_test', $params);
+ $deliveredIds = implode(',', array_keys($deliveredInfo['values']));
+
+ //Change the test mail into live
+ $sql = "UPDATE civicrm_mailing_job SET is_test = 0 WHERE mailing_id = {$mail['id']}";
+ CRM_Core_DAO::executeQuery($sql);
+
+ foreach (array('bounce', 'unsubscribe', 'opened') as $type) {
+ $sql = "CREATE TEMPORARY TABLE mail_{$type}_temp
+(event_queue_id int, time_stamp datetime, delivered_id int)
+SELECT event_queue_id, time_stamp, id
+ FROM civicrm_mailing_event_delivered
+ WHERE id IN ($deliveredIds)
+ ORDER BY RAND() LIMIT 0,20;";
+ CRM_Core_DAO::executeQuery($sql);
+
+ $sql = "DELETE FROM civicrm_mailing_event_delivered WHERE id IN (SELECT delivered_id FROM mail_{$type}_temp);";
+ CRM_Core_DAO::executeQuery($sql);
+
+ if ($type == 'unsubscribe') {
+ $sql = "INSERT INTO civicrm_mailing_event_{$type} (event_queue_id, time_stamp, org_unsubscribe)
+SELECT event_queue_id, time_stamp, 1 FROM mail_{$type}_temp";
+ }
+ else {
+ $sql = "INSERT INTO civicrm_mailing_event_{$type} (event_queue_id, time_stamp)
+SELECT event_queue_id, time_stamp FROM mail_{$type}_temp";
+ }
+ CRM_Core_DAO::executeQuery($sql);
+ }
+
+ $result = $this->callAPISuccess('mailing', 'stats', array('mailing_id' => $mail['id']));
+ $expectedResult = array(
+ 'Delivered' => 80, //since among 100 mails 20 has been bounced
+ 'Bounces' => 20,
+ 'Opened' => 20,
+ 'Unique Clicks' => 0,
+ 'Unsubscribers' => 20,
+ );
+ $this->checkArrayEquals($expectedResult, $result['values'][$mail['id']]);
+ }
+
/**
* Test civicrm_mailing_delete
*/
public function testMailerDeleteSuccess() {
$result = $this->callAPISuccess($this->_entity, 'create', $this->_params);
- $jobs = $this->callAPIAndDocument($this->_entity, 'delete', array('id' => $result['id']), __FUNCTION__, __FILE__);
+ $this->callAPIAndDocument($this->_entity, 'delete', array('id' => $result['id']), __FUNCTION__, __FILE__);
$this->assertAPIDeleted($this->_entity, $result['id']);
}
'body' => 'Body...',
'time_stamp' => '20111109212100',
);
- $result = $this->callAPIFailure('mailing_event', 'bounce', $params,
+ $this->callAPIFailure('mailing_event', 'bounce', $params,
'Queue event could not be found'
);
}
'event_subscribe_id' => '123',
'time_stamp' => '20111111010101',
);
- $result = $this->callAPIFailure('mailing_event', 'confirm', $params,
+ $this->callAPIFailure('mailing_event', 'confirm', $params,
'Confirmation failed'
);
}
'replyTo' => $this->_email,
'time_stamp' => '20111111010101',
);
- $result = $this->callAPIFailure('mailing_event', 'reply', $params,
+ $this->callAPIFailure('mailing_event', 'reply', $params,
'Queue event could not be found'
);
}
'email' => $this->_email,
'time_stamp' => '20111111010101',
);
- $result = $this->callAPIFailure('mailing_event', 'forward', $params,
+ $this->callAPIFailure('mailing_event', 'forward', $params,
'Queue event could not be found'
);
}
-//----------- civicrm_mailing_create ----------
+ /**
+ * @return array|int
+ */
+ public function createDraftMailing() {
+ $createParams = $this->_params;
+ $createParams['api.mailing_job.create'] = 0; // note: exact match to API default
+ $createResult = $this->callAPISuccess('mailing', 'create', $createParams, __FUNCTION__, __FILE__);
+ $this->assertTrue(is_numeric($createResult['id']));
+ $this->assertDBQuery(0, 'SELECT count(*) FROM civicrm_mailing_job WHERE mailing_id = %1', array(
+ 1 => array($createResult['id'], 'Integer'),
+ ));
+ return $createResult['id'];
+ }
+
+ //----------- civicrm_mailing_create ----------
}
projects / civicrm-core.git / blobdiff