CRM-17454 add tests for dedupe query

diff --git a/tests/phpunit/CRM/Dedupe/MergerTest.php b/tests/phpunit/CRM/Dedupe/MergerTest.php
index a5cfd17b8eb3afa3bd4b72630b942cb27eaf0bff..7b524acefcbeaaad1d90488800aa7a67a2d8ea34 100644 (file)
--- a/tests/phpunit/CRM/Dedupe/MergerTest.php
+++ b/tests/phpunit/CRM/Dedupe/MergerTest.php
@@ -232,4 +232,253 @@ class CRM_Dedupe_MergerTest extends CiviUnitTestCase {
     $this->deleteDupeContacts();
   }
 
+  /**
+   * The goal of this function is to test that all required tables are returned.
+   */
+  public function testGetCidRefs() {
+    $this->entityCustomGroupWithSingleFieldCreate(__FUNCTION__, 'Contacts');
+    $this->assertEquals(array_merge($this->getStaticCIDRefs(), $this->getHackedInCIDRef()), CRM_Dedupe_Merger::cidRefs());
+    $this->assertEquals(array_merge($this->getCalculatedCIDRefs(), $this->getHackedInCIDRef()), CRM_Dedupe_Merger::cidRefs());
+  }
+
+  /**
+   * Get the list of not-really-cid-refs that are currently hacked in.
+   *
+   * This is hacked into getCIDs function.
+   *
+   * @return array
+   */
+  public function getHackedInCIDRef() {
+    return array(
+      'civicrm_entity_tag' => array(
+        0 => 'entity_id',
+      ),
+    );
+  }
+
+  /**
+   * Get the list of tables that refer to the CID.
+   *
+   * This is a statically maintained (in this test list).
+   *
+   * There is also a check against an automated list but having both seems to add extra stability to me. They do
+   * not change often.
+   */
+  public function getStaticCIDRefs() {
+    return array(
+      'civicrm_acl_cache' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_acl_contact_cache' => array(
+        0 => 'user_id',
+        1 => 'contact_id',
+      ),
+      'civicrm_action_log' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_activity_contact' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_address' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_batch' => array(
+        0 => 'created_id',
+        1 => 'modified_id',
+      ),
+      'civicrm_campaign' => array(
+        0 => 'created_id',
+        1 => 'last_modified_id',
+      ),
+      'civicrm_case_contact' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_contact' => array(
+        0 => 'primary_contact_id',
+        1 => 'employer_id',
+      ),
+      'civicrm_contribution' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_contribution_page' => array(
+        0 => 'created_id',
+      ),
+      'civicrm_contribution_recur' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_contribution_soft' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_custom_group' => array(
+        0 => 'created_id',
+      ),
+      'civicrm_dashboard_contact' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_dedupe_exception' => array(
+        0 => 'contact_id1',
+        1 => 'contact_id2',
+      ),
+      'civicrm_domain' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_email' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_event' => array(
+        0 => 'created_id',
+      ),
+      'civicrm_event_carts' => array(
+        0 => 'user_id',
+      ),
+      'civicrm_financial_account' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_financial_item' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_grant' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_group' => array(
+        0 => 'created_id',
+        1 => 'modified_id',
+      ),
+      'civicrm_group_contact' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_group_contact_cache' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_group_organization' => array(
+        0 => 'organization_id',
+      ),
+      'civicrm_im' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_log' => array(
+        0 => 'modified_id',
+      ),
+      'civicrm_mailing' => array(
+        0 => 'created_id',
+        1 => 'scheduled_id',
+        2 => 'approver_id',
+      ),
+      'civicrm_mailing_abtest' => array(
+        0 => 'created_id',
+      ),
+      'civicrm_mailing_event_queue' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_mailing_event_subscribe' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_mailing_recipients' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_membership' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_membership_log' => array(
+        0 => 'modified_id',
+      ),
+      'civicrm_membership_type' => array(
+        0 => 'member_of_contact_id',
+      ),
+      'civicrm_note' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_openid' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_participant' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_payment_token' => array(
+        0 => 'contact_id',
+        1 => 'created_id',
+      ),
+      'civicrm_pcp' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_phone' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_pledge' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_print_label' => array(
+        0 => 'created_id',
+      ),
+      'civicrm_relationship' => array(
+        0 => 'contact_id_a',
+        1 => 'contact_id_b',
+      ),
+      'civicrm_report_instance' => array(
+        0 => 'created_id',
+        1 => 'owner_id',
+      ),
+      'civicrm_setting' => array(
+        0 => 'contact_id',
+        1 => 'created_id',
+      ),
+      'civicrm_subscription_history' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_survey' => array(
+        0 => 'created_id',
+        1 => 'last_modified_id',
+      ),
+      'civicrm_tag' => array(
+        0 => 'created_id',
+      ),
+      'civicrm_uf_group' => array(
+        0 => 'created_id',
+      ),
+      'civicrm_uf_match' => array(
+        0 => 'contact_id',
+      ),
+      'civicrm_value_testgetcidref_1' => array(
+        0 => 'entity_id',
+      ),
+      'civicrm_website' => array(
+        0 => 'contact_id',
+      ),
+    );
+  }
+
+  /**
+   * Get a list of CIDs that is calculated off the schema.
+   *
+   * Note this is an expensive and table locking query. Should be safe in tests though.
+   */
+  public function getCalculatedCIDRefs() {
+    $cidRefs = array();
+    $sql = "
+SELECT
+    table_name,
+    column_name
+FROM information_schema.key_column_usage
+WHERE
+    referenced_table_schema = database() AND
+    referenced_table_name = 'civicrm_contact' AND
+    referenced_column_name = 'id';
+      ";
+    $dao = CRM_Core_DAO::executeQuery($sql);
+    while ($dao->fetch()) {
+      $cidRefs[$dao->table_name][] = $dao->column_name;
+    }
+    // Do specific re-ordering changes to make this the same as the ref validated one.
+    // The above query orders by FK alphabetically.
+    // There might be cleverer ways to do this but it shouldn't change much.
+    $cidRefs['civicrm_contact'][0] = 'primary_contact_id';
+    $cidRefs['civicrm_contact'][1] = 'employer_id';
+    $cidRefs['civicrm_acl_contact_cache'][0] = 'user_id';
+    $cidRefs['civicrm_acl_contact_cache'][1] = 'contact_id';
+    $cidRefs['civicrm_mailing'][0] = 'created_id';
+    $cidRefs['civicrm_mailing'][1] = 'scheduled_id';
+    $cidRefs['civicrm_mailing'][2] = 'approver_id';
+    return $cidRefs;
+  }
+
 }