4 * Class CRM_Activity_BAO_ActivityTest
7 class CRM_Activity_BAO_ActivityTest
extends CiviUnitTestCase
{
8 public function setUp() {
10 $this->prepareForACLs();
11 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('view all contacts', 'access CiviCRM');
15 * Clean up after tests.
17 public function tearDown() {
18 $tablesToTruncate = array('civicrm_activity', 'civicrm_activity_contact');
19 $this->quickCleanup($tablesToTruncate);
20 $this->cleanUpAfterACLs();
25 * Test case for create() method.
27 public function testCreate() {
28 $contactId = $this->individualCreate();
31 'source_contact_id' => $contactId,
32 'subject' => 'Scheduling Meeting',
33 'activity_type_id' => 2,
36 CRM_Activity_BAO_Activity
::create($params);
38 $activityId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
39 'subject', 'Database check for created activity.'
42 // Now call create() to modify an existing Activity.
45 'source_contact_id' => $contactId,
46 'subject' => 'Scheduling Interview',
47 'activity_type_id' => 3,
50 CRM_Activity_BAO_Activity
::create($params);
52 $activityTypeId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Interview',
54 'subject', 'Database check on updated activity record.'
56 $this->assertEquals($activityTypeId, 3, 'Verify activity type id is 3.');
58 $this->contactDelete($contactId);
62 * Test case for getContactActivity() method.
64 * getContactActivity() method get activities detail for given target contact id.
66 public function testGetContactActivity() {
67 $contactId = $this->individualCreate();
69 'first_name' => 'liz',
70 'last_name' => 'hurleey',
72 $targetContactId = $this->individualCreate($params);
75 'source_contact_id' => $contactId,
76 'subject' => 'Scheduling Meeting',
77 'activity_type_id' => 2,
78 'target_contact_id' => array($targetContactId),
79 'activity_date_time' => date('Ymd'),
82 $this->callAPISuccess('Activity', 'create', $params);
84 $activityId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting',
86 'subject', 'Database check for created activity.'
89 // @todo - remove this deprecated functions
90 $activities = CRM_Activity_BAO_Activity
::getContactActivity($targetContactId);
92 $this->assertEquals($activities[$activityId]['subject'], 'Scheduling Meeting', 'Verify activity subject is correct.');
94 $this->contactDelete($contactId);
95 $this->contactDelete($targetContactId);
99 * Test case for retrieve() method.
101 * Retrieve($params, $defaults) method return activity detail for given params
104 public function testRetrieve() {
105 $contactId = $this->individualCreate();
107 'first_name' => 'liz',
108 'last_name' => 'hurleey',
110 $targetContactId = $this->individualCreate($params);
113 'source_contact_id' => $contactId,
114 'subject' => 'Scheduling Meeting',
115 'activity_type_id' => 2,
116 'target_contact_id' => array($targetContactId),
117 'activity_date_time' => date('Ymd'),
120 CRM_Activity_BAO_Activity
::create($params);
122 $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
123 'subject', 'Database check for created activity.'
126 $this->assertDBNotNull('CRM_Activity_DAO_ActivityContact', $targetContactId,
128 'Database check for created activity target.'
132 $activity = CRM_Activity_BAO_Activity
::retrieve($params, $defaults);
134 $this->assertEquals($activity->subject
, 'Scheduling Meeting', 'Verify activity subject is correct.');
135 $this->assertEquals($activity->activity_type_id
, 2, 'Verify activity type id is correct.');
136 $this->assertEquals($defaults['source_contact_id'], $contactId, 'Verify source contact id is correct.');
138 $this->assertEquals($defaults['subject'], 'Scheduling Meeting', 'Verify activity subject is correct.');
139 $this->assertEquals($defaults['activity_type_id'], 2, 'Verify activity type id is correct.');
141 $this->assertEquals($defaults['target_contact'][0], $targetContactId, 'Verify target contact id is correct.');
143 $this->contactDelete($contactId);
144 $this->contactDelete($targetContactId);
148 * Test case for deleteActivity() method.
150 * deleteActivity($params) method deletes activity for given params.
152 public function testDeleteActivity() {
153 $contactId = $this->individualCreate();
155 'first_name' => 'liz',
156 'last_name' => 'hurleey',
158 $targetContactId = $this->individualCreate($params);
161 'source_contact_id' => $contactId,
162 'source_record_id' => $contactId,
163 'subject' => 'Scheduling Meeting',
164 'activity_type_id' => 2,
165 'target_contact_id' => array($targetContactId),
166 'activity_date_time' => date('Ymd'),
169 CRM_Activity_BAO_Activity
::create($params);
171 $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
172 'subject', 'Database check for created activity.'
175 $this->assertDBNotNull('CRM_Activity_DAO_ActivityContact', $targetContactId,
177 'Database check for created activity target.'
180 'source_contact_id' => $contactId,
181 'source_record_id' => $contactId,
182 'subject' => 'Scheduling Meeting',
183 'activity_type_id' => 2,
186 CRM_Activity_BAO_Activity
::deleteActivity($params);
188 $this->assertDBNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
189 'subject', 'Database check for deleted activity.'
191 $this->contactDelete($contactId);
192 $this->contactDelete($targetContactId);
196 * Test case for deleteActivityTarget() method.
198 * deleteActivityTarget($activityId) method deletes activity target for given activity id.
200 public function testDeleteActivityTarget() {
201 $contactId = $this->individualCreate();
203 'first_name' => 'liz',
204 'last_name' => 'hurleey',
206 $targetContactId = $this->individualCreate($params);
209 'source_contact_id' => $contactId,
210 'subject' => 'Scheduling Meeting',
211 'activity_type_id' => 2,
212 'target_contact_id' => array($targetContactId),
213 'activity_date_time' => date('Ymd'),
216 CRM_Activity_BAO_Activity
::create($params);
218 $activityId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
219 'subject', 'Database check for created activity.'
222 $this->assertDBNotNull('CRM_Activity_DAO_ActivityContact', $targetContactId,
224 'Database check for created activity target.'
227 CRM_Activity_BAO_Activity
::deleteActivityContact($activityId, 3);
229 $this->assertDBNull('CRM_Activity_DAO_ActivityContact', $targetContactId, 'id',
230 'contact_id', 'Database check for deleted activity target.'
233 $this->contactDelete($contactId);
234 $this->contactDelete($targetContactId);
238 * Test case for deleteActivityAssignment() method.
240 * deleteActivityAssignment($activityId) method deletes activity assignment for given activity id.
242 public function testDeleteActivityAssignment() {
243 $contactId = $this->individualCreate();
245 'first_name' => 'liz',
246 'last_name' => 'hurleey',
248 $assigneeContactId = $this->individualCreate($params);
251 'source_contact_id' => $contactId,
252 'subject' => 'Scheduling Meeting',
253 'activity_type_id' => 2,
254 'assignee_contact_id' => array($assigneeContactId),
255 'activity_date_time' => date('Ymd'),
258 CRM_Activity_BAO_Activity
::create($params);
260 $activityId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
261 'subject', 'Database check for created activity.'
264 $this->assertDBNotNull('CRM_Activity_DAO_ActivityContact',
265 $assigneeContactId, 'id', 'contact_id',
266 'Database check for created activity assignment.'
269 CRM_Activity_BAO_Activity
::deleteActivityContact($activityId, 1);
271 $this->assertDBNull('CRM_Activity_DAO_ActivityContact', $assigneeContactId, 'id',
272 'contact_id', 'Database check for deleted activity assignment.'
275 $this->contactDelete($contactId);
276 $this->contactDelete($assigneeContactId);
280 * Test getActivities BAO method for getting count.
282 public function testGetActivitiesCountForAdminDashboard() {
283 $this->setUpForActivityDashboardTests();
284 $activityCount = CRM_Activity_BAO_Activity
::getActivities($this->_params
, TRUE);
285 $this->assertEquals(8, $activityCount);
289 * Test getActivities BAO method for getting count
291 public function testGetActivitiesCountforNonAdminDashboard() {
292 $op = new PHPUnit_Extensions_Database_Operation_Insert();
293 $op->execute($this->_dbconn
,
294 $this->createFlatXMLDataSet(
295 dirname(__FILE__
) . '/activities_for_dashboard_count.xml'
304 'activity_type_id' => NULL,
310 $activityCount = CRM_Activity_BAO_Activity
::getActivities($params, TRUE);
312 //since we are loading activities from dataset, we know total number of activities for this contact
313 // 5 activities ( 2 scheduled, 3 Completed ), note that dashboard shows only scheduled activities
315 $this->assertEquals($count, $activityCount);
319 * Test getActivities BAO method for getting count
321 public function testGetActivitiesCountforContactSummary() {
322 $op = new PHPUnit_Extensions_Database_Operation_Insert();
323 $op->execute($this->_dbconn
,
324 $this->createFlatXMLDataSet(
325 dirname(__FILE__
) . '/activities_for_dashboard_count.xml'
333 'context' => 'activity',
334 'activity_type_id' => NULL,
339 $activityCount = CRM_Activity_BAO_Activity
::getActivities($params, TRUE);
341 //since we are loading activities from dataset, we know total number of activities for this contact
342 // 5 activities, Contact Summary should show all activities
344 $this->assertEquals($count, $activityCount);
348 * CRM-18706 - Test Include/Exclude Activity Filters
350 public function testActivityFilters() {
351 $op = new PHPUnit_Extensions_Database_Operation_Insert();
352 $op->execute($this->_dbconn
,
353 $this->createFlatXMLDataSet(
354 dirname(__FILE__
) . '/activities_for_dashboard_count.xml'
361 'context' => 'activity',
362 'activity_type_id' => 1,
365 $obj = new CRM_Activity_Page_AJAX();
367 $activities = $obj->getContactActivity();
368 // This should include activities of type Meeting only.
369 foreach ($activities['data'] as $value) {
370 $this->assertContains('Meeting', $value['activity_type']);
372 unset($_GET['activity_type_id']);
374 $_GET['activity_type_exclude_id'] = 1;
375 $activities = $obj->getContactActivity();
376 // None of the activities should be of type Meeting.
377 foreach ($activities['data'] as $value) {
378 $this->assertNotEquals('Meeting', $value['activity_type']);
383 * Test getActivities BAO method for getting count
385 public function testGetActivitiesCountforContactSummaryWithNoActivities() {
386 $op = new PHPUnit_Extensions_Database_Operation_Insert();
387 $op->execute($this->_dbconn
,
388 $this->createFlatXMLDataSet(
389 dirname(__FILE__
) . '/activities_for_dashboard_count.xml'
398 'activity_type_id' => NULL,
403 $activityCount = CRM_Activity_BAO_Activity
::getActivities($params, TRUE);
405 //since we are loading activities from dataset, we know total number of activities for this contact
406 // this contact does not have any activity
407 $this->assertEquals(0, $activityCount);
411 * Test getActivities BAO method.
413 public function testGetActivitiesForAdminDashboard() {
414 $this->setUpForActivityDashboardTests();
415 $activities = CRM_Activity_BAO_Activity
::getActivities($this->_params
);
417 //since we are loading activities from dataset, we know total number of activities
418 // with no contact ID and there should be 8 schedule activities shown on dashboard
420 $this->assertEquals($count, count($activities));
422 foreach ($activities as $key => $value) {
423 $this->assertEquals($value['subject'], "subject {$key}", 'Verify activity subject is correct.');
424 $this->assertEquals($value['activity_type_id'], 2, 'Verify activity type is correct.');
425 $this->assertEquals($value['status_id'], 1, 'Verify all activities are scheduled.');
430 * Test getActivities BAO method.
432 public function testGetActivitiesForAdminDashboardNoViewContacts() {
433 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access CiviCRM');
434 $this->setUpForActivityDashboardTests();
435 $activities = CRM_Activity_BAO_Activity
::getActivities($this->_params
);
436 $this->assertEquals(0, count($activities));
440 * Test getActivities BAO method.
442 public function testGetActivitiesForAdminDashboardAclLimitedViewContacts() {
443 CRM_Core_Config
::singleton()->userPermissionClass
->permissions
= array('access CiviCRM');
444 $this->allowedContacts
= array(1, 3, 4, 5);
445 $this->hookClass
->setHook('civicrm_aclWhereClause', array($this, 'aclWhereMultipleContacts'));
446 $this->setUpForActivityDashboardTests();
447 $activities = CRM_Activity_BAO_Activity
::getActivities($this->_params
);
448 $this->assertEquals(1, count($activities));
453 * Test getActivities BAO method.
455 public function testGetActivitiesforNonAdminDashboard() {
456 $op = new PHPUnit_Extensions_Database_Operation_Insert();
457 $op->execute($this->_dbconn
,
458 $this->createFlatXMLDataSet(
459 dirname(__FILE__
) . '/activities_for_dashboard_count.xml'
465 'contact_id' => $contactID,
469 'activity_type_id' => NULL,
474 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
476 //since we are loading activities from dataset, we know total number of activities for this contact
477 // 5 activities ( 2 scheduled, 3 Completed ), note that dashboard shows only scheduled activities
479 $this->assertEquals($count, count($activities));
481 foreach ($activities as $key => $value) {
482 $this->assertEquals($value['subject'], "subject {$key}", 'Verify activity subject is correct.');
483 $this->assertEquals($value['activity_type_id'], 2, 'Verify activity type is correct.');
484 $this->assertEquals($value['status_id'], 1, 'Verify all activities are scheduled.');
487 $this->assertArrayHasKey($contactID, $value['target_contact_name']);
490 $this->assertArrayHasKey($contactID, $value['assignee_contact_name']);
496 * Test target contact count.
498 public function testTargetCountforContactSummary() {
500 $contactId = $this->individualCreate();
501 $targetContactIDs = array();
502 for ($i = 0; $i < $targetCount; $i++
) {
503 $targetContactIDs[] = $this->individualCreate(array(), $i);
505 // Create activities with 5 target contacts.
506 $activityParams = array(
507 'source_contact_id' => $contactId,
508 'target_contact_id' => $targetContactIDs,
510 $this->activityCreate($activityParams);
513 'contact_id' => $contactId,
514 'context' => 'activity',
516 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
518 //verify target count
519 $this->assertEquals($targetCount, $activities[1]['target_contact_counter']);
523 * Test getActivities BAO method.
525 public function testGetActivitiesforContactSummary() {
526 $op = new PHPUnit_Extensions_Database_Operation_Insert();
527 $op->execute($this->_dbconn
,
528 $this->createFlatXMLDataSet(
529 dirname(__FILE__
) . '/activities_for_dashboard_count.xml'
535 'contact_id' => $contactID,
538 'context' => 'activity',
539 'activity_type_id' => NULL,
544 $activities = CRM_Activity_BAO_Activity
::getActivities($params);
546 //since we are loading activities from dataset, we know total number of activities for this contact
547 // 5 activities, Contact Summary should show all activities
549 $this->assertEquals($count, count($activities));
551 foreach ($activities as $key => $value) {
552 $this->assertEquals($value['subject'], "subject {$key}", 'Verify activity subject is correct.');
555 $this->assertEquals($value['status_id'], 2, 'Verify all activities are scheduled.');
558 $this->assertEquals($value['status_id'], 1, 'Verify all activities are scheduled.');
562 $this->assertEquals($value['activity_type_id'], 1, 'Verify activity type is correct.');
565 $this->assertEquals($value['activity_type_id'], 2, 'Verify activity type is correct.');
569 $this->assertArrayHasKey($contactID, $value['target_contact_name']);
572 $this->assertArrayHasKey($contactID, $value['assignee_contact_name']);
578 * Test getActivities BAO method.
580 public function testGetActivitiesforContactSummaryWithActivities() {
581 $op = new PHPUnit_Extensions_Database_Operation_Insert();
582 $op->execute($this->_dbconn
,
583 $this->createFlatXMLDataSet(
584 dirname(__FILE__
) . '/activities_for_dashboard_count.xml'
588 // parameters for different test casess, check each array key for the specific test-case
590 'with-no-activity' => array(
596 'activity_type_id' => NULL,
602 'with-activity' => array(
608 'activity_type_id' => NULL,
614 'with-activity_type' => array(
620 'activity_type_id' => 2,
626 'exclude-all-activity_type' => array(
632 'activity_type_exclude_id' => array(1, 2),
638 'sort-by-subject' => array(
644 'activity_type_id' => NULL,
647 'sort' => 'subject DESC',
652 foreach ($testCases as $caseName => $testCase) {
653 $activities = CRM_Activity_BAO_Activity
::getActivities($testCase['params']);
654 $activityCount = CRM_Activity_BAO_Activity
::getActivities($testCase['params'], TRUE);
655 if ($caseName == 'with-no-activity') {
656 $this->assertEquals(0, count($activities));
657 $this->assertEquals(0, $activityCount);
659 elseif ($caseName == 'with-activity') {
660 // contact id 1 is assigned as source, target and assignee for activity id 1, 7 and 8 respectively
661 $this->assertEquals(3, count($activities));
662 $this->assertEquals(3, $activityCount);
663 $this->assertEquals(1, $activities[1]['source_contact_id']);
664 $this->assertEquals(TRUE, array_key_exists(1, $activities[7]['target_contact_name']));
665 $this->assertEquals(TRUE, array_key_exists(1, $activities[8]['assignee_contact_name']));
667 elseif ($caseName == 'with-activity_type') {
668 // contact id 3 for activity type 2 is assigned as assignee, source and target for
669 // activity id 1, 3 and 8 respectively
670 $this->assertEquals(3, count($activities));
671 $this->assertEquals(3, $activityCount);
672 // ensure activity type id is 2
673 $this->assertEquals(2, $activities[1]['activity_type_id']);
674 $this->assertEquals(3, $activities[3]['source_contact_id']);
675 $this->assertEquals(TRUE, array_key_exists(3, $activities[8]['target_contact_name']));
676 $this->assertEquals(TRUE, array_key_exists(3, $activities[1]['assignee_contact_name']));
678 if ($caseName == 'exclude-all-activity_type') {
679 $this->assertEquals(0, count($activities));
680 $this->assertEquals(0, $activityCount);
682 if ($caseName == 'sort-by-subject') {
683 $this->assertEquals(3, count($activities));
684 $this->assertEquals(3, $activityCount);
685 // activities should be order by 'subject DESC'
686 $subjectOrder = array(
692 foreach ($activities as $activity) {
693 $this->assertEquals($subjectOrder[$count], $activity['subject']);
701 * CRM-20308: Test from email address when a 'copy of Activity' event occur
703 public function testEmailAddressOfActivityCopy() {
704 // Case 1: assert the 'From' Email Address of source Actvity Contact ID
705 // create activity with source contact ID which has email address
706 $assigneeContactId = $this->individualCreate();
707 $sourceContactParams = array(
708 'first_name' => 'liz',
709 'last_name' => 'hurleey',
710 'email' => substr(sha1(rand()), 0, 7) . '@testemail.com',
712 $sourceContactID = $this->individualCreate($sourceContactParams);
713 $sourceDisplayName = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $sourceContactID, 'display_name');
715 // create an activity using API
717 'source_contact_id' => $sourceContactID,
718 'subject' => 'Scheduling Meeting ' . substr(sha1(rand()), 0, 4),
719 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Meeting'),
720 'assignee_contact_id' => array($assigneeContactId),
721 'activity_date_time' => date('Ymd'),
723 $activity = $this->callAPISuccess('Activity', 'create', $params);
725 // Check that from address is in "Source-Display-Name <source-email>"
726 $formAddress = CRM_Case_BAO_Case
::getReceiptFrom($activity['id']);
727 $expectedFromAddress = sprintf("%s <%s>", $sourceDisplayName, $sourceContactParams['email']);
728 $this->assertEquals($expectedFromAddress, $formAddress);
730 // Case 2: System Default From Address
731 // but first erase the email address of existing source contact ID
732 $withoutEmailParams = array(
735 $sourceContactID = $this->individualCreate($withoutEmailParams);
737 'source_contact_id' => $sourceContactID,
738 'subject' => 'Scheduling Meeting ' . substr(sha1(rand()), 0, 4),
739 'activity_type_id' => CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Meeting'),
740 'activity_date_time' => date('Ymd'),
742 $activity = $this->callAPISuccess('Activity', 'create', $params);
744 $domainInfo = $this->callAPISuccess('Domain', 'getsingle', array('id' => CRM_Core_Config
::domainID()));
746 $formAddress = CRM_Case_BAO_Case
::getReceiptFrom($activity['id']);
747 if (!empty($domainInfo['from_email'])) {
748 $expectedFromAddress = sprintf("%s <%s>", $domainInfo['from_name'], $domainInfo['from_email']);
750 // Case 3: fetch default Organization Contact email address
751 elseif (!empty($domainInfo['domain_email'])) {
752 $expectedFromAddress = sprintf("%s <%s>", $domainInfo['name'], $domainInfo['domain_email']);
754 // TODO: due to unknown reason the following assertion fails on
755 // test.civicrm.org test build but works fine on local
756 // $this->assertEquals($expectedFromAddress, $formAddress);
758 // TODO: Case 4 about checking the $formAddress on basis of logged contact ID respectively needs,
759 // to change the domain setting, which isn't straight forward in test environment
763 * Set up for testing activity queries.
765 protected function setUpForActivityDashboardTests() {
766 $op = new PHPUnit_Extensions_Database_Operation_Insert();
767 $op->execute($this->_dbconn
,
768 $this->createFlatXMLDataSet(
769 dirname(__FILE__
) . '/activities_for_dashboard_count.xml'
773 $this->_params
= array(
774 'contact_id' => NULL,
778 'activity_type_id' => NULL,