[civicrm-core.git] / tests / phpunit / api / v3 / ParticipantTest.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.6                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2014                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*/

require_once 'CiviTest/CiviUnitTestCase.php';

/**
 * Test class for Batch API - civicrm_participant_*
 *
 *  @package CiviCRM_APIv3
 */
require_once 'CRM/Utils/DeprecatedUtils.php';
require_once 'CiviTest/CiviUnitTestCase.php';

/**
 * Class api_v3_ParticipantTest
 */
class api_v3_ParticipantTest extends CiviUnitTestCase {

  protected $_apiversion;
  protected $_entity;
  protected $_contactID;
  protected $_contactID2;
  protected $_createdParticipants;
  protected $_participantID;
  protected $_eventID;
  protected $_individualId;
  protected $_params;

  public function setUp() {
    $this->_apiversion = 3;
    parent::setUp();
    $this->_entity  = 'participant';
    $event          = $this->eventCreate(NULL);
    $this->_eventID = $event['id'];

    $this->_contactID = $this->individualCreate();

    $this->_createdParticipants = array();
    $this->_individualId = $this->individualCreate();

    $this->_participantID = $this->participantCreate(array('contact_id' => $this->_contactID, 'event_id' => $this->_eventID));
    $this->_contactID2 = $this->individualCreate();
    $this->_participantID2 = $this->participantCreate(array('contact_id' => $this->_contactID2, 'event_id' => $this->_eventID));
    $this->_participantID3 = $this->participantCreate(array('contact_id' => $this->_contactID2, 'event_id' => $this->_eventID));
    $this->_params = array(
      'contact_id' => $this->_contactID,
      'event_id' => $this->_eventID,
      'status_id' => 1,
      'role_id' => 1,
      // to ensure it matches later on
      'register_date' => '2007-07-21 00:00:00',
      'source' => 'Online Event Registration: API Testing',
    );
  }

  public function tearDown() {
    $this->eventDelete($this->_eventID);
    $tablesToTruncate = array(
      'civicrm_custom_group', 'civicrm_custom_field', 'civicrm_contact', 'civicrm_participant'
    );
    // true tells quickCleanup to drop any tables that might have been created in the test
    $this->quickCleanup($tablesToTruncate, TRUE);
  }

  /**
   * Check with complete array + custom field
   * Note that the test is written on purpose without any
   * variables specific to participant so it can be replicated into other entities
   * and / or moved to the automated test suite
   */
  public function testCreateWithCustom() {
    $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);

    $params = $this->_params;
    $params['custom_' . $ids['custom_field_id']] = "custom string";

    $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);

    $this->assertEquals($result['id'], $result['values'][$result['id']]['id']);

    $check = $this->callAPISuccess($this->_entity, 'get', array('id' => $result['id']));
    $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__);

    $this->customFieldDelete($ids['custom_field_id']);
    $this->customGroupDelete($ids['custom_group_id']);
  }


  ///////////////// civicrm_participant_get methods

  /**
   * Check with wrong params type
   */
  public function testGetWrongParamsType() {
    $params = 'a string';
    $result = $this->callAPIFailure('participant', 'get', $params);
  }

  /**
   * Test civicrm_participant_get with empty params
   */
  public function testGetEmptyParams() {
    $this->callAPISuccess('participant', 'get', array());
  }

  /**
   * Check with participant_id
   */
  public function testGetParticipantIdOnly() {
    $params = array(
      'participant_id' => $this->_participantID,
      'return' => array(
        'participant_id',
        'event_id',
        'participant_register_date',
        'participant_source',
      )
    );
    $result = $this->callAPISuccess('participant', 'get', $params);
    $this->assertAPISuccess($result, " in line " . __LINE__);
    $this->assertEquals($result['values'][$this->_participantID]['event_id'], $this->_eventID, "in line " . __LINE__);
    $this->assertEquals($result['values'][$this->_participantID]['participant_register_date'], '2007-02-19 00:00:00', "in line " . __LINE__);
    $this->assertEquals($result['values'][$this->_participantID]['participant_source'], 'Wimbeldon', "in line " . __LINE__);
      $params = array(
      'id' => $this->_participantID,
      'return' => 'id,participant_register_date,event_id',

    );
    $result = $this->callAPISuccess('participant', 'get', $params);
    $this->assertEquals($result['values'][$this->_participantID]['event_id'], $this->_eventID);
    $this->assertEquals($result['values'][$this->_participantID]['participant_register_date'], '2007-02-19 00:00:00');

  }

  /**
   * Check with params id
   */
  public function testGetParamsAsIdOnly() {
    $params = array(
      'id' => $this->_participantID,
    );
    $result = $this->callAPIAndDocument('participant', 'get', $params, __FUNCTION__, __FILE__);
    $this->assertEquals($result['values'][$this->_participantID]['event_id'], $this->_eventID);
    $this->assertEquals($result['values'][$this->_participantID]['participant_register_date'], '2007-02-19 00:00:00');
    $this->assertEquals($result['values'][$this->_participantID]['participant_source'], 'Wimbeldon');
    $this->assertEquals($result['id'], $result['values'][$this->_participantID]['id']);
  }

  /**
   * Check with params id
   */
  public function testGetNestedEventGet() {
    //create a second event & add participant to it.
    $event = $this->eventCreate(NULL);
    $this->callAPISuccess('participant', 'create', array('event_id' => $event['id'], 'contact_id' => $this->_contactID));


    $description = "use nested get to get an event";
    $subfile     = "NestedEventGet";
    $params      = array(
      'id' => $this->_participantID,
      'api.event.get' => 1,
    );
    $result = $this->callAPIAndDocument('participant', 'get', $params, __FUNCTION__, __FILE__, $description, $subfile);
    $this->assertEquals($result['values'][$this->_participantID]['event_id'], $this->_eventID);
    $this->assertEquals($result['values'][$this->_participantID]['participant_register_date'], '2007-02-19 00:00:00');
    $this->assertEquals($result['values'][$this->_participantID]['participant_source'], 'Wimbeldon');
    $this->assertEquals($this->_eventID, $result['values'][$this->_participantID]['api.event.get']['id']);
  }

  /**
   * Check Participant Get respects return properties
   */
  public function testGetWithReturnProperties() {
    $params = array(
      'contact_id' => $this->_contactID,      'return.status_id' => 1,
      'return.participant_status_id' => 1,
      'options' => array('limit' => 1)
    );
    $result = $this->callAPISuccess('participant', 'get', $params);
    $this->assertArrayHasKey('participant_status_id', $result['values'][$result['id']]);
  }

  /**
   * Check with contact_id
   */
  public function testGetContactIdOnly() {
    $params = array(
      'contact_id' => $this->_contactID,    );
    $participant = $this->callAPISuccess('participant', 'get', $params);

    $this->assertEquals($this->_participantID, $participant['id'],
      "In line " . __LINE__
    );
    $this->assertEquals($this->_eventID, $participant['values'][$participant['id']]['event_id'],
      "In line " . __LINE__
    );
    $this->assertEquals('2007-02-19 00:00:00', $participant['values'][$participant['id']]['participant_register_date'],
      "In line " . __LINE__
    );
    $this->assertEquals('Wimbeldon', $participant['values'][$participant['id']]['participant_source'],
      "In line " . __LINE__
    );
    $this->assertEquals($participant['id'], $participant['values'][$participant['id']]['id'],
      "In line " . __LINE__
    );
  }

  /**
   * Check with event_id
   * fetch first record
   */
  public function testGetMultiMatchReturnFirst() {
    $params = array(
      'event_id' => $this->_eventID,
      'rowCount' => 1,    );

    $participant = $this->callAPISuccess('participant', 'get', $params);
    $this->assertNotNull($participant['id']);
  }

  /**
   * Check with event_id
   * in v3 this should return all participants
   */
  public function testGetMultiMatchNoReturnFirst() {
    $params = array(
      'event_id' => $this->_eventID,
    );
    $participant = $this->callAPISuccess('participant', 'get', $params);
    $this->assertNotNull($participant['count'], 3);
  }

  ///////////////// civicrm_participant_get methods

  /**
   * Test civicrm_participant_get with empty params
   * In this case all the participant records are returned.
   */
  public function testSearchEmptyParams() {
    $result = $this->callAPISuccess('participant', 'get', array());
    // expecting 3 participant records
    $this->assertEquals($result['count'], 3);
  }

  /**
   * Check with participant_id
   */
  public function testSearchParticipantIdOnly() {
    $params = array(
      'participant_id' => $this->_participantID,
    );
    $participant = $this->callAPISuccess('participant', 'get', $params);
    $this->assertEquals($participant['values'][$this->_participantID]['event_id'], $this->_eventID);
    $this->assertEquals($participant['values'][$this->_participantID]['participant_register_date'], '2007-02-19 00:00:00');
    $this->assertEquals($participant['values'][$this->_participantID]['participant_source'], 'Wimbeldon');
  }

  /**
   * Check with contact_id
   */
  public function testSearchContactIdOnly() {
    // Should get 2 participant records for this contact.
    $params = array(
      'contact_id' => $this->_contactID2,
    );
    $participant = $this->callAPISuccess('participant', 'get', $params);

    $this->assertEquals($participant['count'], 2);
  }

  /**
   * Check with event_id
   */
  public function testSearchByEvent() {
    // Should get >= 3 participant records for this event. Also testing that last_name and event_title are returned.
    $params = array(
      'event_id' => $this->_eventID,
      'return.last_name' => 1,
      'return.event_title' => 1,
    );
    $participant = $this->callAPISuccess('participant', 'get', $params);
    if ($participant['count'] < 3) {
      $this->fail("Event search returned less than expected miniumum of 3 records.");
    }

    $this->assertEquals($participant['values'][$this->_participantID]['last_name'], 'Anderson');
    $this->assertEquals($participant['values'][$this->_participantID]['event_title'], 'Annual CiviCRM meet');
  }

  /**
   * Check with event_id
   * fetch with limit
   */
  public function testSearchByEventWithLimit() {
    // Should 2 participant records since we're passing rowCount = 2.
    $params = array(
      'event_id' => $this->_eventID,
      'rowCount' => 2,
    );
    $participant = $this->callAPISuccess('participant', 'get', $params);

    $this->assertEquals($participant['count'], 2, 'in line ' . __LINE__);
  }

  ///////////////// civicrm_participant_create methods

  /**
   * Test civicrm_participant_create with empty params
   */
  public function testCreateEmptyParams() {
    $params = array();
    $result = $this->callAPIFailure('participant', 'create', $params);
  }

  /**
   * Check with event_id
   */
  public function testCreateMissingContactID() {
    $params = array(
      'event_id' => $this->_eventID,
    );
    $participant = $this->callAPIFailure('participant', 'create', $params);
  }

  /**
   * Check with contact_id
   * without event_id
   */
  public function testCreateMissingEventID() {
    $params = array(
      'contact_id' => $this->_contactID,
    );
    $participant = $this->callAPIFailure('participant', 'create', $params);
  }

  /**
   * Check with contact_id & event_id
   */
  public function testCreateEventIdOnly() {
    $params = array(
      'contact_id' => $this->_contactID,
      'event_id' => $this->_eventID,
    );
    $participant = $this->callAPISuccess('participant', 'create', $params);
    $this->getAndCheck($params, $participant['id'], 'participant');
  }

  /**
   * Check with complete array
   */
  public function testCreateAllParams() {
    $params = $this->_params;

    $participant = $this->callAPISuccess('participant', 'create', $params);
    $this->_participantID = $participant['id'];
    // assertDBState compares expected values in $match to actual values in the DB
    $this->assertDBState('CRM_Event_DAO_Participant', $participant['id'], $params);
  }

  /**
   * Test to check if receive date is being changed per CRM-9763
   */
  public function testCreateUpdateReceiveDate() {
    $participant = $this->callAPISuccess('participant', 'create', $this->_params);
    $update = array(
           'id' => $participant['id'],
      'status_id' => 2,
    );
    $this->callAPISuccess('participant', 'create', $update);
    $this->getAndCheck(array_merge($this->_params, $update), $participant['id'], 'participant');
  }

  /**
   * Test to check if participant fee level is being changed per CRM-9781
   */
  public function testCreateUpdateParticipantFeeLevel() {
    $myParams = $this->_params + array('participant_fee_level' => CRM_Core_DAO::VALUE_SEPARATOR . "fee" . CRM_Core_DAO::VALUE_SEPARATOR);
    $participant = $this->callAPISuccess('participant', 'create', $myParams);
    $update = array(
      'id' => $participant['id'],
      'status_id' => 2,
    );
    $update = $this->callAPISuccess('participant', 'create', $update);

    $this->assertEquals($participant['values'][$participant['id']]['fee_level'],
      $update['values'][$participant['id']]['fee_level']
    );

    $this->callAPISuccess('participant', 'delete', array('id' => $participant['id']));
  }

  /**
   * Test the line items for participant fee with multiple price field values.
   */
  public function testCreateParticipantLineItems() {
    // Create a price set for this event.

    $priceset = $this->callAPISuccess('PriceSet', 'create', array(
      'name' => 'my_price_set',
      'title' => 'My Price Set',
      'is_active' => 1,
      'extends' => 1,
      'financial_type_id' => 4,
      // 'entity' => array('civicrm_event' => array($this->_eventID)),
    ));

    // Add the price set to the event with another API call.
    // I tried to do this at once, but it did not work.

    $priceset = $this->callAPISuccess('PriceSet', 'create', array(
      'entity_table' => 'civicrm_event',
      'entity_id' => $this->_eventID,
      'id' => $priceset['id'],
    ));

    $pricefield = $this->callAPISuccess('PriceField', 'create', array(
      'price_set_id' => $priceset['id'],
      'name' => 'mypricefield',
      'label' => 'My Price Field',
      'html_type' => 'Text',
      'is_enter_qty' => 1,
      'is_display_amounts' => 1,
      'is_active' => 1,
    ));

    $pfv1 = $this->callAPISuccess('PriceFieldValue', 'create', array(
      'price_field_id' => $pricefield['id'],
      'name' => 'pricefieldvalue1',
      'label' => 'pricefieldvalue1',
      'amount' => 20,
      'is_active' => 1,
      'financial_type_id' => 4,
    ));

    $pfv2 = $this->callAPISuccess('PriceFieldValue', 'create', array(
      'price_field_id' => $pricefield['id'],
      'name' => 'pricefieldvalue2',
      'label' => 'pricefieldvalue2',
      'amount' => 5,
      'is_active' => 1,
      'financial_type_id' => 4,
    ));

    // pay 2 times price field value 1, and 2 times price field value 2.
    $myParams = $this->_params + array('participant_fee_level' => CRM_Core_DAO::VALUE_SEPARATOR . "pricefieldvalue1 - 2" . CRM_Core_DAO::VALUE_SEPARATOR . "pricefieldvalue2 - 2" . CRM_Core_DAO::VALUE_SEPARATOR);
    $participant = $this->callAPISuccess('participant', 'create', $myParams);

    // expect 2 line items.
    $lineItems = $this->callAPISuccess('LineItem', 'get', array(
      'entity_id' => $participant['id'],
      'entity_table' => 'civicrm_participant',
    ));

    $this->assertEquals(2, $lineItems['count']);

    // Check quantity, label and unit price of lines.
    // TODO: These assertions depend on the order of the line items, which is
    // technically incorrect.

    $lineItem = array_pop($lineItems['values']);
    $this->assertEquals(2, $lineItem['qty']);
    $this->assertEquals(5, $lineItem['unit_price']);
    $this->assertEquals('pricefieldvalue2', $lineItem['label']);

    $lineItem = array_pop($lineItems['values']);
    $this->assertEquals(2, $lineItem['qty']);
    $this->assertEquals(20, $lineItem['unit_price']);
    $this->assertEquals('pricefieldvalue1', $lineItem['label']);

    // Cleanup
    $this->callAPISuccess('participant', 'delete', array('id' => $participant['id']));

    // TODO: I think the price set should be removed, but I don't know how
    // to decouple it properly from the event. For the moment, I'll just comment
    // out the lines below.

    /*
    $this->callAPISuccess('PriceFieldValue', 'delete', array('id' => $pfv1['id']));
    $this->callAPISuccess('PriceFieldValue', 'delete', array('id' => $pfv2['id']));
    $this->callAPISuccess('PriceField', 'delete', array('id' => $pricefield['id']));
    $this->callAPISuccess('PriceSet', 'delete', array('id' => $priceset['id']));
    */
  }

  /**
   * Check with complete array
   */
  public function testUpdate() {
    $participantId = $this->participantCreate(array(
      'contactID' => $this->_individualId,
      'eventID' => $this->_eventID
    ));
    $params = array(
      'id' => $participantId,
      'contact_id' => $this->_individualId,
      'event_id' => $this->_eventID,
      'status_id' => 3,
      'role_id' => 3,
      'register_date' => '2006-01-21',
      'source' => 'US Open',
    );
    $participant = $this->callAPISuccess('participant', 'create', $params);
    $this->getAndCheck($params, $participant['id'], 'participant');
    $result = $this->participantDelete($params['id']);
  }

  /**
   * Test to check if participant fee level is being changed per CRM-9781
   * Try again  without a custom separater to check that one isn't added
   * (get & check won't accept an array)
   */
  public function testUpdateCreateParticipantFeeLevelNoSeparator() {

    $myParams = $this->_params + array('participant_fee_level' => "fee");
    $participant = $this->callAPISuccess('participant', 'create', $myParams);
    $this->assertAPISuccess($participant);
    $update = array(
           'id' => $participant['id'],
      'status_id' => 2,
    );
    $this->callAPISuccess('participant', 'create', $update);
    $this->assertEquals($participant['values'][$participant['id']]['fee_level'],
      $myParams['participant_fee_level']
    );
    $this->getAndCheck($update, $participant['id'], 'participant');
  }
  ///////////////// civicrm_participant_update methods

  /**
   * Test civicrm_participant_update with wrong params type
   */
  public function testUpdateWrongParamsType() {
    $params = 'a string';
    $result = $this->callAPIFailure('participant', 'create', $params);
    $this->assertEquals('Input variable `params` is not an array', $result['error_message'], 'In line ' . __LINE__);
  }

  /**
   * Check with empty array
   */
  public function testUpdateEmptyParams() {
    $params = array();
    $participant = $this->callAPIFailure('participant', 'create', $params);
    $this->assertEquals($participant['error_message'], 'Mandatory key(s) missing from params array: event_id, contact_id');
  }

  /**
   * Check without event_id
   */
  public function testUpdateWithoutEventId() {
    $participantId = $this->participantCreate(array('contactID' => $this->_individualId, 'eventID' => $this->_eventID));
    $params = array(
      'contact_id' => $this->_individualId,
      'status_id' => 3,
      'role_id' => 3,
      'register_date' => '2006-01-21',
      'source' => 'US Open',
      'event_level' => 'Donation',    );
    $participant = $this->callAPIFailure('participant', 'create', $params);
    $this->assertEquals($participant['error_message'], 'Mandatory key(s) missing from params array: event_id');
    // Cleanup created participant records.
    $result = $this->participantDelete($participantId);
  }

  /**
   * Check with Invalid participantId
   */
  public function testUpdateWithWrongParticipantId() {
    $params = array(
      'id' => 1234,
      'status_id' => 3,
      'role_id' => 3,
      'register_date' => '2006-01-21',
      'source' => 'US Open',
      'event_level' => 'Donation',    );
    $participant = $this->callAPIFailure('Participant', 'update', $params);
  }

  /**
   * Check with Invalid ContactId
   */
  public function testUpdateWithWrongContactId() {
    $participantId = $this->participantCreate(array(
      'contactID' => $this->_individualId,
        'eventID' => $this->_eventID,
      ), $this->_apiversion);
    $params = array(
      'id' => $participantId,
      'contact_id' => 12345,
      'status_id' => 3,
      'role_id' => 3,
      'register_date' => '2006-01-21',
      'source' => 'US Open',
      'event_level' => 'Donation',    );
    $participant = $this->callAPIFailure('participant', 'create', $params);
    $result = $this->participantDelete($participantId);
  }

  ///////////////// civicrm_participant_delete methods

  /**
   * Test civicrm_participant_delete with wrong params type
   */
  public function testDeleteWrongParamsType() {
    $params = 'a string';
    $result = $this->callAPIFailure('participant', 'delete', $params);
  }

  /**
   * Test civicrm_participant_delete with empty params
   */
  public function testDeleteEmptyParams() {
    $params = array();
    $result = $this->callAPIFailure('participant', 'delete', $params);
  }

  /**
   * Check with participant_id
   */
  public function testParticipantDelete() {
    $params = array(
      'id' => $this->_participantID,    );
    $participant = $this->callAPISuccess('participant', 'delete', $params);
    $this->assertAPISuccess($participant);
    $this->assertDBState('CRM_Event_DAO_Participant', $this->_participantID, NULL, TRUE);
  }

  /**
   * Check without participant_id
   * and with event_id
   * This should return an error because required param is missing..
   */
  public function testParticipantDeleteMissingID() {
    $params = array(
      'event_id' => $this->_eventID,    );
    $participant = $this->callAPIFailure('participant', 'delete', $params);
    $this->assertNotNull($participant['error_message']);
  }

  /**
   * Delete with a get - a 'criteria delete'
   */
  public function testNestedDelete() {
    $description  = "Criteria delete by nesting a GET & a DELETE";
    $subfile      = "NestedDelete";
    $participants = $this->callAPISuccess('Participant', 'Get', array());
    $this->assertEquals($participants['count'], 3);
    $params = array('contact_id' => $this->_contactID2, 'api.participant.delete' => 1);
    $participants = $this->callAPIAndDocument('Participant', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile, 'Get');
    $check = $this->callAPISuccess('participant', 'getcount', array());
    $this->assertEquals(1, $check,"only one participant should be left. line " . __LINE__);
  }

  /**
   * Test creation of a participant with an associated contribution
   */
  public function testCreateParticipantWithPayment() {
    $description = "single function to create contact w partipation & contribution. Note that in the
      case of 'contribution' the 'create' is implied (api.contribution.create)";
    $subfile = "CreateParticipantPayment";
    $params = array(
      'contact_type' => 'Individual',
      'display_name' => 'dlobo',
      'api.participant' => array(
        'event_id' => $this->_eventID,
        'status_id' => 1,
        'role_id' => 1,
        'format.only_id' => 1,
      ),
      'api.contribution.create' => array(
        'financial_type_id' => 1,
        'total_amount' => 100,
        'format.only_id' => 1,
      ),
      'api.participant_payment.create' => array(
        'contribution_id' => '$value.api.contribution.create',
        'participant_id' => '$value.api.participant',
      ),
    );

    $result = $this->callAPIAndDocument('contact', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
    $this->assertEquals(1, $result['values'][$result['id']]['api.participant_payment.create']['count']);
    $this->callAPISuccess('contact', 'delete', array('id' => $result['id']));
  }
}