Merge pull request #11642 from JKingsnorth/CRM-21739

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

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.7                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2018                                |
 +--------------------------------------------------------------------+
 | 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 APIv3 civicrm_activity_* functions
 *
 * @package CiviCRM_APIv3
 * @subpackage API_Contact
 */

/**
 * Class api_v3_AddressTest
 * @group headless
 */
class api_v3_AddressTest extends CiviUnitTestCase {
  protected $_apiversion = 3;
  protected $_contactID;
  protected $_locationType;
  protected $_params;

  protected $_entity;

  public function setUp() {
    $this->_entity = 'Address';
    parent::setUp();

    $this->_contactID = $this->organizationCreate();
    $this->_locationType = $this->locationTypeCreate();
    CRM_Core_PseudoConstant::flush();

    $this->_params = array(
      'contact_id' => $this->_contactID,
      'location_type_id' => $this->_locationType->id,
      'street_name' => 'Ambachtstraat',
      'street_number' => '23',
      'street_address' => 'Ambachtstraat 23',
      'postal_code' => '6971 BN',
      'country_id' => '1152',
      'city' => 'Brummen',
      'is_primary' => 1,
    );
  }

  public function tearDown() {
    $this->locationTypeDelete($this->_locationType->id);
    $this->contactDelete($this->_contactID);
    $this->quickCleanup(array('civicrm_address', 'civicrm_relationship'));
  }

  public function testCreateAddress() {
    $result = $this->callAPIAndDocument('address', 'create', $this->_params, __FUNCTION__, __FILE__);
    $this->assertEquals(1, $result['count']);
    $this->assertNotNull($result['values'][$result['id']]['id']);
    $this->getAndCheck($this->_params, $result['id'], 'address');
  }

  public function testCreateAddressParsing() {
    $params = array(
      'street_parsing' => 1,
      'street_address' => '54A Excelsior Ave. Apt 1C',
      'location_type_id' => $this->_locationType->id,
      'contact_id' => $this->_contactID,
    );
    $subfile = "AddressParse";
    $description = "Demonstrates Use of address parsing param.";
    $result = $this->callAPIAndDocument('address', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
    $this->assertEquals(54, $result['values'][$result['id']]['street_number']);
    $this->assertEquals('A', $result['values'][$result['id']]['street_number_suffix']);
    $this->assertEquals('Excelsior Ave.', $result['values'][$result['id']]['street_name']);
    $this->assertEquals('Apt 1C', $result['values'][$result['id']]['street_unit']);
    $this->callAPISuccess('address', 'delete', array('id' => $result['id']));

  }

  /**
   * Is_primary should be set as a default.
   */
  public function testCreateAddressTestDefaults() {
    $params = $this->_params;
    unset($params['is_primary']);
    $result = $this->callAPISuccess('address', 'create', $params);
    $this->assertEquals(1, $result['count']);
    $this->assertEquals(1, $result['values'][$result['id']]['is_primary']);
    $this->getAndCheck($this->_params, $result['id'], 'address');
  }

  public function testCreateAddressTooLongSuffix() {
    $params = $this->_params;
    $params['street_number_suffix'] = 'really long string';
    $this->callAPIFailure('address', 'create', $params);
  }

  /**
   * Create an address with a master ID and ensure that a relationship is created.
   */
  public function testCreateAddressWithMasterRelationshipHousehold() {
    $householdID = $this->householdCreate();
    $address = $this->callAPISuccess('address', 'create', array_merge($this->_params, $this->_params, array('contact_id' => $householdID)));
    $individualID = $this->individualCreate();
    $individualParams = array(
      'contact_id' => $individualID,
      'master_id' => $address['id'],
    );
    $this->callAPISuccess('address', 'create', array_merge($this->_params, $individualParams));
    $this->callAPISuccess('relationship', 'getcount', array(
      'contact_id_a' => $individualID,
      'contact_id_b' => $this->_contactID,
    ));
  }

  /**
   * Create an address with a master ID and ensure that a relationship is created.
   */
  public function testCreateAddressWithMasterRelationshipOrganization() {
    $address = $this->callAPISuccess('address', 'create', $this->_params);
    $individualID = $this->individualCreate();
    $individualParams = array(
      'contact_id' => $individualID,
      'master_id' => $address['id'],
    );
    $this->callAPISuccess('address', 'create', array_merge($this->_params, $individualParams));
    $this->callAPISuccess('relationship', 'getcount', array(
      'contact_id_a' => $individualID,
      'contact_id_b' => $this->_contactID,
    ));
  }

  /**
   * Create an address with a master ID and ensure that a relationship is created.
   */
  public function testCreateAddressWithMasterRelationshipChangingOrganization() {
    $address = $this->callAPISuccess('address', 'create', $this->_params);
    $organisation2ID = $this->organizationCreate();
    $address2 = $this->callAPISuccess('address', 'create', array_merge($this->_params, array('contact_id' => $organisation2ID)));
    $individualID = $this->individualCreate();
    $individualParams = array_merge($this->_params, array(
      'contact_id' => $individualID,
      'master_id' => $address['id'],
    ));
    $individualAddress = $this->callAPISuccess('address', 'create', $individualParams);
    $individualParams['master_id'] = $address2['id'];
    $individualParams['id'] = $individualAddress['id'];
    $this->callAPISuccess('address', 'create', $individualParams);
    $this->callAPISuccessGetCount('relationship', array('contact_id_a' => $individualID), 2);
    $this->markTestIncomplete('Remainder of test checks that employer relationship is disabled when new one is created but turns out to be not happening - by design?');
    $this->callAPISuccessGetCount('relationship', array('contact_id_a' => $individualID, 'is_active' => FALSE), 1);
    $this->callAPISuccessGetCount('relationship', array(
      'contact_id_a' => $individualID,
      'is_active' => TRUE,
      'contact_id_b' => $organisation2ID,
    ), 1);

  }

  /**
   * Is_primary should be set as a default.
   *
   * ie. create the address, unset the params & recreate.
   * is_primary should be 0 before & after the update. ie - having no other address
   * is_primary is invalid.
   */
  public function testCreateAddressTestDefaultWithID() {
    $params = $this->_params;
    $params['is_primary'] = 0;
    $result = $this->callAPISuccess('address', 'create', $params);
    unset($params['is_primary']);
    $params['id'] = $result['id'];
    $result = $this->callAPISuccess('address', 'create', $params);
    $this->callAPISuccess('address', 'get', array('contact_id' => $params['contact_id']));
    $this->assertEquals(1, $result['count']);
    $this->assertEquals(1, $result['values'][$result['id']]['is_primary']);
    $this->getAndCheck($params, $result['id'], 'address', __FUNCTION__);
  }

  /**
   * test address deletion.
   */
  public function testDeleteAddress() {
    //check there are no address to start with
    $get = $this->callAPISuccess('address', 'get', array(
      'location_type_id' => $this->_locationType->id,
    ));
    $this->assertEquals(0, $get['count'], 'Contact already exists ');

    //create one
    $create = $this->callAPISuccess('address', 'create', $this->_params);

    $result = $this->callAPIAndDocument('address', 'delete', array('id' => $create['id']), __FUNCTION__, __FILE__);
    $this->assertEquals(1, $result['count']);
    $get = $this->callAPISuccess('address', 'get', array(
      'location_type_id' => $this->_locationType->id,
    ));
    $this->assertEquals(0, $get['count'], 'Contact not successfully deleted In line ' . __LINE__);
  }

  /**
   * Test civicrm_address_get - success expected.
   */
  public function testGetAddress() {
    $address = $this->callAPISuccess('address', 'create', $this->_params);

    $params = array(
      'contact_id' => $this->_contactID,
      'street_name' => $address['values'][$address['id']]['street_name'],
    );
    $result = $this->callAPIAndDocument('Address', 'Get', $params, __FUNCTION__, __FILE__);
    $this->callAPISuccess('Address', 'delete', array('id' => $result['id']));
    $this->assertEquals($address['values'][$address['id']]['location_type_id'], $result['values'][$address['id']]['location_type_id']);
    $this->assertEquals($address['values'][$address['id']]['is_primary'], $result['values'][$address['id']]['is_primary']);
    $this->assertEquals($address['values'][$address['id']]['street_address'], $result['values'][$address['id']]['street_address']);
  }

  /**
   * Test civicrm_address_get - success expected.
   */
  public function testGetSingleAddress() {
    $this->callAPISuccess('address', 'create', $this->_params);
    $params = array(
      'contact_id' => $this->_contactID,
    );
    $address = $this->callAPISuccess('Address', 'getsingle', ($params));
    $this->assertEquals($address['location_type_id'], $this->_params['location_type_id']);
    $this->callAPISuccess('address', 'delete', array('id' => $address['id']));
  }

  /**
   * Test civicrm_address_get with sort option- success expected.
   */
  public function testGetAddressSort() {
    $create = $this->callAPISuccess('address', 'create', $this->_params);
    $this->callAPISuccess('address', 'create', array_merge($this->_params, array('street_address' => 'yzy')));
    $subfile = "AddressSort";
    $description = "Demonstrates Use of sort filter.";
    $params = array(
      'options' => array(
        'sort' => 'street_address DESC',
        'limit' => 2,
      ),
      'sequential' => 1,
    );
    $result = $this->callAPIAndDocument('Address', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
    $this->assertEquals(2, $result['count']);
    $this->assertEquals('Ambachtstraat 23', $result['values'][1]['street_address']);
    $this->callAPISuccess('address', 'delete', array('id' => $create['id']));
  }

  /**
   * Test civicrm_address_get with sort option- success expected.
   */
  public function testGetAddressLikeSuccess() {
    $this->callAPISuccess('address', 'create', $this->_params);
    $subfile = "AddressLike";
    $description = "Demonstrates Use of Like.";
    $params = array(
      'street_address' => array('LIKE' => '%mb%'),
      'sequential' => 1,
    );
    $result = $this->callAPIAndDocument('Address', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
    $this->assertEquals(1, $result['count']);
    $this->assertEquals('Ambachtstraat 23', $result['values'][0]['street_address']);
    $this->callAPISuccess('address', 'delete', array('id' => $result['id']));
  }

  /**
   * Test civicrm_address_get with sort option- success expected.
   */
  public function testGetAddressLikeFail() {
    $create = $this->callAPISuccess('address', 'create', $this->_params);
    $params = array(
      'street_address' => array('LIKE' => "'%xy%'"),
      'sequential' => 1,
    );
    $result = $this->callAPISuccess('Address', 'Get', ($params));
    $this->assertEquals(0, $result['count']);
    $this->callAPISuccess('address', 'delete', array('id' => $create['id']));
  }

  /**
   */
  public function testGetWithCustom() {
    $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);

    $params = $this->_params;
    $params['custom_' . $ids['custom_field_id']] = "custom string";

    $result = $this->callAPISuccess($this->_entity, 'create', $params);

    $getParams = array('id' => $result['id'], 'return' => array('custom'));
    $check = $this->callAPISuccess($this->_entity, 'get', $getParams);

    $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__);

    $this->customFieldDelete($ids['custom_field_id']);
    $this->customGroupDelete($ids['custom_group_id']);
    $this->callAPISuccess('address', 'delete', array('id' => $result['id']));
  }

  /**
   */
  public function testCreateAddressPrimaryHandlingChangeToPrimary() {
    $params = $this->_params;
    unset($params['is_primary']);
    $address1 = $this->callAPISuccess('address', 'create', $params);
    $this->assertApiSuccess($address1);
    //now we check & make sure it has been set to primary
    $check = $this->callAPISuccess('address', 'getcount', array(
      'is_primary' => 1,
      'id' => $address1['id'],
    ));
    $this->assertEquals(1, $check);
    $this->callAPISuccess('address', 'delete', array('id' => $address1['id']));
  }

  /**
   */
  public function testCreateAddressPrimaryHandlingChangeExisting() {
    $address1 = $this->callAPISuccess('address', 'create', $this->_params);
    $this->callAPISuccess('address', 'create', $this->_params);
    $check = $this->callAPISuccess('address', 'getcount', array(
      'is_primary' => 1,
      'contact_id' => $this->_contactID,
    ));
    $this->assertEquals(1, $check);
    $this->callAPISuccess('address', 'delete', array('id' => $address1['id']));
  }

  /**
   * Test Creating address of same type alreay ind the database
   * This is legacy API v3 behaviour and not correct behaviour
   * however we are too far down the path wiwth v3 to fix this
   * @link https://chat.civicrm.org/civicrm/pl/zcq3jkg69jdt5g4aqze6bbe9pc
   * @todo vis this in v4 api
   */
  public function testCreateDuplicateLocationTypes() {
    $address1 = $this->callAPISuccess('address', 'create', $this->_params);
    $address2 = $this->callAPISuccess('address', 'create', array(
      'location_type_id' => $this->_locationType->id,
      'street_address' => '1600 Pensilvania Avenue',
      'city' => 'Washington DC',
      'is_primary' => 0,
      'is_billing' => 0,
      'contact_id' => $this->_contactID,
    ));
    $check = $this->callAPISuccess('address', 'getcount', array(
      'contact_id' => $this->_contactID,
      'location_type_id' => $this->_locationType->id,
    ));
    $this->assertEquals(2, $check);
    $this->callAPISuccess('address', 'delete', array('id' => $address1['id']));
    $this->callAPISuccess('address', 'delete', array('id' => $address2['id']));
  }

  public function testGetWithJoin() {
    $cid = $this->individualCreate(array(
      'api.Address.create' => array(
        'street_address' => __FUNCTION__,
        'location_type_id' => $this->_locationType->id,
      ),
    ));
    $result = $this->callAPISuccess('address', 'getsingle', array(
      'check_permissions' => TRUE,
      'contact_id' => $cid,
      'street_address' => __FUNCTION__,
      'return' => 'contact_id.contact_type',
    ));
    $this->assertEquals('Individual', $result['contact_id.contact_type']);
  }

}