Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[NFC] CRM-21739 Test improvements for mailing getRecipients #11642

Merged
merged 3 commits into from
Feb 27, 2018
Merged

[NFC] CRM-21739 Test improvements for mailing getRecipients #11642

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
251a884
Fix primary mobile number test for CRM-21320
JKingsnorth Feb 6, 2018
7ff80da
CRM-21739 Test for getRecipients in/exclude mailing groups
JKingsnorth Feb 26, 2018
6ff6f4f
CRM-21739 [NFC] Refactoring for SMS recipient test
JKingsnorth Feb 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 175 additions & 14 deletions tests/phpunit/CRM/Mailing/BAO/MailingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,177 @@ public function setUp() {
parent::setUp();
}

/**
* Helper function to assert whether the calculated recipients of a mailing
* match the expected list
*
* @param $mailingID
* @param $expectedRecipients array
* Array of contact ID that should be in the recipient list.
*/
private function assertRecipientsCorrect($mailingID, $expectedRecipients) {

// Reset keys to ensure match
$expectedRecipients = array_values($expectedRecipients);

// Load the recipients as a list of contact IDs
CRM_Mailing_BAO_Mailing::getRecipients($mailingID);
$recipients = $this->callAPISuccess('MailingRecipients', 'get', array('mailing_id' => $mailingID));
$contactIDs = array();
foreach ($recipients['values'] as $recipient) {
$contactIDs[] = $recipient['contact_id'];
}

// Check the lists match
$this->assertTreeEquals($expectedRecipients, $contactIDs);
}

/**
* Helper function to create a mailing include/exclude group.
*
* @param $mailingID
* @param $groupID
* @param string $type
* @return array|int
*/
private function createMailingGroup($mailingID, $groupID, $type = 'Include') {
return $this->callAPISuccess('MailingGroup', 'create', array(
'mailing_id' => $mailingID,
'group_type' => $type,
'entity_table' => "civicrm_group",
'entity_id' => $groupID,
));
}

/**
* @todo Missing tests:
* - Ensure opt out emails are not mailed
* - Ensure 'stop' emails are not mailed
* - Ensure the deceased are not mailed
* - Tests for getLocationFilterAndOrderBy (selecting correct 'type')
* - ...
*/

/**
* Test to ensure that static and smart mailing groups can be added to an
* email mailing as 'include' or 'exclude' groups - and the members are
* included or excluded appropriately.
*
* contact 0 : static 0 (inc) + smart 5 (exc)
* contact 1 : static 0 (inc)
* contact 2 : static 1 (inc)
* contact 3 : static 1 (inc)
* contact 4 : static 2 (exc) + smart 3 (inc)
* contact 5 : smart 3 (inc)
* contact 6 : smart 4 (inc)
* contact 7 : smart 4 (inc)
*/
public function testgetRecipientsEmailGroupIncludeExclude() {

// Set up groups; 3 standard, 3 smart
$groupIDs = array();
for ($i = 0; $i < 6; $i++) {
$params = array(
'name' => 'Test static group ' . $i,
'title' => 'Test static group ' . $i,
'is_active' => 1,
);
if ($i < 3) {
$groupIDs[$i] = $this->groupCreate($params);
}
else {
$groupIDs[$i] = $this->smartGroupCreate(array(
'formValues' => array('last_name' => 'smart' . $i),
), $params);
}
}

// Create contacts
$contactIDs = array(
0 => $this->individualCreate(array('last_name' => 'smart5'), 0),
1 => $this->individualCreate(array(), 1),
2 => $this->individualCreate(array(), 2),
3 => $this->individualCreate(array(), 3),
4 => $this->individualCreate(array('last_name' => 'smart3'), 4),
5 => $this->individualCreate(array('last_name' => 'smart3'), 5),
6 => $this->individualCreate(array('last_name' => 'smart4'), 6),
7 => $this->individualCreate(array('last_name' => 'smart4'), 7),
);

// Add contacts to static groups
$this->callAPISuccess('GroupContact', 'Create', array(
'group_id' => $groupIDs[0],
'contact_id' => $contactIDs[0],
));
$this->callAPISuccess('GroupContact', 'Create', array(
'group_id' => $groupIDs[0],
'contact_id' => $contactIDs[1],
));
$this->callAPISuccess('GroupContact', 'Create', array(
'group_id' => $groupIDs[1],
'contact_id' => $contactIDs[2],
));
$this->callAPISuccess('GroupContact', 'Create', array(
'group_id' => $groupIDs[1],
'contact_id' => $contactIDs[3],
));
$this->callAPISuccess('GroupContact', 'Create', array(
'group_id' => $groupIDs[2],
'contact_id' => $contactIDs[4],
));

// Force rebuild the smart groups
for ($i = 3; $i < 6; $i++) {
$group = new CRM_Contact_DAO_Group();
$group->id = $groupIDs[$i];
$group->find(TRUE);
CRM_Contact_BAO_GroupContactCache::load($group, TRUE);
}

// Check that we can include static groups in the mailing.
// Expected: Contacts [0-3] should be included.
$mailing = $this->callAPISuccess('Mailing', 'create', array());
$this->createMailingGroup($mailing['id'], $groupIDs[0]);
$this->createMailingGroup($mailing['id'], $groupIDs[1]);
$expected = $contactIDs;
unset($expected[4], $expected[5], $expected[6], $expected[7]);
$this->assertRecipientsCorrect($mailing['id'], $expected);

// Check that we can include smart groups in the mailing too.
// Expected: All contacts should be included.
$this->createMailingGroup($mailing['id'], $groupIDs[3]);
$this->createMailingGroup($mailing['id'], $groupIDs[4]);
$this->assertRecipientsCorrect($mailing['id'], $contactIDs);

// Check we can exclude static groups from the mailing.
// Expected: All contacts except [4]
$this->createMailingGroup($mailing['id'], $groupIDs[2], 'Exclude');
$expected = $contactIDs;
unset($expected[4]);
$this->assertRecipientsCorrect($mailing['id'], $expected);

// Check we can exclude smart groups from the mailing too.
// Expected: All contacts except [0] and [4]
$this->createMailingGroup($mailing['id'], $groupIDs[5], 'Exclude');
$expected = $contactIDs;
unset($expected[0], $expected[4]);
$this->assertRecipientsCorrect($mailing['id'], $expected);

// Tear down: delete mailing, groups, contacts
$this->deleteMailing($mailing['id']);
foreach ($groupIDs as $groupID) {
$this->groupDelete($groupID);
}
foreach ($contactIDs as $contactID) {
$this->contactDelete($contactID);
}

}

/**
* Test CRM_Mailing_BAO_Mailing::getRecipients() on sms mode
*/
public function testgetRecipients() {
public function testgetRecipientsSMS() {
// Tests for SMS bulk mailing recipients
// +CRM-21320 Ensure primary mobile number is selected over non-primary

Expand Down Expand Up @@ -87,20 +254,21 @@ public function testgetRecipients() {
'is_primary' => 0,
))),
),
// Create the non-primary with a lower ID than the primary, to test CRM-21320
$contactID2 => array(
'primary_phone_id' => CRM_Utils_Array::value('id', $this->callAPISuccess('Phone', 'create', array(
'other_phone_id' => CRM_Utils_Array::value('id', $this->callAPISuccess('Phone', 'create', array(
'contact_id' => $contactID2,
'phone' => "02 01",
'location_type_id' => "Home",
'phone_type_id' => "Mobile",
'is_primary' => 1,
'is_primary' => 0,
))),
'other_phone_id' => CRM_Utils_Array::value('id', $this->callAPISuccess('Phone', 'create', array(
'primary_phone_id' => CRM_Utils_Array::value('id', $this->callAPISuccess('Phone', 'create', array(
'contact_id' => $contactID2,
'phone' => "02 02",
'location_type_id' => "Work",
'phone_type_id' => "Mobile",
'is_primary' => 0,
'is_primary' => 1,
))),
),
);
Expand All @@ -113,17 +281,10 @@ public function testgetRecipients() {

// Create mailing
$mailing = $this->callAPISuccess('Mailing', 'create', array('sms_provider_id' => $sms_provider['id']));
$mailing_include_group = $this->callAPISuccess('MailingGroup', 'create', array(
'mailing_id' => $mailing['id'],
'group_type' => "Include",
'entity_table' => "civicrm_group",
'entity_id' => $group,
));

// Populate the recipients table (job id doesn't matter)
CRM_Mailing_BAO_Mailing::getRecipients($mailing['id']);
$mailingInclude = $this->createMailingGroup($mailing['id'], $group);

// Get recipients
CRM_Mailing_BAO_Mailing::getRecipients($mailing['id']);
$recipients = $this->callAPISuccess('MailingRecipients', 'get', array('mailing_id' => $mailing['id']));

// Check the count is correct
Expand Down