tests/phpunit/api/v3/MailingABTest.php

   1 <?php
   2 /*
   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_mailingab_* functions
  31  *
  32  * @package   CiviCRM
  33  */
  34 class api_v3_MailingABTest extends CiviUnitTestCase {
  35   protected $_mailingID_A;
  36   protected $_mailingID_B;
  37   protected $_mailingID_C;
  38   protected $_params;
  39   protected $_apiversion = 3;
  40   protected $_entity = 'MailingAB';
  41   protected $_groupID;
  42
  43   public function setUp() {
  44     parent::setUp();
  45     $this->useTransaction(TRUE);
  46     $this->createLoggedInUser();
  47     $this->_mailingID_A = $this->createMailing();
  48     $this->_mailingID_B = $this->createMailing();
  49     $this->_mailingID_C = $this->createMailing();
  50     $this->_groupID = $this->groupCreate();
  51
  52     $this->_params = array(
  53       'mailing_id_a' => $this->_mailingID_A,
  54       'mailing_id_b' => $this->_mailingID_B,
  55       'mailing_id_c' => $this->_mailingID_C,
  56       'testing_criteria' => 'subject',
  57       'winner_criteria' => 'open',
  58       'declare_winning_time' => '+2 days',
  59       'group_percentage' => 10,
  60     );
  61   }
  62
  63   /**
  64    * Test civicrm_mailing_create.
  65    */
  66   public function testMailingABCreateSuccess() {
  67     $result = $this->callAPIAndDocument($this->_entity, 'create', $this->_params, __FUNCTION__, __FILE__);
  68     $this->assertTrue(is_numeric($result['id']), "In line " . __LINE__);
  69     $this->assertEquals($this->_params['group_percentage'], $result['values'][$result['id']]['group_percentage']);
  70   }
  71
  72   /**
  73    * Test civicrm_mailing_delete.
  74    */
  75   public function testMailerDeleteSuccess() {
  76     $result = $this->callAPISuccess($this->_entity, 'create', $this->_params);
  77
  78     $this->assertDBQuery(1, "SELECT count(*) FROM civicrm_mailing_abtest WHERE id = %1", array(
  79       1 => array($result['id'], 'Integer'),
  80     ));
  81     $this->assertDBQuery(3, "SELECT count(*) FROM civicrm_mailing WHERE id IN (%1,%2,%3)", array(
  82       1 => array($this->_mailingID_A, 'Integer'),
  83       2 => array($this->_mailingID_B, 'Integer'),
  84       3 => array($this->_mailingID_C, 'Integer'),
  85     ));
  86
  87     $this->callAPISuccess($this->_entity, 'delete', array('id' => $result['id']));
  88
  89     $this->assertDBQuery(0, "SELECT count(*) FROM civicrm_mailing_abtest WHERE id = %1", array(
  90       1 => array($result['id'], 'Integer'),
  91     ));
  92     $this->assertDBQuery(0, "SELECT count(*) FROM civicrm_mailing WHERE id IN (%1,%2,%3)", array(
  93       1 => array($this->_mailingID_A, 'Integer'),
  94       2 => array($this->_mailingID_B, 'Integer'),
  95       3 => array($this->_mailingID_C, 'Integer'),
  96     ));
  97   }
  98
  99   /**
 100    * @return array
 101    */
 102   public function groupPctProvider() {
 103     $cases = array(); // array(int $totalSize, int $groupPct, int $expectedCountA, $expectedCountB, $expectedCountC)
 104     $cases[] = array(400, 7, 28, 28, 344);
 105     $cases[] = array(100, 10, 10, 10, 80);
 106     $cases[] = array(50, 20, 10, 10, 30);
 107     $cases[] = array(50, 10, 5, 5, 40);
 108     $cases[] = array(3, 10, 1, 1, 1);
 109     $cases[] = array(2, 10, 1, 1, 0);
 110     $cases[] = array(1, 10, 1, 0, 0);
 111     return $cases;
 112   }
 113
 114   /**
 115    * Create a test and ensure that all three mailings (A/B/C) wind up with the correct
 116    * number of recipients.
 117    *
 118    * @param $totalGroupContacts
 119    * @param $groupPct
 120    * @param $expectedCountA
 121    * @param $expectedCountB
 122    * @param $expectedCountC
 123    * @dataProvider groupPctProvider
 124    */
 125   public function testDistribution($totalGroupContacts, $groupPct, $expectedCountA, $expectedCountB, $expectedCountC) {
 126     $this->createLoggedInUser();
 127
 128     $result = $this->groupContactCreate($this->_groupID, $totalGroupContacts);
 129     $this->assertEquals($totalGroupContacts, $result['added'], "in line " . __LINE__);
 130
 131     $params = $this->_params;
 132     $params['group_percentage'] = $groupPct;
 133     $result = $this->callAPISuccess($this->_entity, 'create', $params);
 134
 135     $this->callAPISuccess('Mailing', 'create', array(
 136       'id' => $this->_mailingID_A,
 137       'groups' => array('include' => array($this->_groupID)),
 138     ));
 139     $this->assertJobCounts(0, 0, 0);
 140
 141     $this->callAPISuccess('MailingAB', 'submit', array(
 142       'id' => $result['id'],
 143       'status' => 'Testing',
 144       'scheduled_date' => date('YmdHis'),
 145       'approval_date' => date('YmdHis'),
 146     ));
 147     $this->assertRecipientCounts($expectedCountA, $expectedCountB, $expectedCountC);
 148     $this->assertJobCounts(1, 1, 0);
 149
 150     $this->callAPISuccess('MailingAB', 'submit', array(
 151       'id' => $result['id'],
 152       'status' => 'Final',
 153       'scheduled_date' => date('YmdHis'),
 154       'approval_date' => date('YmdHis'),
 155     ));
 156     $this->assertRecipientCounts($expectedCountA, $expectedCountB, $expectedCountC);
 157     $this->assertJobCounts(1, 1, 1);
 158   }
 159
 160   /**
 161    * @param $expectedCountA
 162    * @param $expectedCountB
 163    * @param $expectedCountC
 164    */
 165   protected function assertRecipientCounts($expectedCountA, $expectedCountB, $expectedCountC) {
 166     $countA = $this->callAPISuccess('MailingRecipients', 'getcount', array('mailing_id' => $this->_mailingID_A));
 167     $countB = $this->callAPISuccess('MailingRecipients', 'getcount', array('mailing_id' => $this->_mailingID_B));
 168     $countC = $this->callAPISuccess('MailingRecipients', 'getcount', array('mailing_id' => $this->_mailingID_C));
 169     $this->assertEquals($expectedCountA, $countA, "check mailing recipients A in line " . __LINE__);
 170     $this->assertEquals($expectedCountB, $countB, "check mailing recipients B in line " . __LINE__);
 171     $this->assertEquals($expectedCountC, $countC, "check mailing recipients C in line " . __LINE__);
 172   }
 173
 174   /**
 175    * @param $expectedA
 176    * @param $expectedB
 177    * @param $expectedC
 178    */
 179   protected function assertJobCounts($expectedA, $expectedB, $expectedC) {
 180     $this->assertDBQuery($expectedA, 'SELECT count(*) FROM civicrm_mailing_job WHERE mailing_id = %1', array(
 181       1 => array(
 182         $this->_mailingID_A,
 183         'Integer',
 184       ),
 185     ));
 186     $this->assertDBQuery($expectedB, 'SELECT count(*) FROM civicrm_mailing_job WHERE mailing_id = %1', array(
 187       1 => array(
 188         $this->_mailingID_B,
 189         'Integer',
 190       ),
 191     ));
 192     $this->assertDBQuery($expectedC, 'SELECT count(*) FROM civicrm_mailing_job WHERE mailing_id = %1', array(
 193       1 => array(
 194         $this->_mailingID_C,
 195         'Integer',
 196       ),
 197     ));
 198   }
 199
 200 }