(801) 534-1262 * @copyright Copyright CiviCRM LLC (C) 2009 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html * GNU Affero General Public License version 3 * @version $Id: ActivityTest.php 31254 2010-12-15 10:09:29Z eileen $ * @package CiviCRM * * This file is part of CiviCRM * * CiviCRM is free software; you can redistribute it and/or * modify it under the terms of the GNU Affero General Public License * as published by the Free Software Foundation; either version 3 of * the License, or (at your option) any later version. * * CiviCRM is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public * License along with this program. If not, see * . */ /** * Include class definitions */ require_once 'CiviTest/CiviUnitTestCase.php'; /** * Test APIv3 civicrm_activity_* functions * * @package CiviCRM_APIv3 * @subpackage API_Activity */ class api_v3_ActivityTest extends CiviUnitTestCase { protected $_params; protected $_params2; protected $_entity = 'activity'; protected $_apiversion = 3; protected $test_activity_type_value; protected $_contactID; /** * Test setup for every test * * Connect to the database, truncate the tables that will be used * and redirect stdin to a temporary file */ public function setUp() { // Connect to the database parent::setUp(); $this->_contactID = $this->individualCreate(); //create activity types $activityTypes = $this->callAPISuccess('option_value', 'create', array( 'option_group_id' => 2, 'name' => 'Test activity type', 'label' => 'Test activity type', 'sequential' => 1, )); $this->test_activity_type_value = $activityTypes['values'][0]['value']; $this->test_activity_type_id = $activityTypes['id']; $this->_params = array( 'source_contact_id' => $this->_contactID, 'activity_type_id' => $this->test_activity_type_value, 'subject' => 'test activity type id', 'activity_date_time' => '2011-06-02 14:36:13', 'status_id' => 2, 'priority_id' => 1, 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', ); $this->_params2 = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Eat & drink', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Napier', 'details' => 'discuss & eat', 'status_id' => 1, 'activity_type_id' => $this->test_activity_type_value, ); // create a logged in USER since the code references it for source_contact_id $this->createLoggedInUser(); } /** * Tears down the fixture, for example, closes a network connection. * This method is called after a test is executed. */ public function tearDown() { $tablesToTruncate = array( 'civicrm_contact', 'civicrm_activity', 'civicrm_activity_contact', ); $this->quickCleanup($tablesToTruncate, TRUE); $this->callAPISuccess('option_value', 'delete', array('id' => $this->test_activity_type_id)); } /** * Check with empty array */ public function testActivityCreateEmpty() { $result = $this->callAPIFailure('activity', 'create', array()); } /** * Check if required fields are not passed */ public function testActivityCreateWithoutRequired() { $params = array( 'subject' => 'this case should fail', 'scheduled_date_time' => date('Ymd'), ); $result = $this->callAPIFailure('activity', 'create', $params); } /** * Test civicrm_activity_create() with mismatched activity_type_id * and activity_name */ public function testActivityCreateMismatchNameType() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Test activity', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_name' => 'Fubar activity type', 'activity_type_id' => 5, 'scheduled_date_time' => date('Ymd'), ); $result = $this->callAPIFailure('activity', 'create', $params); } /** * Test civicrm_activity_id() with missing source_contact_id is put with the current user. */ public function testActivityCreateWithMissingContactId() { $params = array( 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_name' => 'Test activity type', ); $result = $this->callAPISuccess('activity', 'create', $params); } /** * Test civicrm_activity_id() with non-numeric source_contact_id */ public function testActivityCreateWithNonNumericContactId() { $params = array( 'source_contact_id' => 'fubar', 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_name' => 'Test activity type', ); $result = $this->callAPIFailure('activity', 'create', $params); } /** * Ensure that an invalid activity type causes failure * oddly enough this test was failing because the creation of the invalid type * got added to the set up routine. Probably a mis-fix on a test */ public function testActivityCreateWithNonNumericActivityTypeId() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_type_id' => 'Invalid Test activity type', ); $result = $this->callAPIFailure('activity', 'create', $params); } /** * Check with incorrect required fields */ public function testActivityCreateWithUnknownActivityTypeId() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_type_id' => 699, ); $result = $this->callAPIFailure('activity', 'create', $params); } public function testActivityCreateWithInvalidPriority() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'priority_id' => 44, 'activity_type_id' => 1, ); $result = $this->callAPIFailure('activity', 'create', $params, "'44' is not a valid option for field priority_id"); $this->assertEquals('priority_id', $result['error_field']); } public function testActivityCreateWithValidStringPriority() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'priority_id' => 'Urgent', 'activity_type_id' => 1, ); $result = $this->callAPISuccess('activity', 'create', $params); $this->assertEquals(1, $result['values'][$result['id']]['priority_id']); } public function testActivityCreateWithInValidStringPriority() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'priority_id' => 'ergUrgent', 'activity_type_id' => 1, ); $result = $this->callAPIFailure('activity', 'create', $params, "'ergUrgent' is not a valid option for field priority_id"); } /** * Test civicrm_activity_create() with valid parameters */ public function testActivityCreate() { $result = $this->callAPISuccess('activity', 'create', $this->_params); $result = $this->callAPISuccess('activity', 'get', $this->_params); $this->assertEquals($result['values'][$result['id']]['duration'], 120, 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['subject'], 'test activity type id', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['activity_date_time'], '2011-06-02 14:36:13', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['location'], 'Pensulvania', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['details'], 'a test activity', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['status_id'], 2, 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['id'], $result['id'], 'in line ' . __LINE__); } /** * Test civicrm_activity_create() with valid parameters - use type_id */ public function testActivityCreateCampaignTypeID() { $this->enableCiviCampaign(); $defaults = array(); $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => '20110316', 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_type_id' => 29, 'priority_id' => 1, ); $result = $this->callAPISuccess('activity', 'create', $params); //todo test target & assignee are set //$this->assertEquals($result['values'][$result['id']]['source_contact_id'], $this->_contactID, 'in line ' . __LINE__); $result = $this->callAPISuccess('activity', 'get', array('id' => $result['id'])); $this->assertEquals($result['values'][$result['id']]['duration'], 120, 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['subject'], 'Make-it-Happen Meeting', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['activity_date_time'], '2011-03-16 00:00:00', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['location'], 'Pensulvania', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['details'], 'a test activity', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['status_id'], 1, 'in line ' . __LINE__); } public function testActivityReturnTargetAssignee() { $description = "Example demonstrates setting & retrieving the target & source"; $subfile = "GetTargetandAssignee"; $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => '20110316', 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_type_id' => 1, 'priority_id' => 1, 'target_contact_id' => $this->_contactID, 'assignee_contact_id' => $this->_contactID, ); $result = $this->callAPIAndDocument('activity', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile); $result = $this->callAPISuccess('activity', 'get', array( 'id' => $result['id'], 'version' => $this->_apiversion, 'return.assignee_contact_id' => 1, 'return.target_contact_id' => 1 )); $this->assertEquals($this->_contactID, $result['values'][$result['id']]['assignee_contact_id'][0], 'in line ' . __LINE__); $this->assertEquals($this->_contactID, $result['values'][$result['id']]['target_contact_id'][0], 'in line ' . __LINE__); } public function testActivityCreateExample() { /** * Test civicrm_activity_create() using example code */ require_once 'api/v3/examples/Activity/Create.php'; $result = activity_create_example(); $expectedResult = activity_create_expectedresult(); $this->assertEquals($result, $expectedResult); } /** * Test civicrm_activity_create() with valid parameters * and some custom data */ public function testActivityCreateCustom() { $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); $params = $this->_params; $params['custom_' . $ids['custom_field_id']] = "custom string"; $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__); $result = $this->callAPISuccess($this->_entity, 'get', array( 'return.custom_' . $ids['custom_field_id'] => 1, 'version' => 3, 'id' => $result['id'] )); $this->assertEquals("custom string", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__); $this->customFieldDelete($ids['custom_field_id']); $this->customGroupDelete($ids['custom_group_id']); } /** * Test civicrm_activity_create() with valid parameters * and some custom data */ public function testActivityCreateCustomContactRefField() { $this->callAPISuccess('contact', 'create', array('id' => $this->_contactID, 'sort_name' => 'Contact, Test')); $subfile = 'ContactRefCustomField'; $description = "demonstrates create with Contact Reference Custom Field"; $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); $params = array( 'custom_group_id' => $ids['custom_group_id'], 'name' => 'Worker_Lookup', 'label' => 'Worker Lookup', 'html_type' => 'Autocomplete-Select', 'data_type' => 'ContactReference', 'weight' => 4, 'is_searchable' => 1, 'is_active' => 1, ); $customField = $this->callAPISuccess('custom_field', 'create', $params); $params = $this->_params; $params['custom_' . $customField['id']] = "$this->_contactID"; $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__, $description, $subfile, 'Create'); $result = $this->callAPIAndDocument($this->_entity, 'get', array( 'return.custom_' . $customField['id'] => 1, 'id' => $result['id'] ), __FUNCTION__, __FILE__, 'Get with Contact Ref Custom Field', 'ContactRefCustomFieldGet', 'get'); $this->assertEquals('Anderson, Anthony', $result['values'][$result['id']]['custom_' . $customField['id']], ' in line ' . __LINE__); $this->assertEquals($this->_contactID, $result['values'][$result['id']]['custom_' . $customField['id'] . "_id"], ' in line ' . __LINE__); $this->assertEquals('Anderson, Anthony', $result['values'][$result['id']]['custom_' . $customField['id'] . '_1'], ' in line ' . __LINE__); $this->assertEquals($this->_contactID, $result['values'][$result['id']]['custom_' . $customField['id'] . "_1_id"], ' in line ' . __LINE__); $this->customFieldDelete($ids['custom_field_id']); $this->customGroupDelete($ids['custom_group_id']); } /** * Test civicrm_activity_create() with an invalid text status_id */ public function testActivityCreateBadTextStatus() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Discussion on Apis for v3', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 'Invalid', 'activity_name' => 'Test activity type', ); $result = $this->callAPIFailure('activity', 'create', $params); } /** * Test civicrm_activity_create() with an invalid text status_id */ public function testActivityCreateSupportActivityStatus() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Discussion on Apis for v3', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'activity_status_id' => 'Invalid', 'activity_name' => 'Test activity type', ); $result = $this->callAPIFailure('activity', 'create', $params, "'Invalid' is not a valid option for field status_id"); } /** * Test civicrm_activity_create() with valid parameters, * using a text status_id */ public function testActivityCreateTextStatus() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => date('Ymd'), 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 'Scheduled', 'activity_name' => 'Test activity type', ); $result = $this->callAPISuccess('activity', 'create', $params); $this->assertEquals($result['values'][$result['id']]['duration'], 120, 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['subject'], 'Make-it-Happen Meeting', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['activity_date_time'], date('Ymd') . '000000', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['location'], 'Pensulvania', 'in line ' . __LINE__); $this->assertEquals($result['values'][$result['id']]['details'], 'a test activity', 'in line ' . __LINE__); } /** * Test civicrm_activity_get() with no params */ public function testActivityGetEmpty() { $result = $this->callAPISuccess('activity', 'get', array()); } /** * Test civicrm_activity_get() with a good activity ID */ public function testActivityGetGoodID1() { // Insert rows in civicrm_activity creating activities 4 and // 13 $description = "Function demonstrates getting asignee_contact_id & using it to get the contact"; $subfile = 'ReturnAssigneeContact'; $activity = $this->callAPISuccess('activity', 'create', $this->_params); $contact = $this->callAPISuccess('Contact', 'Create', array( 'first_name' => "The Rock", 'last_name' => 'roccky', 'contact_type' => 'Individual', 'version' => 3, 'api.activity.create' => array( 'id' => $activity['id'], 'assignee_contact_id' => '$value.id', ), )); $params = array( 'activity_id' => $activity['id'], 'version' => $this->_apiversion, 'sequential' => 1, 'return.assignee_contact_id' => 1, 'api.contact.get' => array( 'id' => '$value.source_contact_id', ), ); $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); $this->assertEquals($activity['id'], $result['id'], 'In line ' . __LINE__); $this->assertEquals($contact['id'], $result['values'][0]['assignee_contact_id'][0], 'In line ' . __LINE__); $this->assertEquals($this->_contactID, $result['values'][0]['api.contact.get']['values'][0]['contact_id'], 'In line ' . __LINE__); $this->assertEquals($this->test_activity_type_value, $result['values'][0]['activity_type_id'], 'In line ' . __LINE__); $this->assertEquals("test activity type id", $result['values'][0]['subject'], 'In line ' . __LINE__); } /* * test that get functioning does filtering */ public function testGetFilter() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => '20110316', 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_name' => 'Test activity type', 'priority_id' => 1, ); $result = $this->callAPISuccess('Activity', 'Create', $params); $this->callAPISuccess('Activity', 'Get', array('subject' => 'Make-it-Happen Meeting')); $this->assertEquals(1, $result['count']); $this->assertEquals('Make-it-Happen Meeting', $result['values'][$result['id']]['subject']); $this->callAPISuccess('Activity', 'Delete', array('id' => $result['id'])); } /** * Test civicrm_activity_get() with filter target_contact_id */ public function testActivityGetTargetFilter() { $params = $this->_params; $contact1Params = array( 'first_name' => 'John', 'middle_name' => 'J.', 'last_name' => 'Anderson', 'prefix_id' => 3, 'suffix_id' => 3, 'email' => 'john_anderson@civicrm.org', 'contact_type' => 'Individual', ); $contact1 = $this->individualCreate($contact1Params); $contact2Params = array( 'first_name' => 'Michal', 'middle_name' => 'J.', 'last_name' => 'Anderson', 'prefix_id' => 3, 'suffix_id' => 3, 'email' => 'michal_anderson@civicrm.org', 'contact_type' => 'Individual', ); $contact2 = $this->individualCreate($contact2Params); $params['assignee_contact_id'] = array($contact1, $contact2); $params['target_contact_id'] = array($contact2 => $contact2); $activity = $this->callAPISuccess('Activity', 'Create', $params); $activityget = $this->callAPISuccess('Activity', 'get', array( 'id' => $activity['id'], 'target_contact_id' => $contact2, 'return.target_contact_id' => 1 )); $this->assertEquals($activity['id'], $activityget['id'], 'In line ' . __LINE__); $this->assertEquals($contact2, $activityget['values'][$activityget['id']]['target_contact_id'][0], 'In line ' . __LINE__); $activityget = $this->callAPISuccess('activity', 'get', array( 'target_contact_id' => $this->_contactID, 'return.target_contact_id' => 1, 'id' => $activity['id'] )); if ($activityget['count'] > 0) { $this->assertNotEquals($contact2, $activityget['values'][$activityget['id']]['target_contact_id'][0], 'In line ' . __LINE__); } } /* * test that get functioning does filtering */ public function testGetStatusID() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => '20110316', 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_name' => 'Test activity type', 'priority_id' => 1, ); $this->callAPISuccess('Activity', 'Create', $params); $result = $this->callAPISuccess('Activity', 'Get', array('activity_status_id' => '1')); $this->assertEquals(1, $result['count'], 'one activity of status 1 should exist'); $result = $this->callAPISuccess('Activity', 'Get', array('status_id' => '1')); $this->assertEquals(1, $result['count'], 'status_id should also work'); $result = $this->callAPISuccess('Activity', 'Get', array('activity_status_id' => '2')); $this->assertEquals(0, $result['count'], 'No activities of status 1 should exist'); $result = $this->callAPISuccess('Activity', 'Get', array( 'version' => $this->_apiversion, 'status_id' => '2' )); $this->assertEquals(0, $result['count'], 'No activities of status 1 should exist'); } /* * test that get functioning does filtering */ public function testGetFilterMaxDate() { $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => '20110101', 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity', 'status_id' => 1, 'activity_name' => 'Test activity type', 'version' => $this->_apiversion, 'priority_id' => 1, ); $activityOne = $this->callAPISuccess('Activity', 'Create', $params); $params['activity_date_time'] = 20120216; $activityTwo = $this->callAPISuccess('Activity', 'Create', $params); $result = $this->callAPISuccess('Activity', 'Get', array( 'version' => 3, )); $description = "demonstrates _low filter (at time of writing doesn't work if contact_id is set"; $subfile = "DateTimeLow"; $this->assertEquals(2, $result['count']); $params = array( 'version' => 3, 'filter.activity_date_time_low' => '20120101000000', 'sequential' => 1, ); $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); $this->assertEquals(1, $result['count'], 'in line ' . __LINE__); $description = "demonstrates _high filter (at time of writing doesn't work if contact_id is set"; $subfile = "DateTimeHigh"; $this->assertEquals('2012-02-16 00:00:00', $result['values'][0]['activity_date_time'], 'in line ' . __LINE__); $params = array( 'source_contact_id' => $this->_contactID, 'version' => 3, 'filter.activity_date_time_high' => '20120101000000', 'sequential' => 1, ); $result = $this->callAPIAndDocument('Activity', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile); $this->assertEquals(1, $result['count']); $this->assertEquals('2011-01-01 00:00:00', $result['values'][0]['activity_date_time'], 'in line ' . __LINE__); $this->callAPISuccess('Activity', 'Delete', array('version' => 3, 'id' => $activityOne['id'])); $this->callAPISuccess('Activity', 'Delete', array('version' => 3, 'id' => $activityTwo['id'])); } /** * Test civicrm_activity_get() with a good activity ID which * has associated custom data */ public function testActivityGetGoodIDCustom() { $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); $params = $this->_params; $params['custom_' . $ids['custom_field_id']] = "custom string"; $result = $this->callAPISuccess($this->_entity, 'create', $params); // Retrieve the test value $params = array( 'activity_type_id' => $this->test_activity_type_value, 'sequential' => 1, 'return.custom_' . $ids['custom_field_id'] => 1, ); $result = $this->callAPIAndDocument('activity', 'get', $params, __FUNCTION__, __FILE__); $this->assertEquals("custom string", $result['values'][0]['custom_' . $ids['custom_field_id']]); $this->assertEquals($this->test_activity_type_value, $result['values'][0]['activity_type_id']); $this->assertEquals('test activity type id', $result['values'][0]['subject'], 'In line ' . __LINE__); $this->customFieldDelete($ids['custom_field_id']); $this->customGroupDelete($ids['custom_group_id']); } /** * Test civicrm_activity_get() with a good activity ID which * has associated custom data */ public function testActivityGetContact_idCustom() { $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); $params = $this->_params; $params['custom_' . $ids['custom_field_id']] = "custom string"; $result = $this->callAPISuccess($this->_entity, 'create', $params); // Retrieve the test value $params = array( 'contact_id' => $this->_params['source_contact_id'], 'activity_type_id' => $this->test_activity_type_value, 'sequential' => 1, 'return.custom_' . $ids['custom_field_id'] => 1, ); $result = $this->callAPIAndDocument('activity', 'get', $params, __FUNCTION__, __FILE__); $this->assertEquals("custom string", $result['values'][0]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__); $this->assertEquals($this->test_activity_type_value, $result['values'][0]['activity_type_id'], 'In line ' . __LINE__); $this->assertEquals('test activity type id', $result['values'][0]['subject'], 'In line ' . __LINE__); $this->assertEquals($result['values'][0]['id'], $result['id'], 'in line ' . __LINE__); } /** * Check activity deletion with empty params */ public function testDeleteActivityForEmptyParams() { $params = array('version' => $this->_apiversion); $result = $this->callAPIFailure('activity', 'delete', $params); } /** * Check activity deletion without activity id */ public function testDeleteActivityWithoutId() { $params = array( 'activity_name' => 'Meeting', 'version' => $this->_apiversion, ); $result = $this->callAPIFailure('activity', 'delete', $params); } /** * Check activity deletion without activity type */ public function testDeleteActivityWithoutActivityType() { $params = array('id' => 1); $result = $this->callAPIFailure('activity', 'delete', $params); } /** * Check activity deletion with incorrect data */ public function testDeleteActivityWithIncorrectActivityType() { $params = array( 'id' => 1, 'activity_name' => 'Test Activity', ); $result = $this->callAPIFailure('activity', 'delete', $params); } /** * Check activity deletion with correct data */ public function testDeleteActivity() { $result = $this->callAPISuccess('activity', 'create', $this->_params); $params = array( 'id' => $result['id'], 'version' => $this->_apiversion, ); $result = $this->callAPISuccess('activity', 'delete', $params); $this->documentMe($params, $result, __FUNCTION__, __FILE__); } /** * Check if required fields are not passed */ public function testActivityUpdateWithoutRequired() { $params = array( 'subject' => 'this case should fail', 'scheduled_date_time' => date('Ymd'), ); $result = $this->callAPIFailure('activity', 'create', $params); } /** * Test civicrm_activity_update() with non-numeric id */ public function testActivityUpdateWithNonNumericId() { $params = array( 'id' => 'lets break it', 'activity_name' => 'Meeting', 'subject' => 'this case should fail', 'scheduled_date_time' => date('Ymd'), ); $result = $this->callAPIFailure('activity', 'create', $params); } /** * Check with incorrect required fields */ public function testActivityUpdateWithIncorrectContactActivityType() { $params = array( 'id' => 1, 'activity_name' => 'Test Activity', 'subject' => 'this case should fail', 'scheduled_date_time' => date('Ymd'), 'source_contact_id' => $this->_contactID, ); $result = $this->callAPIFailure('activity', 'create', $params, 'Invalid Activity Id'); } /** * Test civicrm_activity_update() to update an existing activity */ public function testActivityUpdate() { $result = $this->callAPISuccess('activity', 'create', $this->_params); $params = array( 'id' => $result['id'], 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => '20091011123456', 'duration' => 120, 'location' => '21, Park Avenue', 'details' => 'Lets update Meeting', 'status_id' => 1, 'source_contact_id' => $this->_contactID, 'priority_id' => 1, ); $result = $this->callAPISuccess('activity', 'create', $params); //hack on date comparison - really we should make getAndCheck smarter to handle dates $params['activity_date_time'] = '2009-10-11 12:34:56'; // we also unset source_contact_id since it is stored in an aux table unset($params['source_contact_id']); $this->getAndCheck($params, $result['id'], 'activity'); } /** * Test civicrm_activity_update() with valid parameters * and some custom data */ public function testActivityUpdateCustom() { $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__); $params = $this->_params; // Create an activity with custom data //this has been updated from the previous 'old format' function - need to make it work $params = array( 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'activity_date_time' => '2009-10-18', 'duration' => 120, 'location' => 'Pensulvania', 'details' => 'a test activity to check the update api', 'status_id' => 1, 'activity_name' => 'Test activity type', 'version' => $this->_apiversion, 'custom_' . $ids['custom_field_id'] => 'custom string', ); $result = $this->callAPISuccess('activity', 'create', $params); $activityId = $result['id']; $result = $this->callAPISuccess($this->_entity, 'get', array( 'return.custom_' . $ids['custom_field_id'] => 1, 'version' => 3, 'id' => $result['id'] )); $this->assertEquals("custom string", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__); $this->assertEquals("2009-10-18 00:00:00", $result['values'][$result['id']]['activity_date_time'], ' in line ' . __LINE__); $fields = $this->callAPISuccess('activity', 'getfields', array('version' => $this->_apiversion)); $this->assertTrue(is_array($fields['values']['custom_' . $ids['custom_field_id']])); // Update the activity with custom data $params = array( 'id' => $activityId, 'source_contact_id' => $this->_contactID, 'subject' => 'Make-it-Happen Meeting', 'status_id' => 1, 'activity_name' => 'Test activity type', // add this since dates are messed up 'activity_date_time' => date('Ymd'), 'custom_' . $ids['custom_field_id'] => 'Updated my test data', 'version' => $this->_apiversion, ); $result = $this->callAPISuccess('Activity', 'Create', $params); $result = $this->callAPISuccess($this->_entity, 'get', array( 'return.custom_' . $ids['custom_field_id'] => 1, 'version' => 3, 'id' => $result['id'] )); $this->assertEquals("Updated my test data", $result['values'][$result['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__); } /** * Test civicrm_activity_update() for core activity fields * and some custom data */ public function testActivityUpdateCheckCoreFields() { $params = $this->_params; $contact1Params = array( 'first_name' => 'John', 'middle_name' => 'J.', 'last_name' => 'Anderson', 'prefix_id' => 3, 'suffix_id' => 3, 'email' => 'john_anderson@civicrm.org', 'contact_type' => 'Individual', ); $contact1 = $this->individualCreate($contact1Params); $contact2Params = array( 'first_name' => 'Michal', 'middle_name' => 'J.', 'last_name' => 'Anderson', 'prefix_id' => 3, 'suffix_id' => 3, 'email' => 'michal_anderson@civicrm.org', 'contact_type' => 'Individual', ); $contact2 = $this->individualCreate($contact2Params); $params['assignee_contact_id'] = array($contact1, $contact2); $params['target_contact_id'] = array($contact2 => $contact2); $result = $this->callAPISuccess('Activity', 'Create', $params); $activityId = $result['id']; $getParams = array( 'return.assignee_contact_id' => 1, 'return.target_contact_id' => 1, 'version' => $this->_apiversion, 'id' => $activityId, ); $result = $this->callAPISuccess($this->_entity, 'get', $getParams); $assignee = $result['values'][$result['id']]['assignee_contact_id']; $target = $result['values'][$result['id']]['target_contact_id']; $this->assertEquals(2, count($assignee), ' in line ' . __LINE__); $this->assertEquals(1, count($target), ' in line ' . __LINE__); $this->assertEquals(TRUE, in_array($contact1, $assignee), ' in line ' . __LINE__); $this->assertEquals(TRUE, in_array($contact2, $target), ' in line ' . __LINE__); $contact3Params = array( 'first_name' => 'Jijo', 'middle_name' => 'J.', 'last_name' => 'Anderson', 'prefix_id' => 3, 'suffix_id' => 3, 'email' => 'jijo_anderson@civicrm.org', 'contact_type' => 'Individual', ); $contact4Params = array( 'first_name' => 'Grant', 'middle_name' => 'J.', 'last_name' => 'Anderson', 'prefix_id' => 3, 'suffix_id' => 3, 'email' => 'grant_anderson@civicrm.org', 'contact_type' => 'Individual', ); $contact3 = $this->individualCreate($contact3Params); $contact4 = $this->individualCreate($contact4Params); $params = array(); $params['id'] = $activityId; $params['assignee_contact_id'] = array($contact3 => $contact3); $params['target_contact_id'] = array($contact4 => $contact4); $result = $this->callAPISuccess('activity', 'create', $params); $this->assertEquals($activityId, $result['id'], ' in line ' . __LINE__); $result = $this->callAPISuccess( $this->_entity, 'get', array( 'return.assignee_contact_id' => 1, 'return.target_contact_id' => 1, 'return.source_contact_id' => 1, 'id' => $result['id'], ) ); $assignee = $result['values'][$result['id']]['assignee_contact_id']; $target = $result['values'][$result['id']]['target_contact_id']; $this->assertEquals(1, count($assignee), ' in line ' . __LINE__); $this->assertEquals(1, count($target), ' in line ' . __LINE__); $this->assertEquals(TRUE, in_array($contact3, $assignee), ' in line ' . __LINE__); $this->assertEquals(TRUE, in_array($contact4, $target), ' in line ' . __LINE__); foreach ($this->_params as $fld => $val) { $this->assertEquals($val, $result['values'][$result['id']][$fld]); } } /** * Test civicrm_activity_update() where the DB has a date_time * value and there is none in the update params. */ public function testActivityUpdateNotDate() { $result = $this->callAPISuccess('activity', 'create', $this->_params); $params = array( 'id' => $result['id'], 'subject' => 'Make-it-Happen Meeting', 'duration' => 120, 'location' => '21, Park Avenue', 'details' => 'Lets update Meeting', 'status_id' => 1, 'source_contact_id' => $this->_contactID, 'priority_id' => 1, ); $result = $this->callAPISuccess('activity', 'create', $params); //hack on date comparison - really we should make getAndCheck smarter to handle dates $params['activity_date_time'] = $this->_params['activity_date_time']; // we also unset source_contact_id since it is stored in an aux table unset($params['source_contact_id']); $this->getAndCheck($params, $result['id'], 'activity'); } /** * Check activity update with status */ public function testActivityUpdateWithStatus() { $activity = $this->callAPISuccess('activity', 'create', $this->_params); $params = array( 'id' => $activity['id'], 'source_contact_id' => $this->_contactID, 'subject' => 'Hurry update works', 'status_id' => 1, 'activity_name' => 'Test activity type', ); $result = $this->callAPISuccess('activity', 'create', $params); $this->assertEquals($result['id'], $activity['id']); $this->assertEquals($result['values'][$activity['id']]['subject'], 'Hurry update works'); $this->assertEquals($result['values'][$activity['id']]['status_id'], 1 ); } /** * Test civicrm_activity_update() where the source_contact_id * is not in the update params. */ public function testActivityUpdateKeepSource() { $activity = $this->callAPISuccess('activity', 'create', $this->_params); // Updating the activity but not providing anything for the source contact // (It was set as $this->_contactID earlier.) $params = array( 'id' => $activity['id'], 'subject' => 'Updated Make-it-Happen Meeting', 'duration' => 120, 'location' => '21, Park Avenue', 'details' => 'Lets update Meeting', 'status_id' => 1, 'activity_name' => 'Test activity type', 'priority_id' => 1, ); $result = $this->callAPISuccess('activity', 'create', $params); $findactivity = $this->callAPISuccess('Activity', 'Get', array('id' => $activity['id'])); } /** * Test civicrm_activities_contact_get() */ public function testActivitiesContactGet() { $activity = $this->callAPISuccess('activity', 'create', $this->_params); $activity2 = $this->callAPISuccess('activity', 'create', $this->_params2); // Get activities associated with contact $this->_contactID $params = array( 'contact_id' => $this->_contactID, ); $result = $this->callAPISuccess('activity', 'get', $params); $this->assertEquals(2, $result['count'], 'In line ' . __LINE__); $this->assertEquals($this->test_activity_type_value, $result['values'][$activity['id']]['activity_type_id'], 'In line ' . __LINE__); $this->assertEquals('Test activity type', $result['values'][$activity['id']]['activity_name'], 'In line ' . __LINE__); $this->assertEquals('Test activity type', $result['values'][$activity2['id']]['activity_name'], 'In line ' . __LINE__); } /* * test chained Activity format */ public function testchainedActivityGet() { $activity = $this->callAPISuccess('Contact', 'Create', array( 'display_name' => "bob brown", 'contact_type' => 'Individual', 'api.activity_type.create' => array( 'weight' => '2', 'label' => 'send out letters', 'filter' => 0, 'is_active' => 1, 'is_optgroup' => 1, 'is_default' => 0, ), 'api.activity.create' => array( 'subject' => 'send letter', 'activity_type_id' => '$value.api.activity_type.create.values.0.value' ), )); $result = $this->callAPISuccess('Activity', 'Get', array( 'id' => $activity['id'], 'return.assignee_contact_id' => 1, 'api.contact.get' => array('api.pledge.get' => 1), )); } /** * Test civicrm_activity_contact_get() with invalid Contact Id */ public function testActivitiesContactGetWithInvalidContactId() { $params = array('contact_id' => 'contact'); $result = $this->callAPIFailure('activity', 'get', $params); } /** * Test civicrm_activity_contact_get() with contact having no Activity */ public function testActivitiesContactGetHavingNoActivity() { $params = array( 'first_name' => 'dan', 'last_name' => 'conberg', 'email' => 'dan.conberg@w.co.in', 'contact_type' => 'Individual', ); $contact = $this->callAPISuccess('contact', 'create', $params); $params = array( 'contact_id' => $contact['id'], ); $result = $this->callAPISuccess('activity', 'get', $params); $this->assertEquals($result['count'], 0, 'in line ' . __LINE__); } public function testGetFields() { $params = array('action' => 'create'); $result = $this->callAPIAndDocument('activity', 'getfields', $params, __FUNCTION__, __FILE__, NULL, NULL, 'getfields'); $this->assertTrue(is_array($result['values']), 'get fields doesnt return values array in line ' . __LINE__); // $this->assertTrue(is_array($result['values']['priority_id']['options'])); foreach ($result['values'] as $key => $value) { $this->assertTrue(is_array($value), $key . " is not an array in line " . __LINE__); } } }