[civicrm-core.git] / tests / phpunit / api / v3 / MailingTest.php

<?php
/*
 *  File for the TestMailing class
 *
 *  (PHP 5)
 *
 *   @package   CiviCRM
 *
 *   This file is part of CiviCRM
 *
 *   CiviCRM is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Affero General Public License
 *   as published by the Free Software Foundation; either version 3 of
 *   the License, or (at your option) any later version.
 *
 *   CiviCRM is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public
 *   License along with this program.  If not, see
 *   <http://www.gnu.org/licenses/>.
 */

require_once 'CiviTest/CiviUnitTestCase.php';


/**
 *  Test APIv3 civicrm_mailing_* functions
 *
 *  @package   CiviCRM
 */
class api_v3_MailingTest extends CiviUnitTestCase {
  protected $_groupID;
  protected $_email;
  protected $_apiversion = 3;
  protected $_params = array();
  protected $_entity = 'Mailing';
  protected $_groupIDs; // array(string $pseudonym => int $id)
  protected $_contactIDs; // array(string $pseudonym => int $id)

  /**
   * @return array
   */
  function get_info() {
    return array(
      'name' => 'Mailer',
      'description' => 'Test all Mailer methods.',
      'group' => 'CiviCRM API Tests',
    );
  }

  function setUp() {
    parent::setUp();
    CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
    $this->_contactIDs = array();
    $this->_contactIDs[] = $this->individualCreate();
    $this->_groupID = $this->groupCreate();
    $this->_groupIDs = array();
    $this->_email = 'test@test.test';
    $this->_params = array(
      'subject' => 'maild',
      'body_text' => "This is {contact.display_name}",
      'name' => 'mailing name',
      'created_id' => $this->_contactIDs[0],
    );
  }

  function tearDown() {
    foreach ($this->_contactIDs as $contactID) {
      $this->contactDelete($contactID);
    }
    $this->groupDelete($this->_groupID);
    foreach ($this->_groupIDs as $groupID) {
      $this->groupDelete($groupID);
    }
    CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
    parent::tearDown();
  }

  /**
   * Test civicrm_mailing_create
   */
  public function testMailerCreateSuccess() {
    $result = $this->callAPIAndDocument('mailing', 'create', $this->_params, __FUNCTION__, __FILE__);
    $jobs = $this->callAPISuccess('mailing_job', 'get', array('mailing_id' => $result['id']));
    $this->assertEquals(1, $jobs['count']);
    unset($this->_params['created_id']); // return isn't working on this in getAndCheck so lets not check it for now
    $this->getAndCheck($this->_params, $result['id'], 'mailing');
  }

  public function testMailerPreview() {
    $contactID =  $this->individualCreate();
    $displayName = $this->callAPISuccess('contact', 'get', array('id' => $contactID));
    $displayName = $displayName['values'][$contactID]['display_name'];

    $result = $this->callAPISuccess('mailing', 'create', $this->_params);

    $params = array('id' => $result['id'], 'contact_id' => $contactID);
    $result = $this->callAPISuccess('mailing', 'preview', $params);
    $text = $result['values']['text'];
    $this->assertEquals("This is $displayName", $text); // verify the text returned is correct, with replaced token
    $this->deleteMailing($result['id']);
  }

  public function testMailerPreviewRecipients() {
    // BEGIN SAMPLE DATA
    $this->groupIDs['inc'] = $this->groupCreate(array('name' => 'Example include group', 'title' => 'Example include group'));
    $this->groupIDs['exc'] = $this->groupCreate(array('name' => 'Example exclude group', 'title' => 'Example exclude group'));
    $this->contactIDs['includeme'] = $this->individualCreate(array('email' => 'include.me@example.org', 'first_name' => 'Includer', 'last_name' => 'Person'));
    $this->contactIDs['excludeme'] = $this->individualCreate(array('email' => 'exclude.me@example.org', 'last_name' => 'Excluder', 'last_name' => 'Excluder'));
    $this->callAPISuccess('GroupContact', 'create', array('group_id' => $this->groupIDs['inc'], 'contact_id' => $this->contactIDs['includeme']));
    $this->callAPISuccess('GroupContact', 'create', array('group_id' => $this->groupIDs['inc'], 'contact_id' => $this->contactIDs['excludeme']));
    $this->callAPISuccess('GroupContact', 'create', array('group_id' => $this->groupIDs['exc'], 'contact_id' => $this->contactIDs['excludeme']));

    $params = $this->_params;
    $params['groups']['include'] = array($this->groupIDs['inc']);
    $params['groups']['exclude'] = array($this->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)$this->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 testMailerSendTestMail() {
    $contactID =  $this->individualCreate();
    $result = $this->callAPISuccess('contact', 'get', array('id' => $contactID));
    $email = $result['values'][$contactID]['email'];

    $mail = $this->callAPISuccess('mailing', 'create', $this->_params);

    $params = array('mailing_id' => $mail['id'], 'test_email' => $email, '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
    $this->assertEquals($contactID, $deliveredInfo['values'][$deliveredInfo['id']]['contact_id'], "in line " . __LINE__); //verify the contact_id of the recipient
    $this->deleteMailing($mail['id']);
  }

  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']]);
    $this->deleteMailing($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->assertAPIDeleted($this->_entity, $result['id']);
  }

  //@ todo tests below here are all failure tests which are not hugely useful - need success tests

  //------------ civicrm_mailing_event_bounce methods------------

  /**
   * Test civicrm_mailing_event_bounce with wrong params.
   * Note that tests like this are slightly better than no test but an
   * api function cannot be considered supported  / 'part of the api' without a
   * success test
   */
  public function testMailerBounceWrongParams() {
    $params = array(
      'job_id' => 'Wrong ID',
      'event_queue_id' => 'Wrong ID',
      'hash' => 'Wrong Hash',
      'body' => 'Body...',
      'time_stamp' => '20111109212100',
    );
    $result = $this->callAPIFailure('mailing_event', 'bounce', $params,
      'Queue event could not be found'
    );
  }

  //----------- civicrm_mailing_event_confirm methods -----------

  /**
   * Test civicrm_mailing_event_confirm with wrong params.
   * Note that tests like this are slightly better than no test but an
   * api function cannot be considered supported  / 'part of the api' without a
   * success test
   */
  public function testMailerConfirmWrongParams() {
    $params = array(
      'contact_id' => 'Wrong ID',
      'subscribe_id' => 'Wrong ID',
      'hash' => 'Wrong Hash',
      'event_subscribe_id' => '123',
      'time_stamp' => '20111111010101',
    );
    $result = $this->callAPIFailure('mailing_event', 'confirm', $params,
      'Confirmation failed'
    );
  }

  //---------- civicrm_mailing_event_reply methods -----------

  /**
   * Test civicrm_mailing_event_reply with wrong params.
   *
   * Note that tests like this are slightly better than no test but an
   * api function cannot be considered supported  / 'part of the api' without a
   * success test
   */
  public function testMailerReplyWrongParams() {
    $params = array(
      'job_id' => 'Wrong ID',
      'event_queue_id' => 'Wrong ID',
      'hash' => 'Wrong Hash',
      'bodyTxt' => 'Body...',
      'replyTo' => $this->_email,
      'time_stamp' => '20111111010101',
    );
    $result = $this->callAPIFailure('mailing_event', 'reply', $params,
      'Queue event could not be found'
    );
  }


  //----------- civicrm_mailing_event_forward methods ----------

  /**
   * Test civicrm_mailing_event_forward with wrong params.
   * Note that tests like this are slightly better than no test but an
   * api function cannot be considered supported  / 'part of the api' without a
   * success test
   */
  public function testMailerForwardWrongParams() {
    $params = array(
      'job_id' => 'Wrong ID',
      'event_queue_id' => 'Wrong ID',
      'hash' => 'Wrong Hash',
      'email' => $this->_email,
      'time_stamp' => '20111111010101',
    );
    $result = $this->callAPIFailure('mailing_event', 'forward', $params,
      'Queue event could not be found'
    );
  }

//----------- civicrm_mailing_create ----------

}
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
	26	require_once 'CiviTest/CiviUnitTestCase.php';
	27
	28
	29	/**
	30	* Test APIv3 civicrm_mailing_* functions
	31	*
	32	* @package CiviCRM
	33	*/
	34	class api_v3_MailingTest extends CiviUnitTestCase {
	35	protected $_groupID;
	36	protected $_email;
c43d01f3	37	protected $_apiversion = 3;
c43d01f3	38	protected $_params = array();
e37b4b04	39	protected $_entity = 'Mailing';
fddd185d TO	40	protected $_groupIDs; // array(string $pseudonym => int $id)
fddd185d TO	41	protected $_contactIDs; // array(string $pseudonym => int $id)
430ae6dd	42
4cbe18b8 EM	43	/**
	44	* @return array
	45	*/
430ae6dd	46	function get_info() {
6a488035 TO	47	return array(
	48	'name' => 'Mailer',
	49	'description' => 'Test all Mailer methods.',
	50	'group' => 'CiviCRM API Tests',
	51	);
	52	}
	53
	54	function setUp() {
	55	parent::setUp();
97b7d4a0	56	CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
fddd185d	57	$this->_contactIDs = array();
7e3920b2	58	$this->_contactIDs[] = $this->individualCreate();
fadb804f	59	$this->_groupID = $this->groupCreate();
fddd185d	60	$this->_groupIDs = array();
ef170fe0	61	$this->_email = 'test@test.test';
c43d01f3	62	$this->_params = array(
c43d01f3	63	'subject' => 'maild',
7811a84b	64	'body_text' => "This is {contact.display_name}",
c43d01f3	65	'name' => 'mailing name',
7e3920b2	66	'created_id' => $this->_contactIDs[0],
c43d01f3	67	);
6a488035 TO	68	}
	69
	70	function tearDown() {
fddd185d TO	71	foreach ($this->_contactIDs as $contactID) {
	72	$this->contactDelete($contactID);
	73	}
6a488035	74	$this->groupDelete($this->_groupID);
fddd185d TO	75	foreach ($this->_groupIDs as $groupID) {
	76	$this->groupDelete($groupID);
	77	}
97b7d4a0 TO	78	CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
97b7d4a0 TO	79	parent::tearDown();
6a488035 TO	80	}
	81
	82	/**
	83	* Test civicrm_mailing_create
	84	*/
	85	public function testMailerCreateSuccess() {
c43d01f3	86	$result = $this->callAPIAndDocument('mailing', 'create', $this->_params, __FUNCTION__, __FILE__);
c43d01f3	87	$jobs = $this->callAPISuccess('mailing_job', 'get', array('mailing_id' => $result['id']));
6a488035	88	$this->assertEquals(1, $jobs['count']);
ef170fe0	89	unset($this->_params['created_id']); // return isn't working on this in getAndCheck so lets not check it for now
e37b4b04	90	$this->getAndCheck($this->_params, $result['id'], 'mailing');
6a488035 TO	91	}
6a488035 TO	92
ef643544	93	public function testMailerPreview() {
	94	$contactID = $this->individualCreate();
	95	$displayName = $this->callAPISuccess('contact', 'get', array('id' => $contactID));
	96	$displayName = $displayName['values'][$contactID]['display_name'];
7811a84b	97
ef643544	98	$result = $this->callAPISuccess('mailing', 'create', $this->_params);
7811a84b	99
ef643544	100	$params = array('id' => $result['id'], 'contact_id' => $contactID);
	101	$result = $this->callAPISuccess('mailing', 'preview', $params);
	102	$text = $result['values']['text'];
ef643544	103	$this->assertEquals("This is $displayName", $text); // verify the text returned is correct, with replaced token
	104	$this->deleteMailing($result['id']);
	105	}
7811a84b	106
fddd185d TO	107	public function testMailerPreviewRecipients() {
	108	// BEGIN SAMPLE DATA
	109	$this->groupIDs['inc'] = $this->groupCreate(array('name' => 'Example include group', 'title' => 'Example include group'));
	110	$this->groupIDs['exc'] = $this->groupCreate(array('name' => 'Example exclude group', 'title' => 'Example exclude group'));
b73e0c53 TO	111	$this->contactIDs['includeme'] = $this->individualCreate(array('email' => 'include.me@example.org', 'first_name' => 'Includer', 'last_name' => 'Person'));
b73e0c53 TO	112	$this->contactIDs['excludeme'] = $this->individualCreate(array('email' => 'exclude.me@example.org', 'last_name' => 'Excluder', 'last_name' => 'Excluder'));
fddd185d TO	113	$this->callAPISuccess('GroupContact', 'create', array('group_id' => $this->groupIDs['inc'], 'contact_id' => $this->contactIDs['includeme']));
	114	$this->callAPISuccess('GroupContact', 'create', array('group_id' => $this->groupIDs['inc'], 'contact_id' => $this->contactIDs['excludeme']));
	115	$this->callAPISuccess('GroupContact', 'create', array('group_id' => $this->groupIDs['exc'], 'contact_id' => $this->contactIDs['excludeme']));
	116
	117	$params = $this->_params;
	118	$params['groups']['include'] = array($this->groupIDs['inc']);
	119	$params['groups']['exclude'] = array($this->groupIDs['exc']);
	120	$params['mailings']['include'] = array();
	121	$params['mailings']['exclude'] = array();
b73e0c53 TO	122	$params['options']['force_rollback'] = 1;
	123	$params['api.MailingRecipients.get'] = array(
	124	'mailing_id' => '$value.id',
	125	'api.contact.getvalue' => array(
	126	'return' => 'display_name',
	127	),
	128	'api.email.getvalue' => array(
	129	'return' => 'email',
	130	),
	131	);
fddd185d TO	132	// END SAMPLE DATA
	133
	134	$maxIDs = array(
	135	'mailing' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing'),
	136	'job' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_job'),
	137	'group' => CRM_Core_DAO::singleValueQuery('SELECT MAX(id) FROM civicrm_mailing_group'),
	138	);
b73e0c53	139	$create = $this->callAPIAndDocument('Mailing', 'create', $params, __FUNCTION__, __FILE__);
fddd185d TO	140	$this->assertDBQuery($maxIDs['mailing'], 'SELECT MAX(id) FROM civicrm_mailing'); // 'Preview should not create any mailing records'
	141	$this->assertDBQuery($maxIDs['job'], 'SELECT MAX(id) FROM civicrm_mailing_job'); // 'Preview should not create any mailing_job record'
	142	$this->assertDBQuery($maxIDs['group'], 'SELECT MAX(id) FROM civicrm_mailing_group'); // 'Preview should not create any mailing_group records'
	143
b73e0c53	144	$preview = $create['values'][$create['id']]['api.MailingRecipients.get'];
fddd185d TO	145	$previewIds = array_values(CRM_Utils_Array::collect('contact_id', $preview['values']));
fddd185d TO	146	$this->assertEquals(array((string)$this->contactIDs['includeme']), $previewIds);
b73e0c53 TO	147	$previewEmails = array_values(CRM_Utils_Array::collect('api.email.getvalue', $preview['values']));
	148	$this->assertEquals(array('include.me@example.org'), $previewEmails);
	149	$previewNames = array_values(CRM_Utils_Array::collect('api.contact.getvalue', $preview['values']));
	150	$this->assertTrue((bool)preg_match('/Includer Person/', $previewNames[0]), "Name 'Includer Person' should appear in '" . $previewNames[0] . '"');
fddd185d TO	151	}
fddd185d TO	152
ef643544	153	public function testMailerSendTestMail() {
	154	$contactID = $this->individualCreate();
	155	$result = $this->callAPISuccess('contact', 'get', array('id' => $contactID));
	156	$email = $result['values'][$contactID]['email'];
7811a84b	157
ef643544	158	$mail = $this->callAPISuccess('mailing', 'create', $this->_params);
7811a84b	159
ef643544	160	$params = array('mailing_id' => $mail['id'], 'test_email' => $email, 'test_group' => NULL);
	161	$deliveredInfo = $this->callAPISuccess($this->_entity, 'send_test', $params);
	162	$this->assertEquals(1, $deliveredInfo['count'], "in line " . __LINE__); // verify mail has been sent to user by count
	163	$this->assertEquals($contactID, $deliveredInfo['values'][$deliveredInfo['id']]['contact_id'], "in line " . __LINE__); //verify the contact_id of the recipient
	164	$this->deleteMailing($mail['id']);
	165	}
7811a84b	166
ef643544	167	public function testMailerStats() {
	168	$result = $this->groupContactCreate($this->_groupID, 100);
	169	$this->assertEquals(100, $result['added']); //verify if 100 contacts are added for group
7811a84b	170
	171	//Create and send test mail first and change the mail job to live,
	172	//because stats api only works on live mail
ef643544	173	$mail = $this->callAPISuccess('mailing', 'create', $this->_params);
7811a84b	174	$params = array('mailing_id' => $mail['id'], 'test_email' => NULL, 'test_group' => $this->_groupID);
ef643544	175	$deliveredInfo = $this->callAPISuccess($this->_entity, 'send_test', $params);
ef643544	176	$deliveredIds = implode(',', array_keys($deliveredInfo['values']));
7811a84b	177
	178	//Change the test mail into live
	179	$sql = "UPDATE civicrm_mailing_job SET is_test = 0 WHERE mailing_id = {$mail['id']}";
	180	CRM_Core_DAO::executeQuery($sql);
	181
ef643544	182	foreach (array('bounce', 'unsubscribe', 'opened') as $type) {
	183	$sql = "CREATE TEMPORARY TABLE mail_{$type}_temp
	184	(event_queue_id int, time_stamp datetime, delivered_id int)
	185	SELECT event_queue_id, time_stamp, id
	186	FROM civicrm_mailing_event_delivered
	187	WHERE id IN ($deliveredIds)
	188	ORDER BY RAND() LIMIT 0,20;";
ef643544	189	CRM_Core_DAO::executeQuery($sql);
7811a84b	190
ef643544	191	$sql = "DELETE FROM civicrm_mailing_event_delivered WHERE id IN (SELECT delivered_id FROM mail_{$type}_temp);";
ef643544	192	CRM_Core_DAO::executeQuery($sql);
7811a84b	193
ef643544	194	if ($type == 'unsubscribe') {
	195	$sql = "INSERT INTO civicrm_mailing_event_{$type} (event_queue_id, time_stamp, org_unsubscribe)
	196	SELECT event_queue_id, time_stamp, 1 FROM mail_{$type}_temp";
	197	}
	198	else {
	199	$sql = "INSERT INTO civicrm_mailing_event_{$type} (event_queue_id, time_stamp)
	200	SELECT event_queue_id, time_stamp FROM mail_{$type}_temp";
	201	}
	202	CRM_Core_DAO::executeQuery($sql);
	203	}
7811a84b	204
ef643544	205	$result = $this->callAPISuccess('mailing', 'stats', array('mailing_id' => $mail['id']));
	206	$expectedResult = array(
	207	'Delivered' => 80, //since among 100 mails 20 has been bounced
	208	'Bounces' => 20,
	209	'Opened' => 20,
	210	'Unique Clicks' => 0,
	211	'Unsubscribers' => 20
	212	);
ef643544	213	$this->checkArrayEquals($expectedResult, $result['values'][$mail['id']]);
7811a84b	214	$this->deleteMailing($mail['id']);
ef643544	215	}
c43d01f3	216	/**
30d44db2	217	* Test civicrm_mailing_delete
c43d01f3	218	*/
c43d01f3	219	public function testMailerDeleteSuccess() {
e37b4b04	220	$result = $this->callAPISuccess($this->_entity, 'create', $this->_params);
	221	$jobs = $this->callAPIAndDocument($this->_entity, 'delete', array('id' => $result['id']), __FUNCTION__, __FILE__);
	222	$this->assertAPIDeleted($this->_entity, $result['id']);
c43d01f3	223	}
6a488035 TO	224
	225	//@ todo tests below here are all failure tests which are not hugely useful - need success tests
	226
	227	//------------ civicrm_mailing_event_bounce methods------------
	228
	229	/**
	230	* Test civicrm_mailing_event_bounce with wrong params.
e37b4b04	231	* Note that tests like this are slightly better than no test but an
	232	* api function cannot be considered supported / 'part of the api' without a
	233	* success test
6a488035 TO	234	*/
	235	public function testMailerBounceWrongParams() {
	236	$params = array(
	237	'job_id' => 'Wrong ID',
	238	'event_queue_id' => 'Wrong ID',
	239	'hash' => 'Wrong Hash',
	240	'body' => 'Body...',
6a488035 TO	241	'time_stamp' => '20111109212100',
6a488035 TO	242	);
e37b4b04	243	$result = $this->callAPIFailure('mailing_event', 'bounce', $params,
30d44db2	244	'Queue event could not be found'
30d44db2	245	);
6a488035 TO	246	}
	247
	248	//----------- civicrm_mailing_event_confirm methods -----------
	249
	250	/**
	251	* Test civicrm_mailing_event_confirm with wrong params.
e37b4b04	252	* Note that tests like this are slightly better than no test but an
	253	* api function cannot be considered supported / 'part of the api' without a
	254	* success test
6a488035 TO	255	*/
	256	public function testMailerConfirmWrongParams() {
	257	$params = array(
	258	'contact_id' => 'Wrong ID',
	259	'subscribe_id' => 'Wrong ID',
	260	'hash' => 'Wrong Hash',
	261	'event_subscribe_id' => '123',
	262	'time_stamp' => '20111111010101',
ef170fe0	263	);
e37b4b04	264	$result = $this->callAPIFailure('mailing_event', 'confirm', $params,
	265	'Confirmation failed'
	266	);
6a488035 TO	267	}
	268
	269	//---------- civicrm_mailing_event_reply methods -----------
	270
	271	/**
	272	* Test civicrm_mailing_event_reply with wrong params.
e37b4b04	273	*
	274	* Note that tests like this are slightly better than no test but an
	275	* api function cannot be considered supported / 'part of the api' without a
	276	* success test
6a488035 TO	277	*/
	278	public function testMailerReplyWrongParams() {
	279	$params = array(
	280	'job_id' => 'Wrong ID',
	281	'event_queue_id' => 'Wrong ID',
	282	'hash' => 'Wrong Hash',
	283	'bodyTxt' => 'Body...',
	284	'replyTo' => $this->_email,
	285	'time_stamp' => '20111111010101',
ef170fe0	286	);
e37b4b04	287	$result = $this->callAPIFailure('mailing_event', 'reply', $params,
e37b4b04	288	'Queue event could not be found'
30d44db2	289	);
6a488035 TO	290	}
	291
	292
	293	//----------- civicrm_mailing_event_forward methods ----------
	294
	295	/**
	296	* Test civicrm_mailing_event_forward with wrong params.
e37b4b04	297	* Note that tests like this are slightly better than no test but an
	298	* api function cannot be considered supported / 'part of the api' without a
	299	* success test
6a488035 TO	300	*/
	301	public function testMailerForwardWrongParams() {
	302	$params = array(
	303	'job_id' => 'Wrong ID',
	304	'event_queue_id' => 'Wrong ID',
	305	'hash' => 'Wrong Hash',
	306	'email' => $this->_email,
	307	'time_stamp' => '20111111010101',
ef170fe0	308	);
e37b4b04	309	$result = $this->callAPIFailure('mailing_event', 'forward', $params,
	310	'Queue event could not be found'
	311	);
6a488035 TO	312	}
6a488035 TO	313
6a488035 TO	314	//----------- civicrm_mailing_create ----------
	315
	316	}