tests/phpunit/api/v3/AddressTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  *  Test APIv3 civicrm_activity_* functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Contact
  33  */
  34
  35 /**
  36  * Class api_v3_AddressTest
  37  */
  38 class api_v3_AddressTest extends CiviUnitTestCase {
  39   protected $_apiversion = 3;
  40   protected $_contactID;
  41   protected $_locationType;
  42   protected $_params;
  43
  44   protected $_entity;
  45
  46   public function setUp() {
  47     $this->_entity = 'Address';
  48     parent::setUp();
  49
  50     $this->_contactID = $this->organizationCreate();
  51     $this->_locationType = $this->locationTypeCreate();
  52     CRM_Core_PseudoConstant::flush();
  53
  54     $this->_params = array(
  55       'contact_id' => $this->_contactID,
  56       'location_type_id' => $this->_locationType->id,
  57       'street_name' => 'Ambachtstraat',
  58       'street_number' => '23',
  59       'street_address' => 'Ambachtstraat 23',
  60       'postal_code' => '6971 BN',
  61       'country_id' => '1152',
  62       'city' => 'Brummen',
  63       'is_primary' => 1,
  64     );
  65   }
  66
  67   public function tearDown() {
  68     $this->locationTypeDelete($this->_locationType->id);
  69     $this->contactDelete($this->_contactID);
  70     $this->quickCleanup(array('civicrm_address', 'civicrm_relationship'));
  71   }
  72
  73   public function testCreateAddress() {
  74     $result = $this->callAPIAndDocument('address', 'create', $this->_params, __FUNCTION__, __FILE__);
  75     $this->assertEquals(1, $result['count']);
  76     $this->assertNotNull($result['values'][$result['id']]['id']);
  77     $this->getAndCheck($this->_params, $result['id'], 'address');
  78   }
  79
  80   public function testCreateAddressParsing() {
  81     $params = array(
  82       'street_parsing' => 1,
  83       'street_address' => '54A Excelsior Ave. Apt 1C',
  84       'location_type_id' => $this->_locationType->id,
  85       'contact_id' => $this->_contactID,
  86     );
  87     $subfile = "AddressParse";
  88     $description = "Demonstrates Use of address parsing param.";
  89     $result = $this->callAPIAndDocument('address', 'create', $params, __FUNCTION__, __FILE__, $description, $subfile);
  90     $this->assertEquals(54, $result['values'][$result['id']]['street_number']);
  91     $this->assertEquals('A', $result['values'][$result['id']]['street_number_suffix']);
  92     $this->assertEquals('Excelsior Ave.', $result['values'][$result['id']]['street_name']);
  93     $this->assertEquals('Apt 1C', $result['values'][$result['id']]['street_unit']);
  94     $this->callAPISuccess('address', 'delete', array('id' => $result['id']));
  95
  96   }
  97
  98   /**
  99    * Is_primary should be set as a default.
 100    */
 101   public function testCreateAddressTestDefaults() {
 102     $params = $this->_params;
 103     unset($params['is_primary']);
 104     $result = $this->callAPISuccess('address', 'create', $params);
 105     $this->assertEquals(1, $result['count']);
 106     $this->assertEquals(1, $result['values'][$result['id']]['is_primary']);
 107     $this->getAndCheck($this->_params, $result['id'], 'address');
 108   }
 109
 110   public function testCreateAddressTooLongSuffix() {
 111     $params = $this->_params;
 112     $params['street_number_suffix'] = 'really long string';
 113     $this->callAPIFailure('address', 'create', $params);
 114   }
 115
 116   /**
 117    * Create an address with a master ID and ensure that a relationship is created.
 118    */
 119   public function testCreateAddressWithMasterRelationshipHousehold() {
 120     $householdID = $this->householdCreate();
 121     $address = $this->callAPISuccess('address', 'create', array_merge($this->_params, $this->_params, array('contact_id' => $householdID)));
 122     $individualID = $this->individualCreate();
 123     $individualParams = array(
 124       'contact_id' => $individualID,
 125       'master_id' => $address['id'],
 126     );
 127     $this->callAPISuccess('address', 'create', array_merge($this->_params, $individualParams));
 128     $this->callAPISuccess('relationship', 'getcount', array(
 129       'contact_id_a' => $individualID,
 130       'contact_id_b' => $this->_contactID,
 131     ));
 132   }
 133
 134   /**
 135    * Create an address with a master ID and ensure that a relationship is created.
 136    */
 137   public function testCreateAddressWithMasterRelationshipOrganization() {
 138     $address = $this->callAPISuccess('address', 'create', $this->_params);
 139     $individualID = $this->individualCreate();
 140     $individualParams = array(
 141       'contact_id' => $individualID,
 142       'master_id' => $address['id'],
 143     );
 144     $this->callAPISuccess('address', 'create', array_merge($this->_params, $individualParams));
 145     $this->callAPISuccess('relationship', 'getcount', array(
 146       'contact_id_a' => $individualID,
 147       'contact_id_b' => $this->_contactID,
 148     ));
 149   }
 150
 151   /**
 152    * Create an address with a master ID and ensure that a relationship is created.
 153    */
 154   public function testCreateAddressWithMasterRelationshipChangingOrganization() {
 155     $address = $this->callAPISuccess('address', 'create', $this->_params);
 156     $organisation2ID = $this->organizationCreate();
 157     $address2 = $this->callAPISuccess('address', 'create', array_merge($this->_params, array('contact_id' => $organisation2ID)));
 158     $individualID = $this->individualCreate();
 159     $individualParams = array_merge($this->_params, array(
 160       'contact_id' => $individualID,
 161       'master_id' => $address['id'],
 162     ));
 163     $individualAddress = $this->callAPISuccess('address', 'create', $individualParams);
 164     $individualParams['master_id'] = $address2['id'];
 165     $individualParams['id'] = $individualAddress['id'];
 166     $this->callAPISuccess('address', 'create', $individualParams);
 167     $this->callAPISuccessGetCount('relationship', array('contact_id_a' => $individualID), 2);
 168     $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?');
 169     $this->callAPISuccessGetCount('relationship', array('contact_id_a' => $individualID, 'is_active' => FALSE), 1);
 170     $this->callAPISuccessGetCount('relationship', array(
 171       'contact_id_a' => $individualID,
 172       'is_active' => TRUE,
 173       'contact_id_b' => $organisation2ID,
 174     ), 1);
 175
 176   }
 177
 178   /**
 179    * Is_primary should be set as a default.
 180    *
 181    * ie. create the address, unset the params & recreate.
 182    * is_primary should be 0 before & after the update. ie - having no other address
 183    * is_primary is invalid.
 184    */
 185   public function testCreateAddressTestDefaultWithID() {
 186     $params = $this->_params;
 187     $params['is_primary'] = 0;
 188     $result = $this->callAPISuccess('address', 'create', $params);
 189     unset($params['is_primary']);
 190     $params['id'] = $result['id'];
 191     $result = $this->callAPISuccess('address', 'create', $params);
 192     $this->callAPISuccess('address', 'get', array('contact_id' => $params['contact_id']));
 193     $this->assertEquals(1, $result['count']);
 194     $this->assertEquals(1, $result['values'][$result['id']]['is_primary']);
 195     $this->getAndCheck($params, $result['id'], 'address', __FUNCTION__);
 196   }
 197
 198   /**
 199    * test address deletion.
 200    */
 201   public function testDeleteAddress() {
 202     //check there are no address to start with
 203     $get = $this->callAPISuccess('address', 'get', array(
 204       'location_type_id' => $this->_locationType->id,
 205     ));
 206     $this->assertEquals(0, $get['count'], 'Contact already exists ');
 207
 208     //create one
 209     $create = $this->callAPISuccess('address', 'create', $this->_params);
 210
 211     $result = $this->callAPIAndDocument('address', 'delete', array('id' => $create['id']), __FUNCTION__, __FILE__);
 212     $this->assertEquals(1, $result['count']);
 213     $get = $this->callAPISuccess('address', 'get', array(
 214       'location_type_id' => $this->_locationType->id,
 215     ));
 216     $this->assertEquals(0, $get['count'], 'Contact not successfully deleted In line ' . __LINE__);
 217   }
 218
 219   /**
 220    * Test civicrm_address_get - success expected.
 221    */
 222   public function testGetAddress() {
 223     $address = $this->callAPISuccess('address', 'create', $this->_params);
 224
 225     $params = array(
 226       'contact_id' => $this->_contactID,
 227       'street_name' => $address['values'][$address['id']]['street_name'],
 228     );
 229     $result = $this->callAPIAndDocument('Address', 'Get', $params, __FUNCTION__, __FILE__);
 230     $this->callAPISuccess('Address', 'delete', array('id' => $result['id']));
 231     $this->assertEquals($address['values'][$address['id']]['location_type_id'], $result['values'][$address['id']]['location_type_id']);
 232     $this->assertEquals($address['values'][$address['id']]['is_primary'], $result['values'][$address['id']]['is_primary']);
 233     $this->assertEquals($address['values'][$address['id']]['street_address'], $result['values'][$address['id']]['street_address']);
 234   }
 235
 236   /**
 237    * Test civicrm_address_get - success expected.
 238    */
 239   public function testGetSingleAddress() {
 240     $this->callAPISuccess('address', 'create', $this->_params);
 241     $params = array(
 242       'contact_id' => $this->_contactID,
 243     );
 244     $address = $this->callAPISuccess('Address', 'getsingle', ($params));
 245     $this->assertEquals($address['location_type_id'], $this->_params['location_type_id']);
 246     $this->callAPISuccess('address', 'delete', array('id' => $address['id']));
 247   }
 248
 249   /**
 250    * Test civicrm_address_get with sort option- success expected.
 251    */
 252   public function testGetAddressSort() {
 253     $create = $this->callAPISuccess('address', 'create', $this->_params);
 254     $this->callAPISuccess('address', 'create', array_merge($this->_params, array('street_address' => 'yzy')));
 255     $subfile = "AddressSort";
 256     $description = "Demonstrates Use of sort filter.";
 257     $params = array(
 258       'options' => array(
 259         'sort' => 'street_address DESC',
 260         'limit' => 2,
 261       ),
 262       'sequential' => 1,
 263     );
 264     $result = $this->callAPIAndDocument('Address', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
 265     $this->assertEquals(2, $result['count']);
 266     $this->assertEquals('Ambachtstraat 23', $result['values'][1]['street_address']);
 267     $this->callAPISuccess('address', 'delete', array('id' => $create['id']));
 268   }
 269
 270   /**
 271    * Test civicrm_address_get with sort option- success expected.
 272    */
 273   public function testGetAddressLikeSuccess() {
 274     $this->callAPISuccess('address', 'create', $this->_params);
 275     $subfile = "AddressLike";
 276     $description = "Demonstrates Use of Like.";
 277     $params = array(
 278       'street_address' => array('LIKE' => '%mb%'),
 279       'sequential' => 1,
 280     );
 281     $result = $this->callAPIAndDocument('Address', 'Get', $params, __FUNCTION__, __FILE__, $description, $subfile);
 282     $this->assertEquals(1, $result['count']);
 283     $this->assertEquals('Ambachtstraat 23', $result['values'][0]['street_address']);
 284     $this->callAPISuccess('address', 'delete', array('id' => $result['id']));
 285   }
 286
 287   /**
 288    * Test civicrm_address_get with sort option- success expected.
 289    */
 290   public function testGetAddressLikeFail() {
 291     $create = $this->callAPISuccess('address', 'create', $this->_params);
 292     $params = array(
 293       'street_address' => array('LIKE' => "'%xy%'"),
 294       'sequential' => 1,
 295     );
 296     $result = $this->callAPISuccess('Address', 'Get', ($params));
 297     $this->assertEquals(0, $result['count']);
 298     $this->callAPISuccess('address', 'delete', array('id' => $create['id']));
 299   }
 300
 301   /**
 302    */
 303   public function testGetWithCustom() {
 304     $ids = $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, __FILE__);
 305
 306     $params = $this->_params;
 307     $params['custom_' . $ids['custom_field_id']] = "custom string";
 308
 309     $result = $this->callAPISuccess($this->_entity, 'create', $params);
 310
 311     $getParams = array('id' => $result['id'], 'return' => array('custom'));
 312     $check = $this->callAPISuccess($this->_entity, 'get', $getParams);
 313
 314     $this->assertEquals("custom string", $check['values'][$check['id']]['custom_' . $ids['custom_field_id']], ' in line ' . __LINE__);
 315
 316     $this->customFieldDelete($ids['custom_field_id']);
 317     $this->customGroupDelete($ids['custom_group_id']);
 318     $this->callAPISuccess('address', 'delete', array('id' => $result['id']));
 319   }
 320
 321   /**
 322    */
 323   public function testCreateAddressPrimaryHandlingChangeToPrimary() {
 324     $params = $this->_params;
 325     unset($params['is_primary']);
 326     $address1 = $this->callAPISuccess('address', 'create', $params);
 327     $this->assertApiSuccess($address1);
 328     //now we check & make sure it has been set to primary
 329     $check = $this->callAPISuccess('address', 'getcount', array(
 330       'is_primary' => 1,
 331       'id' => $address1['id'],
 332     ));
 333     $this->assertEquals(1, $check);
 334     $this->callAPISuccess('address', 'delete', array('id' => $address1['id']));
 335   }
 336
 337   /**
 338    */
 339   public function testCreateAddressPrimaryHandlingChangeExisting() {
 340     $address1 = $this->callAPISuccess('address', 'create', $this->_params);
 341     $this->callAPISuccess('address', 'create', $this->_params);
 342     $check = $this->callAPISuccess('address', 'getcount', array(
 343       'is_primary' => 1,
 344       'contact_id' => $this->_contactID,
 345     ));
 346     $this->assertEquals(1, $check);
 347     $this->callAPISuccess('address', 'delete', array('id' => $address1['id']));
 348   }
 349
 350 }