tests/phpunit/api/v3/CaseTest.php

   1 <?php
   2 /**
   3  * @file
   4  * File for the TestCase class
   5  *
   6  *  (PHP 5)
   7  *
   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 $
  13  * @package   CiviCRM
  14  *
  15  *   This file is part of CiviCRM
  16  *
  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.
  21  *
  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.
  26  *
  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/>.
  30  */
  31
  32 /**
  33  * Include class definitions
  34  */
  35 require_once 'CiviTest/CiviCaseTestCase.php';
  36
  37 /**
  38  *  Test APIv3 civicrm_case_* functions
  39  *
  40  * @package CiviCRM_APIv3
  41  * @group headless
  42  */
  43 class api_v3_CaseTest extends CiviCaseTestCase {
  44   protected $_params;
  45   protected $_entity;
  46   protected $_apiversion = 3;
  47   protected $followup_activity_type_value;
  48   /**
  49    * Activity ID of created case.
  50    *
  51    * @var int
  52    */
  53   protected $_caseActivityId;
  54
  55   /**
  56    * Test setup for every test.
  57    *
  58    * Connect to the database, truncate the tables that will be used
  59    * and redirect stdin to a temporary file.
  60    */
  61   public function setUp() {
  62     $this->_entity = 'case';
  63
  64     parent::setUp();
  65
  66     $activityTypes = $this->callAPISuccess('option_value', 'get', array(
  67       'option_group_id' => 2,
  68       'name' => 'Follow Up',
  69       'label' => 'Follow Up',
  70       'sequential' => 1,
  71     ));
  72     $this->followup_activity_type_value = $activityTypes['values'][0]['value'];
  73
  74     $this->_params = array(
  75       'case_type_id' => $this->caseTypeId,
  76       'subject' => 'Test case',
  77       'contact_id' => 17,
  78     );
  79   }
  80
  81   /**
  82    * Check with empty array.
  83    */
  84   public function testCaseCreateEmpty() {
  85     $this->callAPIFailure('case', 'create', array());
  86   }
  87
  88   /**
  89    * Check if required fields are not passed.
  90    */
  91   public function testCaseCreateWithoutRequired() {
  92     $params = array(
  93       'subject' => 'this case should fail',
  94       'case_type_id' => 1,
  95     );
  96
  97     $this->callAPIFailure('case', 'create', $params);
  98   }
  99
 100   /**
 101    * Test create function with valid parameters.
 102    */
 103   public function testCaseCreate() {
 104     $params = $this->_params;
 105     // Test using label instead of value.
 106     unset($params['case_type_id']);
 107     $params['case_type'] = $this->caseType;
 108     $result = $this->callAPIAndDocument('case', 'create', $params, __FUNCTION__, __FILE__);
 109     $id = $result['id'];
 110
 111     // Check result
 112     $result = $this->callAPISuccess('case', 'get', array('id' => $id));
 113     $this->assertEquals($result['values'][$id]['id'], $id);
 114     $this->assertEquals($result['values'][$id]['case_type_id'], $this->caseTypeId);
 115     $this->assertEquals($result['values'][$id]['subject'], $params['subject']);
 116   }
 117
 118   /**
 119    * Test update (create with id) function with valid parameters.
 120    */
 121   public function testCaseUpdate() {
 122     $params = $this->_params;
 123     // Test using name instead of value
 124     unset($params['case_type_id']);
 125     $params['case_type'] = $this->caseType;
 126     $result = $this->callAPISuccess('case', 'create', $params);
 127     $id = $result['id'];
 128     $case = $this->callAPISuccess('case', 'getsingle', array('id' => $id));
 129
 130     // Update Case.
 131     $params = array('id' => $id);
 132     $params['subject'] = $case['subject'] = 'Something Else';
 133     $this->callAPISuccess('case', 'create', $params);
 134
 135     // Verify that updated case is exactly equal to the original with new subject.
 136     $result = $this->callAPISuccessGetSingle('Case', array('case_id' => $id));
 137     $this->assertAPIArrayComparison($result, $case);
 138   }
 139
 140   /**
 141    * Test delete function with valid parameters.
 142    */
 143   public function testCaseDelete() {
 144     // Create Case
 145     $result = $this->callAPISuccess('case', 'create', $this->_params);
 146
 147     // Move Case to Trash
 148     $id = $result['id'];
 149     $result = $this->callAPISuccess('case', 'delete', array('id' => $id, 'move_to_trash' => 1));
 150
 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']);
 154
 155     // Delete Case Permanently - also check that 'case_id' works as well as 'id'
 156     $result = $this->callAPISuccess('case', 'delete', array('case_id' => $id));
 157
 158     // Check result - case should no longer exist
 159     $result = $this->callAPISuccess('case', 'get', array('id' => $id));
 160     $this->assertEquals(0, $result['count']);
 161   }
 162
 163   /**
 164    * Test get function based on activity.
 165    */
 166   public function testCaseGetByActivity() {
 167     // Create Case
 168     $result = $this->callAPISuccess('case', 'create', $this->_params);
 169     $id = $result['id'];
 170
 171     // Check result - we should get a list of activity ids
 172     $result = $this->callAPISuccess('case', 'get', array('id' => $id, 'return' => 'activities'));
 173     $case = $result['values'][$id];
 174     $activity = $case['activities'][0];
 175
 176     // Fetch case based on an activity id
 177     $result = $this->callAPISuccess('case', 'get', array(
 178         'activity_id' => $activity,
 179         'return' => 'activities',
 180       ));
 181     $this->assertEquals(FALSE, empty($result['values'][$id]));
 182     $this->assertEquals($result['values'][$id], $case);
 183   }
 184
 185   /**
 186    * Test get function based on contact id.
 187    */
 188   public function testCaseGetByContact() {
 189     // Create Case
 190     $result = $this->callAPISuccess('case', 'create', $this->_params);
 191     $id = $result['id'];
 192
 193     // Store result for later
 194     $case = $this->callAPISuccessGetSingle('case', array('id' => $id, 'return' => array('activities', 'contacts')));
 195
 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'),
 200       ));
 201     $this->assertAPIArrayComparison($result['values'][$id], $case);
 202   }
 203
 204   /**
 205    * Test get function based on subject.
 206    */
 207   public function testCaseGetBySubject() {
 208     // Create Case
 209     $result = $this->callAPISuccess('case', 'create', $this->_params);
 210     $id = $result['id'];
 211
 212     // Store result for later
 213     $case = $this->callAPISuccessGetSingle('Case', array('id' => $id, 'return' => 'subject'));
 214
 215     // Fetch case based on client contact id
 216     $result = $this->callAPISuccess('case', 'get', array(
 217         'subject' => $this->_params['subject'],
 218         'return' => array('subject'),
 219       ));
 220     $this->assertAPIArrayComparison($result['values'][$id], $case);
 221   }
 222
 223   /**
 224    * Test get function based on wrong subject.
 225    */
 226   public function testCaseGetByWrongSubject() {
 227     $result = $this->callAPISuccess('case', 'create', $this->_params);
 228
 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'),
 233       ));
 234     $this->assertEquals(0, $result['count']);
 235   }
 236
 237   /**
 238    * Test get function with no criteria.
 239    */
 240   public function testCaseGetNoCriteria() {
 241     $result = $this->callAPISuccess('case', 'create', $this->_params);
 242     $id = $result['id'];
 243
 244     // Store result for later
 245     $case = $this->callAPISuccessGetSingle('Case', array('id' => $id, 'return' => 'contact_id'));
 246
 247     $result = $this->callAPISuccess('case', 'get', array('limit' => 0, 'return' => array('contact_id')));
 248     $this->assertAPIArrayComparison($result['values'][$id], $case);
 249   }
 250
 251   /**
 252    * Test activity api create for case activities.
 253    */
 254   public function testCaseActivityCreate() {
 255     $params = $this->_params;
 256     $this->callAPISuccess('case', 'create', $params);
 257     $params = array(
 258       'case_id' => 1,
 259       // follow up
 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'],
 264     );
 265     $result = $this->callAPISuccess('activity', 'create', $params);
 266     $this->assertEquals($result['values'][$result['id']]['activity_type_id'], $params['activity_type_id']);
 267
 268     // might need this for other tests that piggyback on this one
 269     $this->_caseActivityId = $result['values'][$result['id']]['id'];
 270
 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();
 273     $dao->case_id = 1;
 274     $dao->activity_id = $this->_caseActivityId;
 275     $this->assertEquals($dao->find(), 1, 'case_activity table not populated correctly in line ' . __LINE__);
 276     $dao->free();
 277
 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__);
 283     $dao->free();
 284
 285     // TODO: There's more things we could check
 286   }
 287
 288   /**
 289    * Test activity api update for case activities.
 290    */
 291   public function testCaseActivityUpdate() {
 292     // Need to create the case and activity before we can update it
 293     $this->testCaseActivityCreate();
 294
 295     $params = array(
 296       'activity_id' => $this->_caseActivityId,
 297       'case_id' => 1,
 298       'activity_type_id' => 14,
 299       'source_contact_id' => $this->_loggedInUser,
 300       'subject' => 'New subject',
 301     );
 302     $result = $this->callAPISuccess('activity', 'create', $params);
 303
 304     $this->assertEquals($result['values'][$result['id']]['subject'], $params['subject']);
 305
 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__
 310     );
 311     $this->assertEquals($result['values'][$result['id']]['original_id'],
 312       $this->_caseActivityId,
 313       'in line ' . __LINE__
 314     );
 315
 316     // Check revision is as expected
 317     $revParams = array(
 318       'activity_id' => $this->_caseActivityId,
 319     );
 320     $revActivity = $this->callAPISuccess('activity', 'get', $revParams);
 321     $this->assertEquals($revActivity['values'][$this->_caseActivityId]['is_current_revision'],
 322       0);
 323     $this->assertEquals($revActivity['values'][$this->_caseActivityId]['is_deleted'],
 324       0
 325     );
 326
 327     //TODO: check some more things
 328   }
 329
 330   public function testCaseActivityUpdateCustom() {
 331     // Create a case first
 332     $result = $this->callAPISuccess('case', 'create', $this->_params);
 333
 334     // Create custom field group
 335     // Note the second parameter is Activity on purpose, not Case.
 336     $custom_ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'ActivityTest.php');
 337
 338     // create activity
 339     $params = array(
 340       'case_id' => $result['id'],
 341       // follow up
 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",
 347     );
 348     $result = $this->callAPISuccess('activity', 'create', $params);
 349
 350     $aid = $result['values'][$result['id']]['id'];
 351
 352     // Update activity
 353     $params = array(
 354       'activity_id' => $aid,
 355       'case_id' => 1,
 356       'activity_type_id' => 14,
 357       'source_contact_id' => $this->_loggedInUser,
 358       'subject' => 'New subject',
 359     );
 360     $this->callAPISuccess('activity', 'create', $params);
 361
 362     // Retrieve revision and check custom fields got copied.
 363     $revParams = array(
 364       'activity_id' => $aid + 1,
 365       'return.custom_' . $custom_ids['custom_field_id'] => 1,
 366     );
 367     $revAct = $this->callAPISuccess('activity', 'get', $revParams);
 368
 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));
 371
 372     $this->customFieldDelete($custom_ids['custom_field_id']);
 373     $this->customGroupDelete($custom_ids['custom_group_id']);
 374   }
 375
 376   public function testCaseGetByStatus() {
 377     // Create 2 cases with different status ids.
 378     $case1 = $this->callAPISuccess('Case', 'create', array(
 379       'contact_id' => 17,
 380       'subject' => "Test case 1",
 381       'case_type_id' => $this->caseTypeId,
 382       'status_id' => "Open",
 383       'sequential' => 1,
 384     ));
 385     $this->callAPISuccess('Case', 'create', array(
 386       'contact_id' => 17,
 387       'subject' => "Test case 2",
 388       'case_type_id' => $this->caseTypeId,
 389       'status_id' => "Urgent",
 390       'sequential' => 1,
 391     ));
 392     $result = $this->callAPISuccessGetSingle('Case', array(
 393       'sequential' => 1,
 394       'contact_id' => 17,
 395       'status_id' => "Open",
 396     ));
 397     $this->assertEquals($case1['id'], $result['id']);
 398   }
 399
 400 }