tests/phpunit/api/v3/EventTest.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29
  30 require_once 'CiviTest/CiviUnitTestCase.php';
  31
  32 /**
  33  * Class api_v3_EventTest
  34  */
  35 class api_v3_EventTest extends CiviUnitTestCase {
  36   protected $_params;
  37   protected $_apiversion;
  38   protected $_entity;
  39
  40   /**
  41    * @return array
  42    */
  43   function get_info() {
  44     return array(
  45       'name' => 'Event Create',
  46       'description' => 'Test all Event Create API methods.',
  47       'group' => 'CiviCRM API Tests',
  48     );
  49   }
  50
  51   function setUp() {
  52     parent::setUp();
  53     $this->_apiversion = 3;
  54     $this->_entity     = 'event';
  55     $this->_params     = array(
  56       array(
  57         'title' => 'Annual CiviCRM meet',
  58         'summary' => 'If you have any CiviCRM realted issues or want to track where CiviCRM is heading, Sign up now',
  59         'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
  60         'event_type_id' => 1,
  61         'is_public' => 1,
  62         'start_date' => 20081021,
  63         'end_date' => 20081023,
  64         'is_online_registration' => 1,
  65         'registration_start_date' => 20080601,
  66         'registration_end_date' => '2008-10-15',
  67         'max_participants' => 100,
  68         'event_full_text' => 'Sorry! We are already full',
  69         'is_monetary' => 0,
  70         'is_active' => 1,
  71         'is_show_location' => 0,
  72       ),
  73       array(
  74         'title' => 'Annual CiviCRM meet 2',
  75         'summary' => 'If you have any CiviCRM realted issues or want to track where CiviCRM is heading, Sign up now',
  76         'description' => 'This event is intended to give brief idea about progess of CiviCRM and giving solutions to common user issues',
  77         'event_type_id' => 1,
  78         'is_public' => 1,
  79         'start_date' => 20101021,
  80         'end_date' => 20101023,
  81         'is_online_registration' => 1,
  82         'registration_start_date' => 20100601,
  83         'registration_end_date' => '2010-10-15',
  84         'max_participants' => 100,
  85         'event_full_text' => 'Sorry! We are already full',
  86         'is_monetory' => 0,
  87         'is_active' => 1,
  88         'is_show_location' => 0,
  89       ),
  90     );
  91
  92     $params = array(
  93       array(
  94         'title' => 'Annual CiviCRM meet',
  95         'event_type_id' => 1,
  96         'start_date' => 20081021,      ),
  97       array(
  98         'title' => 'Annual CiviCRM meet 2',
  99         'event_type_id' => 1,
 100         'start_date' => 20101021,      ),
 101     );
 102
 103     $this->events = array();
 104     $this->eventIds = array();
 105     foreach ($params as $event) {
 106       $result            = $this->callAPISuccess('Event', 'Create', $event);
 107       $this->_events[]   = $result;
 108       $this->_eventIds[] = $result['id'];
 109     }
 110   }
 111
 112   function tearDown() {
 113     foreach ($this->eventIds as $eventId) {
 114       $this->eventDelete($eventId);
 115     }
 116     $tablesToTruncate = array(
 117       'civicrm_participant',
 118       'civicrm_event',
 119     );
 120     $this->quickCleanup($tablesToTruncate, TRUE);
 121   }
 122
 123   ///////////////// civicrm_event_get methods
 124
 125   function testGetEventById() {
 126     $params = array(
 127       'id' => $this->_events[1]['id'],);
 128     $result = $this->callAPISuccess('event', 'get', $params);
 129     $this->assertEquals($result['values'][$this->_eventIds[1]]['event_title'], 'Annual CiviCRM meet 2');
 130   }
 131
 132   function testGetEventByEventTitle() {
 133
 134     $params = array(
 135       'event_title' => 'Annual CiviCRM meet',
 136       'sequential' => TRUE,
 137     );
 138
 139     $result = $this->callAPIAndDocument('event', 'get', $params, __FUNCTION__, __FILE__);
 140     $this->assertEquals(1, $result['count']);
 141     $this->assertEquals($result['values'][0]['id'], $this->_eventIds[0]);
 142   }
 143
 144   function testGetEventByWrongTitle() {
 145     $params = array(
 146       'title' => 'No event with that title',);
 147     $result = $this->callAPISuccess('Event', 'Get', $params);
 148     $this->assertEquals(0, $result['count']);
 149   }
 150   function testGetEventByIdSort() {
 151     $params = array(
 152       'return.sort' => 'id ASC',
 153       'return.max_results' => 1,    );
 154     $result = $this->callAPISuccess('Event', 'Get', $params);
 155     $this->assertEquals(1, $result['id'], ' in line ' . __LINE__);
 156     $params = array(
 157       'options' => array(
 158         'sort' => 'id DESC',
 159         'limit' => 1,
 160       ),    );
 161
 162     $result = $this->callAPISuccess('Event', 'Get', $params);
 163     $this->assertAPISuccess($result, ' in line ' . __LINE__);
 164     $this->assertEquals(2, $result['id'], ' in line ' . __LINE__);
 165     $params = array(
 166       'options' => array(
 167         'sort' => 'id ASC',
 168         'limit' => 1,
 169       ),    );
 170     $result = $this->callAPISuccess('Event', 'Get', $params);
 171     $this->assertEquals(1, $result['id'], ' in line ' . __LINE__);
 172
 173
 174   }
 175   /*
 176    * Getting the id back of an event.
 177    * Does not work yet, bug in API
 178    */
 179
 180   /*
 181   function testGetIdOfEventByEventTitle() {
 182     $params = array(      'title' => 'Annual CiviCRM meet',
 183       'return' => 'id'
 184     );
 185
 186     $result = $this->callAPISuccess('Event', 'Get', $params);
 187   }
 188   */
 189
 190
 191   /*
 192      * Test 'is.Current' option. Existing event is 'old' so only current should be returned
 193      */
 194   function testGetIsCurrent() {
 195     $params = array(
 196       'isCurrent' => 1,
 197     );
 198     $currentEventParams = array('start_date' => date('Y-m-d', strtotime('+ 1 day')),
 199       'end_date' => date('Y-m-d', strtotime('+ 1 week')),
 200     );
 201     $currentEventParams = array_merge($this->_params[1], $currentEventParams);
 202     $currentEvent       = $this->callAPISuccess('Event', 'Create', $currentEventParams);
 203     $description        = "demonstrates use of is.Current option";
 204     $subfile            = "IsCurrentOption";
 205     $result             = $this->callAPIAndDocument('Event', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
 206     $allEvents = $this->callAPISuccess('Event', 'Get', array());
 207     $this->callAPISuccess('Event', 'Delete', array('id' => $currentEvent['id']));
 208     $this->assertEquals(1, $result['count'], 'confirm only one event found in line ' . __LINE__);
 209     $this->assertEquals(3, $allEvents['count'], 'confirm three events exist (ie. two not found) ' . __LINE__);
 210     $this->assertEquals($currentEvent['id'], $result['id'], '');
 211   }
 212 /*
 213  * There has been a schema change & the api needs to buffer developers from it
 214  */
 215   function testGetPaymentProcessorId() {
 216     $params = $this->_params[0];
 217     $params['payment_processor_id'] = 1;
 218     $params['sequential'] =1;
 219     $result = $this->callAPISuccess('event', 'create', $params);
 220     $this->assertEquals( 1,$result['values'][0]['payment_processor'][0], "handing of payment processor compatibility");
 221     $result = $this->callAPISuccess('event', 'get', $params);
 222     $this->assertEquals($result['values'][0]['payment_processor_id'], 1,"handing get payment processor compatibility");
 223   }
 224
 225   function testInvalidData() {
 226     $params = $this->_params[0];
 227     $params['sequential'] =1;
 228     $params['loc_block_id'] =100;
 229     $result = $this->callAPIFailure('event', 'create', $params);
 230
 231   }
 232
 233   /*
 234      * Test 'is.Current' option. Existing event is 'old' so only current should be returned
 235      */
 236   function testGetSingleReturnIsFull() {
 237     $contactID = $this->individualCreate();
 238     $params = array(
 239       'id' => $this->_eventIds[0],      'max_participants' => 1,
 240     );
 241     $result = $this->callAPISuccess('Event', 'Create', $params);
 242
 243     $getEventParams = array(
 244       'id' => $this->_eventIds[0],      'return.is_full' => 1,
 245     );
 246
 247     $currentEvent = $this->callAPISuccess('Event', 'getsingle', $getEventParams);
 248     $description  = "demonstrates use of return is_full ";
 249     $subfile      = "IsFullOption";
 250     $this->assertEquals(0, $currentEvent['is_full'], ' is full is set in line ' . __LINE__);
 251     $this->assertEquals(1, $currentEvent['available_places'], 'available places is set in line ' . __LINE__);
 252     $participant = $this->callAPISuccess('Participant', 'create', array('participant_status' => 1, 'role_id' => 1, 'contact_id' => $contactID, 'event_id' => $this->_eventIds[0]));
 253     $currentEvent = $this->callAPIAndDocument('Event', 'getsingle', $getEventParams, __FUNCTION__, __FILE__, $description, $subfile, 'getsingle');
 254     $this->assertEquals(1, $currentEvent['is_full'], ' is full is set in line ' . __LINE__);
 255     $this->assertEquals(0, $currentEvent['available_places'], 'available places is set in line ' . __LINE__);
 256
 257     $this->contactDelete($contactID);
 258   }
 259   /*
 260    * Legacy support for Contribution Type ID. We need to ensure this is supported
 261    * as an alias for financial_type_id
 262    */
 263   function testCreateGetEventLegacyContributionTypeID() {
 264     $contributionTypeArray = array('contribution_type_id' => 3);
 265     if(isset($this->_params[0]['financial_type_id'])){
 266       //in case someone edits $this->_params & invalidates this test :-)
 267       unset($this->_params[0]['financial_type_id']);
 268     }
 269     $result = $this->callAPISuccess('event', 'create', $this->_params[0] + $contributionTypeArray);
 270     $getresult = $this->callAPISuccess('event', 'get', array() + $contributionTypeArray);
 271     $this->assertEquals($getresult['values'][$getresult['id']]['contribution_type_id'], 3);
 272     $this->assertEquals($result['id'], $getresult['id']);
 273     $this->callAPISuccess('event', 'delete', array('id' => $result['id']));
 274   }
 275   ///////////////// civicrm_event_create methods
 276
 277   /**
 278    * check with complete array + custom field
 279    * Note that the test is written on purpose without any
 280    * variables specific to participant so it can be replicated into other entities
 281    * and / or moved to the automated test suite
 282    */
 283   function testCreateWithCustom() {
 284     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 285
 286     $params = $this->_params[0];
 287     $params['custom_' . $ids['custom_field_id']] = "custom string";
 288
 289     $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
 290
 291     $check = $this->callAPISuccess($this->_entity, 'get', array('return.custom_' . $ids['custom_field_id'] => 1, 'id' => $result['id']));
 292     $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__);
 293
 294     $this->customFieldDelete($ids['custom_field_id']);
 295     $this->customGroupDelete($ids['custom_group_id']);
 296     $this->callAPISuccess($this->_entity, 'Delete', array('id' => $result['id']));
 297   }
 298
 299   /**
 300    * Test that an event with a price set can be created
 301    */
 302   function testCreatePaidEvent() {
 303     //@todo alter API so that an integer is converted to an array
 304     $priceSetParams = array('price_set_id' => (array) 1, 'is_monetary' => 1);
 305     $result = $this->callAPISuccess('Event', 'Create', array_merge($this->_params[0], $priceSetParams));
 306     $event = $this->callAPISuccess('Event', 'getsingle', array('id' => $result['id'], 'return' => 'price_set_id'));
 307     $this->assertArrayKeyExists('price_set_id', $event);
 308   }
 309
 310   function testCreateEventParamsNotArray() {
 311     $params = NULL;
 312     $result = $this->callAPIFailure('event', 'create', $params);
 313   }
 314
 315   function testCreateEventEmptyParams() {
 316     $params = array();
 317     $result = $this->callAPIFailure('event', 'create', $params);
 318   }
 319
 320   function testCreateEventParamsWithoutTitle() {
 321     unset($this->_params['title']);
 322     $result = $this->callAPIFailure('event', 'create', $this->_params);
 323     $this->assertAPIFailure($result);
 324   }
 325
 326   function testCreateEventParamsWithoutEventTypeId() {
 327     unset($this->_params['event_type_id']);
 328     $result = $this->callAPIFailure('event', 'create', $this->_params);
 329   }
 330
 331   function testCreateEventParamsWithoutStartDate() {
 332     unset($this->_params['start_date']);
 333     $result = $this->callAPIFailure('event', 'create', $this->_params);
 334   }
 335
 336   function testCreateEventSuccess() {
 337     $result = $this->callAPIAndDocument('Event', 'Create', $this->_params[0], __FUNCTION__, __FILE__);
 338     $this->assertArrayHasKey('id', $result['values'][$result['id']], 'In line ' . __LINE__);
 339     $result = $this->callAPISuccess($this->_entity, 'Get', array('id' => $result['id']));
 340     $this->callAPISuccess($this->_entity, 'Delete', array('id' => $result['id']));
 341     $this->assertEquals('2008-10-21 00:00:00', $result['values'][$result['id']]['start_date'], 'start date is not set in line ' . __LINE__);
 342     $this->assertEquals('2008-10-23 00:00:00', $result['values'][$result['id']]['end_date'], 'end date is not set in line ' . __LINE__);
 343     $this->assertEquals('2008-06-01 00:00:00', $result['values'][$result['id']]['registration_start_date'], 'start date is not set in line ' . __LINE__);
 344     $this->assertEquals('2008-10-15 00:00:00', $result['values'][$result['id']]['registration_end_date'], 'end date is not set in line ' . __LINE__);
 345   }
 346   /*
 347      * Test that passing in Unique field names works
 348      */
 349   function testCreateEventSuccessUniqueFieldNames() {
 350     $this->_params[0]['event_start_date'] = $this->_params[0]['start_date'];
 351     unset($this->_params[1]['start_date']);
 352     $this->_params[0]['event_title'] = $this->_params[0]['title'];
 353     unset($this->_params[0]['title']);
 354     $result = $this->callAPISuccess('Event', 'Create', $this->_params[0]);
 355     $this->assertAPISuccess($result, 'In line ' . __LINE__);
 356     $this->assertArrayHasKey('id', $result['values'][$result['id']], 'In line ' . __LINE__);
 357     $result = $this->callAPISuccess($this->_entity, 'Get', array('id' => $result['id']));
 358     $this->callAPISuccess($this->_entity, 'Delete', array('id' => $result['id']));
 359
 360     $this->assertEquals('2008-10-21 00:00:00', $result['values'][$result['id']]['start_date'], 'start date is not set in line ' . __LINE__);
 361     $this->assertEquals('2008-10-23 00:00:00', $result['values'][$result['id']]['end_date'], 'end date is not set in line ' . __LINE__);
 362     $this->assertEquals('2008-06-01 00:00:00', $result['values'][$result['id']]['registration_start_date'], 'start date is not set in line ' . __LINE__);
 363     $this->assertEquals('2008-10-15 00:00:00', $result['values'][$result['id']]['registration_end_date'], 'end date is not set in line ' . __LINE__);
 364     $this->assertEquals($this->_params[0]['event_title'], $result['values'][$result['id']]['title'], 'end date is not set in line ' . __LINE__);
 365   }
 366
 367   function testUpdateEvent() {
 368     $result = $this->callAPISuccess('event', 'create', $this->_params[1]);
 369
 370     $params = array(
 371       'id' => $result['id'], 'max_participants' => 150,
 372     );
 373     $this->callAPISuccess('Event', 'Create', $params);
 374     $updated = $this->callAPISuccess('Event', 'Get', $params, __FUNCTION__, __FILE__);
 375     $this->assertEquals(150, $updated['values'][$result['id']]['max_participants']);
 376     $this->assertEquals('Annual CiviCRM meet 2', $updated['values'][$result['id']]['title']);
 377     $this->callAPISuccess($this->_entity, 'Delete', array('id' => $result['id']));
 378   }
 379
 380
 381   function testDeleteEmptyParams() {
 382     $result = $this->callAPIFailure('Event', 'Delete', array());
 383   }
 384
 385   function testDelete() {
 386     $params = array(
 387       'id' => $this->_eventIds[0],
 388     );
 389     $result = $this->callAPIAndDocument('Event', 'Delete', $params, __FUNCTION__, __FILE__);
 390   }
 391
 392   /**
 393    * check event_id still supported for delete
 394    */
 395   function testDeleteWithEventId() {
 396     $params = array(
 397       'event_id' => $this->_eventIds[0],    );
 398     $result = $this->callAPISuccess('Event', 'Delete', $params);
 399     $this->assertAPISuccess($result, 'in line ' . __LINE__);
 400   }
 401   /*
 402      * Trying to delete an event with participants should return error
 403      */
 404   function testDeleteWithExistingParticipant() {
 405     $contactID = $this->individualCreate();
 406     $participantID = $this->participantCreate(
 407       array(
 408         'contactID' => $contactID,
 409         'eventID' => $this->_eventIds[0],
 410       )
 411     );
 412     $result = $this->callAPISuccess('Event', 'Delete', array('id' => $this->_eventIds[0]));
 413   }
 414
 415   function testDeleteWithWrongEventId() {
 416     $params = array('event_id' => $this->_eventIds[0]);
 417     $result = $this->callAPISuccess('Event', 'Delete', $params);
 418     // try to delete again - there's no such event anymore
 419     $params = array('event_id' => $this->_eventIds[0]);
 420     $result = $this->callAPIFailure('Event', 'Delete', $params);
 421   }
 422
 423   ///////////////// civicrm_event_search methods
 424
 425   /**
 426    *  Test civicrm_event_search with wrong params type
 427    */
 428   function testSearchWrongParamsType() {
 429     $params = 'a string';
 430     $result = $this->callAPIFailure('event', 'get', $params);
 431   }
 432
 433   /**
 434    *  Test civicrm_event_search with empty params
 435    */
 436   function testSearchEmptyParams() {
 437     $event = $this->callAPISuccess('event', 'create', $this->_params[1]);
 438
 439     $getparams = array(      'sequential' => 1,
 440     );
 441     $result = $this->callAPISuccess('event', 'get', $getparams);
 442     $this->assertEquals($result['count'], 3, 'In line ' . __LINE__);
 443     $res = $result['values'][0];
 444     $this->assertArrayKeyExists('title', $res, 'In line ' . __LINE__);
 445     $this->assertEquals($res['event_type_id'], $this->_params[1]['event_type_id'], 'In line ' . __LINE__);
 446   }
 447
 448   /**
 449    *  Test civicrm_event_search. Success expected.
 450    */
 451   function testSearch() {
 452     $params = array(
 453       'event_type_id' => 1,
 454       'return.title' => 1,
 455       'return.id' => 1,
 456       'return.start_date' => 1,    );
 457     $result = $this->callAPISuccess('event', 'get', $params);
 458
 459     $this->assertEquals($result['values'][$this->_eventIds[0]]['id'], $this->_eventIds[0], 'In line ' . __LINE__);
 460     $this->assertEquals($result['values'][$this->_eventIds[0]]['title'], 'Annual CiviCRM meet', 'In line ' . __LINE__);
 461   }
 462
 463   /**
 464    *  Test civicrm_event_search. Success expected.
 465    *  return.offset and return.max_results test (CRM-5266)
 466    */
 467   function testSearchWithOffsetAndMaxResults() {
 468     $maxEvents = 5;
 469     $events = array();
 470     while ($maxEvents > 0) {
 471       $params = array(        'title' => 'Test Event' . $maxEvents,
 472         'event_type_id' => 2,
 473         'start_date' => 20081021,
 474       );
 475
 476       $events[$maxEvents] = $this->callAPISuccess('event', 'create', $params);
 477       $maxEvents--;
 478     }
 479     $params = array(      'event_type_id' => 2,
 480       'return.id' => 1,
 481       'return.title' => 1,
 482       'return.offset' => 2,
 483       'return.max_results' => 2,
 484     );
 485     $result = $this->callAPISuccess('event', 'get', $params);
 486     $this->assertAPISuccess($result);
 487     $this->assertEquals(2, $result['count'], ' 2 results returned In line ' . __LINE__);
 488   }
 489
 490   function testEventCreationPermissions() {
 491     $params = array(
 492       'event_type_id' => 1, 'start_date' => '2010-10-03', 'title' => 'le cake is a tie', 'check_permissions' => TRUE,    );
 493     $config = &CRM_Core_Config::singleton();
 494     $config->userPermissionClass->permissions = array('access CiviCRM');
 495     $result = $this->callAPIFailure('event', 'create', $params);
 496     $this->assertEquals('API permission check failed for event/create call; insufficient permission: require access CiviCRM and access CiviEvent and edit all events', $result['error_message'], 'lacking permissions should not be enough to create an event');
 497
 498     $config->userPermissionClass->permissions = array('access CiviEvent', 'edit all events', 'access CiviCRM');
 499     $result = $this->callAPISuccess('event', 'create', $params);
 500   }
 501
 502   function testgetfields() {
 503     $description = "demonstrate use of getfields to interogate api";
 504     $params = array('action' => 'create');
 505     $result = $this->callAPISuccess('event', 'getfields', $params);
 506     $this->assertEquals(1, $result['values']['title']['api.required'], 'in line ' . __LINE__);
 507   }
 508   /*
 509      * test api_action param also works
 510      */
 511   function testgetfieldsRest() {
 512     $description = "demonstrate use of getfields to interogate api";
 513     $params = array('api_action' => 'create');
 514     $result = $this->callAPISuccess('event', 'getfields', $params);
 515     $this->assertEquals(1, $result['values']['title']['api.required'], 'in line ' . __LINE__);
 516   }
 517   function testgetfieldsGet() {
 518     $description = "demonstrate use of getfields to interogate api";
 519     $params = array('action' => 'get');
 520     $result = $this->callAPISuccess('event', 'getfields', $params);
 521     $this->assertEquals('title', $result['values']['event_title']['name'], 'in line ' . __LINE__);
 522   }
 523   function testgetfieldsDelete() {
 524     $description = "demonstrate use of getfields to interogate api";
 525     $params = array('action' => 'delete');
 526     $result = $this->callAPISuccess('event', 'getfields', $params);
 527     $this->assertEquals(1, $result['values']['id']['api.required']);
 528   }
 529 }
 530