tests/phpunit/CRM/Dedupe/DedupeFinderTest.php

   1 <?php
   2
   3 /**
   4  * Class CRM_Dedupe_DedupeFinderTest
   5  * @group headless
   6  */
   7 class CRM_Dedupe_DedupeFinderTest extends CiviUnitTestCase {
   8
   9   /**
  10    * IDs of created contacts.
  11    *
  12    * @var array
  13    */
  14   protected $contactIDs = [];
  15
  16   /**
  17    * ID of the group holding the contacts.
  18    *
  19    * @var int
  20    */
  21   protected $groupID;
  22
  23   /**
  24    * Clean up after the test.
  25    */
  26   public function tearDown() {
  27
  28     foreach ($this->contactIDs as $contactId) {
  29       $this->contactDelete($contactId);
  30     }
  31     if ($this->groupID) {
  32       $this->callAPISuccess('group', 'delete', ['id' => $this->groupID]);
  33     }
  34     parent::tearDown();
  35   }
  36
  37   /**
  38    * Test the unsupervised dedupe rule against a group.
  39    *
  40    * @throws \Exception
  41    */
  42   public function testUnsupervisedDupes() {
  43     // make dupe checks based on following contact sets:
  44     // FIRST - LAST - EMAIL
  45     // ---------------------------------
  46     // robin  - hood - robin@example.com
  47     // robin  - hood - hood@example.com
  48     // robin  - dale - robin@example.com
  49     // little - dale - dale@example.com
  50     // will   - dale - dale@example.com
  51     // will   - dale - will@example.com
  52     // will   - dale - will@example.com
  53     $this->setupForGroupDedupe();
  54
  55     $ruleGroup = $this->callAPISuccessGetSingle('RuleGroup', ['is_reserved' => 1, 'contact_type' => 'Individual', 'used' => 'Unsupervised']);
  56
  57     $foundDupes = CRM_Dedupe_Finder::dupesInGroup($ruleGroup['id'], $this->groupID);
  58     $this->assertEquals(count($foundDupes), 3, 'Check Individual-Fuzzy dupe rule for dupesInGroup().');
  59   }
  60
  61   /**
  62    * Test duplicate contact retrieval with 2 email fields.
  63    */
  64   public function testUnsupervisedWithTwoEmailFields() {
  65     $this->setupForGroupDedupe();
  66     $emails = [
  67       ['hood@example.com', ''],
  68       ['', 'hood@example.com'],
  69     ];
  70     for ($i = 0; $i < 2; $i++) {
  71       $fields = [
  72         'first_name' => 'robin',
  73         'last_name' => 'hood',
  74         'email-1' => $emails[$i][0],
  75         'email-2' => $emails[$i][1],
  76       ];
  77       $dedupeParams = CRM_Dedupe_Finder::formatParams($fields, 'Individual');
  78       $dedupeResults = CRM_Dedupe_Finder::dupesByParams($dedupeParams, 'Individual');
  79       $this->assertEquals(count($dedupeResults), 1);
  80     }
  81   }
  82
  83   /**
  84    * Test that a rule set to is_reserved = 0 works.
  85    *
  86    * There is a different search used dependent on this variable.
  87    */
  88   public function testCustomRule() {
  89     $this->setupForGroupDedupe();
  90
  91     $ruleGroup = $this->callAPISuccess('RuleGroup', 'create', [
  92       'contact_type' => 'Individual',
  93       'threshold' => 8,
  94       'used' => 'General',
  95       'name' => 'TestRule',
  96       'title' => 'TestRule',
  97       'is_reserved' => 0,
  98     ]);
  99     $rules = [];
 100     foreach (['birth_date', 'first_name', 'last_name'] as $field) {
 101       $rules[$field] = $this->callAPISuccess('Rule', 'create', [
 102         'dedupe_rule_group_id' => $ruleGroup['id'],
 103         'rule_table' => 'civicrm_contact',
 104         'rule_weight' => 4,
 105         'rule_field' => $field,
 106       ]);
 107     }
 108     $foundDupes = CRM_Dedupe_Finder::dupesInGroup($ruleGroup['id'], $this->groupID);
 109     $this->assertEquals(count($foundDupes), 4);
 110     CRM_Dedupe_Finder::dupes($ruleGroup['id']);
 111
 112   }
 113
 114   /**
 115    * Test a custom rule with a non-default field.
 116    */
 117   public function testCustomRuleWithAddress() {
 118     $this->setupForGroupDedupe();
 119
 120     $ruleGroup = $this->callAPISuccess('RuleGroup', 'create', [
 121       'contact_type' => 'Individual',
 122       'threshold' => 10,
 123       'used' => 'General',
 124       'name' => 'TestRule',
 125       'title' => 'TestRule',
 126       'is_reserved' => 0,
 127     ]);
 128     $rules = [];
 129     foreach (['postal_code'] as $field) {
 130       $rules[$field] = $this->callAPISuccess('Rule', 'create', [
 131         'dedupe_rule_group_id' => $ruleGroup['id'],
 132         'rule_table' => 'civicrm_address',
 133         'rule_weight' => 10,
 134         'rule_field' => $field,
 135       ]);
 136     }
 137     $foundDupes = CRM_Dedupe_Finder::dupesInGroup($ruleGroup['id'], $this->groupID);
 138     $this->assertEquals(count($foundDupes), 1);
 139     CRM_Dedupe_Finder::dupes($ruleGroup['id']);
 140
 141   }
 142
 143   /**
 144    * Test the supervised dedupe rule against a group.
 145    *
 146    * @throws \Exception
 147    */
 148   public function testSupervisedDupes() {
 149     $this->setupForGroupDedupe();
 150     $ruleGroup = $this->callAPISuccessGetSingle('RuleGroup', ['is_reserved' => 1, 'contact_type' => 'Individual', 'used' => 'Supervised']);
 151     $foundDupes = CRM_Dedupe_Finder::dupesInGroup($ruleGroup['id'], $this->groupID);
 152     // -------------------------------------------------------------------------
 153     // default dedupe rule: threshold = 20 => (First + Last + Email) Matches ( 1 pair )
 154     // --------------------------------------------------------------------------
 155     // will   - dale - will@example.com
 156     // will   - dale - will@example.com
 157     // so 1 pair for - first + last + mail
 158     $this->assertEquals(count($foundDupes), 1, 'Check Individual-Fuzzy dupe rule for dupesInGroup().');
 159   }
 160
 161   /**
 162    * Test dupesByParams function.
 163    */
 164   public function testDupesByParams() {
 165     // make dupe checks based on based on following contact sets:
 166     // FIRST - LAST - EMAIL
 167     // ---------------------------------
 168     // robin  - hood - robin@example.com
 169     // robin  - hood - hood@example.com
 170     // robin  - dale - robin@example.com
 171     // little - dale - dale@example.com
 172     // will   - dale - dale@example.com
 173     // will   - dale - will@example.com
 174     // will   - dale - will@example.com
 175
 176     // contact data set
 177     // FIXME: move create params to separate function
 178     $params = [
 179       [
 180         'first_name' => 'robin',
 181         'last_name' => 'hood',
 182         'email' => 'robin@example.com',
 183         'contact_type' => 'Individual',
 184       ],
 185       [
 186         'first_name' => 'robin',
 187         'last_name' => 'hood',
 188         'email' => 'hood@example.com',
 189         'contact_type' => 'Individual',
 190       ],
 191       [
 192         'first_name' => 'robin',
 193         'last_name' => 'dale',
 194         'email' => 'robin@example.com',
 195         'contact_type' => 'Individual',
 196       ],
 197       [
 198         'first_name' => 'little',
 199         'last_name' => 'dale',
 200         'email' => 'dale@example.com',
 201         'contact_type' => 'Individual',
 202       ],
 203       [
 204         'first_name' => 'will',
 205         'last_name' => 'dale',
 206         'email' => 'dale@example.com',
 207         'contact_type' => 'Individual',
 208       ],
 209       [
 210         'first_name' => 'will',
 211         'last_name' => 'dale',
 212         'email' => 'will@example.com',
 213         'contact_type' => 'Individual',
 214       ],
 215       [
 216         'first_name' => 'will',
 217         'last_name' => 'dale',
 218         'email' => 'will@example.com',
 219         'contact_type' => 'Individual',
 220       ],
 221     ];
 222
 223     $this->hookClass->setHook('civicrm_findDuplicates', [$this, 'hook_civicrm_findDuplicates']);
 224
 225     $count = 1;
 226
 227     foreach ($params as $param) {
 228       $contact = $this->callAPISuccess('contact', 'create', $param);
 229       $params = [
 230         'contact_id' => $contact['id'],
 231         'street_address' => 'Ambachtstraat 23',
 232         'location_type_id' => 1,
 233       ];
 234       $this->callAPISuccess('address', 'create', $params);
 235       $contactIds[$count++] = $contact['id'];
 236     }
 237
 238     // verify that all contacts have been created separately
 239     $this->assertEquals(count($contactIds), 7, 'Check for number of contacts.');
 240
 241     $fields = [
 242       'first_name' => 'robin',
 243       'last_name' => 'hood',
 244       'email' => 'hood@example.com',
 245       'street_address' => 'Ambachtstraat 23',
 246     ];
 247     CRM_Core_TemporaryErrorScope::useException();
 248     $ids = CRM_Contact_BAO_Contact::getDuplicateContacts($fields, 'Individual', 'General', [], TRUE, NULL, ['event_id' => 1]);
 249
 250     // Check with default Individual-General rule
 251     $this->assertEquals(count($ids), 2, 'Check Individual-General rule for dupesByParams().');
 252
 253     // delete all created contacts
 254     foreach ($contactIds as $contactId) {
 255       $this->contactDelete($contactId);
 256     }
 257   }
 258
 259   /**
 260    * Implements hook_civicrm_findDuplicates().
 261    *
 262    * Locks in expected params
 263    *
 264    */
 265   public function hook_civicrm_findDuplicates($dedupeParams, &$dedupeResults, $contextParams) {
 266     $expectedDedupeParams = [
 267       'check_permission' => TRUE,
 268       'contact_type' => 'Individual',
 269       'rule' => 'General',
 270       'rule_group_id' => NULL,
 271       'excluded_contact_ids' => [],
 272     ];
 273     foreach ($expectedDedupeParams as $key => $value) {
 274       $this->assertEquals($value, $dedupeParams[$key]);
 275     }
 276     $expectedDedupeResults = [
 277       'ids' => [],
 278       'handled' => FALSE,
 279     ];
 280     foreach ($expectedDedupeResults as $key => $value) {
 281       $this->assertEquals($value, $dedupeResults[$key]);
 282     }
 283
 284     $expectedContext = ['event_id' => 1];
 285     foreach ($expectedContext as $key => $value) {
 286       $this->assertEquals($value, $contextParams[$key]);
 287     }
 288
 289     return $dedupeResults;
 290   }
 291
 292   /**
 293    * Set up a group of dedupable contacts.
 294    */
 295   protected function setupForGroupDedupe() {
 296     $params = [
 297       'name' => 'Dupe Group',
 298       'title' => 'New Test Dupe Group',
 299       'domain_id' => 1,
 300       'is_active' => 1,
 301       'visibility' => 'Public Pages',
 302     ];
 303
 304     $result = $this->callAPISuccess('group', 'create', $params);
 305     $this->groupID = $result['id'];
 306
 307     $params = [
 308       [
 309         'first_name' => 'robin',
 310         'last_name' => 'hood',
 311         'email' => 'robin@example.com',
 312         'contact_type' => 'Individual',
 313         'birth_date' => '2016-01-01',
 314         'api.Address.create' => ['location_type_id' => 'Billing', 'postal_code' => '99999'],
 315       ],
 316       [
 317         'first_name' => 'robin',
 318         'last_name' => 'hood',
 319         'email' => 'hood@example.com',
 320         'contact_type' => 'Individual',
 321         'birth_date' => '2016-01-01',
 322         'api.Address.create' => ['location_type_id' => 'Billing', 'postal_code' => '99999'],
 323       ],
 324       [
 325         'first_name' => 'robin',
 326         'last_name' => 'dale',
 327         'email' => 'robin@example.com',
 328         'contact_type' => 'Individual',
 329       ],
 330       [
 331         'first_name' => 'little',
 332         'last_name' => 'dale',
 333         'email' => 'dale@example.com',
 334         'contact_type' => 'Individual',
 335       ],
 336       [
 337         'first_name' => 'will',
 338         'last_name' => 'dale',
 339         'email' => 'dale@example.com',
 340         'contact_type' => 'Individual',
 341       ],
 342       [
 343         'first_name' => 'will',
 344         'last_name' => 'dale',
 345         'email' => 'will@example.com',
 346         'contact_type' => 'Individual',
 347       ],
 348       [
 349         'first_name' => 'will',
 350         'last_name' => 'dale',
 351         'email' => 'will@example.com',
 352         'contact_type' => 'Individual',
 353       ],
 354     ];
 355
 356     $count = 1;
 357     foreach ($params as $param) {
 358       $contact = $this->callAPISuccess('contact', 'create', $param);
 359       $this->contactIDs[$count++] = $contact['id'];
 360
 361       $grpParams = [
 362         'contact_id' => $contact['id'],
 363         'group_id' => $this->groupID,
 364       ];
 365       $this->callAPISuccess('group_contact', 'create', $grpParams);
 366     }
 367
 368     // verify that all contacts have been created separately
 369     $this->assertEquals(count($this->contactIDs), 7, 'Check for number of contacts.');
 370   }
 371
 372 }