tests/phpunit/api/v3/UtilsTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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 require_once 'CRM/Utils/DeprecatedUtils.php';
  30
  31 /**
  32  * Test class for API utils
  33  *
  34  * @package   CiviCRM
  35  */
  36 class api_v3_UtilsTest extends CiviUnitTestCase {
  37   protected $_apiversion = 3;
  38   public $DBResetRequired = FALSE;
  39
  40   public $_contactID = 1;
  41
  42   /**
  43    * Sets up the fixture, for example, opens a network connection.
  44    * This method is called before a test is executed.
  45    *
  46    * @access protected
  47    */
  48   protected function setUp() {
  49     parent::setUp();
  50   }
  51
  52   /**
  53    * Tears down the fixture, for example, closes a network connection.
  54    * This method is called after a test is executed.
  55    *
  56    * @access protected
  57    */
  58   protected function tearDown() {}
  59
  60   function testAddFormattedParam() {
  61     $values = array('contact_type' => 'Individual');
  62     $params = array('something' => 1);
  63     $result = _civicrm_api3_deprecated_add_formatted_param($values, $params);
  64     $this->assertTrue($result);
  65   }
  66
  67   function testCheckPermissionReturn() {
  68     $check = array('check_permissions' => TRUE);
  69     $config = CRM_Core_Config::singleton();
  70     $config->userPermissionClass->permissions = array();
  71     $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'empty permissions should not be enough');
  72     $config->userPermissionClass->permissions = array('access CiviCRM');
  73     $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'lacking permissions should not be enough');
  74     $config->userPermissionClass->permissions = array('add contacts');
  75     $this->assertFalse($this->runPermissionCheck('contact', 'create', $check), 'lacking permissions should not be enough');
  76
  77     $config->userPermissionClass->permissions = array('access CiviCRM', 'add contacts');
  78     $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'exact permissions should be enough');
  79
  80     $config->userPermissionClass->permissions = array('access CiviCRM', 'add contacts', 'import contacts');
  81     $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'overfluous permissions should be enough');
  82   }
  83
  84   function testCheckPermissionThrow() {
  85     $check = array('check_permissions' => TRUE);
  86     $config = CRM_Core_Config::singleton();
  87     try {
  88       $config->userPermissionClass->permissions = array('access CiviCRM');
  89       $this->runPermissionCheck('contact', 'create', $check, TRUE);
  90     }
  91     catch(Exception $e) {
  92       $message = $e->getMessage();
  93     }
  94     $this->assertEquals($message, 'API permission check failed for contact/create call; insufficient permission: require access CiviCRM and add contacts', 'lacking permissions should throw an exception');
  95
  96     $config->userPermissionClass->permissions = array('access CiviCRM', 'add contacts', 'import contacts');
  97     $this->assertTrue($this->runPermissionCheck('contact', 'create', $check), 'overfluous permissions should return true');
  98   }
  99
 100   function testCheckPermissionSkip() {
 101     $config = CRM_Core_Config::singleton();
 102     $config->userPermissionClass->permissions = array('access CiviCRM');
 103     $params = array('check_permissions' => TRUE);
 104     $this->assertFalse($this->runPermissionCheck('contact', 'create', $params), 'lacking permissions should not be enough');
 105     $params = array('check_permissions' => FALSE);
 106     $this->assertTrue($this->runPermissionCheck('contact', 'create', $params), 'permission check should be skippable');
 107   }
 108
 109   /**
 110    * @param string $entity
 111    * @param string $action
 112    * @param array $params
 113    * @param bool $throws whether we should pass any exceptions for authorization failures
 114    *
 115    * @throws API_Exception
 116    * @throws Exception
 117    * @return bool TRUE or FALSE depending on the outcome of the authorization check
 118    */
 119   function runPermissionCheck($entity, $action, $params, $throws = FALSE) {
 120     $dispatcher = new \Symfony\Component\EventDispatcher\EventDispatcher();
 121     $dispatcher->addSubscriber(new \Civi\API\Subscriber\PermissionCheck());
 122     $kernel = new \Civi\API\Kernel($dispatcher);
 123     $apiRequest = \Civi\API\Request::create($entity, $action, $params, NULL);
 124     try {
 125       $kernel->authorize(NULL, $apiRequest);
 126       return TRUE;
 127     } catch (\API_Exception $e) {
 128       $extra = $e->getExtraParams();
 129       if (!$throws && $extra['error_code'] == API_Exception::UNAUTHORIZED) {
 130         return FALSE;
 131       } else {
 132         throw $e;
 133       }
 134     }
 135   }
 136
 137   /**
 138    * Test verify mandatory - includes DAO & passed as well as empty & NULL fields
 139    */
 140   function testVerifyMandatory() {
 141     _civicrm_api3_initialize(TRUE);
 142     $params = array(
 143       'entity_table' => 'civicrm_contact',
 144       'note' => '',
 145       'contact_id' => $this->_contactID,
 146       'modified_date' => '2011-01-31',
 147       'subject' => NULL,
 148       'version' => $this->_apiversion
 149     );
 150     try {
 151       $result = civicrm_api3_verify_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
 152     }
 153     catch(Exception $expected) {
 154       $this->assertEquals('Mandatory key(s) missing from params array: entity_id, note, subject', $expected->getMessage());
 155       return;
 156     }
 157
 158     $this->fail('An expected exception has not been raised.');
 159   }
 160
 161   /**
 162    * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
 163    */
 164   function testVerifyOneMandatory() {
 165     _civicrm_api3_initialize(TRUE);
 166     $params = array(
 167       'entity_table' => 'civicrm_contact',
 168       'note' => '',
 169       'contact_id' => $this->_contactID,
 170       'modified_date' => '2011-01-31',
 171       'subject' => NULL,
 172       'version' => $this->_apiversion,
 173     );
 174
 175     try {
 176       $result = civicrm_api3_verify_one_mandatory($params, 'CRM_Core_BAO_Note', array('note', 'subject'));
 177     }
 178     catch(Exception $expected) {
 179       $this->assertEquals('Mandatory key(s) missing from params array: entity_id, one of (note, subject)', $expected->getMessage());
 180       return;
 181     }
 182
 183     $this->fail('An expected exception has not been raised.');
 184   }
 185
 186   /**
 187    * Test verify one mandatory - includes DAO & passed as well as empty & NULL fields
 188    */
 189   function testVerifyOneMandatoryOneSet() {
 190     _civicrm_api3_initialize(TRUE);
 191     $params = array('version' => 3, 'entity_table' => 'civicrm_contact', 'note' => 'note', 'contact_id' => $this->_contactID, 'modified_date' => '2011-01-31', 'subject' => NULL);
 192
 193     try {
 194       civicrm_api3_verify_one_mandatory($params, NULL, array('note', 'subject'));
 195     }
 196     catch(Exception$expected) {
 197       $this->fail('Exception raised when it shouldn\'t have been  in line ' . __LINE__);
 198     }
 199   }
 200
 201
 202   /**
 203    * Test GET DAO function returns DAO
 204    */
 205   function testGetDAO() {
 206     $params = array(
 207       'civicrm_api3_custom_group_get' => 'CRM_Core_DAO_CustomGroup',
 208       'custom_group' => 'CRM_Core_DAO_CustomGroup',
 209       'CustomGroup' => 'CRM_Core_DAO_CustomGroup',
 210       'civicrm_api3_custom_field_get' => 'CRM_Core_DAO_CustomField',
 211       'civicrm_api3_survey_get' => 'CRM_Campaign_DAO_Survey',
 212       'civicrm_api3_pledge_payment_get' => 'CRM_Pledge_DAO_PledgePayment',
 213       'civicrm_api3_website_get' => 'CRM_Core_DAO_Website',
 214       'Membership' => 'CRM_Member_DAO_Membership',
 215     );
 216     foreach ($params as $input => $expected) {
 217       $result = _civicrm_api3_get_DAO($input);
 218       $this->assertEquals($expected, $result);
 219     }
 220   }
 221
 222   /**
 223    * Test GET BAO function returns BAO when it exists
 224    */
 225   function testGetBAO() {
 226     $params = array(
 227       'civicrm_api3_website_get' => 'CRM_Core_BAO_Website',
 228       'civicrm_api3_survey_get' => 'CRM_Campaign_BAO_Survey',
 229       'civicrm_api3_pledge_payment_get' => 'CRM_Pledge_BAO_PledgePayment',
 230       'Household' => 'CRM_Contact_BAO_Contact',
 231       // Note this one DOES NOT have a BAO so we expect to fall back on returning the DAO
 232       'mailing_group' => 'CRM_Mailing_DAO_MailingGroup',
 233       // Make sure we get null back with nonexistant entities
 234       'civicrm_this_does_not_exist' => NULL,
 235     );
 236     foreach ($params as $input => $expected) {
 237       $result = _civicrm_api3_get_BAO($input);
 238       $this->assertEquals($expected, $result);
 239     }
 240   }
 241
 242   function test_civicrm_api3_validate_fields() {
 243     $params = array('start_date' => '2010-12-20', 'end_date' => '');
 244     $fields = civicrm_api3('relationship', 'getfields', array('action' => 'get'));
 245     _civicrm_api3_validate_fields('relationship', 'get', $params, $fields['values']);
 246     $this->assertEquals('20101220000000', $params['start_date']);
 247     $this->assertEquals('', $params['end_date']);
 248   }
 249
 250   function test_civicrm_api3_validate_fields_membership() {
 251     $params = array('start_date' => '2010-12-20', 'end_date' => '', 'membership_end_date' => '0', 'join_date' => '2010-12-20', 'membership_start_date' => '2010-12-20');
 252     $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
 253     _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
 254     $this->assertEquals('20101220000000', $params['start_date'], 'in line ' . __LINE__);
 255     $this->assertEquals('', $params['end_date']);
 256     $this->assertEquals('20101220000000', $params['join_date'], 'join_date not set in line ' . __LINE__);
 257   }
 258
 259   function test_civicrm_api3_validate_fields_event() {
 260
 261     $params = array(
 262       'registration_start_date' => 20080601,
 263       'registration_end_date' => '2008-10-15', 'start_date' => '2010-12-20', 'end_date' => '',
 264     );
 265     $fields = civicrm_api3('Event', 'getfields', array('action' => 'create'));
 266     _civicrm_api3_validate_fields('event', 'create', $params, $fields['values']);
 267     $this->assertEquals('20101220000000', $params['start_date'], 'in line ' . __LINE__);
 268     $this->assertEquals('20081015000000', $params['registration_end_date'], 'in line ' . __LINE__);
 269     $this->assertEquals('', $params['end_date'], 'in line ' . __LINE__);
 270     $this->assertEquals('20080601000000', $params['registration_start_date']);
 271   }
 272
 273   function test_civicrm_api3_validate_fields_exception() {
 274     $params = array(
 275       'join_date' => 'abc',
 276     );
 277     try {
 278       $fields = civicrm_api3('Membership', 'getfields', array('action' => 'get'));
 279       _civicrm_api3_validate_fields('Membership', 'get', $params, $fields['values']);
 280     }
 281     catch(Exception$expected) {
 282       $this->assertEquals('join_date is not a valid date: abc', $expected->getMessage());
 283     }
 284   }
 285
 286   function testGetFields() {
 287     $result = $this->callAPISuccess('membership', 'getfields', array());
 288     $this->assertArrayHasKey('values', $result);
 289     $result = $this->callAPISuccess('relationship', 'getfields', array());
 290     $this->assertArrayHasKey('values', $result);
 291     $result = $this->callAPISuccess('event', 'getfields', array());
 292     $this->assertArrayHasKey('values', $result);
 293   }
 294
 295   function testGetFields_AllOptions() {
 296     $result = $this->callAPISuccess('contact', 'getfields', array(
 297       'options' => array(
 298         'get_options' => 'all',
 299       ),
 300     ));
 301     $this->assertEquals('Household', $result['values']['contact_type']['options']['Household']);
 302     $this->assertEquals('HTML', $result['values']['preferred_mail_format']['options']['HTML']);
 303   }
 304 }
 305