tests/phpunit/api/v3/CustomGroupTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 require_once 'CiviTest/CiviUnitTestCase.php';
  29
  30
  31 /**
  32  *  Test APIv3 civicrm_custom_group* functions
  33  *
  34  * @package CiviCRM_APIv3
  35  * @subpackage API_CustomGroup
  36  */
  37 class api_v3_CustomGroupTest extends CiviUnitTestCase {
  38   protected $_apiversion = 3;
  39   protected $_entity;
  40   protected $_params;
  41
  42   public $DBResetRequired = TRUE;
  43
  44   public function setUp() {
  45     $this->_entity = 'CustomGroup';
  46     $this->_params = array(
  47       'title' => 'Test_Group_1',
  48       'name' => 'test_group_1',
  49       'extends' => 'Individual',
  50       'weight' => 4,
  51       'collapse_display' => 1,
  52       'style' => 'Inline',
  53       'help_pre' => 'This is Pre Help For Test Group 1',
  54       'help_post' => 'This is Post Help For Test Group 1',
  55       'is_active' => 1,
  56     );
  57     parent::setUp();
  58   }
  59
  60   public function tearDown() {
  61     $tablesToTruncate = array('civicrm_custom_group', 'civicrm_custom_field');
  62     // true tells quickCleanup to drop any tables that might have been created in the test
  63     $this->quickCleanup($tablesToTruncate, TRUE);
  64   }
  65
  66   ///////////////// civicrm_custom_group_create methods
  67
  68   /**
  69    * Check with empty array.
  70    * note that these tests are of marginal value so should not be included in copy & paste
  71    * code. The SyntaxConformance is capable of testing this for all entities on create
  72    * & delete (& it would be easy to add if not there)
  73    */
  74   public function testCustomGroupCreateNoParam() {
  75     $customGroup = $this->callAPIFailure('custom_group', 'create', array(),
  76       'Mandatory key(s) missing from params array: title, extends'
  77     );
  78   }
  79
  80   /**
  81    * Check with empty array.
  82    */
  83   public function testCustomGroupCreateNoExtends() {
  84     $params = array(
  85       'domain_id' => 1,
  86       'title' => 'Test_Group_1',
  87       'name' => 'test_group_1',
  88       'weight' => 4,
  89       'collapse_display' => 1,
  90       'style' => 'Tab',
  91       'help_pre' => 'This is Pre Help For Test Group 1',
  92       'help_post' => 'This is Post Help For Test Group 1',
  93       'is_active' => 1,
  94     );
  95
  96     $customGroup = $this->callAPIFailure('custom_group', 'create', $params);
  97     $this->assertEquals($customGroup['error_message'], 'Mandatory key(s) missing from params array: extends');
  98     $this->assertAPIFailure($customGroup);
  99   }
 100
 101   /**
 102    * Check with empty array.
 103    */
 104   public function testCustomGroupCreateInvalidExtends() {
 105     $params = array(
 106       'domain_id' => 1,
 107       'title' => 'Test_Group_1',
 108       'name' => 'test_group_1',
 109       'weight' => 4,
 110       'collapse_display' => 1,
 111       'style' => 'Tab',
 112       'help_pre' => 'This is Pre Help For Test Group 1',
 113       'help_post' => 'This is Post Help For Test Group 1',
 114       'is_active' => 1,
 115       'extends' => array(),
 116     );
 117
 118     $customGroup = $this->callAPIFailure('custom_group', 'create', $params);
 119     $this->assertEquals($customGroup['error_message'], 'Mandatory key(s) missing from params array: extends');
 120   }
 121
 122   /**
 123    * Check with a string instead of array for extends.
 124    */
 125   public function testCustomGroupCreateExtendsString() {
 126     $params = array(
 127       'domain_id' => 1,
 128       'title' => 'Test_Group_1',
 129       'name' => 'test_group_1',
 130       'weight' => 4,
 131       'collapse_display' => 1,
 132       'style' => 'Tab',
 133       'help_pre' => 'This is Pre Help For Test Group 1',
 134       'help_post' => 'This is Post Help For Test Group 1',
 135       'is_active' => 1,
 136       'extends' => 'Individual',
 137     );
 138
 139     $customGroup = $this->callAPISuccess('custom_group', 'create', $params);
 140   }
 141
 142   /**
 143    * Check with valid array.
 144    */
 145   public function testCustomGroupCreate() {
 146     $params = array(
 147       'title' => 'Test_Group_1',
 148       'name' => 'test_group_1',
 149       'extends' => array('Individual'),
 150       'weight' => 4,
 151       'collapse_display' => 1,
 152       'style' => 'Inline',
 153       'help_pre' => 'This is Pre Help For Test Group 1',
 154       'help_post' => 'This is Post Help For Test Group 1',
 155       'is_active' => 1,
 156     );
 157
 158     $result = $this->callAPIAndDocument('custom_group', 'create', $params, __FUNCTION__, __FILE__);
 159     $this->assertNotNull($result['id']);
 160     $this->assertEquals($result['values'][$result['id']]['extends'], 'Individual');
 161   }
 162
 163   /**
 164    * Check with valid array.
 165    */
 166   public function testCustomGroupGetFields() {
 167     $params = array(
 168       'options' => array('get_options' => 'style'),
 169     );
 170
 171     $result = $this->callAPISuccess('custom_group', 'getfields', $params);
 172     $expected = array(
 173       'Tab' => 'Tab',
 174       'Inline' => 'Inline',
 175       'Tab with table' => 'Tab with table',
 176     );
 177     $this->assertEquals($expected, $result['values']['style']['options']);
 178   }
 179
 180   /**
 181    * Check with extends array length greater than 1
 182    */
 183   public function testCustomGroupExtendsMultipleCreate() {
 184     $params = array(
 185       'title' => 'Test_Group_1',
 186       'name' => 'test_group_1',
 187       'extends' => array('Individual', 'Household'),
 188       'weight' => 4,
 189       'collapse_display' => 1,
 190       'style' => 'Inline',
 191       'help_pre' => 'This is Pre Help For Test Group 1',
 192       'help_post' => 'This is Post Help For Test Group 1',
 193       'is_active' => 1,
 194     );
 195
 196     $result = $this->callAPIFailure('custom_group', 'create', $params,
 197       'implode(): Invalid arguments passed');
 198   }
 199
 200   /**
 201    * Check with style missing from params array.
 202    */
 203   public function testCustomGroupCreateNoStyle() {
 204     $params = array(
 205       'title' => 'Test_Group_1',
 206       'name' => 'test_group_1',
 207       'extends' => array('Individual'),
 208       'weight' => 4,
 209       'collapse_display' => 1,
 210       'help_pre' => 'This is Pre Help For Test Group 1',
 211       'help_post' => 'This is Post Help For Test Group 1',
 212       'is_active' => 1,
 213     );
 214
 215     $customGroup = $this->callAPISuccess('custom_group', 'create', $params);
 216     $this->assertNotNull($customGroup['id']);
 217     $this->assertEquals($customGroup['values'][$customGroup['id']]['style'], 'Inline');
 218   }
 219
 220   /**
 221    * Check with not array.
 222    */
 223   public function testCustomGroupCreateNotArray() {
 224     $params = NULL;
 225     $customGroup = $this->callAPIFailure('custom_group', 'create', $params);
 226     $this->assertEquals($customGroup['error_message'], 'Input variable `params` is not an array');
 227   }
 228
 229   /**
 230    * Check without title.
 231    */
 232   public function testCustomGroupCreateNoTitle() {
 233     $params = array(
 234       'extends' => array('Contact'),
 235       'weight' => 5,
 236       'collapse_display' => 1,
 237       'style' => 'Tab',
 238       'help_pre' => 'This is Pre Help For Test Group 2',
 239       'help_post' => 'This is Post Help For Test Group 2',
 240     );
 241
 242     $customGroup = $this->callAPIFailure('custom_group', 'create', $params,
 243       'Mandatory key(s) missing from params array: title');
 244   }
 245
 246   /**
 247    * Check for household without weight.
 248    */
 249   public function testCustomGroupCreateHouseholdNoWeight() {
 250     $params = array(
 251       'title' => 'Test_Group_3',
 252       'name' => 'test_group_3',
 253       'extends' => array('Household'),
 254       'collapse_display' => 1,
 255       'style' => 'Tab',
 256       'help_pre' => 'This is Pre Help For Test Group 3',
 257       'help_post' => 'This is Post Help For Test Group 3',
 258       'is_active' => 1,
 259     );
 260
 261     $customGroup = $this->callAPISuccess('custom_group', 'create', $params);
 262     $this->assertNotNull($customGroup['id']);
 263     $this->assertEquals($customGroup['values'][$customGroup['id']]['extends'], 'Household');
 264     $this->assertEquals($customGroup['values'][$customGroup['id']]['style'], 'Tab');
 265   }
 266
 267   /**
 268    * Check for Contribution Donation.
 269    */
 270   public function testCustomGroupCreateContributionDonation() {
 271     $params = array(
 272       'title' => 'Test_Group_6',
 273       'name' => 'test_group_6',
 274       'extends' => array('Contribution', array(1)),
 275       'weight' => 6,
 276       'collapse_display' => 1,
 277       'style' => 'Inline',
 278       'help_pre' => 'This is Pre Help For Test Group 6',
 279       'help_post' => 'This is Post Help For Test Group 6',
 280       'is_active' => 1,
 281     );
 282
 283     $customGroup = $this->callAPISuccess('custom_group', 'create', $params);
 284     $this->assertNotNull($customGroup['id']);
 285     $this->assertEquals($customGroup['values'][$customGroup['id']]['extends'], 'Contribution');
 286   }
 287
 288   /**
 289    * Check with valid array.
 290    */
 291   public function testCustomGroupCreateGroup() {
 292     $params = array(
 293       'domain_id' => 1,
 294       'title' => 'Test_Group_8',
 295       'name' => 'test_group_8',
 296       'extends' => array('Group'),
 297       'weight' => 7,
 298       'collapse_display' => 1,
 299       'is_active' => 1,
 300       'style' => 'Inline',
 301       'help_pre' => 'This is Pre Help For Test Group 8',
 302       'help_post' => 'This is Post Help For Test Group 8',
 303     );
 304
 305     $customGroup = $this->callAPISuccess('custom_group', 'create', $params);
 306     $this->assertNotNull($customGroup['id']);
 307     $this->assertEquals($customGroup['values'][$customGroup['id']]['extends'], 'Group');
 308   }
 309
 310   /**
 311    * Check with Activity - Meeting Type
 312    */
 313   public function testCustomGroupCreateActivityMeeting() {
 314     $params = array(
 315       'title' => 'Test_Group_10',
 316       'name' => 'test_group_10',
 317       'extends' => array('Activity', array(1)),
 318       'weight' => 8,
 319       'collapse_display' => 1,
 320       'style' => 'Inline',
 321       'help_pre' => 'This is Pre Help For Test Group 10',
 322       'help_post' => 'This is Post Help For Test Group 10',
 323     );
 324
 325     $customGroup = $this->callAPISuccess('custom_group', 'create', $params);
 326     $this->assertNotNull($customGroup['id']);
 327     $this->assertEquals($customGroup['values'][$customGroup['id']]['extends'], 'Activity');
 328   }
 329
 330   ///////////////// civicrm_custom_group_delete methods
 331
 332   /**
 333    * Check without GroupID.
 334    */
 335   public function testCustomGroupDeleteWithoutGroupID() {
 336     $customGroup = $this->callAPIFailure('custom_group', 'delete', array());
 337     $this->assertEquals($customGroup['error_message'], 'Mandatory key(s) missing from params array: id');
 338   }
 339
 340   /**
 341    * Check with no array.
 342    */
 343   public function testCustomGroupDeleteNoArray() {
 344     $params = NULL;
 345     $customGroup = $this->callAPIFailure('custom_group', 'delete', $params);
 346     $this->assertEquals($customGroup['error_message'], 'Input variable `params` is not an array');
 347   }
 348
 349   /**
 350    * Check with valid custom group id.
 351    */
 352   public function testCustomGroupDelete() {
 353     $customGroup = $this->customGroupCreate(array('extends' => 'Individual', 'title' => 'test_group'));
 354     $params = array(
 355       'id' => $customGroup['id'],
 356     );
 357     $result = $this->callAPIAndDocument('custom_group', 'delete', $params, __FUNCTION__, __FILE__);
 358     $this->assertAPISuccess($result);
 359   }
 360
 361   /**
 362    * Main success get function.
 363    */
 364   public function testGetCustomGroupSuccess() {
 365
 366     $this->callAPISuccess($this->_entity, 'create', $this->_params);
 367     $params = array();
 368     $result = $this->callAPIAndDocument($this->_entity, 'get', $params, __FUNCTION__, __FILE__);
 369     $values = $result['values'][$result['id']];
 370     foreach ($this->_params as $key => $value) {
 371       if ($key == 'weight') {
 372         continue;
 373       }
 374       $this->assertEquals($value, $values[$key], $key . " doesn't match " . print_r($values, TRUE) . 'in line' . __LINE__);
 375     }
 376   }
 377
 378 }