3 * File for the TestCase class
7 * @author Walt Haas <walt@dharmatech.org> (801) 534-1262
8 * @copyright Copyright CiviCRM LLC (C) 2009
9 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html
10 * GNU Affero General Public License version 3
11 * @version $Id: ActivityTest.php 31254 2010-12-15 10:09:29Z eileen $
14 * This file is part of CiviCRM
16 * CiviCRM is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU Affero General Public License
18 * as published by the Free Software Foundation; either version 3 of
19 * the License, or (at your option) any later version.
21 * CiviCRM is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU Affero General Public License for more details.
26 * You should have received a copy of the GNU Affero General Public
27 * License along with this program. If not, see
28 * <http://www.gnu.org/licenses/>.
32 * Include class definitions
34 require_once 'CiviTest/CiviCaseTestCase.php';
37 * Test APIv3 civicrm_case_* functions
39 * @package CiviCRM_APIv3
41 class api_v3_CaseTest
extends CiviCaseTestCase
{
44 protected $_apiversion = 3;
45 protected $followup_activity_type_value;
48 * Test setup for every test
50 * Connect to the database, truncate the tables that will be used
51 * and redirect stdin to a temporary file
53 public function setUp() {
54 $this->_entity
= 'case';
58 $activityTypes = $this->callAPISuccess('option_value', 'get', array(
59 'option_group_id' => 2,
60 'name' => 'Follow Up',
61 'label' => 'Follow Up',
64 $this->followup_activity_type_value
= $activityTypes['values'][0]['value'];
66 $this->_params
= array(
67 'case_type_id' => $this->caseTypeId
,
68 'subject' => 'Test case',
74 * Check with empty array
76 public function testCaseCreateEmpty() {
77 $result = $this->callAPIFailure('case', 'create', array());
81 * Check if required fields are not passed
83 public function testCaseCreateWithoutRequired() {
85 'subject' => 'this case should fail',
89 $result = $this->callAPIFailure('case', 'create', $params);
93 * Test create function with valid parameters
95 public function testCaseCreate() {
97 $params = $this->_params
;
98 // Test using label instead of value
99 unset($params['case_type_id']);
100 $params['case_type'] = $this->caseType
;
101 $result = $this->callAPIAndDocument('case', 'create', $params, __FUNCTION__
, __FILE__
);
105 $result = $this->callAPISuccess('case', 'get', array('id' => $id));
106 $this->assertEquals($result['values'][$id]['id'], $id, 'in line ' . __LINE__
);
107 $this->assertEquals($result['values'][$id]['case_type_id'], $this->caseTypeId
, 'in line ' . __LINE__
);
108 $this->assertEquals($result['values'][$id]['subject'], $params['subject'], 'in line ' . __LINE__
);
112 * Test update (create with id) function with valid parameters
114 public function testCaseUpdate() {
116 $params = $this->_params
;
117 // Test using name instead of value
118 unset($params['case_type_id']);
119 $params['case_type'] = $this->caseType
;
120 $result = $this->callAPISuccess('case', 'create', $params);
122 $result = $this->callAPISuccess('case', 'get', array('id' => $id));
123 $case = $result['values'][$id];
126 $params = array('id' => $id);
127 $params['subject'] = $case['subject'] = 'Something Else';
128 $result = $this->callAPISuccess('case', 'create', $params);
130 // Verify that updated case is exactly equal to the original with new subject
131 $result = $this->callAPISuccess('case', 'get', array('case_id' => $id));
132 $this->assertEquals($result['values'][$id], $case, 'in line ' . __LINE__
);
136 * Test delete function with valid parameters
138 public function testCaseDelete() {
140 $result = $this->callAPISuccess('case', 'create', $this->_params
);
142 // Move Case to Trash
144 $result = $this->callAPISuccess('case', 'delete', array('id' => $id, 'move_to_trash' => 1));
146 // Check result - also check that 'case_id' works as well as 'id'
147 $result = $this->callAPISuccess('case', 'get', array('case_id' => $id));
148 $this->assertEquals(1, $result['values'][$id]['is_deleted'], 'in line ' . __LINE__
);
150 // Delete Case Permanently - also check that 'case_id' works as well as 'id'
151 $result = $this->callAPISuccess('case', 'delete', array('case_id' => $id));
153 // Check result - case should no longer exist
154 $result = $this->callAPISuccess('case', 'get', array('id' => $id));
155 $this->assertEquals(0, $result['count']);
159 * Test get function based on activity
161 public function testCaseGetByActivity() {
163 $result = $this->callAPISuccess('case', 'create', $this->_params
);
166 // Check result - we should get a list of activity ids
167 $result = $this->callAPISuccess('case', 'get', array('id' => $id));
168 $case = $result['values'][$id];
169 $activity = $case['activities'][0];
171 // Fetch case based on an activity id
172 $result = $this->callAPISuccess('case', 'get', array(
173 'activity_id' => $activity,
174 'return' => 'activities,contacts'
176 $this->assertEquals(FALSE, empty($result['values'][$id]), 'in line ' . __LINE__
);
177 $this->assertEquals($result['values'][$id], $case, 'in line ' . __LINE__
);
181 * Test get function based on contact id
183 public function testCaseGetByContact() {
185 $result = $this->callAPISuccess('case', 'create', $this->_params
);
188 // Store result for later
189 $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));
191 // Fetch case based on client contact id
192 $result = $this->callAPISuccess('case', 'get', array(
193 'client_id' => $this->_params
['contact_id'],
194 'return' => array('activities', 'contacts')
196 $this->assertAPIArrayComparison($result['values'][$id], $case);
200 * Test get function based on subject
202 public function testCaseGetBySubject() {
204 $result = $this->callAPISuccess('case', 'create', $this->_params
);
207 // Store result for later
208 $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));
210 // Fetch case based on client contact id
211 $result = $this->callAPISuccess('case', 'get', array(
212 'subject' => $this->_params
['subject'],
213 'return' => array('activities', 'contacts')
215 $this->assertAPIArrayComparison($result['values'][$id], $case);
219 * Test get function based on wrong subject
221 public function testCaseGetByWrongSubject() {
223 $result = $this->callAPISuccess('case', 'create', $this->_params
);
226 // Append 'wrong' to subject so that it is no longer the same
227 $result = $this->callAPISuccess('case', 'get', array(
228 'subject' => $this->_params
['subject'] . 'wrong',
229 'return' => array('activities', 'contacts')
231 $this->assertEquals(0, $result['count'], 'in line ' . __LINE__
);
235 * Test get function with no criteria
237 public function testCaseGetNoCriteria() {
239 $result = $this->callAPISuccess('case', 'create', $this->_params
);
242 // Store result for later
243 $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));
245 $result = $this->callAPISuccess('case', 'get', array('return' => array('activities', 'contacts')));
246 $this->assertAPIArrayComparison($result['values'][$id], $case);
250 * Test activity api create for case activities
252 public function testCaseActivityCreate() {
253 // Create a case first
254 $params = $this->_params
;
255 $result = $this->callAPISuccess('case', 'create', $params);
259 'activity_type_id' => $this->followup_activity_type_value
,
260 'subject' => 'Test followup',
261 'source_contact_id' => $this->_loggedInUser
,
262 'target_contact_id' => $this->_params
['contact_id'],
264 $result = $this->callAPISuccess('activity', 'create', $params);
265 $this->assertEquals($result['values'][$result['id']]['activity_type_id'], $params['activity_type_id'], 'in line ' . __LINE__
);
267 // might need this for other tests that piggyback on this one
268 $this->_caseActivityId
= $result['values'][$result['id']]['id'];
270 // Check other DB tables populated properly - is there a better way to do this? assertDBState() requires that we know the id already.
271 $dao = new CRM_Case_DAO_CaseActivity();
273 $dao->activity_id
= $this->_caseActivityId
;
274 $this->assertEquals($dao->find(), 1, 'case_activity table not populated correctly in line ' . __LINE__
);
277 $dao = new CRM_Activity_DAO_ActivityContact();
278 $dao->activity_id
= $this->_caseActivityId
;
279 $dao->contact_id
= $this->_params
['contact_id'];
280 $dao->record_type_id
= 3;
281 $this->assertEquals($dao->find(), 1, 'activity_contact table not populated correctly in line ' . __LINE__
);
284 // TODO: There's more things we could check
288 * Test activity api update for case activities
290 public function testCaseActivityUpdate() {
291 // Need to create the case and activity before we can update it
292 $this->testCaseActivityCreate();
295 'activity_id' => $this->_caseActivityId
,
297 'activity_type_id' => 14,
298 'source_contact_id' => $this->_loggedInUser
,
299 'subject' => 'New subject',
301 $result = $this->callAPISuccess('activity', 'create', $params);
303 $this->assertEquals($result['values'][$result['id']]['subject'], $params['subject'], 'in line ' . __LINE__
);
305 // id should be one greater, since this is a new revision
306 $this->assertEquals($result['values'][$result['id']]['id'],
307 $this->_caseActivityId +
1,
308 'in line ' . __LINE__
310 $this->assertEquals($result['values'][$result['id']]['original_id'],
311 $this->_caseActivityId
,
312 'in line ' . __LINE__
315 // Check revision is as expected
317 'activity_id' => $this->_caseActivityId
,
319 $revActivity = $this->callAPISuccess('activity', 'get', $revParams);
320 $this->assertEquals($revActivity['values'][$this->_caseActivityId
]['is_current_revision'],
322 $this->assertEquals($revActivity['values'][$this->_caseActivityId
]['is_deleted'],
326 //TODO: check some more things
329 public function testCaseActivityUpdateCustom() {
330 // Create a case first
331 $result = $this->callAPISuccess('case', 'create', $this->_params
);
333 // Create custom field group
334 // Note the second parameter is Activity on purpose, not Case.
335 $custom_ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__
, 'ActivityTest.php');
339 'case_id' => $result['id'],
341 'activity_type_id' => 14,
342 'subject' => 'Test followup',
343 'source_contact_id' => $this->_loggedInUser
,
344 'target_contact_id' => $this->_params
['contact_id'],
345 'custom_' . $custom_ids['custom_field_id'] => "custom string",
347 $result = $this->callAPISuccess('activity', 'create', $params);
349 $aid = $result['values'][$result['id']]['id'];
353 'activity_id' => $aid,
355 'activity_type_id' => 14,
356 'source_contact_id' => $this->_loggedInUser
,
357 'subject' => 'New subject',
359 $revAct = $this->callAPISuccess('activity', 'create', $params);
361 // Retrieve revision and check custom fields got copied
363 'activity_id' => $aid +
1,
364 'return.custom_' . $custom_ids['custom_field_id'] => 1,
366 $revAct = $this->callAPISuccess('activity', 'get', $revParams);
368 $this->assertEquals($revAct['values'][$aid +
1]['custom_' . $custom_ids['custom_field_id']], "custom string",
369 "Error message: " . CRM_Utils_Array
::value('error_message', $revAct) . ' in line ' . __LINE__
372 $this->customFieldDelete($custom_ids['custom_field_id']);
373 $this->customGroupDelete($custom_ids['custom_group_id']);