-
-
Notifications
You must be signed in to change notification settings - Fork 812
/
AddressTest.php
597 lines (517 loc) · 20.9 KB
/
AddressTest.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 5 |
+--------------------------------------------------------------------+
| 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 |
+--------------------------------------------------------------------+
*/
/**
* Class CRM_Core_BAO_AddressTest
* @group headless
*/
class CRM_Core_BAO_AddressTest extends CiviUnitTestCase {
public function setUp() {
parent::setUp();
$this->quickCleanup(array('civicrm_contact', 'civicrm_address'));
}
/**
* Create() method (create and update modes)
*/
public function testCreate() {
$contactId = $this->individualCreate();
$params = array();
$params['address']['1'] = array(
'street_address' => 'Oberoi Garden',
'supplemental_address_1' => 'Attn: Accounting',
'supplemental_address_2' => 'Powai',
'supplemental_address_3' => 'Somewhere',
'city' => 'Athens',
'postal_code' => '01903',
'state_province_id' => '1000',
'country_id' => '1228',
'geo_code_1' => '18.219023',
'geo_code_2' => '-105.00973',
'location_type_id' => '1',
'is_primary' => '1',
'is_billing' => '0',
);
$params['contact_id'] = $contactId;
$fixAddress = TRUE;
CRM_Core_BAO_Address::create($params, $fixAddress, $entity = NULL);
$addressId = $this->assertDBNotNull('CRM_Core_DAO_Address', 'Oberoi Garden', 'id', 'street_address',
'Database check for created address.'
);
// Now call add() to modify an existing address
$params = array();
$params['address']['1'] = array(
'id' => $addressId,
'street_address' => '120 Terminal Road',
'supplemental_address_1' => 'A-wing:3037',
'supplemental_address_2' => 'Bandra',
'supplemental_address_3' => 'Somewhere',
'city' => 'Athens',
'postal_code' => '01903',
'state_province_id' => '1000',
'country_id' => '1228',
'geo_code_1' => '18.219023',
'geo_code_2' => '-105.00973',
'location_type_id' => '1',
'is_primary' => '1',
'is_billing' => '0',
);
$params['contact_id'] = $contactId;
$block = CRM_Core_BAO_Address::create($params, $fixAddress, $entity = NULL);
$this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
'Database check for updated address by contactId.'
);
$this->assertDBNotNull('CRM_Core_DAO_Address', '120 Terminal Road', 'id', 'street_address',
'Database check for updated address by street_name.'
);
$this->contactDelete($contactId);
}
/**
* Add() method ( )
*/
public function testAdd() {
$contactId = $this->individualCreate();
$fixParams = array(
'street_address' => 'E 906N Pine Pl W',
'supplemental_address_1' => 'Editorial Dept',
'supplemental_address_2' => '',
'supplemental_address_3' => '',
'city' => 'El Paso',
'postal_code' => '88575',
'postal_code_suffix' => '',
'state_province_id' => '1001',
'country_id' => '1228',
'geo_code_1' => '31.694842',
'geo_code_2' => '-106.29998',
'location_type_id' => '1',
'is_primary' => '1',
'is_billing' => '0',
'contact_id' => $contactId,
);
$addAddress = CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
$addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
'Database check for created contact address.'
);
$this->assertEquals($addAddress->street_address, 'E 906N Pine Pl W', 'In line' . __LINE__);
$this->assertEquals($addAddress->supplemental_address_1, 'Editorial Dept', 'In line' . __LINE__);
$this->assertEquals($addAddress->city, 'El Paso', 'In line' . __LINE__);
$this->assertEquals($addAddress->postal_code, '88575', 'In line' . __LINE__);
$this->assertEquals($addAddress->geo_code_1, '31.694842', 'In line' . __LINE__);
$this->assertEquals($addAddress->geo_code_2, '-106.29998', 'In line' . __LINE__);
$this->assertEquals($addAddress->country_id, '1228', 'In line' . __LINE__);
$this->contactDelete($contactId);
}
/**
* AllAddress() method ( )
*/
public function testallAddress() {
$contactId = $this->individualCreate();
$fixParams = array(
'street_address' => 'E 906N Pine Pl W',
'supplemental_address_1' => 'Editorial Dept',
'supplemental_address_2' => '',
'supplemental_address_3' => '',
'city' => 'El Paso',
'postal_code' => '88575',
'postal_code_suffix' => '',
'state_province_id' => '1001',
'country_id' => '1228',
'geo_code_1' => '31.694842',
'geo_code_2' => '-106.29998',
'location_type_id' => '1',
'is_primary' => '1',
'is_billing' => '0',
'contact_id' => $contactId,
);
CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
$addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
'Database check for created contact address.'
);
$fixParams = array(
'street_address' => 'SW 719B Beech Dr NW',
'supplemental_address_1' => 'C/o OPDC',
'supplemental_address_2' => '',
'supplemental_address_3' => '',
'city' => 'Neillsville',
'postal_code' => '54456',
'postal_code_suffix' => '',
'state_province_id' => '1001',
'country_id' => '1228',
'geo_code_1' => '44.553719',
'geo_code_2' => '-90.61457',
'location_type_id' => '2',
'is_primary' => '',
'is_billing' => '1',
'contact_id' => $contactId,
);
CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
$addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
'Database check for created contact address.'
);
$allAddress = CRM_Core_BAO_Address::allAddress($contactId);
$this->assertEquals(count($allAddress), 2, 'Checking number of returned addresses.');
$this->contactDelete($contactId);
}
/**
* AllAddress() method ( ) with null value
*/
public function testnullallAddress() {
$contactId = $this->individualCreate();
$fixParams = array(
'street_address' => 'E 906N Pine Pl W',
'supplemental_address_1' => 'Editorial Dept',
'supplemental_address_2' => '',
'supplemental_address_3' => '',
'city' => 'El Paso',
'postal_code' => '88575',
'postal_code_suffix' => '',
'state_province_id' => '1001',
'country_id' => '1228',
'geo_code_1' => '31.694842',
'geo_code_2' => '-106.29998',
'location_type_id' => '1',
'is_primary' => '1',
'is_billing' => '0',
'contact_id' => $contactId,
);
CRM_Core_BAO_Address::add($fixParams, $fixAddress = TRUE);
$addParams = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
'Database check for created contact address.'
);
$contact_Id = NULL;
$allAddress = CRM_Core_BAO_Address::allAddress($contact_Id);
$this->assertEquals($allAddress, NULL, 'Checking null for returned addresses.');
$this->contactDelete($contactId);
}
/**
* GetValues() method (get Address fields)
*/
public function testGetValues() {
$contactId = $this->individualCreate();
$params = array();
$params['address']['1'] = array(
'street_address' => 'Oberoi Garden',
'supplemental_address_1' => 'Attn: Accounting',
'supplemental_address_2' => 'Powai',
'supplemental_address_3' => 'Somewhere',
'city' => 'Athens',
'postal_code' => '01903',
'state_province_id' => '1000',
'country_id' => '1228',
'geo_code_1' => '18.219023',
'geo_code_2' => '-105.00973',
'location_type_id' => '1',
'is_primary' => '1',
'is_billing' => '0',
);
$params['contact_id'] = $contactId;
$fixAddress = TRUE;
CRM_Core_BAO_Address::create($params, $fixAddress, $entity = NULL);
$addressId = $this->assertDBNotNull('CRM_Core_DAO_Address', $contactId, 'id', 'contact_id',
'Database check for created address.'
);
$entityBlock = array('contact_id' => $contactId);
$address = CRM_Core_BAO_Address::getValues($entityBlock);
$this->assertEquals($address[1]['id'], $addressId);
$this->assertEquals($address[1]['contact_id'], $contactId);
$this->assertEquals($address[1]['street_address'], 'Oberoi Garden');
$this->contactDelete($contactId);
}
public function setStreetAddressParsing($status) {
$address_options = CRM_Core_BAO_Setting::valueOptions(
CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
'address_options',
TRUE, NULL, TRUE
);
if ($status) {
$value = 1;
}
else {
$value = 0;
}
$address_options['street_address_parsing'] = $value;
CRM_Core_BAO_Setting::setValueOption(
CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
'address_options',
$address_options
);
}
/**
* ParseStreetAddress if enabled, otherwise, don't.
*/
public function testParseStreetAddressIfEnabled() {
// Turn off address standardization. Parsing should work without it.
Civi::settings()->set('address_standardization_provider', NULL);
// Ensure street parsing happens if enabled.
$this->setStreetAddressParsing(TRUE);
$contactId = $this->individualCreate();
$street_address = "54 Excelsior Ave.";
$params = array(
'contact_id' => $contactId,
'street_address' => $street_address,
'location_type_id' => 1,
);
$result = civicrm_api3('Address', 'create', $params);
$value = array_pop($result['values']);
$street_number = CRM_Utils_Array::value('street_number', $value);
$this->assertEquals($street_number, '54');
// Ensure street parsing does not happen if disabled.
$this->setStreetAddressParsing(FALSE);
$result = civicrm_api3('Address', 'create', $params);
$value = array_pop($result['values']);
$street_number = CRM_Utils_Array::value('street_number', $value);
$this->assertEmpty($street_number);
}
/**
* ParseStreetAddress() method (get street address parsed)
*/
public function testParseStreetAddress() {
// valid Street address to be parsed ( without locale )
$street_address = "54A Excelsior Ave. Apt 1C";
$parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address);
$this->assertEquals($parsedStreetAddress['street_name'], 'Excelsior Ave.');
$this->assertEquals($parsedStreetAddress['street_unit'], 'Apt 1C');
$this->assertEquals($parsedStreetAddress['street_number'], '54');
$this->assertEquals($parsedStreetAddress['street_number_suffix'], 'A');
// valid Street address to be parsed ( $locale = 'en_US' )
$street_address = "54A Excelsior Ave. Apt 1C";
$locale = 'en_US';
$parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
$this->assertEquals($parsedStreetAddress['street_name'], 'Excelsior Ave.');
$this->assertEquals($parsedStreetAddress['street_unit'], 'Apt 1C');
$this->assertEquals($parsedStreetAddress['street_number'], '54');
$this->assertEquals($parsedStreetAddress['street_number_suffix'], 'A');
// invalid Street address ( $locale = 'en_US' )
$street_address = "West St. Apt 1";
$locale = 'en_US';
$parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
$this->assertEquals($parsedStreetAddress['street_name'], 'West St.');
$this->assertEquals($parsedStreetAddress['street_unit'], 'Apt 1');
$this->assertNotContains('street_number', $parsedStreetAddress);
$this->assertNotContains('street_number_suffix', $parsedStreetAddress);
// valid Street address to be parsed ( $locale = 'fr_CA' )
$street_address = "2-123CA Main St";
$locale = 'fr_CA';
$parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
$this->assertEquals($parsedStreetAddress['street_name'], 'Main St');
$this->assertEquals($parsedStreetAddress['street_unit'], '2');
$this->assertEquals($parsedStreetAddress['street_number'], '123');
$this->assertEquals($parsedStreetAddress['street_number_suffix'], 'CA');
// invalid Street address ( $locale = 'fr_CA' )
$street_address = "123 Main St";
$locale = 'fr_CA';
$parsedStreetAddress = CRM_Core_BAO_Address::parseStreetAddress($street_address, $locale);
$this->assertEquals($parsedStreetAddress['street_name'], 'Main St');
$this->assertEquals($parsedStreetAddress['street_number'], '123');
$this->assertNotContains('street_unit', $parsedStreetAddress);
$this->assertNotContains('street_number_suffix', $parsedStreetAddress);
}
/**
* @dataProvider supportedAddressParsingLocales
*/
public function testIsSupportedByAddressParsingReturnTrueForSupportedLocales($locale) {
$isSupported = CRM_Core_BAO_Address::isSupportedParsingLocale($locale);
$this->assertTrue($isSupported);
}
/**
* @dataProvider supportedAddressParsingLocales
*/
public function testIsSupportedByAddressParsingReturnTrueForSupportedDefaultLocales($locale) {
CRM_Core_Config::singleton()->lcMessages = $locale;
$isSupported = CRM_Core_BAO_Address::isSupportedParsingLocale();
$this->assertTrue($isSupported);
}
public function supportedAddressParsingLocales() {
return array(
array('en_US'),
array('en_CA'),
array('fr_CA'),
);
}
/**
* @dataProvider sampleOFUnsupportedAddressParsingLocales
*/
public function testIsSupportedByAddressParsingReturnFalseForUnSupportedLocales($locale) {
$isNotSupported = CRM_Core_BAO_Address::isSupportedParsingLocale($locale);
$this->assertFalse($isNotSupported);
}
/**
* @dataProvider sampleOFUnsupportedAddressParsingLocales
*/
public function testIsSupportedByAddressParsingReturnFalseForUnSupportedDefaultLocales($locale) {
CRM_Core_Config::singleton()->lcMessages = $locale;
$isNotSupported = CRM_Core_BAO_Address::isSupportedParsingLocale();
$this->assertFalse($isNotSupported);
}
public function sampleOFUnsupportedAddressParsingLocales() {
return array(
array('en_GB'),
array('af_ZA'),
array('da_DK'),
);
}
/**
* CRM-21214 - Ensure all child addresses are updated correctly - 1.
* 1. First, create three contacts: A, B, and C
* 2. Create an address for contact A
* 3. Use contact A's address for contact B
* 4. Use contact B's address for contact C
* 5. Change contact A's address
* Address of Contact C should reflect contact A's address change
* Also, Contact C's address' master_id should be Contact A's address id.
*/
public function testSharedAddressChaining1() {
$contactIdA = $this->individualCreate(array(), 0);
$contactIdB = $this->individualCreate(array(), 1);
$contactIdC = $this->individualCreate(array(), 2);
$addressParamsA = array(
'street_address' => '123 Fake St.',
'location_type_id' => '1',
'is_primary' => '1',
'contact_id' => $contactIdA,
);
$addAddressA = CRM_Core_BAO_Address::add($addressParamsA, FALSE);
$addressParamsB = array(
'street_address' => '123 Fake St.',
'location_type_id' => '1',
'is_primary' => '1',
'master_id' => $addAddressA->id,
'contact_id' => $contactIdB,
);
$addAddressB = CRM_Core_BAO_Address::add($addressParamsB, FALSE);
$addressParamsC = array(
'street_address' => '123 Fake St.',
'location_type_id' => '1',
'is_primary' => '1',
'master_id' => $addAddressB->id,
'contact_id' => $contactIdC,
);
$addAddressC = CRM_Core_BAO_Address::add($addressParamsC, FALSE);
$updatedAddressParamsA = array(
'id' => $addAddressA->id,
'street_address' => '1313 New Address Lane',
'location_type_id' => '1',
'is_primary' => '1',
'contact_id' => $contactIdA,
);
$updatedAddressA = CRM_Core_BAO_Address::add($updatedAddressParamsA, FALSE);
// CRM-21214 - Has Address C been updated with Address A's new values?
$newAddressC = new CRM_Core_DAO_Address();
$newAddressC->id = $addAddressC->id;
$newAddressC->find(TRUE);
$newAddressC->fetch(TRUE);
$this->assertEquals($updatedAddressA->street_address, $newAddressC->street_address);
$this->assertEquals($updatedAddressA->id, $newAddressC->master_id);
}
/**
* CRM-21214 - Ensure all child addresses are updated correctly - 2.
* 1. First, create three contacts: A, B, and C
* 2. Create an address for contact A and B
* 3. Use contact A's address for contact C
* 4. Use contact B's address for contact A
* 5. Change contact B's address
* Address of Contact C should reflect contact B's address change
* Also, Contact C's address' master_id should be Contact B's address id.
*/
public function testSharedAddressChaining2() {
$contactIdA = $this->individualCreate(array(), 0);
$contactIdB = $this->individualCreate(array(), 1);
$contactIdC = $this->individualCreate(array(), 2);
$addressParamsA = array(
'street_address' => '123 Fake St.',
'location_type_id' => '1',
'is_primary' => '1',
'contact_id' => $contactIdA,
);
$addAddressA = CRM_Core_BAO_Address::add($addressParamsA, FALSE);
$addressParamsB = array(
'street_address' => '123 Fake St.',
'location_type_id' => '1',
'is_primary' => '1',
'contact_id' => $contactIdB,
);
$addAddressB = CRM_Core_BAO_Address::add($addressParamsB, FALSE);
$addressParamsC = array(
'street_address' => '123 Fake St.',
'location_type_id' => '1',
'is_primary' => '1',
'master_id' => $addAddressA->id,
'contact_id' => $contactIdC,
);
$addAddressC = CRM_Core_BAO_Address::add($addressParamsC, FALSE);
$updatedAddressParamsA = array(
'id' => $addAddressA->id,
'street_address' => '123 Fake St.',
'location_type_id' => '1',
'is_primary' => '1',
'master_id' => $addAddressB->id,
'contact_id' => $contactIdA,
);
$updatedAddressA = CRM_Core_BAO_Address::add($updatedAddressParamsA, FALSE);
$updatedAddressParamsB = array(
'id' => $addAddressB->id,
'street_address' => '1313 New Address Lane',
'location_type_id' => '1',
'is_primary' => '1',
'contact_id' => $contactIdB,
);
$updatedAddressB = CRM_Core_BAO_Address::add($updatedAddressParamsB, FALSE);
// CRM-21214 - Has Address C been updated with Address B's new values?
$newAddressC = new CRM_Core_DAO_Address();
$newAddressC->id = $addAddressC->id;
$newAddressC->find(TRUE);
$newAddressC->fetch(TRUE);
$this->assertEquals($updatedAddressB->street_address, $newAddressC->street_address);
$this->assertEquals($updatedAddressB->id, $newAddressC->master_id);
}
/**
* CRM-21214 - Ensure all child addresses are updated correctly - 3.
* 1. First, create a contact: A
* 2. Create an address for contact A
* 3. Use contact A's address for contact A's address
* An error should be given, and master_id should remain the same.
*/
public function testSharedAddressChaining3() {
$contactIdA = $this->individualCreate(array(), 0);
$addressParamsA = array(
'street_address' => '123 Fake St.',
'location_type_id' => '1',
'is_primary' => '1',
'contact_id' => $contactIdA,
);
$addAddressA = CRM_Core_BAO_Address::add($addressParamsA, FALSE);
$updatedAddressParamsA = array(
'id' => $addAddressA->id,
'street_address' => '123 Fake St.',
'location_type_id' => '1',
'is_primary' => '1',
'master_id' => $addAddressA->id,
'contact_id' => $contactIdA,
);
$updatedAddressA = CRM_Core_BAO_Address::add($updatedAddressParamsA, FALSE);
// CRM-21214 - AdressA shouldn't be master of itself.
$this->assertEmpty($updatedAddressA->master_id);
}
}