Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
2fe49090 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 | 27 | |
6a488035 TO |
28 | /** |
29 | * Class contains api test cases for "civicrm_payment_processor_type" | |
30 | * | |
acb109b7 | 31 | * @group headless |
6a488035 TO |
32 | */ |
33 | class api_v3_PaymentProcessorTypeTest extends CiviUnitTestCase { | |
6a488035 TO |
34 | protected $_ppTypeID; |
35 | protected $_apiversion; | |
b7c9bc4c | 36 | |
00be9182 | 37 | public function setUp() { |
6a488035 TO |
38 | |
39 | parent::setUp(); | |
1da902df | 40 | $this->useTransaction(TRUE); |
6a488035 | 41 | $this->_apiversion = 3; |
6a488035 TO |
42 | } |
43 | ||
6c6e6187 TO |
44 | // function tearDown() { |
45 | // | |
46 | // $tablesToTruncate = array( | |
47 | // 'civicrm_payment_processor_type', | |
48 | // ); | |
49 | // $this->quickCleanup($tablesToTruncate); | |
50 | // } | |
6a488035 TO |
51 | |
52 | ///////////////// civicrm_payment_processor_type_add methods | |
53 | ||
54 | /** | |
eceb18cc | 55 | * Check with no name. |
6a488035 | 56 | */ |
00be9182 | 57 | public function testPaymentProcessorTypeCreateWithoutName() { |
6a488035 | 58 | $payProcParams = array( |
92915c55 TO |
59 | 'is_active' => 1, |
60 | ); | |
d0e1eff2 | 61 | $result = $this->callAPIFailure('payment_processor_type', 'create', $payProcParams); |
6a488035 TO |
62 | $this->assertEquals($result['error_message'], |
63 | 'Mandatory key(s) missing from params array: name, title, class_name, billing_mode' | |
64 | ); | |
65 | } | |
66 | ||
67 | /** | |
eceb18cc | 68 | * Create payment processor type. |
6a488035 | 69 | */ |
00be9182 | 70 | public function testPaymentProcessorTypeCreate() { |
6c6e6187 | 71 | $params = array( |
92915c55 | 72 | 'sequential' => 1, |
6a488035 TO |
73 | 'name' => 'API_Test_PP', |
74 | 'title' => 'API Test Payment Processor', | |
75 | 'class_name' => 'CRM_Core_Payment_APITest', | |
76 | 'billing_mode' => 'form', | |
77 | 'is_recur' => 0, | |
78 | ); | |
fa7b9efb | 79 | $result = $this->callAPIAndDocument('payment_processor_type', 'create', $params, __FUNCTION__, __FILE__); |
ba4a1892 | 80 | $this->assertNotNull($result['values'][0]['id']); |
6a488035 TO |
81 | |
82 | // mutate $params to match expected return value | |
6a488035 TO |
83 | unset($params['sequential']); |
84 | $params['billing_mode'] = CRM_Core_Payment::BILLING_MODE_FORM; | |
85 | //assertDBState compares expected values in $result to actual values in the DB | |
86 | $this->assertDBState('CRM_Financial_DAO_PaymentProcessorType', $result['id'], $params); | |
87 | } | |
88 | ||
89 | /** | |
eceb18cc | 90 | * Test using example code. |
6a488035 | 91 | */ |
00be9182 | 92 | public function testPaymentProcessorTypeCreateExample() { |
3ec6e38d | 93 | require_once 'api/v3/examples/PaymentProcessorType/Create.php'; |
6a488035 TO |
94 | $result = payment_processor_type_create_example(); |
95 | $expectedResult = payment_processor_type_create_expectedresult(); | |
48ab68c7 | 96 | $this->assertAPISuccess($result); |
6a488035 TO |
97 | } |
98 | ||
99 | ///////////////// civicrm_payment_processor_type_delete methods | |
100 | ||
101 | /** | |
eceb18cc | 102 | * Check with empty array. |
6a488035 | 103 | */ |
00be9182 | 104 | public function testPaymentProcessorTypeDeleteEmpty() { |
6a488035 | 105 | $params = array(); |
d0e1eff2 | 106 | $result = $this->callAPIFailure('payment_processor_type', 'delete', $params); |
6a488035 TO |
107 | } |
108 | ||
109 | /** | |
eceb18cc | 110 | * Check with No array. |
6a488035 | 111 | */ |
00be9182 | 112 | public function testPaymentProcessorTypeDeleteParamsNotArray() { |
d0e1eff2 | 113 | $result = $this->callAPIFailure('payment_processor_type', 'delete', 'string'); |
6a488035 TO |
114 | } |
115 | ||
116 | /** | |
eceb18cc | 117 | * Check if required fields are not passed. |
6a488035 | 118 | */ |
00be9182 | 119 | public function testPaymentProcessorTypeDeleteWithoutRequired() { |
6a488035 TO |
120 | $params = array( |
121 | 'name' => 'API_Test_PP', | |
122 | 'title' => 'API Test Payment Processor', | |
123 | 'class_name' => 'CRM_Core_Payment_APITest', | |
124 | ); | |
125 | ||
d0e1eff2 CW |
126 | $result = $this->callAPIFailure('payment_processor_type', 'delete', $params); |
127 | $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: id'); | |
6a488035 TO |
128 | } |
129 | ||
130 | /** | |
eceb18cc | 131 | * Check with incorrect required fields. |
6a488035 | 132 | */ |
00be9182 | 133 | public function testPaymentProcessorTypeDeleteWithIncorrectData() { |
fa7b9efb | 134 | $result = $this->callAPIFailure('payment_processor_type', 'delete', array('id' => 'abcd')); |
6a488035 TO |
135 | } |
136 | ||
137 | /** | |
eceb18cc | 138 | * Check payment processor type delete. |
6a488035 | 139 | */ |
00be9182 | 140 | public function testPaymentProcessorTypeDelete() { |
6a488035 | 141 | $payProcType = $this->paymentProcessorTypeCreate(); |
6a488035 TO |
142 | $params = array( |
143 | 'id' => $payProcType, | |
6a488035 TO |
144 | ); |
145 | ||
fa7b9efb | 146 | $result = $this->callAPIAndDocument('payment_processor_type', 'delete', $params, __FUNCTION__, __FILE__); |
6a488035 TO |
147 | } |
148 | ||
149 | ///////////////// civicrm_payment_processor_type_update | |
150 | ||
151 | /** | |
eceb18cc | 152 | * Check with empty array. |
6a488035 | 153 | */ |
00be9182 | 154 | public function testPaymentProcessorTypeUpdateEmpty() { |
6a488035 | 155 | $params = array(); |
d0e1eff2 CW |
156 | $result = $this->callAPIFailure('payment_processor_type', 'create', $params); |
157 | $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: name, title, class_name, billing_mode'); | |
6a488035 TO |
158 | } |
159 | ||
160 | /** | |
eceb18cc | 161 | * Check with No array. |
6a488035 | 162 | */ |
00be9182 | 163 | public function testPaymentProcessorTypeUpdateParamsNotArray() { |
d0e1eff2 | 164 | $result = $this->callAPIFailure('payment_processor_type', 'create', 'string'); |
6a488035 TO |
165 | $this->assertEquals($result['error_message'], 'Input variable `params` is not an array'); |
166 | } | |
167 | ||
168 | /** | |
eceb18cc | 169 | * Check with all parameters. |
6a488035 | 170 | */ |
00be9182 | 171 | public function testPaymentProcessorTypeUpdate() { |
6a488035 TO |
172 | // create sample payment processor type. |
173 | $this->_ppTypeID = $this->paymentProcessorTypeCreate(NULL); | |
174 | ||
175 | $params = array( | |
176 | 'id' => $this->_ppTypeID, | |
177 | 'name' => 'API_Test_PP', // keep the same | |
178 | 'title' => 'API Test Payment Processor 2', | |
179 | 'class_name' => 'CRM_Core_Payment_APITest 2', | |
180 | 'billing_mode' => 2, | |
92915c55 TO |
181 | 'is_recur' => 0, |
182 | ); | |
6a488035 | 183 | |
fa7b9efb | 184 | $result = $this->callAPISuccess('payment_processor_type', 'create', $params); |
6a488035 | 185 | $this->assertNotNull($result['id']); |
6a488035 TO |
186 | // assertDBState compares expected values in $result to actual values in the DB |
187 | $this->assertDBState('CRM_Financial_DAO_PaymentProcessorType', $this->_ppTypeID, $params); | |
188 | } | |
189 | ||
190 | ///////////////// civicrm_payment_processor_types_get methods | |
191 | ||
192 | /** | |
eceb18cc | 193 | * Check with empty array. |
6a488035 | 194 | */ |
00be9182 | 195 | public function testPaymentProcessorTypesGetEmptyParams() { |
6c6e6187 | 196 | $results = $this->callAPISuccess('payment_processor_type', 'get', array()); |
6a488035 TO |
197 | $baselineCount = $results['count']; |
198 | ||
199 | $firstRelTypeParams = array( | |
200 | 'name' => 'API_Test_PP', | |
201 | 'title' => 'API Test Payment Processor', | |
202 | 'class_name' => 'CRM_Core_Payment_APITest', | |
203 | 'billing_mode' => 1, | |
92915c55 TO |
204 | 'is_recur' => 0, |
205 | ); | |
6a488035 | 206 | |
fa7b9efb | 207 | $first = $this->callAPISuccess('PaymentProcessorType', 'Create', $firstRelTypeParams); |
6a488035 TO |
208 | |
209 | $secondRelTypeParams = array( | |
210 | 'name' => 'API_Test_PP2', | |
211 | 'title' => 'API Test Payment Processor 2', | |
212 | 'class_name' => 'CRM_Core_Payment_APITest 2', | |
213 | 'billing_mode' => 2, | |
92915c55 TO |
214 | 'is_recur' => 0, |
215 | ); | |
fa7b9efb | 216 | $second = $this->callAPISuccess('PaymentProcessorType', 'Create', $secondRelTypeParams); |
6c6e6187 | 217 | $result = $this->callAPISuccess('payment_processor_type', 'get', array()); |
6a488035 | 218 | |
48ab68c7 | 219 | $this->assertEquals($baselineCount + 2, $result['count']); |
220 | $this->assertAPISuccess($result); | |
6a488035 TO |
221 | } |
222 | ||
223 | /** | |
100fef9d | 224 | * Check with valid params array. |
6a488035 | 225 | */ |
00be9182 | 226 | public function testPaymentProcessorTypesGet() { |
6a488035 TO |
227 | $firstRelTypeParams = array( |
228 | 'name' => 'API_Test_PP_11', | |
229 | 'title' => 'API Test Payment Processor 11', | |
230 | 'class_name' => 'CRM_Core_Payment_APITest_11', | |
231 | 'billing_mode' => 1, | |
92915c55 TO |
232 | 'is_recur' => 0, |
233 | ); | |
6a488035 | 234 | |
fa7b9efb | 235 | $first = $this->callAPISuccess('PaymentProcessorType', 'Create', $firstRelTypeParams); |
6a488035 TO |
236 | |
237 | $secondRelTypeParams = array( | |
238 | 'name' => 'API_Test_PP_12', | |
239 | 'title' => 'API Test Payment Processor 12', | |
240 | 'class_name' => 'CRM_Core_Payment_APITest_12', | |
241 | 'billing_mode' => 2, | |
92915c55 TO |
242 | 'is_recur' => 0, |
243 | ); | |
fa7b9efb | 244 | $second = $this->callAPISuccess('PaymentProcessorType', 'Create', $secondRelTypeParams); |
6a488035 TO |
245 | |
246 | $params = array( | |
92915c55 TO |
247 | 'name' => 'API_Test_PP_12', |
248 | ); | |
fa7b9efb | 249 | $result = $this->callAPISuccess('payment_processor_type', 'get', $params); |
6a488035 | 250 | |
48ab68c7 | 251 | $this->assertAPISuccess($result); |
252 | $this->assertEquals(1, $result['count'], ' in line ' . __LINE__); | |
253 | $this->assertEquals('CRM_Core_Payment_APITest_12', $result['values'][$result['id']]['class_name'], ' in line ' . __LINE__); | |
6a488035 | 254 | } |
96025800 | 255 | |
6a488035 | 256 | } |