4 * File for the TestCase class
8 * @author Walt Haas <walt@dharmatech.org> (801) 534-1262
9 * @copyright Copyright CiviCRM LLC (C) 2009
10 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html
11 * GNU Affero General Public License version 3
12 * @version $Id: ActivityTest.php 31254 2010-12-15 10:09:29Z eileen $
15 * This file is part of CiviCRM
17 * CiviCRM is free software; you can redistribute it and/or
18 * modify it under the terms of the GNU Affero General Public License
19 * as published by the Free Software Foundation; either version 3 of
20 * the License, or (at your option) any later version.
22 * CiviCRM is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU Affero General Public License for more details.
27 * You should have received a copy of the GNU Affero General Public
28 * License along with this program. If not, see
29 * <http://www.gnu.org/licenses/>.
33 * Include class definitions
35 require_once 'CiviTest/CiviCaseTestCase.php';
38 * Test APIv3 civicrm_case_* functions
40 * @package CiviCRM_APIv3
42 class api_v3_CaseTest
extends CiviCaseTestCase
{
45 protected $_apiversion = 3;
46 protected $followup_activity_type_value;
48 * Activity ID of created case.
52 protected $_caseActivityId;
55 * Test setup for every test.
57 * Connect to the database, truncate the tables that will be used
58 * and redirect stdin to a temporary file.
60 public function setUp() {
61 $this->_entity
= 'case';
65 $activityTypes = $this->callAPISuccess('option_value', 'get', array(
66 'option_group_id' => 2,
67 'name' => 'Follow Up',
68 'label' => 'Follow Up',
71 $this->followup_activity_type_value
= $activityTypes['values'][0]['value'];
73 $this->_params
= array(
74 'case_type_id' => $this->caseTypeId
,
75 'subject' => 'Test case',
81 * Check with empty array.
83 public function testCaseCreateEmpty() {
84 $this->callAPIFailure('case', 'create', array());
88 * Check if required fields are not passed.
90 public function testCaseCreateWithoutRequired() {
92 'subject' => 'this case should fail',
96 $this->callAPIFailure('case', 'create', $params);
100 * Test create function with valid parameters.
102 public function testCaseCreate() {
103 $params = $this->_params
;
104 // Test using label instead of value.
105 unset($params['case_type_id']);
106 $params['case_type'] = $this->caseType
;
107 $result = $this->callAPIAndDocument('case', 'create', $params, __FUNCTION__
, __FILE__
);
111 $result = $this->callAPISuccess('case', 'get', array('id' => $id));
112 $this->assertEquals($result['values'][$id]['id'], $id);
113 $this->assertEquals($result['values'][$id]['case_type_id'], $this->caseTypeId
);
114 $this->assertEquals($result['values'][$id]['subject'], $params['subject']);
118 * Test update (create with id) function with valid parameters.
120 public function testCaseUpdate() {
121 $params = $this->_params
;
122 // Test using name instead of value
123 unset($params['case_type_id']);
124 $params['case_type'] = $this->caseType
;
125 $result = $this->callAPISuccess('case', 'create', $params);
127 $result = $this->callAPISuccess('case', 'get', array('id' => $id));
128 $case = $result['values'][$id];
131 $params = array('id' => $id);
132 $params['subject'] = $case['subject'] = 'Something Else';
133 $this->callAPISuccess('case', 'create', $params);
135 // Verify that updated case is exactly equal to the original with new subject.
136 $result = $this->callAPISuccess('case', 'get', array('case_id' => $id));
137 $this->assertEquals($result['values'][$id], $case);
141 * Test delete function with valid parameters.
143 public function testCaseDelete() {
145 $result = $this->callAPISuccess('case', 'create', $this->_params
);
147 // Move Case to Trash
149 $result = $this->callAPISuccess('case', 'delete', array('id' => $id, 'move_to_trash' => 1));
151 // Check result - also check that 'case_id' works as well as 'id'
152 $result = $this->callAPISuccess('case', 'get', array('case_id' => $id));
153 $this->assertEquals(1, $result['values'][$id]['is_deleted']);
155 // Delete Case Permanently - also check that 'case_id' works as well as 'id'
156 $result = $this->callAPISuccess('case', 'delete', array('case_id' => $id));
158 // Check result - case should no longer exist
159 $result = $this->callAPISuccess('case', 'get', array('id' => $id));
160 $this->assertEquals(0, $result['count']);
164 * Test get function based on activity.
166 public function testCaseGetByActivity() {
168 $result = $this->callAPISuccess('case', 'create', $this->_params
);
171 // Check result - we should get a list of activity ids
172 $result = $this->callAPISuccess('case', 'get', array('id' => $id));
173 $case = $result['values'][$id];
174 $activity = $case['activities'][0];
176 // Fetch case based on an activity id
177 $result = $this->callAPISuccess('case', 'get', array(
178 'activity_id' => $activity,
179 'return' => 'activities,contacts',
181 $this->assertEquals(FALSE, empty($result['values'][$id]));
182 $this->assertEquals($result['values'][$id], $case);
186 * Test get function based on contact id.
188 public function testCaseGetByContact() {
190 $result = $this->callAPISuccess('case', 'create', $this->_params
);
193 // Store result for later
194 $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));
196 // Fetch case based on client contact id
197 $result = $this->callAPISuccess('case', 'get', array(
198 'client_id' => $this->_params
['contact_id'],
199 'return' => array('activities', 'contacts'),
201 $this->assertAPIArrayComparison($result['values'][$id], $case);
205 * Test get function based on subject.
207 public function testCaseGetBySubject() {
209 $result = $this->callAPISuccess('case', 'create', $this->_params
);
212 // Store result for later
213 $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));
215 // Fetch case based on client contact id
216 $result = $this->callAPISuccess('case', 'get', array(
217 'subject' => $this->_params
['subject'],
218 'return' => array('activities', 'contacts'),
220 $this->assertAPIArrayComparison($result['values'][$id], $case);
224 * Test get function based on wrong subject.
226 public function testCaseGetByWrongSubject() {
227 $result = $this->callAPISuccess('case', 'create', $this->_params
);
229 // Append 'wrong' to subject so that it is no longer the same.
230 $result = $this->callAPISuccess('case', 'get', array(
231 'subject' => $this->_params
['subject'] . 'wrong',
232 'return' => array('activities', 'contacts'),
234 $this->assertEquals(0, $result['count']);
238 * Test get function with no criteria.
240 public function testCaseGetNoCriteria() {
241 $result = $this->callAPISuccess('case', 'create', $this->_params
);
244 // Store result for later
245 $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));
247 $result = $this->callAPISuccess('case', 'get', array('return' => array('activities', 'contacts')));
248 $this->assertAPIArrayComparison($result['values'][$id], $case);
252 * Test activity api create for case activities.
254 public function testCaseActivityCreate() {
255 $params = $this->_params
;
256 $this->callAPISuccess('case', 'create', $params);
260 'activity_type_id' => $this->followup_activity_type_value
,
261 'subject' => 'Test followup',
262 'source_contact_id' => $this->_loggedInUser
,
263 'target_contact_id' => $this->_params
['contact_id'],
265 $result = $this->callAPISuccess('activity', 'create', $params);
266 $this->assertEquals($result['values'][$result['id']]['activity_type_id'], $params['activity_type_id']);
268 // might need this for other tests that piggyback on this one
269 $this->_caseActivityId
= $result['values'][$result['id']]['id'];
271 // Check other DB tables populated properly - is there a better way to do this? assertDBState() requires that we know the id already.
272 $dao = new CRM_Case_DAO_CaseActivity();
274 $dao->activity_id
= $this->_caseActivityId
;
275 $this->assertEquals($dao->find(), 1, 'case_activity table not populated correctly in line ' . __LINE__
);
278 $dao = new CRM_Activity_DAO_ActivityContact();
279 $dao->activity_id
= $this->_caseActivityId
;
280 $dao->contact_id
= $this->_params
['contact_id'];
281 $dao->record_type_id
= 3;
282 $this->assertEquals($dao->find(), 1, 'activity_contact table not populated correctly in line ' . __LINE__
);
285 // TODO: There's more things we could check
289 * Test activity api update for case activities.
291 public function testCaseActivityUpdate() {
292 // Need to create the case and activity before we can update it
293 $this->testCaseActivityCreate();
296 'activity_id' => $this->_caseActivityId
,
298 'activity_type_id' => 14,
299 'source_contact_id' => $this->_loggedInUser
,
300 'subject' => 'New subject',
302 $result = $this->callAPISuccess('activity', 'create', $params);
304 $this->assertEquals($result['values'][$result['id']]['subject'], $params['subject']);
306 // id should be one greater, since this is a new revision
307 $this->assertEquals($result['values'][$result['id']]['id'],
308 $this->_caseActivityId +
1,
309 'in line ' . __LINE__
311 $this->assertEquals($result['values'][$result['id']]['original_id'],
312 $this->_caseActivityId
,
313 'in line ' . __LINE__
316 // Check revision is as expected
318 'activity_id' => $this->_caseActivityId
,
320 $revActivity = $this->callAPISuccess('activity', 'get', $revParams);
321 $this->assertEquals($revActivity['values'][$this->_caseActivityId
]['is_current_revision'],
323 $this->assertEquals($revActivity['values'][$this->_caseActivityId
]['is_deleted'],
327 //TODO: check some more things
330 public function testCaseActivityUpdateCustom() {
331 // Create a case first
332 $result = $this->callAPISuccess('case', 'create', $this->_params
);
334 // Create custom field group
335 // Note the second parameter is Activity on purpose, not Case.
336 $custom_ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, 'ActivityTest.php');
340 'case_id' => $result['id'],
342 'activity_type_id' => 14,
343 'subject' => 'Test followup',
344 'source_contact_id' => $this->_loggedInUser
,
345 'target_contact_id' => $this->_params
['contact_id'],
346 'custom_' . $custom_ids['custom_field_id'] => "custom string",
348 $result = $this->callAPISuccess('activity', 'create', $params);
350 $aid = $result['values'][$result['id']]['id'];
354 'activity_id' => $aid,
356 'activity_type_id' => 14,
357 'source_contact_id' => $this->_loggedInUser
,
358 'subject' => 'New subject',
360 $this->callAPISuccess('activity', 'create', $params);
362 // Retrieve revision and check custom fields got copied.
364 'activity_id' => $aid +
1,
365 'return.custom_' . $custom_ids['custom_field_id'] => 1,
367 $revAct = $this->callAPISuccess('activity', 'get', $revParams);
369 $this->assertEquals($revAct['values'][$aid +
1]['custom_' . $custom_ids['custom_field_id']], "custom string",
370 "Error message: " . CRM_Utils_Array
::value('error_message', $revAct));
372 $this->customFieldDelete($custom_ids['custom_field_id']);
373 $this->customGroupDelete($custom_ids['custom_group_id']);