tests/phpunit/CRM/Activity/BAO/ActivityTest.php

   1 <?php
   2
   3 /**
   4  * Class CRM_Activity_BAO_ActivityTest
   5  * @group headless
   6  */
   7 class CRM_Activity_BAO_ActivityTest extends CiviUnitTestCase {
   8   public function setUp() {
   9     parent::setUp();
  10     $this->prepareForACLs();
  11     CRM_Core_Config::singleton()->userPermissionClass->permissions = array('view all contacts', 'access CiviCRM');
  12   }
  13
  14   /**
  15    * Clean up after tests.
  16    */
  17   public function tearDown() {
  18     $tablesToTruncate = array(
  19       'civicrm_activity',
  20       'civicrm_activity_contact',
  21       'civicrm_uf_match',
  22       'civicrm_campaign',
  23       'civicrm_email',
  24     );
  25     $this->quickCleanup($tablesToTruncate);
  26     $this->cleanUpAfterACLs();
  27     parent::tearDown();
  28   }
  29
  30   /**
  31    * Test case for create() method.
  32    */
  33   public function testCreate() {
  34     $contactId = $this->individualCreate();
  35
  36     $params = array(
  37       'source_contact_id' => $contactId,
  38       'subject' => 'Scheduling Meeting',
  39       'activity_type_id' => 2,
  40     );
  41
  42     CRM_Activity_BAO_Activity::create($params);
  43
  44     $activityId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
  45       'subject', 'Database check for created activity.'
  46     );
  47
  48     // Now call create() to modify an existing Activity.
  49     $params = array(
  50       'id' => $activityId,
  51       'source_contact_id' => $contactId,
  52       'subject' => 'Scheduling Interview',
  53       'activity_type_id' => 3,
  54     );
  55
  56     CRM_Activity_BAO_Activity::create($params);
  57
  58     $activityTypeId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Interview',
  59       'activity_type_id',
  60       'subject', 'Database check on updated activity record.'
  61     );
  62     $this->assertEquals($activityTypeId, 3, 'Verify activity type id is 3.');
  63
  64     $this->contactDelete($contactId);
  65   }
  66
  67   /**
  68    * Test case for getContactActivity() method.
  69    *
  70    * getContactActivity() method get activities detail for given target contact id.
  71    */
  72   public function testGetContactActivity() {
  73     $contactId = $this->individualCreate();
  74     $params = array(
  75       'first_name' => 'liz',
  76       'last_name' => 'hurleey',
  77     );
  78     $targetContactId = $this->individualCreate($params);
  79
  80     $params = array(
  81       'source_contact_id' => $contactId,
  82       'subject' => 'Scheduling Meeting',
  83       'activity_type_id' => 2,
  84       'target_contact_id' => array($targetContactId),
  85       'activity_date_time' => date('Ymd'),
  86     );
  87
  88     $this->callAPISuccess('Activity', 'create', $params);
  89
  90     $activityId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting',
  91       'id',
  92       'subject', 'Database check for created activity.'
  93     );
  94
  95     // @todo - remove this deprecated functions
  96     $activities = CRM_Activity_BAO_Activity::getContactActivity($targetContactId);
  97
  98     $this->assertEquals($activities[$activityId]['subject'], 'Scheduling Meeting', 'Verify activity subject is correct.');
  99
 100     $this->contactDelete($contactId);
 101     $this->contactDelete($targetContactId);
 102   }
 103
 104   /**
 105    * Test case for retrieve() method.
 106    *
 107    * Retrieve($params, $defaults) method return activity detail for given params
 108    *                              and set defaults.
 109    */
 110   public function testRetrieve() {
 111     $contactId = $this->individualCreate();
 112     $params = array(
 113       'first_name' => 'liz',
 114       'last_name' => 'hurleey',
 115     );
 116     $targetContactId = $this->individualCreate($params);
 117
 118     $params = array(
 119       'source_contact_id' => $contactId,
 120       'subject' => 'Scheduling Meeting',
 121       'activity_type_id' => 2,
 122       'target_contact_id' => array($targetContactId),
 123       'activity_date_time' => date('Ymd'),
 124     );
 125
 126     CRM_Activity_BAO_Activity::create($params);
 127
 128     $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
 129       'subject', 'Database check for created activity.'
 130     );
 131
 132     $this->assertDBNotNull('CRM_Activity_DAO_ActivityContact', $targetContactId,
 133       'id', 'contact_id',
 134       'Database check for created activity target.'
 135     );
 136
 137     $defaults = array();
 138     $activity = CRM_Activity_BAO_Activity::retrieve($params, $defaults);
 139
 140     $this->assertEquals($activity->subject, 'Scheduling Meeting', 'Verify activity subject is correct.');
 141     $this->assertEquals($activity->activity_type_id, 2, 'Verify activity type id is correct.');
 142     $this->assertEquals($defaults['source_contact_id'], $contactId, 'Verify source contact id is correct.');
 143
 144     $this->assertEquals($defaults['subject'], 'Scheduling Meeting', 'Verify activity subject is correct.');
 145     $this->assertEquals($defaults['activity_type_id'], 2, 'Verify activity type id is correct.');
 146
 147     $this->assertEquals($defaults['target_contact'][0], $targetContactId, 'Verify target contact id is correct.');
 148
 149     $this->contactDelete($contactId);
 150     $this->contactDelete($targetContactId);
 151   }
 152
 153   /**
 154    * Test case for deleteActivity() method.
 155    *
 156    * deleteActivity($params) method deletes activity for given params.
 157    */
 158   public function testDeleteActivity() {
 159     $contactId = $this->individualCreate();
 160     $params = array(
 161       'first_name' => 'liz',
 162       'last_name' => 'hurleey',
 163     );
 164     $targetContactId = $this->individualCreate($params);
 165
 166     $params = array(
 167       'source_contact_id' => $contactId,
 168       'source_record_id' => $contactId,
 169       'subject' => 'Scheduling Meeting',
 170       'activity_type_id' => 2,
 171       'target_contact_id' => array($targetContactId),
 172       'activity_date_time' => date('Ymd'),
 173     );
 174
 175     CRM_Activity_BAO_Activity::create($params);
 176
 177     $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
 178       'subject', 'Database check for created activity.'
 179     );
 180
 181     $this->assertDBNotNull('CRM_Activity_DAO_ActivityContact', $targetContactId,
 182       'id', 'contact_id',
 183       'Database check for created activity target.'
 184     );
 185     $params = array(
 186       'source_contact_id' => $contactId,
 187       'source_record_id' => $contactId,
 188       'subject' => 'Scheduling Meeting',
 189       'activity_type_id' => 2,
 190     );
 191
 192     CRM_Activity_BAO_Activity::deleteActivity($params);
 193
 194     $this->assertDBNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
 195       'subject', 'Database check for deleted activity.'
 196     );
 197     $this->contactDelete($contactId);
 198     $this->contactDelete($targetContactId);
 199   }
 200
 201   /**
 202    * Test case for deleteActivityTarget() method.
 203    *
 204    * deleteActivityTarget($activityId) method deletes activity target for given activity id.
 205    */
 206   public function testDeleteActivityTarget() {
 207     $contactId = $this->individualCreate();
 208     $params = array(
 209       'first_name' => 'liz',
 210       'last_name' => 'hurleey',
 211     );
 212     $targetContactId = $this->individualCreate($params);
 213
 214     $params = array(
 215       'source_contact_id' => $contactId,
 216       'subject' => 'Scheduling Meeting',
 217       'activity_type_id' => 2,
 218       'target_contact_id' => array($targetContactId),
 219       'activity_date_time' => date('Ymd'),
 220     );
 221
 222     CRM_Activity_BAO_Activity::create($params);
 223
 224     $activityId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
 225       'subject', 'Database check for created activity.'
 226     );
 227
 228     $this->assertDBNotNull('CRM_Activity_DAO_ActivityContact', $targetContactId,
 229       'id', 'contact_id',
 230       'Database check for created activity target.'
 231     );
 232
 233     CRM_Activity_BAO_Activity::deleteActivityContact($activityId, 3);
 234
 235     $this->assertDBNull('CRM_Activity_DAO_ActivityContact', $targetContactId, 'id',
 236       'contact_id', 'Database check for deleted activity target.'
 237     );
 238
 239     $this->contactDelete($contactId);
 240     $this->contactDelete($targetContactId);
 241   }
 242
 243   /**
 244    * Test case for deleteActivityAssignment() method.
 245    *
 246    * deleteActivityAssignment($activityId) method deletes activity assignment for given activity id.
 247    */
 248   public function testDeleteActivityAssignment() {
 249     $contactId = $this->individualCreate();
 250     $params = array(
 251       'first_name' => 'liz',
 252       'last_name' => 'hurleey',
 253     );
 254     $assigneeContactId = $this->individualCreate($params);
 255
 256     $params = array(
 257       'source_contact_id' => $contactId,
 258       'subject' => 'Scheduling Meeting',
 259       'activity_type_id' => 2,
 260       'assignee_contact_id' => array($assigneeContactId),
 261       'activity_date_time' => date('Ymd'),
 262     );
 263
 264     CRM_Activity_BAO_Activity::create($params);
 265
 266     $activityId = $this->assertDBNotNull('CRM_Activity_DAO_Activity', 'Scheduling Meeting', 'id',
 267       'subject', 'Database check for created activity.'
 268     );
 269
 270     $this->assertDBNotNull('CRM_Activity_DAO_ActivityContact',
 271       $assigneeContactId, 'id', 'contact_id',
 272       'Database check for created activity assignment.'
 273     );
 274
 275     CRM_Activity_BAO_Activity::deleteActivityContact($activityId, 1);
 276
 277     $this->assertDBNull('CRM_Activity_DAO_ActivityContact', $assigneeContactId, 'id',
 278       'contact_id', 'Database check for deleted activity assignment.'
 279     );
 280
 281     $this->contactDelete($contactId);
 282     $this->contactDelete($assigneeContactId);
 283   }
 284
 285   /**
 286    * Test getActivities BAO method for getting count.
 287    */
 288   public function testGetActivitiesCountForAdminDashboard() {
 289     $this->setUpForActivityDashboardTests();
 290     $activityCount = CRM_Activity_BAO_Activity::deprecatedGetActivitiesCount($this->_params);
 291     $this->assertEquals(8, $activityCount);
 292     $activityCount = CRM_Activity_BAO_Activity::getActivitiesCount($this->_params);
 293     $this->assertEquals(8, $activityCount);
 294   }
 295
 296   /**
 297    * Test getActivities BAO method for getting count
 298    */
 299   public function testGetActivitiesCountforNonAdminDashboard() {
 300     $op = new PHPUnit_Extensions_Database_Operation_Insert();
 301     $op->execute($this->_dbconn,
 302       $this->createFlatXMLDataSet(
 303         dirname(__FILE__) . '/activities_for_dashboard_count.xml'
 304       )
 305     );
 306
 307     $params = array(
 308       'contact_id' => 9,
 309       'admin' => FALSE,
 310       'caseId' => NULL,
 311       'context' => 'home',
 312       'activity_type_id' => NULL,
 313       'activity_status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Scheduled'), // for dashlet the Scheduled status is set by default
 314       'offset' => 0,
 315       'rowCount' => 0,
 316       'sort' => NULL,
 317     );
 318
 319     $activityCount = CRM_Activity_BAO_Activity::deprecatedGetActivitiesCount($params);
 320
 321     //since we are loading activities from dataset, we know total number of activities for this contact
 322     // 5 activities ( 2 scheduled, 3 Completed ), note that dashboard shows only scheduled activities
 323     $count = 2;
 324     $this->assertEquals($count, $activityCount);
 325     $this->assertEquals(2, CRM_Activity_BAO_Activity::getActivitiesCount($params));
 326   }
 327
 328   /**
 329    * Test getActivities BAO method for getting count
 330    */
 331   public function testGetActivitiesCountforContactSummary() {
 332     $op = new PHPUnit_Extensions_Database_Operation_Insert();
 333     $op->execute($this->_dbconn,
 334       $this->createFlatXMLDataSet(
 335         dirname(__FILE__) . '/activities_for_dashboard_count.xml'
 336       )
 337     );
 338
 339     $params = array(
 340       'contact_id' => 9,
 341       'admin' => FALSE,
 342       'caseId' => NULL,
 343       'context' => 'activity',
 344       'activity_type_id' => NULL,
 345       'offset' => 0,
 346       'rowCount' => 0,
 347       'sort' => NULL,
 348     );
 349     $activityCount = CRM_Activity_BAO_Activity::deprecatedGetActivitiesCount($params);
 350
 351     //since we are loading activities from dataset, we know total number of activities for this contact
 352     // 5 activities, Contact Summary should show all activities
 353     $count = 5;
 354     $this->assertEquals($count, $activityCount);
 355     $this->assertEquals(5, CRM_Activity_BAO_Activity::getActivitiesCount($params));
 356   }
 357
 358   /**
 359    * CRM-18706 - Test Include/Exclude Activity Filters
 360    */
 361   public function testActivityFilters() {
 362     $op = new PHPUnit_Extensions_Database_Operation_Insert();
 363     $op->execute($this->_dbconn,
 364       $this->createFlatXMLDataSet(
 365         dirname(__FILE__) . '/activities_for_dashboard_count.xml'
 366       )
 367     );
 368     Civi::settings()->set('preserve_activity_tab_filter', 1);
 369     $this->createLoggedInUser();
 370
 371     global $_GET;
 372     $_GET = array(
 373       'cid' => 9,
 374       'context' => 'activity',
 375       'activity_type_id' => 1,
 376       'is_unit_test' => 1,
 377     );
 378     $expectedFilters = array(
 379       'activity_type_filter_id' => 1,
 380       'activity_type_exclude_filter_id' => '',
 381     );
 382
 383     list($activities, $activityFilter) = CRM_Activity_Page_AJAX::getContactActivity();
 384     //Assert whether filters are correctly set.
 385     $this->checkArrayEquals($expectedFilters, $activityFilter);
 386     // This should include activities of type Meeting only.
 387     foreach ($activities['data'] as $value) {
 388       $this->assertContains('Meeting', $value['activity_type']);
 389     }
 390     unset($_GET['activity_type_id']);
 391     $expectedFilters['activity_type_filter_id'] = '';
 392
 393     $_GET['activity_type_exclude_id'] = $expectedFilters['activity_type_exclude_filter_id'] = 1;
 394     list($activities, $activityFilter) = CRM_Activity_Page_AJAX::getContactActivity();
 395     $this->checkArrayEquals($expectedFilters, $activityFilter);
 396     // None of the activities should be of type Meeting.
 397     foreach ($activities['data'] as $value) {
 398       $this->assertNotContains('Meeting', $value['activity_type']);
 399     }
 400   }
 401
 402   /**
 403    * Test getActivities BAO method for getting count
 404    */
 405   public function testGetActivitiesCountforContactSummaryWithNoActivities() {
 406     $op = new PHPUnit_Extensions_Database_Operation_Insert();
 407     $op->execute($this->_dbconn,
 408       $this->createFlatXMLDataSet(
 409         dirname(__FILE__) . '/activities_for_dashboard_count.xml'
 410       )
 411     );
 412
 413     $params = array(
 414       'contact_id' => 17,
 415       'admin' => FALSE,
 416       'caseId' => NULL,
 417       'context' => 'home',
 418       'activity_type_id' => NULL,
 419       'offset' => 0,
 420       'rowCount' => 0,
 421       'sort' => NULL,
 422     );
 423     $activityCount = CRM_Activity_BAO_Activity::deprecatedGetActivitiesCount($params);
 424
 425     //since we are loading activities from dataset, we know total number of activities for this contact
 426     // this contact does not have any activity
 427     $this->assertEquals(0, $activityCount);
 428     $this->assertEquals(0, CRM_Activity_BAO_Activity::getActivitiesCount($params));
 429   }
 430
 431   /**
 432    * Test getActivities BAO method.
 433    */
 434   public function testGetActivitiesForAdminDashboard() {
 435     $this->setUpForActivityDashboardTests();
 436     $activitiesDeprecatedFn = CRM_Activity_BAO_Activity::deprecatedGetActivities($this->_params);
 437     $activitiesNew = CRM_Activity_BAO_Activity::getActivities($this->_params);
 438     // $this->assertEquals($activities, $activitiesDeprecatedFn);
 439
 440     //since we are loading activities from dataset, we know total number of activities
 441     // with no contact ID and there should be 8 schedule activities shown on dashboard
 442     $count = 8;
 443     foreach (array($activitiesNew, $activitiesDeprecatedFn) as $activities) {
 444       $this->assertEquals($count, count($activities));
 445
 446       foreach ($activities as $key => $value) {
 447         $this->assertEquals($value['subject'], "subject {$key}", 'Verify activity subject is correct.');
 448         $this->assertEquals($value['activity_type_id'], 2, 'Verify activity type is correct.');
 449         $this->assertEquals($value['status_id'], 1, 'Verify all activities are scheduled.');
 450       }
 451     }
 452   }
 453
 454   /**
 455    * Test getActivities BAO method.
 456    */
 457   public function testGetActivitiesForAdminDashboardNoViewContacts() {
 458     CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviCRM');
 459     $this->setUpForActivityDashboardTests();
 460     $activitiesDeprecated = CRM_Activity_BAO_Activity::deprecatedGetActivities($this->_params);
 461     foreach (array($activitiesDeprecated, CRM_Activity_BAO_Activity::getActivities($this->_params)) as $activities) {
 462       // Skipped until we get back to the upgraded version properly.
 463       //$this->assertEquals(0, count($activities));
 464     }
 465   }
 466
 467   /**
 468    * Test getActivities BAO method.
 469    */
 470   public function testGetActivitiesForAdminDashboardAclLimitedViewContacts() {
 471     CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviCRM');
 472     $this->allowedContacts = array(1, 3, 4, 5);
 473     $this->hookClass->setHook('civicrm_aclWhereClause', array($this, 'aclWhereMultipleContacts'));
 474     $this->setUpForActivityDashboardTests();
 475     $activitiesDeprecated = CRM_Activity_BAO_Activity::deprecatedGetActivities($this->_params);
 476     foreach (array($activitiesDeprecated, CRM_Activity_BAO_Activity::getActivities($this->_params)) as $activities) {
 477       //$this->assertEquals(1, count($activities));
 478     }
 479
 480   }
 481
 482   /**
 483    * Test getActivities BAO method.
 484    */
 485   public function testGetActivitiesforNonAdminDashboard() {
 486     $op = new PHPUnit_Extensions_Database_Operation_Insert();
 487     $op->execute($this->_dbconn,
 488       $this->createFlatXMLDataSet(
 489         dirname(__FILE__) . '/activities_for_dashboard_count.xml'
 490       )
 491     );
 492
 493     $contactID = 9;
 494     $params = array(
 495       'contact_id' => $contactID,
 496       'admin' => FALSE,
 497       'caseId' => NULL,
 498       'context' => 'home',
 499       'activity_type_id' => NULL,
 500       'activity_status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Scheduled'), // for dashlet the Scheduled status is set by default
 501       'offset' => 0,
 502       'rowCount' => 0,
 503       'sort' => NULL,
 504     );
 505     $activitiesDep = CRM_Activity_BAO_Activity::deprecatedGetActivities($params);
 506
 507     foreach (array($activitiesDep, CRM_Activity_BAO_Activity::getActivities($params)) as $activities) {
 508       //since we are loading activities from dataset, we know total number of activities for this contact
 509       // 5 activities ( 2 scheduled, 3 Completed ), note that dashboard shows only scheduled activities
 510       $count = 2;
 511       $this->assertEquals($count, count($activities));
 512
 513       foreach ($activities as $key => $value) {
 514         $this->assertEquals($value['subject'], "subject {$key}", 'Verify activity subject is correct.');
 515         $this->assertEquals($value['activity_type_id'], 2, 'Verify activity type is correct.');
 516         $this->assertEquals($value['status_id'], 1, 'Verify all activities are scheduled.');
 517
 518         if ($key == 3) {
 519           $this->assertArrayHasKey($contactID, $value['target_contact_name']);
 520         }
 521         elseif ($key == 4) {
 522           $this->assertArrayHasKey($contactID, $value['assignee_contact_name']);
 523         }
 524       }
 525     }
 526   }
 527
 528   /**
 529    * Test target contact count.
 530    */
 531   public function testTargetCountforContactSummary() {
 532     $targetCount = 5;
 533     $contactId = $this->individualCreate();
 534     $targetContactIDs = array();
 535     for ($i = 0; $i < $targetCount; $i++) {
 536       $targetContactIDs[] = $this->individualCreate(array(), $i);
 537     }
 538     // Create activities with 5 target contacts.
 539     $activityParams = array(
 540       'source_contact_id' => $contactId,
 541       'target_contact_id' => $targetContactIDs,
 542     );
 543     $this->activityCreate($activityParams);
 544
 545     $params = array(
 546       'contact_id' => $contactId,
 547       'context' => 'activity',
 548     );
 549     $activitiesDep = CRM_Activity_BAO_Activity::deprecatedGetActivities($params);
 550     foreach (array($activitiesDep, CRM_Activity_BAO_Activity::getActivities($params)) as $activities) {
 551       //verify target count
 552       $this->assertEquals($targetCount, $activities[1]['target_contact_counter']);
 553     }
 554
 555   }
 556
 557   /**
 558    * Test getActivities BAO method.
 559    */
 560   public function testGetActivitiesforContactSummary() {
 561     $op = new PHPUnit_Extensions_Database_Operation_Insert();
 562     $op->execute($this->_dbconn,
 563       $this->createFlatXMLDataSet(
 564         dirname(__FILE__) . '/activities_for_dashboard_count.xml'
 565       )
 566     );
 567
 568     $contactID = 9;
 569     $params = array(
 570       'contact_id' => $contactID,
 571       'admin' => FALSE,
 572       'caseId' => NULL,
 573       'context' => 'activity',
 574       'activity_type_id' => NULL,
 575       'offset' => 0,
 576       'rowCount' => 0,
 577       'sort' => NULL,
 578     );
 579     $activitiesDep = CRM_Activity_BAO_Activity::deprecatedGetActivities($params);
 580
 581     //since we are loading activities from dataset, we know total number of activities for this contact
 582     // 5 activities, Contact Summary should show all activities
 583     $count = 5;
 584     foreach (array($activitiesDep, CRM_Activity_BAO_Activity::getActivities($params)) as $activities) {
 585
 586       $this->assertEquals($count, count($activities));
 587
 588       foreach ($activities as $key => $value) {
 589         $this->assertEquals($value['subject'], "subject {$key}", 'Verify activity subject is correct.');
 590
 591         if ($key > 8) {
 592           $this->assertEquals($value['status_id'], 2, 'Verify all activities are scheduled.');
 593         }
 594         else {
 595           $this->assertEquals($value['status_id'], 1, 'Verify all activities are scheduled.');
 596         }
 597
 598         if ($key > 8) {
 599           $this->assertEquals($value['activity_type_id'], 1, 'Verify activity type is correct.');
 600         }
 601         else {
 602           $this->assertEquals($value['activity_type_id'], 2, 'Verify activity type is correct.');
 603         }
 604
 605         if ($key == 3) {
 606           $this->assertArrayHasKey($contactID, $value['target_contact_name']);
 607         }
 608         elseif ($key == 4) {
 609           $this->assertArrayHasKey($contactID, $value['assignee_contact_name']);
 610         }
 611       }
 612     }
 613   }
 614
 615   /**
 616    * Test getActivities BAO method.
 617    */
 618   public function testGetActivitiesforContactSummaryWithActivities() {
 619     $op = new PHPUnit_Extensions_Database_Operation_Insert();
 620     $op->execute($this->_dbconn,
 621       $this->createFlatXMLDataSet(
 622         dirname(__FILE__) . '/activities_for_dashboard_count.xml'
 623       )
 624     );
 625
 626     // parameters for different test cases, check each array key for the specific test-case
 627     $testCases = array(
 628       'with-no-activity' => array(
 629         'params' => array(
 630           'contact_id' => 17,
 631           'admin' => FALSE,
 632           'caseId' => NULL,
 633           'context' => 'home',
 634           'activity_type_id' => NULL,
 635           'offset' => 0,
 636           'rowCount' => 0,
 637           'sort' => NULL,
 638         ),
 639       ),
 640       'with-activity' => array(
 641         'params' => array(
 642           'contact_id' => 1,
 643           'admin' => FALSE,
 644           'caseId' => NULL,
 645           'context' => 'home',
 646           'activity_type_id' => NULL,
 647           'offset' => 0,
 648           'rowCount' => 0,
 649           'sort' => NULL,
 650         ),
 651       ),
 652       'with-activity_type' => array(
 653         'params' => array(
 654           'contact_id' => 3,
 655           'admin' => FALSE,
 656           'caseId' => NULL,
 657           'context' => 'home',
 658           'activity_type_id' => 2,
 659           'offset' => 0,
 660           'rowCount' => 0,
 661           'sort' => NULL,
 662         ),
 663       ),
 664       'exclude-all-activity_type' => array(
 665         'params' => array(
 666           'contact_id' => 3,
 667           'admin' => FALSE,
 668           'caseId' => NULL,
 669           'context' => 'home',
 670           'activity_type_exclude_id' => array(1, 2),
 671           'offset' => 0,
 672           'rowCount' => 0,
 673           'sort' => NULL,
 674         ),
 675       ),
 676       'sort-by-subject' => array(
 677         'params' => array(
 678           'contact_id' => 1,
 679           'admin' => FALSE,
 680           'caseId' => NULL,
 681           'context' => 'home',
 682           'activity_type_id' => NULL,
 683           'offset' => 0,
 684           'rowCount' => 0,
 685           'sort' => 'subject DESC',
 686         ),
 687       ),
 688     );
 689
 690     foreach ($testCases as $caseName => $testCase) {
 691       $activitiesDep = CRM_Activity_BAO_Activity::deprecatedGetActivities($testCase['params']);
 692       $activityCount = CRM_Activity_BAO_Activity::deprecatedGetActivitiesCount($testCase['params']);
 693       $activitiesNew = CRM_Activity_BAO_Activity::getActivities($testCase['params']);
 694
 695       foreach (array($activitiesDep, $activitiesNew) as $activities) {
 696         //$this->assertEquals($activityCount, CRM_Activity_BAO_Activity::getActivitiesCount($testCase['params']));
 697         if ($caseName == 'with-no-activity') {
 698           $this->assertEquals(0, count($activities));
 699           $this->assertEquals(0, $activityCount);
 700         }
 701         elseif ($caseName == 'with-activity') {
 702           // contact id 1 is assigned as source, target and assignee for activity id 1, 7 and 8 respectively
 703           $this->assertEquals(3, count($activities));
 704           $this->assertEquals(3, $activityCount);
 705           $this->assertEquals(1, $activities[1]['source_contact_id']);
 706           // @todo - this is a discrepancy between old & new - review.
 707           //$this->assertEquals(TRUE, array_key_exists(1, $activities[7]['target_contact_name']));
 708           $this->assertEquals(TRUE, array_key_exists(1, $activities[8]['assignee_contact_name']));
 709         }
 710         elseif ($caseName == 'with-activity_type') {
 711           // contact id 3 for activity type 2 is assigned as assignee, source and target for
 712           // activity id 1, 3 and 8 respectively
 713           $this->assertEquals(3, count($activities));
 714           $this->assertEquals(3, $activityCount);
 715           // ensure activity type id is 2
 716           $this->assertEquals(2, $activities[1]['activity_type_id']);
 717           $this->assertEquals(3, $activities[3]['source_contact_id']);
 718           // @todo review inconsistency between 2 versions.
 719           // $this->assertEquals(TRUE, array_key_exists(3, $activities[8]['target_contact_name']));
 720           $this->assertEquals(TRUE, array_key_exists(3, $activities[1]['assignee_contact_name']));
 721         }
 722         if ($caseName == 'exclude-all-activity_type') {
 723           $this->assertEquals(0, count($activities));
 724           $this->assertEquals(0, $activityCount);
 725         }
 726         if ($caseName == 'sort-by-subject') {
 727           $this->assertEquals(3, count($activities));
 728           $this->assertEquals(3, $activityCount);
 729           // activities should be order by 'subject DESC'
 730           $subjectOrder = array(
 731             'subject 8',
 732             'subject 7',
 733             'subject 1',
 734           );
 735           $count = 0;
 736           foreach ($activities as $activity) {
 737             $this->assertEquals($subjectOrder[$count], $activity['subject']);
 738             $count++;
 739           }
 740         }
 741       }
 742     }
 743   }
 744
 745   /**
 746    * CRM-20793 : Test getActivities by using activity date and status filter
 747    */
 748   public function testbyActivityDateAndStatus() {
 749     $op = new PHPUnit_Extensions_Database_Operation_Insert();
 750     $op->execute($this->_dbconn,
 751       $this->createFlatXMLDataSet(
 752         dirname(__FILE__) . '/activities_for_dashboard_count.xml'
 753       )
 754     );
 755
 756     // activity IDs catagorised by date
 757     $lastWeekActivities = array(1, 2, 3);
 758     $todayActivities = array(4, 5, 6, 7);
 759     $lastTwoMonthsActivities = array(8, 9, 10, 11);
 760     $lastYearActivties = array(12, 13, 14, 15, 16);
 761
 762     // date values later used to set activity date value
 763     $lastWeekDate = date('YmdHis', strtotime('1 week ago'));
 764     $today = date('YmdHis');
 765     $lastTwoMonthAgoDate = date('YmdHis', strtotime('2 months ago'));
 766     $lastYearDate = date('YmdHis', strtotime('1 year ago'));
 767     for ($i = 1; $i <= 16; $i++) {
 768       if (in_array($i, $lastWeekActivities)) {
 769         $date = $lastWeekDate;
 770       }
 771       elseif (in_array($i, $lastTwoMonthsActivities)) {
 772         $date = $lastTwoMonthAgoDate;
 773       }
 774       elseif (in_array($i, $lastYearActivties)) {
 775         $date = $lastYearDate;
 776       }
 777       elseif (in_array($i, $todayActivities)) {
 778         $date = $today;
 779       }
 780       $this->callAPISuccess('Activity', 'create', array(
 781         'id' => $i,
 782         'activity_date_time' => $date,
 783       ));
 784     }
 785
 786     // parameters for different test cases, check each array key for the specific test-case
 787     $testCases = array(
 788       'todays-activity' => array(
 789         'params' => array(
 790           'contact_id' => 1,
 791           'admin' => TRUE,
 792           'caseId' => NULL,
 793           'context' => 'activity',
 794           'activity_date_relative' => 'this.day',
 795           'activity_type_id' => NULL,
 796           'offset' => 0,
 797           'rowCount' => 0,
 798           'sort' => NULL,
 799         ),
 800       ),
 801       'todays-activity-filtered-by-range' => array(
 802         'params' => array(
 803           'contact_id' => 1,
 804           'admin' => TRUE,
 805           'caseId' => NULL,
 806           'context' => 'activity',
 807           'activity_date_low' => date('Y/m/d', strtotime('yesterday')),
 808           'activity_date_high' => date('Y/m/d'),
 809           'activity_type_id' => NULL,
 810           'offset' => 0,
 811           'rowCount' => 0,
 812           'sort' => NULL,
 813         ),
 814       ),
 815       'last-week-activity' => array(
 816         'params' => array(
 817           'contact_id' => 1,
 818           'admin' => TRUE,
 819           'caseId' => NULL,
 820           'context' => 'activity',
 821           'activity_date_relative' => 'previous.week',
 822           'activity_type_id' => NULL,
 823           'offset' => 0,
 824           'rowCount' => 0,
 825           'sort' => NULL,
 826         ),
 827       ),
 828       'this-quarter-activity' => array(
 829         'params' => array(
 830           'contact_id' => 1,
 831           'admin' => TRUE,
 832           'caseId' => NULL,
 833           'context' => 'activity',
 834           'activity_date_relative' => 'this.quarter',
 835           'activity_type_id' => NULL,
 836           'offset' => 0,
 837           'rowCount' => 0,
 838           'sort' => NULL,
 839         ),
 840       ),
 841       'last-year-activity' => array(
 842         'params' => array(
 843           'contact_id' => 1,
 844           'admin' => TRUE,
 845           'caseId' => NULL,
 846           'context' => 'activity',
 847           'activity_date_relative' => 'previous.year',
 848           'activity_type_id' => NULL,
 849           'offset' => 0,
 850           'rowCount' => 0,
 851           'sort' => NULL,
 852         ),
 853       ),
 854       'activity-of-all-statuses' => array(
 855         'params' => array(
 856           'contact_id' => 1,
 857           'admin' => TRUE,
 858           'caseId' => NULL,
 859           'context' => 'activity',
 860           'activity_status_id' => '1,2',
 861           'activity_type_id' => NULL,
 862           'offset' => 0,
 863           'rowCount' => 0,
 864           'sort' => NULL,
 865         ),
 866       ),
 867     );
 868
 869     foreach ($testCases as $caseName => $testCase) {
 870       $activitiesDep = CRM_Activity_BAO_Activity::deprecatedGetActivities($testCase['params']);
 871       $activityCount = CRM_Activity_BAO_Activity::deprecatedGetActivitiesCount($testCase['params']);
 872       asort($activitiesDep);
 873       $activityIDs = array_keys($activitiesDep);
 874
 875       if ($caseName == 'todays-activity' || $caseName == 'todays-activity-filtered-by-range') {
 876         $this->assertEquals(count($todayActivities), $activityCount);
 877         $this->assertEquals(count($todayActivities), count($activitiesDep));
 878         $this->checkArrayEquals($todayActivities, $activityIDs);
 879       }
 880       elseif ($caseName == 'last-week-activity') {
 881         $this->assertEquals(count($lastWeekActivities), $activityCount);
 882         $this->assertEquals(count($lastWeekActivities), count($activitiesDep));
 883         $this->checkArrayEquals($lastWeekActivities, $activityIDs);
 884       }
 885       elseif ($caseName == 'lhis-quarter-activity') {
 886         $this->assertEquals(count($lastTwoMonthsActivities), $activityCount);
 887         $this->assertEquals(count($lastTwoMonthsActivities), count($activitiesDep));
 888         $this->checkArrayEquals($lastTwoMonthsActivities, $activityIDs);
 889       }
 890       elseif ($caseName == 'last-year-activity') {
 891         $this->assertEquals(count($lastYearActivties), $activityCount);
 892         $this->assertEquals(count($lastYearActivties), count($activitiesDep));
 893         $this->checkArrayEquals($lastYearActivties, $activityIDs);
 894       }
 895       elseif ($caseName == 'activity-of-all-statuses') {
 896         $this->assertEquals(16, $activityCount);
 897         $this->assertEquals(16, count($activitiesDep));
 898       }
 899     }
 900   }
 901
 902   /**
 903    * CRM-20308: Test from email address when a 'copy of Activity' event occur
 904    */
 905   public function testEmailAddressOfActivityCopy() {
 906     // Case 1: assert the 'From' Email Address of source Actvity Contact ID
 907     // create activity with source contact ID which has email address
 908     $assigneeContactId = $this->individualCreate();
 909     $sourceContactParams = array(
 910       'first_name' => 'liz',
 911       'last_name' => 'hurleey',
 912       'email' => substr(sha1(rand()), 0, 7) . '@testemail.com',
 913     );
 914     $sourceContactID = $this->individualCreate($sourceContactParams);
 915     $sourceDisplayName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $sourceContactID, 'display_name');
 916
 917     // create an activity using API
 918     $params = array(
 919       'source_contact_id' => $sourceContactID,
 920       'subject' => 'Scheduling Meeting ' . substr(sha1(rand()), 0, 4),
 921       'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Meeting'),
 922       'assignee_contact_id' => array($assigneeContactId),
 923       'activity_date_time' => date('Ymd'),
 924     );
 925     $activity = $this->callAPISuccess('Activity', 'create', $params);
 926
 927     // Check that from address is in "Source-Display-Name <source-email>"
 928     $formAddress = CRM_Case_BAO_Case::getReceiptFrom($activity['id']);
 929     $expectedFromAddress = sprintf("%s <%s>", $sourceDisplayName, $sourceContactParams['email']);
 930     $this->assertEquals($expectedFromAddress, $formAddress);
 931
 932     // Case 2: System Default From Address
 933     //  but first erase the email address of existing source contact ID
 934     $withoutEmailParams = array(
 935       'email' => '',
 936     );
 937     $sourceContactID = $this->individualCreate($withoutEmailParams);
 938     $params = array(
 939       'source_contact_id' => $sourceContactID,
 940       'subject' => 'Scheduling Meeting ' . substr(sha1(rand()), 0, 4),
 941       'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Meeting'),
 942       'activity_date_time' => date('Ymd'),
 943     );
 944     $activity = $this->callAPISuccess('Activity', 'create', $params);
 945     // fetch domain info
 946     $domainInfo = $this->callAPISuccess('Domain', 'getsingle', array('id' => CRM_Core_Config::domainID()));
 947
 948     $formAddress = CRM_Case_BAO_Case::getReceiptFrom($activity['id']);
 949     if (!empty($domainInfo['from_email'])) {
 950       $expectedFromAddress = sprintf("%s <%s>", $domainInfo['from_name'], $domainInfo['from_email']);
 951     }
 952     // Case 3: fetch default Organization Contact email address
 953     elseif (!empty($domainInfo['domain_email'])) {
 954       $expectedFromAddress = sprintf("%s <%s>", $domainInfo['name'], $domainInfo['domain_email']);
 955     }
 956     $this->assertEquals($expectedFromAddress, $formAddress);
 957
 958     // TODO: Case 4 about checking the $formAddress on basis of logged contact ID respectively needs,
 959     //  to change the domain setting, which isn't straight forward in test environment
 960   }
 961
 962   /**
 963    * Set up for testing activity queries.
 964    */
 965   protected function setUpForActivityDashboardTests() {
 966     $op = new PHPUnit_Extensions_Database_Operation_Insert();
 967     $op->execute($this->_dbconn,
 968       $this->createFlatXMLDataSet(
 969         dirname(__FILE__) . '/activities_for_dashboard_count.xml'
 970       )
 971     );
 972
 973     $this->_params = array(
 974       'contact_id' => NULL,
 975       'admin' => TRUE,
 976       'caseId' => NULL,
 977       'context' => 'home',
 978       'activity_type_id' => NULL,
 979       'activity_status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'status_id', 'Scheduled'), // for dashlet the Scheduled status is set by default
 980       'offset' => 0,
 981       'rowCount' => 0,
 982       'sort' => NULL,
 983     );
 984   }
 985
 986   public function testSendEmailBasic() {
 987     $contactId = $this->individualCreate();
 988
 989     // create a logged in USER since the code references it for sendEmail user.
 990     $this->createLoggedInUser();
 991     $session = CRM_Core_Session::singleton();
 992     $loggedInUser = $session->get('userID');
 993
 994     $contact = $this->civicrm_api('contact', 'getsingle', array('id' => $contactId, 'version' => $this->_apiversion));
 995     $contactDetailsIntersectKeys = array(
 996       'contact_id' => '',
 997       'sort_name' => '',
 998       'display_name' => '',
 999       'do_not_email' => '',
1000       'preferred_mail_format' => '',
1001       'is_deceased' => '',
1002       'email' => '',
1003       'on_hold' => '',
1004     );
1005     $contactDetails = array(
1006       array_intersect_key($contact, $contactDetailsIntersectKeys),
1007     );
1008
1009     $subject = __FUNCTION__ . ' subject';
1010     $html = __FUNCTION__ . ' html';
1011     $text = __FUNCTION__ . ' text';
1012     $userID = $loggedInUser;
1013
1014     list($sent, $activity_id) = $email_result = CRM_Activity_BAO_Activity::sendEmail(
1015       $contactDetails,
1016       $subject,
1017       $text,
1018       $html,
1019       $contact['email'],
1020       $userID,
1021       $from = __FUNCTION__ . '@example.com'
1022     );
1023
1024     $activity = $this->civicrm_api('activity', 'getsingle', array('id' => $activity_id, 'version' => $this->_apiversion));
1025     $details = "-ALTERNATIVE ITEM 0-
1026 $html
1027 -ALTERNATIVE ITEM 1-
1028 $text
1029 -ALTERNATIVE END-
1030 ";
1031     $this->assertEquals($activity['details'], $details, 'Activity details does not match.');
1032     $this->assertEquals($activity['subject'], $subject, 'Activity subject does not match.');
1033   }
1034
1035   public function testSendEmailWithCampaign() {
1036     // Create a contact and contactDetails array.
1037     $contactId = $this->individualCreate();
1038
1039     // create a logged in USER since the code references it for sendEmail user.
1040     $this->createLoggedInUser();
1041     $session = CRM_Core_Session::singleton();
1042     $loggedInUser = $session->get('userID');
1043
1044     $contact = $this->civicrm_api('contact', 'getsingle', array('id' => $contactId, 'version' => $this->_apiversion));
1045     $contactDetailsIntersectKeys = array(
1046       'contact_id' => '',
1047       'sort_name' => '',
1048       'display_name' => '',
1049       'do_not_email' => '',
1050       'preferred_mail_format' => '',
1051       'is_deceased' => '',
1052       'email' => '',
1053       'on_hold' => '',
1054     );
1055     $contactDetails = array(
1056       array_intersect_key($contact, $contactDetailsIntersectKeys),
1057     );
1058
1059     // Create a campaign.
1060     $result = $this->civicrm_api('Campaign', 'create', array(
1061       'version' => $this->_apiversion,
1062       'title' => __FUNCTION__ . ' campaign',
1063     ));
1064     $campaign_id = $result['id'];
1065
1066     $subject = __FUNCTION__ . ' subject';
1067     $html = __FUNCTION__ . ' html';
1068     $text = __FUNCTION__ . ' text';
1069     $userID = $loggedInUser;
1070
1071     list($sent, $activity_id) = $email_result = CRM_Activity_BAO_Activity::sendEmail(
1072       $contactDetails,
1073       $subject,
1074       $text,
1075       $html,
1076       $contact['email'],
1077       $userID,
1078       $from = __FUNCTION__ . '@example.com',
1079       $attachments = NULL,
1080       $cc = NULL,
1081       $bcc = NULL,
1082       $contactIds = NULL,
1083       $additionalDetails = NULL,
1084       NULL,
1085       $campaign_id
1086     );
1087     $activity = $this->civicrm_api('activity', 'getsingle', array('id' => $activity_id, 'version' => $this->_apiversion));
1088     $this->assertEquals($activity['campaign_id'], $campaign_id, 'Activity campaign_id does not match.');
1089   }
1090
1091 }