tests/phpunit/api/v3/PriceSetTest.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  * Class api_v3_PriceSetTest
  32  */
  33 class api_v3_PriceSetTest extends CiviUnitTestCase {
  34   protected $_apiversion = 3;
  35   protected $_params;
  36   protected $id = 0;
  37   protected $contactIds = array();
  38   protected $_entity = 'price_set';
  39
  40   public $DBResetRequired = TRUE;
  41
  42   /**
  43    * Set up for class.
  44    */
  45   public function setUp() {
  46     parent::setUp();
  47     $this->_params = array(
  48       'name' => 'default_goat_priceset',
  49       'title' => 'Goat accessories',
  50       'is_active' => 1,
  51       'help_pre' => "Please describe your goat in detail",
  52       'help_post' => "thank you for your time",
  53       'extends' => 2,
  54       'financial_type_id' => 1,
  55       'is_quick_config' => 1,
  56       'is_reserved' => 1,
  57     );
  58   }
  59
  60   public function tearDown() {
  61   }
  62
  63   /**
  64    * Test create price set.
  65    */
  66   public function testCreatePriceSet() {
  67     $result = $this->callAPIAndDocument($this->_entity, 'create', $this->_params, __FUNCTION__, __FILE__);
  68     $this->assertEquals(1, $result['count']);
  69     $this->assertNotNull($result['values'][$result['id']]['id']);
  70     $this->getAndCheck($this->_params, $result['id'], $this->_entity);
  71   }
  72
  73   /**
  74    * Test for creating price sets used for both events and contributions.
  75    */
  76   public function testCreatePriceSetForEventAndContribution() {
  77     // Create the price set
  78     $createParams = array(
  79       'name' => 'some_price_set',
  80       'title' => 'Some Price Set',
  81       'is_active' => 1,
  82       'financial_type_id' => 1,
  83       'extends' => array(1, 2),
  84     );
  85     $createResult = $this->callAPIAndDocument($this->_entity, 'create', $createParams, __FUNCTION__, __FILE__);
  86
  87     // Get priceset we just created.
  88     $result = $this->callAPISuccess($this->_entity, 'getSingle', array(
  89       'id' => $createResult['id'],
  90     ));
  91
  92     // Count the number of items in 'extends'.
  93     $this->assertEquals(2, count($result['extends']));
  94   }
  95
  96   /**
  97    * Check that no name doesn't cause failure.
  98    */
  99   public function testCreatePriceSetNoName() {
 100     $params = $this->_params;
 101     unset($params['name']);
 102     $this->callAPISuccess($this->_entity, 'create', $params);
 103   }
 104
 105   /**
 106    */
 107   public function testGetBasicPriceSet() {
 108     $getParams = array(
 109       'name' => 'default_contribution_amount',
 110     );
 111     $getResult = $this->callAPIAndDocument($this->_entity, 'get', $getParams, __FUNCTION__, __FILE__);
 112     $this->assertEquals(1, $getResult['count']);
 113   }
 114
 115   public function testEventPriceSet() {
 116     $event = $this->callAPISuccess('event', 'create', array(
 117       'title' => 'Event with Price Set',
 118       'event_type_id' => 1,
 119       'is_public' => 1,
 120       'start_date' => 20151021,
 121       'end_date' => 20151023,
 122       'is_active' => 1,
 123     ));
 124     $createParams = array(
 125       'entity_table' => 'civicrm_event',
 126       'entity_id' => $event['id'],
 127       'name' => 'event price',
 128       'title' => 'event price',
 129       'extends' => 1,
 130     );
 131     $createResult = $this->callAPIAndDocument($this->_entity, 'create', $createParams, __FUNCTION__, __FILE__);
 132     $result = $this->callAPISuccess($this->_entity, 'get', array(
 133       'id' => $createResult['id'],
 134     ));
 135     $this->assertEquals(array('civicrm_event' => array($event['id'])), $result['values'][$createResult['id']]['entity']);
 136   }
 137
 138   public function testDeletePriceSet() {
 139     $startCount = $this->callAPISuccess($this->_entity, 'getcount', array());
 140     $createResult = $this->callAPISuccess($this->_entity, 'create', $this->_params);
 141     $deleteParams = array('id' => $createResult['id']);
 142     $this->callAPIAndDocument($this->_entity, 'delete', $deleteParams, __FUNCTION__, __FILE__);
 143     $endCount = $this->callAPISuccess($this->_entity, 'getcount', array());
 144     $this->assertEquals($startCount, $endCount);
 145   }
 146
 147   public function testGetFieldsPriceSet() {
 148     $result = $this->callAPISuccess($this->_entity, 'getfields', array('action' => 'create'));
 149     $this->assertEquals(16, $result['values']['is_quick_config']['type']);
 150   }
 151
 152   public static function setUpBeforeClass() {
 153     // put stuff here that should happen before all tests in this unit
 154   }
 155
 156   public static function tearDownAfterClass() {
 157     $tablesToTruncate = array(
 158       'civicrm_contact',
 159       'civicrm_contribution',
 160     );
 161     $unitTest = new CiviUnitTestCase();
 162     $unitTest->quickCleanup($tablesToTruncate);
 163   }
 164
 165 }