3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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
32 * @subpackage API_MailingContact
34 * @copyright CiviCRM LLC (c) 2004-2019
35 * @version $Id: Job.php 30879 2010-11-22 15:45:55Z shot $
39 * Class api_v3_MailingContactTest
42 class api_v3_MailingContactTest
extends CiviUnitTestCase
{
43 protected $_entity = 'mailing';
45 public function setUp() {
48 'first_name' => 'abc1',
49 'contact_type' => 'Individual',
50 'last_name' => 'xyz1',
52 $this->_contact
= $this->callAPISuccess("contact", "create", $params);
55 public function tearDown() {
56 $this->callAPISuccess("contact", "delete", ['id' => $this->_contact
['id']]);
61 * Test that the api responds correctly to null params.
63 * Do not copy and paste.
65 * Tests like this that test the wrapper belong in the SyntaxConformance class
66 * (which already has a 'not array test)
67 * I have left this here in case 'null' isn't covered in that class
68 * but don't copy it only any other classes
70 public function testMailingNullParams() {
71 $this->callAPIFailure('MailingContact', 'get', NULL);
74 public function testMailingContactGetFields() {
75 $result = $this->callAPISuccess('MailingContact', 'getfields', [
78 $this->assertEquals('Delivered', $result['values']['type']['api.default']);
82 * Test for proper error when you do not supply the contact_id.
84 * Do not copy and paste.
86 * Test is of marginal if any value & testing of wrapper level functionality
87 * belongs in the SyntaxConformance class
89 public function testMailingNoContactID() {
90 $this->callAPIFailure('MailingContact', 'get', ['something' => 'This is not a real field']);
94 * Test that invalid contact_id return with proper error messages.
96 * Do not copy & paste.
98 * Test is of marginal if any value & testing of wrapper level functionality
99 * belongs in the SyntaxConformance class
101 public function testMailingContactInvalidContactID() {
102 $this->callAPIFailure('MailingContact', 'get', ['contact_id' => 'This is not a number']);
106 * Test that invalid types are returned with appropriate errors.
108 public function testMailingContactInvalidType() {
113 $this->callAPIFailure('MailingContact', 'get', $params);
117 * Test for success result when there are no mailings for a the given contact.
119 public function testMailingContactNoMailings() {
121 'contact_id' => $this->_contact
['id'],
123 $result = $this->callAPISuccess('MailingContact', 'get', $params);
124 $this->assertEquals($result['count'], 0);
125 $this->assertTrue(empty($result['values']));
129 * Test that the API returns a mailing properly when there is only one.
131 public function testMailingContactDelivered() {
132 list($contactID, $mailingID, $eventQueueID) = $this->setupEventQueue();
133 CRM_Core_DAO
::executeQuery("INSERT INTO civicrm_mailing_event_delivered (event_queue_id) VALUES(%1)", [1 => [$eventQueueID, 'Integer']]);
136 'contact_id' => $contactID,
137 'type' => 'Delivered',
140 $result = $this->callAPISuccess('MailingContact', 'get', $params);
141 $count = $this->callAPISuccess('MailingContact', 'getcount', $params);
142 $this->assertEquals($result['count'], 1);
143 $this->assertEquals($count, 1);
144 $this->assertFalse(empty($result['values']));
145 $this->assertEquals($result['values'][1]['mailing_id'], 1);
146 $this->assertEquals($result['values'][1]['subject'], "Some Subject");
147 $this->assertEquals(CRM_Core_Session
::getLoggedInContactID(), $result['values'][1]['creator_id']);
151 * Test that the API returns only the "Bounced" mailings when instructed to
156 public function testMailingContactBounced() {
157 list($contactID, $mailingID, $eventQueueID) = $this->setupEventQueue();
158 CRM_Core_DAO
::executeQuery("INSERT INTO civicrm_mailing_event_bounce (event_queue_id, bounce_type_id) VALUES(%1, 6)", [1 => [$eventQueueID, 'Integer']]);
161 'contact_id' => $contactID,
165 $result = $this->callAPISuccess('MailingContact', 'get', $params)['values'];
166 $this->assertEquals(1, count($result));
167 $this->assertEquals($mailingID, $result[$mailingID]['mailing_id']);
168 $this->assertEquals('Some Subject', $result[$mailingID]['subject']);
169 $this->assertEquals(CRM_Core_Session
::getLoggedInContactID(), $result[$mailingID]['creator_id'], 3);
176 public function setupEventQueue() {
177 $contactID = $this->individualCreate(['first_name' => 'Test']);
178 $emailID = $this->callAPISuccessGetValue('Email', [
180 'contact_id' => $contactID,
182 $this->createLoggedInUser();
183 $mailingID = $this->callAPISuccess('Mailing', 'create', [
184 'name' => 'Test Mailing',
185 'subject' => 'Some Subject',
187 $mailingJobID = $this->callAPISuccess('MailingJob', 'create', ['mailing_id' => $mailingID])['id'];
188 $eventQueueID = $this->callAPISuccess('MailingEventQueue', 'create', [
189 'contact_id' => $contactID,
190 'mailing_id' => $mailingID,
191 'email_id' => $emailID,
192 'job_id' => $mailingJobID,
194 return [$contactID, $mailingID, $eventQueueID];