From: Tim Otten <totten@civicrm.org>
Date: Tue, 26 Mar 2013 04:07:16 +0000 (-0400)
Subject: CRM-12146 - Add test case for Group.get(group_id=>1) and Contact.get(contact_id=>1).
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=afb0ff51bd94657c346c860e4b2f040c2d4c9ae3;p=civicrm-core.git

CRM-12146 - Add test case for Group.get(group_id=>1) and Contact.get(contact_id=>1).

I tried inspecting the DAO_*::fields() metadata to determine which entities
and field names to test.  This can be done (if you see that the array-keys
are unique-names and the 'name' properties ar enon-unique-names), but it
doesn't ultimately help because the XML schema for group doesn't officially
list group_id as a unique-name.  I'm nervous that changing that schema would
have unintended consequences, so...  this patch uses a more conservative
approach (whitelisting/hardcoding certain entities/unique-names).
---

diff --git a/tests/phpunit/api/v3/SyntaxConformanceAllEntitiesTest.php b/tests/phpunit/api/v3/SyntaxConformanceAllEntitiesTest.php
index 8950ef35e9..c7c8652d80 100644
--- a/tests/phpunit/api/v3/SyntaxConformanceAllEntitiesTest.php
+++ b/tests/phpunit/api/v3/SyntaxConformanceAllEntitiesTest.php
@@ -43,10 +43,12 @@ class api_v3_SyntaxConformanceAllEntitiesTest extends CiviUnitTestCase {
    */
   protected $deletableTestObjects;
 
-  /* This test case doesn't require DB reset */
-
-
+  /**
+   * @var array ($entityName => $fieldName) where $fieldName is expected as an alias for 'id'
+   */
+  protected $idAliasFields;
 
+  /** This test case doesn't require DB reset */
   public $DBResetRequired = FALSE;
 
   /* they are two types of missing APIs:
@@ -63,6 +65,7 @@ class api_v3_SyntaxConformanceAllEntitiesTest extends CiviUnitTestCase {
     $this->toBeImplemented['delete'] = array('MembershipPayment', 'OptionGroup', 'SurveyRespondant', 'UFJoin', 'UFMatch', 'Extension', 'LocationType', 'System');
     $this->onlyIDNonZeroCount['get'] = array('ActivityType', 'Entity', 'Domain','Setting');
     $this->deprecatedAPI = array('Location', 'ActivityType', 'SurveyRespondant');
+    $this->idAliasFields = array('Group' => 'group_id', 'Contact' => 'contact_id');
     $this->deletableTestObjects = array();
   }
 
@@ -458,7 +461,58 @@ class api_v3_SyntaxConformanceAllEntitiesTest extends CiviUnitTestCase {
     $this->assertEquals(1, count($result['values']));
   }
 
-    /**
+  /**
+   * Create two entities and make sure we can fetch them individually by ID (e.g. using "contact_id=>2"
+   * or "group_id=>4")
+   *
+   * @dataProvider entities_get
+   *
+   * limitations include the problem with avoiding loops when creating test objects -
+   * hence FKs only set by createTestObject when required. e.g parent_id on campaign is not being followed through
+   * Currency - only seems to support US
+   */
+  public function testByIDAlias_get($entityName) {
+    if (in_array($entityName, self::toBeSkipped_automock(TRUE)) || empty($this->idAliasFields[$entityName])) {
+      // $this->markTestIncomplete("civicrm_api3_{$Entity}_create to be implemented");
+      return;
+    }
+
+    $baoString = _civicrm_api3_get_DAO($entityName);
+    if (empty($baoString)) {
+      $this->markTestIncomplete("Entity [$entityName] cannot be mocked - no known DAO");
+      return;
+    }
+
+    // create entities
+    $baoObj1 = CRM_Core_DAO::createTestObject($baoString, array('currency' => 'USD'));
+    $this->assertTrue(is_integer($baoObj1->id), 'check first id');
+    $this->deletableTestObjects[$baoString][] = $baoObj1->id;
+    $baoObj2 = CRM_Core_DAO::createTestObject($baoString, array('currency' => 'USD'));
+    $this->assertTrue(is_integer($baoObj2->id), 'check second id');
+    $this->deletableTestObjects[$baoString][] = $baoObj2->id;
+
+    // fetch first by ID
+    $result = civicrm_api($entityName, 'get', array(
+      'version' => 3,
+      $this->idAliasFields[$entityName] => $baoObj1->id,
+    ));
+    $this->assertAPISuccess($result);
+    $this->assertTrue(!empty($result['values'][$baoObj1->id]), 'Should find first object by id');
+    $this->assertEquals($baoObj1->id, $result['values'][$baoObj1->id]['id'], 'Should find id on first object');
+    $this->assertEquals(1, count($result['values']));
+
+    // fetch second by ID
+    $result = civicrm_api($entityName, 'get', array(
+      'version' => 3,
+      $this->idAliasFields[$entityName] => $baoObj2->id,
+    ));
+    $this->assertAPISuccess($result);
+    $this->assertTrue(!empty($result['values'][$baoObj2->id]), 'Should find second object by id');
+    $this->assertEquals($baoObj2->id, $result['values'][$baoObj2->id]['id'], 'Should find id on second object');
+    $this->assertEquals(1, count($result['values']));
+  }
+
+  /**
    * @dataProvider entities_get
    */
   public function testNonExistantID_get($Entity) {