tests/phpunit/api/v3/JobProcessMailingTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * File for the CiviCRM APIv3 job functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Job
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2015
  35  * @version $Id: Job.php 30879 2010-11-22 15:45:55Z shot $
  36  *
  37  */
  38 require_once 'CiviTest/CiviUnitTestCase.php';
  39 //@todo - why doesn't class loader find these (I tried renaming)
  40 require_once 'CiviTest/CiviMailUtils.php';
  41
  42 /**
  43  * Class api_v3_JobTest
  44  */
  45 class api_v3_JobProcessMailingTest extends CiviUnitTestCase {
  46   protected $_apiversion = 3;
  47
  48   public $DBResetRequired = FALSE;
  49   public $_entity = 'Job';
  50   public $_params = array();
  51   private $_groupID;
  52   private $_email;
  53
  54   /**
  55    * @var CiviMailUtils
  56    */
  57   private $_mut;
  58
  59   public function setUp() {
  60     parent::setUp();
  61     $this->useTransaction();
  62     CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
  63     $this->_groupID = $this->groupCreate();
  64     $this->_email = 'test@test.test';
  65     $this->_params = array(
  66       'subject' => 'Accidents in cars cause children',
  67       'body_text' => 'BEWARE children need regular infusions of toys. Santa knows your {domain.address}. There is no {action.optOutUrl}.',
  68       'name' => 'mailing name',
  69       'created_id' => 1,
  70       'groups' => array('include' => array($this->_groupID)),
  71       'scheduled_date' => 'now',
  72     );
  73     $this->_mut = new CiviMailUtils($this, TRUE);
  74     $this->callAPISuccess('mail_settings', 'get', array('api.mail_settings.create' => array('domain' => 'chaos.org')));
  75   }
  76
  77   /**
  78    */
  79   public function tearDown() {
  80     $this->_mut->stop();
  81     //    $this->quickCleanup(array('civicrm_mailing', 'civicrm_mailing_job', 'civicrm_contact'));
  82     CRM_Utils_Hook::singleton()->reset();
  83     CRM_Mailing_BAO_MailingJob::$mailsProcessed = 0; // DGW
  84     parent::tearDown();
  85
  86   }
  87
  88   /**
  89    * Check mailing is sent.
  90    */
  91   public function testProcessMailing() {
  92     $this->createContactsInGroup(10, $this->_groupID);
  93     CRM_Core_Config::singleton()->mailerBatchLimit = 2;
  94     $this->callAPISuccess('mailing', 'create', $this->_params);
  95     $this->callAPISuccess('job', 'process_mailing', array());
  96     $this->_mut->assertRecipients($this->getRecipients(1, 2));
  97   }
  98
  99   /**
 100    * @param int $count
 101    * @param int $groupID
 102    */
 103   public function createContactsInGroup($count, $groupID) {
 104     for ($i = 1; $i <= $count; $i++) {
 105       $contactID = $this->individualCreate(array('first_name' => $count, 'email' => 'mail' . $i . '@nul.com'));
 106       $this->callAPISuccess('group_contact', 'create', array(
 107           'contact_id' => $contactID,
 108           'group_id' => $groupID,
 109           'status' => 'Added',
 110         ));
 111     }
 112   }
 113
 114   /**
 115    * @param int $start
 116    * @param int $count
 117    *
 118    * @return array
 119    */
 120   public function getRecipients($start, $count) {
 121     $recipients = array();
 122     for ($i = $start; $i < ($start + $count); $i++) {
 123       $recipients[][0] = 'mail' . $i . '@nul.com';
 124     }
 125     return $recipients;
 126   }
 127
 128 }