3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
28 require_once 'CiviTest/CiviUnitTestCase.php';
31 * Class contains api test cases for "civicrm_payment_processor_type"
34 class api_v3_PaymentProcessorTypeTest
extends CiviUnitTestCase
{
36 protected $_apiversion;
38 public function setUp() {
41 $this->useTransaction(TRUE);
42 $this->_apiversion
= 3;
45 // function tearDown() {
47 // $tablesToTruncate = array(
48 // 'civicrm_payment_processor_type',
50 // $this->quickCleanup($tablesToTruncate);
53 ///////////////// civicrm_payment_processor_type_add methods
58 public function testPaymentProcessorTypeCreateWithoutName() {
59 $payProcParams = array(
61 $result = $this->callAPIFailure('payment_processor_type', 'create', $payProcParams);
62 $this->assertEquals($result['error_message'],
63 'Mandatory key(s) missing from params array: name, title, class_name, billing_mode'
68 * Create payment processor type
70 public function testPaymentProcessorTypeCreate() {
73 'name' => 'API_Test_PP',
74 'title' => 'API Test Payment Processor',
75 'class_name' => 'CRM_Core_Payment_APITest',
76 'billing_mode' => 'form',
79 $result = $this->callAPIAndDocument('payment_processor_type', 'create', $params, __FUNCTION__
, __FILE__
);
80 $this->assertNotNull($result['values'][0]['id'], 'in line ' . __LINE__
);
82 // mutate $params to match expected return value
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);
90 * Test using example code
92 public function testPaymentProcessorTypeCreateExample() {
93 require_once 'api/v3/examples/PaymentProcessorType/Create.php';
94 $result = payment_processor_type_create_example();
95 $expectedResult = payment_processor_type_create_expectedresult();
96 $this->assertAPISuccess($result);
99 ///////////////// civicrm_payment_processor_type_delete methods
102 * Check with empty array
104 public function testPaymentProcessorTypeDeleteEmpty() {
106 $result = $this->callAPIFailure('payment_processor_type', 'delete', $params);
110 * Check with No array
112 public function testPaymentProcessorTypeDeleteParamsNotArray() {
113 $result = $this->callAPIFailure('payment_processor_type', 'delete', 'string');
117 * Check if required fields are not passed
119 public function testPaymentProcessorTypeDeleteWithoutRequired() {
121 'name' => 'API_Test_PP',
122 'title' => 'API Test Payment Processor',
123 'class_name' => 'CRM_Core_Payment_APITest',
126 $result = $this->callAPIFailure('payment_processor_type', 'delete', $params);
127 $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: id');
131 * Check with incorrect required fields
133 public function testPaymentProcessorTypeDeleteWithIncorrectData() {
134 $result = $this->callAPIFailure('payment_processor_type', 'delete', array('id' => 'abcd'));
138 * Check payment processor type delete
140 public function testPaymentProcessorTypeDelete() {
141 $payProcType = $this->paymentProcessorTypeCreate();
143 'id' => $payProcType,
146 $result = $this->callAPIAndDocument('payment_processor_type', 'delete', $params, __FUNCTION__
, __FILE__
);
149 ///////////////// civicrm_payment_processor_type_update
152 * Check with empty array
154 public function testPaymentProcessorTypeUpdateEmpty() {
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');
161 * Check with No array
163 public function testPaymentProcessorTypeUpdateParamsNotArray() {
164 $result = $this->callAPIFailure('payment_processor_type', 'create', 'string');
165 $this->assertEquals($result['error_message'], 'Input variable `params` is not an array');
169 * Check with all parameters
171 public function testPaymentProcessorTypeUpdate() {
172 // create sample payment processor type.
173 $this->_ppTypeID
= $this->paymentProcessorTypeCreate(NULL);
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',
183 $result = $this->callAPISuccess('payment_processor_type', 'create', $params);
184 $this->assertNotNull($result['id']);
185 // assertDBState compares expected values in $result to actual values in the DB
186 $this->assertDBState('CRM_Financial_DAO_PaymentProcessorType', $this->_ppTypeID
, $params);
189 ///////////////// civicrm_payment_processor_types_get methods
192 * Check with empty array
194 public function testPaymentProcessorTypesGetEmptyParams() {
195 $results = $this->callAPISuccess('payment_processor_type', 'get', array());
196 $baselineCount = $results['count'];
198 $firstRelTypeParams = array(
199 'name' => 'API_Test_PP',
200 'title' => 'API Test Payment Processor',
201 'class_name' => 'CRM_Core_Payment_APITest',
205 $first = $this->callAPISuccess('PaymentProcessorType', 'Create', $firstRelTypeParams);
207 $secondRelTypeParams = array(
208 'name' => 'API_Test_PP2',
209 'title' => 'API Test Payment Processor 2',
210 'class_name' => 'CRM_Core_Payment_APITest 2',
213 $second = $this->callAPISuccess('PaymentProcessorType', 'Create', $secondRelTypeParams);
214 $result = $this->callAPISuccess('payment_processor_type', 'get', array());
216 $this->assertEquals($baselineCount +
2, $result['count']);
217 $this->assertAPISuccess($result);
221 * Check with valid params array.
223 public function testPaymentProcessorTypesGet() {
224 $firstRelTypeParams = array(
225 'name' => 'API_Test_PP_11',
226 'title' => 'API Test Payment Processor 11',
227 'class_name' => 'CRM_Core_Payment_APITest_11',
231 $first = $this->callAPISuccess('PaymentProcessorType', 'Create', $firstRelTypeParams);
233 $secondRelTypeParams = array(
234 'name' => 'API_Test_PP_12',
235 'title' => 'API Test Payment Processor 12',
236 'class_name' => 'CRM_Core_Payment_APITest_12',
239 $second = $this->callAPISuccess('PaymentProcessorType', 'Create', $secondRelTypeParams);
242 'name' => 'API_Test_PP_12',);
243 $result = $this->callAPISuccess('payment_processor_type', 'get', $params);
245 $this->assertAPISuccess($result);
246 $this->assertEquals(1, $result['count'], ' in line ' . __LINE__
);
247 $this->assertEquals('CRM_Core_Payment_APITest_12', $result['values'][$result['id']]['class_name'], ' in line ' . __LINE__
);