tests/phpunit/api/v3/MembershipStatusTest.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
  30 /**
  31  * Class api_v3_MembershipStatusTest
  32  */
  33 class api_v3_MembershipStatusTest extends CiviUnitTestCase {
  34
  35   protected $_contactID;
  36   protected $_contributionTypeID;
  37   protected $_membershipTypeID;
  38   protected $_membershipStatusID;
  39
  40   protected $_apiversion = 3;
  41
  42   public function setUp() {
  43     parent::setUp();
  44     $this->_contactID = $this->individualCreate();
  45     $this->_membershipTypeID = $this->membershipTypeCreate(array('member_of_contact_id' => $this->_contactID));
  46     $this->_membershipStatusID = $this->membershipStatusCreate('test status');
  47
  48     CRM_Member_PseudoConstant::membershipType($this->_membershipTypeID, TRUE);
  49     CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'name', TRUE);
  50   }
  51
  52   public function tearDown() {
  53     $this->membershipStatusDelete($this->_membershipStatusID);
  54     $this->membershipTypeDelete(array('id' => $this->_membershipTypeID));
  55     $this->contactDelete($this->_contactID);
  56   }
  57
  58   ///////////////// civicrm_membership_status_get methods
  59
  60
  61   /**
  62    *  Test civicrm_membership_status_get with empty params
  63    */
  64   public function testGetEmptyParams() {
  65     $result = $this->callAPISuccess('membership_status', 'get', array());
  66     // It should be 8 statuses, 7 default from mysql_data
  67     // plus one test status added in setUp
  68     $this->assertEquals(8, $result['count']);
  69   }
  70
  71   /**
  72    *  Test civicrm_membership_status_get. Success expected.
  73    */
  74   public function testGet() {
  75     $params = array(
  76       'name' => 'test status',
  77     );
  78     $result = $this->callAPIAndDocument('membership_status', 'get', $params, __FUNCTION__, __FILE__);
  79     $this->assertEquals($result['values'][$this->_membershipStatusID]['name'], "test status", "In line " . __LINE__);
  80   }
  81
  82   /**
  83    *  Test civicrm_membership_status_get. Success expected.
  84    */
  85   public function testGetLimit() {
  86     $result = $this->callAPISuccess('membership_status', 'get', array());
  87     $this->assertGreaterThan(1, $result['count'], "Check more than one exists In line " . __LINE__);
  88     $params['option.limit'] = 1;
  89     $result = $this->callAPISuccess('membership_status', 'get', $params);
  90     $this->assertEquals(1, $result['count'], "Check only 1 retrieved " . __LINE__);
  91   }
  92
  93   public function testCreateDuplicateName() {
  94     $params = array('name' => 'name');
  95     $result = $this->callAPISuccess('membership_status', 'create', $params);
  96     $result = $this->callAPIFailure('membership_status', 'create', $params,
  97       'A membership status with this name already exists.'
  98     );
  99   }
 100
 101   public function testCreateWithMissingRequired() {
 102     $params = array('title' => 'Does not make sense');
 103     $result = $this->callAPIFailure('membership_status', 'create', $params);
 104   }
 105
 106   public function testCreate() {
 107     $params = array(
 108       'name' => 'test membership status',
 109     );
 110     $result = $this->callAPIAndDocument('membership_status', 'create', $params, __FUNCTION__, __FILE__);
 111
 112     $this->assertNotNull($result['id']);
 113     $this->membershipStatusDelete($result['id']);
 114   }
 115
 116   public function testUpdate() {
 117     $params = array(
 118       'name' => 'test membership status',
 119     );
 120     $result = $this->callAPISuccess('membership_status', 'create', $params);
 121     $id = $result['id'];
 122     $result = $this->callAPISuccess('membership_status', 'get', $params);
 123     $this->assertEquals('test membership status', $result['values'][$id]['name']);
 124     $newParams = array(
 125       'id' => $id,
 126       'name' => 'renamed',
 127     );
 128     $result = $this->callAPISuccess('membership_status', 'create', $newParams);
 129     $result = $this->callAPISuccess('membership_status', 'get', array('id' => $id));
 130     $this->assertEquals('renamed', $result['values'][$id]['name']);
 131     $this->membershipStatusDelete($result['id']);
 132   }
 133
 134
 135   ///////////////// civicrm_membership_status_delete methods
 136
 137   /**
 138    * Attempt (and fail) to delete membership status without an parameters.
 139    */
 140   public function testDeleteEmptyParams() {
 141     $result = $this->callAPIFailure('membership_status', 'delete', array());
 142   }
 143
 144   public function testDeleteWithMissingRequired() {
 145     $params = array('title' => 'Does not make sense');
 146     $result = $this->callAPIFailure('membership_status', 'delete', $params);
 147   }
 148
 149   public function testDelete() {
 150     $membershipID = $this->membershipStatusCreate();
 151     $params = array(
 152       'id' => $membershipID,
 153     );
 154     $result = $this->callAPISuccess('membership_status', 'delete', $params);
 155   }
 156
 157   /**
 158    * Test that trying to delete membership status while membership still exists creates error
 159    */
 160   public function testDeleteWithMembershipError() {
 161     $membershipStatusID = $this->membershipStatusCreate();
 162     $this->_contactID = $this->individualCreate();
 163     $this->_entity = 'membership';
 164     $params = array(
 165       'contact_id' => $this->_contactID,
 166       'membership_type_id' => $this->_membershipTypeID,
 167       'join_date' => '2009-01-21',
 168       'start_date' => '2009-01-21',
 169       'end_date' => '2009-12-21',
 170       'source' => 'Payment',
 171       'is_override' => 1,
 172       'status_id' => $membershipStatusID,
 173     );
 174
 175     $result = $this->callAPISuccess('membership', 'create', $params);
 176     $membershipID = $result['id'];
 177
 178     $params = array(
 179       'id' => $membershipStatusID,
 180     );
 181     $result = $this->callAPIFailure('membership_status', 'delete', $params);
 182
 183     $this->callAPISuccess('Membership', 'Delete', array(
 184       'id' => $membershipID,
 185     ));
 186     $result = $this->callAPISuccess('membership_status', 'delete', $params);
 187   }
 188
 189 }