tests/phpunit/api/v3/UtilsTest.php

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