tests/phpunit/api/v3/PaymentProcessorTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 /**
  29  * Class contains api test cases for "civicrm_payment_processor"
  30  *
  31  * @group headless
  32  */
  33 class api_v3_PaymentProcessorTest extends CiviUnitTestCase {
  34   protected $_paymentProcessorType;
  35   protected $_apiversion = 3;
  36   protected $_params;
  37
  38   public function setUp() {
  39     parent::setUp();
  40     $this->useTransaction(TRUE);
  41     // Create dummy processor
  42     $params = [
  43       'name' => 'API_Test_PP_Type',
  44       'title' => 'API Test Payment Processor Type',
  45       'class_name' => 'CRM_Core_Payment_APITest',
  46       'billing_mode' => 'form',
  47       'is_recur' => 0,
  48     ];
  49     $result = $this->callAPISuccess('payment_processor_type', 'create', $params);
  50     $this->_paymentProcessorType = $result['id'];
  51     $this->_params = [
  52       'name' => 'API Test PP',
  53       'payment_processor_type_id' => $this->_paymentProcessorType,
  54       'class_name' => 'CRM_Core_Payment_APITest',
  55       'is_recur' => 0,
  56       'domain_id' => 1,
  57     ];
  58   }
  59
  60   /**
  61    * Check with no name.
  62    */
  63   public function testPaymentProcessorCreateWithoutName() {
  64     $payProcParams = [
  65       'is_active' => 1,
  66     ];
  67     $this->callAPIFailure('payment_processor', 'create', $payProcParams);
  68   }
  69
  70   /**
  71    * Create payment processor.
  72    */
  73   public function testPaymentProcessorCreate() {
  74     $params = $this->_params;
  75     $result = $this->callAPIAndDocument('payment_processor', 'create', $params, __FUNCTION__, __FILE__);
  76     $this->callAPISuccessGetSingle('EntityFinancialAccount', ['entity_table' => 'civicrm_payment_processor', 'entity_id' => $result['id']]);
  77
  78     // Test that the option values are flushed so ths can be used straight away.
  79     $this->callAPISuccess('ContributionRecur', 'create', [
  80       'contact_id' => $this->individualCreate(),
  81       'amount' => 5,
  82       'financial_type_id' => 'Donation',
  83       'payment_processor_id' => 'API Test PP',
  84       'frequency_interval' => 1,
  85     ]);
  86     $this->getAndCheck($params, $result['id'], 'PaymentProcessor');
  87   }
  88
  89   /**
  90    * Update payment processor.
  91    */
  92   public function testPaymentProcessorUpdate() {
  93     $params = $this->_params;
  94     $result = $this->callAPISuccess('payment_processor', 'create', $params);
  95     $this->assertNotNull($result['id']);
  96
  97     $updateParams = [
  98       'id' => $result['id'],
  99       'name' => 'Update API Test',
 100     ];
 101     $this->assertDBState('CRM_Financial_DAO_PaymentProcessor', $result['id'], $params);
 102     $this->callAPISuccess('payment_processor', 'create', $updateParams);
 103     $result = $this->callAPISuccess('payment_processor', 'get', ['id' => $result['id']]);
 104
 105     $expectedResult = [
 106       'id' => $result['id'],
 107       'domain_id' => $params['domain_id'],
 108       'name' => $updateParams['name'],
 109       'payment_processor_type_id' => $params['payment_processor_type_id'],
 110       'is_default' => 0,
 111       'is_test' => 0,
 112       'class_name' => $params['class_name'],
 113       'billing_mode' => 1,
 114       'is_recur' => $params['is_recur'],
 115       'payment_type' => 1,
 116       'payment_instrument_id' => 1,
 117       'is_active' => 1,
 118     ];
 119     $this->checkArrayEquals($expectedResult, $result['values'][$result['id']]);
 120   }
 121
 122   /**
 123    * Test  using example code.
 124    */
 125   public function testPaymentProcessorCreateExample() {
 126     require_once 'api/v3/examples/PaymentProcessor/Create.php';
 127     $result = payment_processor_create_example();
 128     $expectedResult = payment_processor_create_expectedresult();
 129     $this->assertAPISuccess($result);
 130   }
 131
 132   /**
 133    * Check payment processor delete.
 134    */
 135   public function testPaymentProcessorDelete() {
 136     $result = $this->callAPISuccess('payment_processor', 'create', $this->_params);
 137     $params = [
 138       'id' => $result['id'],
 139     ];
 140
 141     $this->callAPIAndDocument('payment_processor', 'delete', $params, __FUNCTION__, __FILE__);
 142   }
 143
 144   /**
 145    * Check with valid params array.
 146    */
 147   public function testPaymentProcessorsGet() {
 148     $params = $this->_params;
 149     $params['user_name'] = 'test@test.com';
 150     $this->callAPISuccess('payment_processor', 'create', $params);
 151
 152     $params = [
 153       'user_name' => 'test@test.com',
 154     ];
 155     $results = $this->callAPISuccess('payment_processor', 'get', $params);
 156
 157     $this->assertEquals(1, $results['count']);
 158     $this->assertEquals('test@test.com', $results['values'][$results['id']]['user_name']);
 159   }
 160
 161 }