tests/phpunit/api/v3/CaseTypeTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * Class api_v3_CaseTypeTest
  30  * @group headless
  31  */
  32 class api_v3_CaseTypeTest extends CiviCaseTestCase {
  33
  34   public function setUp() {
  35     $this->quickCleanup(array('civicrm_case_type'));
  36     parent::setUp();
  37
  38     $this->fixtures['Application_with_Definition'] = array(
  39       'title' => 'Application with Definition',
  40       'name' => 'Application_with_Definition',
  41       'is_active' => 1,
  42       'weight' => 4,
  43       'definition' => array(
  44         'activityTypes' => array(
  45           array('name' => 'First act'),
  46         ),
  47         'activitySets' => array(
  48           array(
  49             'name' => 'set1',
  50             'label' => 'Label 1',
  51             'timeline' => 1,
  52             'activityTypes' => array(
  53               array('name' => 'Open Case', 'status' => 'Completed'),
  54             ),
  55           ),
  56         ),
  57         'caseRoles' => array(
  58           array('name' => 'First role', 'creator' => 1, 'manager' => 1),
  59         ),
  60       ),
  61     );
  62   }
  63
  64   /**
  65    * Tears down the fixture, for example, closes a network connection.
  66    *
  67    * This method is called after a test is executed.
  68    */
  69   public function tearDown() {
  70     parent::tearDown();
  71     $this->quickCleanup(array('civicrm_case_type', 'civicrm_uf_match'));
  72   }
  73
  74   /**
  75    * Check with empty array.
  76    */
  77   public function testCaseTypeCreateEmpty() {
  78     $this->callAPIFailure('CaseType', 'create', array());
  79   }
  80
  81   /**
  82    * Check if required fields are not passed.
  83    */
  84   public function testCaseTypeCreateWithoutRequired() {
  85     $params = array(
  86       'name' => 'this case should fail',
  87     );
  88     $this->callAPIFailure('CaseType', 'create', $params);
  89
  90     $params = array(
  91       'name' => 'this case should fail',
  92       'weight' => 4,
  93     );
  94     $this->callAPIFailure('CaseType', 'create', $params);
  95   }
  96
  97   /**
  98    * Test create methods with valid data.
  99    *
 100    * Success expected.
 101    */
 102   public function testCaseTypeCreate() {
 103     // Create Case Type.
 104     $params = array(
 105       'title' => 'Application',
 106       'name' => 'Application',
 107       'is_active' => 1,
 108       'weight' => 4,
 109     );
 110
 111     $result = $this->callAPISuccess('CaseType', 'create', $params);
 112     $id = $result['id'];
 113
 114     // Check result.
 115     $result = $this->callAPISuccess('CaseType', 'get', array('id' => $id));
 116     $this->assertEquals($result['values'][$id]['id'], $id);
 117     $this->assertEquals($result['values'][$id]['title'], $params['title']);
 118   }
 119
 120   /**
 121    * Create a case with an invalid name.
 122    */
 123   public function testCaseTypeCreate_invalidName() {
 124     // Create Case Type
 125     $params = array(
 126       'title' => 'Application',
 127       'name' => 'Appl ication', // spaces are not allowed
 128       'is_active' => 1,
 129       'weight' => 4,
 130     );
 131
 132     $this->callAPIFailure('CaseType', 'create', $params);
 133   }
 134
 135
 136   /**
 137    * Test update (create with id) function with valid parameters.
 138    */
 139   public function testCaseTypeUpdate() {
 140     // Create Case Type
 141     $params = array(
 142       'title' => 'Application',
 143       'name' => 'Application',
 144       'is_active' => 1,
 145       'weight' => 4,
 146     );
 147     $result = $this->callAPISuccess('CaseType', 'create', $params);
 148     $id = $result['id'];
 149     $result = $this->callAPISuccess('CaseType', 'get', array('id' => $id));
 150     $caseType = $result['values'][$id];
 151
 152     // Update Case Type.
 153     $params = array('id' => $id);
 154     $params['title'] = $caseType['title'] = 'Something Else';
 155     $this->callAPISuccess('CaseType', 'create', $params);
 156
 157     // Verify that updated case Type is exactly equal to the original with new title.
 158     $result = $this->callAPISuccess('CaseType', 'get', array('id' => $id));
 159     $this->assertEquals($result['values'][$id], $caseType);
 160   }
 161
 162   /**
 163    * Test delete function with valid parameters.
 164    */
 165   public function testCaseTypeDelete_New() {
 166     // Create Case Type.
 167     $params = array(
 168       'title' => 'Application',
 169       'name' => 'Application',
 170       'is_active' => 1,
 171       'weight' => 4,
 172     );
 173     $result = $this->callAPISuccess('CaseType', 'create', $params);
 174
 175     $id = $result['id'];
 176     $this->callAPISuccess('CaseType', 'delete', array('id' => $id));
 177
 178     // Check result - case type should no longer exist
 179     $result = $this->callAPISuccess('CaseType', 'get', array('id' => $id));
 180     $this->assertEquals(0, $result['count']);
 181   }
 182
 183   /**
 184    * Test create methods with xml file.
 185    *
 186    * Success expected.
 187    */
 188   public function testCaseTypeCreateWithDefinition() {
 189     // Create Case Type
 190     $params = $this->fixtures['Application_with_Definition'];
 191     $result = $this->callAPISuccess('CaseType', 'create', $params);
 192     $id = $result['id'];
 193
 194     // Check result
 195     $result = $this->callAPISuccess('CaseType', 'get', array('id' => $id));
 196     $this->assertEquals($result['values'][$id]['id'], $id);
 197     $this->assertEquals($result['values'][$id]['title'], $params['title']);
 198     $this->assertEquals($result['values'][$id]['definition'], $params['definition']);
 199
 200     $caseXml = CRM_Case_XMLRepository::singleton()->retrieve('Application_with_Definition');
 201     $this->assertTrue($caseXml instanceof SimpleXMLElement);
 202   }
 203
 204   /**
 205    * Create a CaseType+case then delete the CaseType.
 206    */
 207   public function testCaseTypeDelete_InUse() {
 208     // Create Case Type
 209     $params = $this->fixtures['Application_with_Definition'];
 210     $createCaseType = $this->callAPISuccess('CaseType', 'create', $params);
 211
 212     $createCase = $this->callAPISuccess('Case', 'create', array(
 213       'case_type_id' => $createCaseType['id'],
 214       'contact_id' => $this->_loggedInUser,
 215       'subject' => 'Example',
 216     ));
 217
 218     // Deletion fails while case-type is in-use
 219     $deleteCaseType = $this->callAPIFailure('CaseType', 'delete', array('id' => $createCaseType['id']));
 220     $this->assertEquals("You can not delete this case type -- it is assigned to 1 existing case record(s). If you do not want this case type to be used going forward, consider disabling it instead.", $deleteCaseType['error_message']);
 221     $getCaseType = $this->callAPISuccess('CaseType', 'get', array('id' => $createCaseType['id']));
 222     $this->assertEquals(1, $getCaseType['count']);
 223
 224     // Deletion succeeds when it's not in-use.
 225     $this->callAPISuccess('Case', 'delete', array('id' => $createCase['id']));
 226
 227     // Check result - case type should no longer exist.
 228     $this->callAPISuccess('CaseType', 'delete', array('id' => $createCaseType['id']));
 229     $getCaseType = $this->callAPISuccess('CaseType', 'get', array('id' => $createCaseType['id']));
 230     $this->assertEquals(0, $getCaseType['count']);
 231   }
 232
 233 }