tests/phpunit/api/v3/MembershipStatusTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * Class api_v3_MembershipStatusTest
  14  * @group headless
  15  */
  16 class api_v3_MembershipStatusTest extends CiviUnitTestCase {
  17
  18   protected $_contactID;
  19   protected $_contributionTypeID;
  20   protected $_membershipTypeID;
  21   protected $_membershipStatusID;
  22
  23   protected $_apiversion = 3;
  24
  25   public function setUp() {
  26     parent::setUp();
  27     $this->_contactID = $this->individualCreate();
  28     $this->_membershipTypeID = $this->membershipTypeCreate(['member_of_contact_id' => $this->_contactID]);
  29     $this->_membershipStatusID = $this->membershipStatusCreate('test status');
  30
  31     CRM_Member_PseudoConstant::membershipType($this->_membershipTypeID, TRUE);
  32     CRM_Member_PseudoConstant::membershipStatus(NULL, NULL, 'name', TRUE);
  33   }
  34
  35   /**
  36    * Cleanup after test.
  37    *
  38    * @throws \CRM_Core_Exception
  39    */
  40   public function tearDown() {
  41     $this->membershipStatusDelete($this->_membershipStatusID);
  42     $this->membershipTypeDelete(['id' => $this->_membershipTypeID]);
  43     $this->contactDelete($this->_contactID);
  44     parent::tearDown();
  45   }
  46
  47   ///////////////// civicrm_membership_status_get methods
  48
  49   /**
  50    * Test civicrm_membership_status_get with empty params.
  51    */
  52   public function testGetEmptyParams() {
  53     $result = $this->callAPISuccess('membership_status', 'get', []);
  54     // It should be 8 statuses, 7 default from mysql_data
  55     // plus one test status added in setUp
  56     $this->assertEquals(8, $result['count']);
  57   }
  58
  59   /**
  60    * Test civicrm_membership_status_get. Success expected.
  61    */
  62   public function testGet() {
  63     $params = [
  64       'name' => 'test status',
  65     ];
  66     $result = $this->callAPIAndDocument('membership_status', 'get', $params, __FUNCTION__, __FILE__);
  67     $this->assertEquals($result['values'][$this->_membershipStatusID]['name'], "test status", "In line " . __LINE__);
  68   }
  69
  70   /**
  71    * Test civicrm_membership_status_get. Success expected.
  72    */
  73   public function testGetLimit() {
  74     $result = $this->callAPISuccess('membership_status', 'get', []);
  75     $this->assertGreaterThan(1, $result['count'], "Check more than one exists In line " . __LINE__);
  76     $params['option.limit'] = 1;
  77     $result = $this->callAPISuccess('membership_status', 'get', $params);
  78     $this->assertEquals(1, $result['count'], "Check only 1 retrieved " . __LINE__);
  79   }
  80
  81   public function testCreateDuplicateName() {
  82     $params = ['name' => 'name'];
  83     $result = $this->callAPISuccess('membership_status', 'create', $params);
  84     $result = $this->callAPIFailure('membership_status', 'create', $params,
  85       'A membership status with this name already exists.'
  86     );
  87   }
  88
  89   public function testCreateWithMissingRequired() {
  90     $params = ['title' => 'Does not make sense'];
  91     $this->callAPIFailure('membership_status', 'create', $params, 'Mandatory key(s) missing from params array: name');
  92   }
  93
  94   public function testCreate() {
  95     $params = [
  96       'name' => 'test membership status',
  97     ];
  98     $result = $this->callAPIAndDocument('membership_status', 'create', $params, __FUNCTION__, __FILE__);
  99
 100     $this->assertNotNull($result['id']);
 101     $this->membershipStatusDelete($result['id']);
 102   }
 103
 104   public function testUpdate() {
 105     $params = [
 106       'name' => 'test membership status',
 107     ];
 108     $result = $this->callAPISuccess('membership_status', 'create', $params);
 109     $id = $result['id'];
 110     $result = $this->callAPISuccess('membership_status', 'get', $params);
 111     $this->assertEquals('test membership status', $result['values'][$id]['name']);
 112     $newParams = [
 113       'id' => $id,
 114       'name' => 'renamed',
 115     ];
 116     $result = $this->callAPISuccess('membership_status', 'create', $newParams);
 117     $result = $this->callAPISuccess('membership_status', 'get', ['id' => $id]);
 118     $this->assertEquals('renamed', $result['values'][$id]['name']);
 119     $this->membershipStatusDelete($result['id']);
 120   }
 121
 122   ///////////////// civicrm_membership_status_delete methods
 123
 124   /**
 125    * Attempt (and fail) to delete membership status without an parameters.
 126    */
 127   public function testDeleteEmptyParams() {
 128     $result = $this->callAPIFailure('membership_status', 'delete', []);
 129   }
 130
 131   public function testDeleteWithMissingRequired() {
 132     $params = ['title' => 'Does not make sense'];
 133     $result = $this->callAPIFailure('membership_status', 'delete', $params);
 134   }
 135
 136   public function testDelete() {
 137     $membershipID = $this->membershipStatusCreate();
 138     $params = [
 139       'id' => $membershipID,
 140     ];
 141     $result = $this->callAPISuccess('membership_status', 'delete', $params);
 142   }
 143
 144   /**
 145    * Test that after checking the person as 'Deceased', the Membership is also 'Deceased' both through inline and normal edit.
 146    */
 147   public function testDeceasedMembershipInline() {
 148     $contactID = $this->individualCreate();
 149     $params = [
 150       'contact_id' => $contactID,
 151       'membership_type_id' => $this->_membershipTypeID,
 152       'join_date' => '2006-01-21',
 153       'start_date' => '2006-01-21',
 154       'end_date' => '2006-12-21',
 155       'status_id' => $this->_membershipStatusID,
 156     ];
 157     $this->callApiSuccess('membership', 'create', $params);
 158     $this->callApiSuccess('contact', 'create', ['id' => $contactID, 'is_deceased' => 1]);
 159     $membership = $this->callApiSuccessGetSingle('membership', ['contact_id' => $contactID]);
 160     $this->assertEquals(CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Deceased'), $membership['status_id']);
 161   }
 162
 163   /**
 164    * Test that trying to delete membership status while membership still exists creates error.
 165    */
 166   public function testDeleteWithMembershipError() {
 167     $membershipStatusID = $this->membershipStatusCreate();
 168     $this->_contactID = $this->individualCreate();
 169     $this->_entity = 'membership';
 170     $params = [
 171       'contact_id' => $this->_contactID,
 172       'membership_type_id' => $this->_membershipTypeID,
 173       'join_date' => '2009-01-21',
 174       'start_date' => '2009-01-21',
 175       'end_date' => '2009-12-21',
 176       'source' => 'Payment',
 177       'is_override' => 1,
 178       'status_id' => $membershipStatusID,
 179     ];
 180
 181     $result = $this->callAPISuccess('membership', 'create', $params);
 182     $membershipID = $result['id'];
 183
 184     $params = [
 185       'id' => $membershipStatusID,
 186     ];
 187     $result = $this->callAPIFailure('membership_status', 'delete', $params);
 188
 189     $this->callAPISuccess('Membership', 'Delete', [
 190       'id' => $membershipID,
 191     ]);
 192     $result = $this->callAPISuccess('membership_status', 'delete', $params);
 193   }
 194
 195 }