Merge pull request #14315 from eileenmcnaughton/dbunit_xml

[civicrm-core.git] / tests / phpunit / api / v3 / UFJoinTest.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 5                                                  |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2019                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
 */

/**
 * Test class for UFGroup API - civicrm_uf_*
 * @todo Split UFGroup and UFJoin tests
 *
 * @package   CiviCRM
 * @group headless
 */
class api_v3_UFJoinTest extends CiviUnitTestCase {
  /**
   * ids from the uf_group_test.xml fixture
   * @var int
   */
  protected $_ufGroupId = 11;
  protected $_ufFieldId;
  protected $_contactId = 69;
  protected $_apiversion;

  protected function setUp() {
    parent::setUp();
    //  Truncate the tables
    $this->quickCleanup(
      array(
        'civicrm_group',
        'civicrm_contact',
        'civicrm_uf_group',
        'civicrm_uf_join',
        'civicrm_uf_match',
      )
    );
    $this->_apiversion = 3;
    $op = new PHPUnit_Extensions_Database_Operation_Insert();
    $op->execute(
      $this->_dbconn,
      $this->createFlatXMLDataSet(dirname(__FILE__) . '/dataset/uf_group_test.xml')
    );
  }

  public function tearDown() {
    //  Truncate the tables
    $this->quickCleanup(
      array(
        'civicrm_group',
        'civicrm_contact',
        'civicrm_uf_group',
        'civicrm_uf_join',
        'civicrm_uf_match',
      )
    );
  }

  /**
   * Find uf join group id.
   */
  public function testFindUFGroupId() {
    $params = array(
      'module' => 'CiviContribute',
      'entity_table' => 'civicrm_contribution_page',
      'entity_id' => 1,
      'weight' => 1,
      'uf_group_id' => $this->_ufGroupId,
      'is_active' => 1,
    );
    $ufJoin = $this->callAPISuccess('uf_join', 'create', $params);

    $searchParams = array(
      'entity_table' => 'civicrm_contribution_page',
      'entity_id' => 1,
    );
    $result = $this->callAPISuccess('uf_join', 'get', $searchParams);

    foreach ($result['values'] as $key => $value) {
      $this->assertEquals($value['uf_group_id'], $this->_ufGroupId);
    }
  }

  public function testUFJoinEditWrongParamsType() {
    $params = 'a string';
    $result = $this->callAPIFailure('uf_join', 'create', $params);
    $this->assertEquals($result['error_message'], 'Input variable `params` is not an array');
  }

  public function testUFJoinEditEmptyParams() {
    $params = array();
    $result = $this->callAPIFailure('uf_join', 'create', $params);
    $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: module, weight, uf_group_id');
  }

  public function testUFJoinEditWithoutUFGroupId() {
    $params = array(
      'module' => 'CiviContribute',
      'entity_table' => 'civicrm_contribution_page',
      'entity_id' => 1,
      'weight' => 1,
      'is_active' => 1,
    );
    $result = $this->callAPIFailure('uf_join', 'create', $params);
    $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: uf_group_id');
  }

  /**
   * Create/update uf join
   */
  public function testCreateUFJoin() {
    $params = array(
      'module' => 'CiviContribute',
      'entity_table' => 'civicrm_contribution_page',
      'entity_id' => 1,
      'weight' => 1,
      'uf_group_id' => $this->_ufGroupId,
      'is_active' => 1,
      'sequential' => 1,
    );
    $ufJoin = $this->callAPIAndDocument('uf_join', 'create', $params, __FUNCTION__, __FILE__);
    $this->assertEquals($ufJoin['values'][0]['module'], $params['module']);
    $this->assertEquals($ufJoin['values'][0]['uf_group_id'], $params['uf_group_id']);
    $this->assertEquals($ufJoin['values'][0]['is_active'], $params['is_active']);

    $params = array(
      'id' => $ufJoin['id'],
      'module' => 'CiviContribute',
      'entity_table' => 'civicrm_contribution_page',
      'entity_id' => 1,
      'weight' => 1,
      'uf_group_id' => $this->_ufGroupId,
      'is_active' => 0,
      'sequential' => 1,
    );
    $ufJoinUpdated = $this->callAPISuccess('uf_join', 'create', $params);
    $this->assertEquals($ufJoinUpdated['values'][0]['module'], $params['module']);
    $this->assertEquals($ufJoinUpdated['values'][0]['uf_group_id'], $params['uf_group_id']);
    $this->assertEquals($ufJoinUpdated['values'][0]['is_active'], $params['is_active']);
  }

  /**
   * Ensure we can create a survey join which is less common than event or contribution
   * joins.
   */
  public function testCreateSurveyUFJoin() {
    $params = array(
      'module' => 'CiviCampaign',
      'entity_table' => 'civicrm_survey',
      'entity_id' => 1,
      'weight' => 1,
      'uf_group_id' => $this->_ufGroupId,
      'is_active' => 1,
      'sequential' => 1,
    );
    $ufJoin = $this->callAPIAndDocument('uf_join', 'create', $params, __FUNCTION__, __FILE__);
    $this->assertEquals($ufJoin['values'][0]['module'], $params['module']);
    $this->assertEquals($ufJoin['values'][0]['uf_group_id'], $params['uf_group_id']);
    $this->assertEquals($ufJoin['values'][0]['is_active'], $params['is_active']);
  }

  public function testFindUFJoinWrongParamsType() {
    $params = 'a string';
    $result = $this->callAPIFailure('uf_join', 'create', $params);
    $this->assertEquals($result['error_message'], 'Input variable `params` is not an array');
  }

  public function testFindUFJoinEmptyParams() {
    $result = $this->callAPIFailure('uf_join', 'create', array());
    $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: module, weight, uf_group_id');
  }

  public function testFindUFJoinWithoutUFGroupId() {
    $params = array(
      'module' => 'CiviContribute',
      'entity_table' => 'civicrm_contribution_page',
      'entity_id' => 1,
      'weight' => 1,
      'is_active' => 1,
    );
    $result = $this->callAPIFailure('uf_join', 'create', $params);
    $this->assertEquals($result['error_message'], 'Mandatory key(s) missing from params array: uf_group_id');
  }

  /**
   * Find uf join id.
   */
  public function testGetUFJoinId() {
    $params = array(
      'module' => 'CiviContribute',
      'entity_table' => 'civicrm_contribution_page',
      'entity_id' => 1,
      'weight' => 1,
      'uf_group_id' => $this->_ufGroupId,
      'is_active' => 1,
    );

    $ufJoin = $this->callAPISuccess('uf_join', 'create', $params);
    $searchParams = array(
      'entity_table' => 'civicrm_contribution_page',
      'entity_id' => 1,
      'sequential' => 1,
    );

    $result = $this->callAPIAndDocument('uf_join', 'get', $searchParams, __FUNCTION__, __FILE__);
    $this->assertEquals($result['values'][0]['module'], $params['module']);
    $this->assertEquals($result['values'][0]['uf_group_id'], $params['uf_group_id']);
    $this->assertEquals($result['values'][0]['entity_id'], $params['entity_id']);
  }

  /**
   * Test civicrm_activity_create() using example code.
   */
  public function testUFJoinCreateExample() {
    require_once 'api/v3/examples/UFJoin/Create.php';
    $result = UF_join_create_example();
    $expectedResult = UF_join_create_expectedresult();
    $this->assertEquals($result, $expectedResult);
  }

}