Merge pull request #11735 from mukeshcompucorp/CRM-21814-add-proper-container-to...

[civicrm-core.git] / tests / phpunit / api / v3 / GroupTest.php

diff --git a/tests/phpunit/api/v3/GroupTest.php b/tests/phpunit/api/v3/GroupTest.php
index 1860085cc6f4663a677f7b7cd757ce4790a921d6..98e975d506613644bbc64399d55e1df5c7e98ea3 100644 (file)
--- a/tests/phpunit/api/v3/GroupTest.php
+++ b/tests/phpunit/api/v3/GroupTest.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2017                                |
+ | Copyright CiviCRM LLC (c) 2004-2018                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -32,22 +32,33 @@
  * @group headless
  */
 class api_v3_GroupTest extends CiviUnitTestCase {
-  protected $_apiversion;
+  protected $_apiversion = 3;
   protected $_groupID;
 
+  /**
+   * Set up for tests.
+   */
   public function setUp() {
-    $this->_apiversion = 3;
-
     parent::setUp();
     $this->_groupID = $this->groupCreate();
+    $config = CRM_Core_Config::singleton();
+    $config->userPermissionClass->permissions = array();
   }
 
+  /**
+   * Clean up after test.
+   */
   public function tearDown() {
-
     $this->groupDelete($this->_groupID);
+    CRM_Utils_Hook::singleton()->reset();
+    $config = CRM_Core_Config::singleton();
+    unset($config->userPermissionClass->permissions);
   }
 
-  public function testgroupCreateNoTitle() {
+  /**
+   * Test missing required title parameter results in an error.
+   */
+  public function testGroupCreateNoTitle() {
     $params = array(
       'name' => 'Test Group No title ',
       'domain_id' => 1,
@@ -60,12 +71,12 @@ class api_v3_GroupTest extends CiviUnitTestCase {
       ),
     );
 
-    $group = $this->callAPIFailure('group', 'create', $params, 'Mandatory key(s) missing from params array: title');
+    $this->callAPIFailure('group', 'create', $params, 'Mandatory key(s) missing from params array: title');
   }
 
 
   public function testGetGroupWithEmptyParams() {
-    $group = $this->callAPISuccess('group', 'get', $params = array());
+    $group = $this->callAPISuccess('group', 'get', array());
 
     $group = $group["values"];
     $this->assertNotNull(count($group));
@@ -139,7 +150,7 @@ class api_v3_GroupTest extends CiviUnitTestCase {
       //check for empty parent
       'parents' => "",
       'visibility' => 'Public Pages',
-      'group_type' => array(1, 2),
+      'group_type' => [1, 2],
     );
 
     $result = $this->callAPISuccess('Group', 'create', $params);
@@ -167,12 +178,47 @@ class api_v3_GroupTest extends CiviUnitTestCase {
         'title' => 'Test Group 2',
         'group_type' => 2,
         'parents' => $result['id'],
+        'sequential' => 1,
       )
     );
-    $result = $this->callAPISuccess('Group', 'create', $params);
-    $group = $result["values"][$result['id']];
-    $this->assertEquals($group['group_type'], array($params['group_type']));
-    $this->assertEquals($group['parents'], $params['parents']);
+    $group2 = $this->callAPISuccess('Group', 'create', $params)['values'][0];
+
+    $this->assertEquals($group2['group_type'], array($params['group_type']));
+    $this->assertEquals($params['parents'], $group2['parents']);
+
+    // Test array format for parents.
+    $params = array_merge($params, array(
+        'name' => 'Test Group 3',
+        'title' => 'Test Group 3',
+        'parents' => [$result['id'], $group2['id']],
+      )
+    );
+    $group3 = $this->callAPISuccess('Group', 'create', $params)['values'][0];
+    $parents = $this->callAPISuccess('Group', 'getvalue', ['return' => 'parents', 'id' => $group3['id']]);
+
+    $this->assertAPIArrayComparison("{$result['id']},{$group2['id']}", $parents);
+
+    $groupNesting = $this->callAPISuccess('GroupNesting', 'get', ['child_group_id' => $group3['id']]);
+    // 2 Group nesting entries - one for direct parent & one for grandparent.
+    $this->assertEquals(2, $groupNesting['count']);
+    $this->groupDelete($group2['id']);
+    $this->groupDelete($group3['id']);
+  }
+
+  /**
+   * Test that an array of valid values works for group_type field.
+   */
+  public function testGroupTypeWithPseudoconstantArray() {
+    $params = [
+      'name' => 'Test Group 2',
+      'title' => 'Test Group 2',
+      'group_type' => ['Mailing List', 'Access Control'],
+      'sequential' => 1,
+    ];
+    $group = $this->callAPISuccess('Group', 'create', $params);
+    $groupType = $this->callAPISuccess('Group', 'getvalue', ['return' => 'group_type', 'id' => $group['id']]);
+
+    $this->assertAPIArrayComparison([2, 1], $groupType);
   }
 
   public function testGetNonExistingGroup() {
@@ -213,10 +259,35 @@ class api_v3_GroupTest extends CiviUnitTestCase {
     $params['parents'] = array();
     $params['parents'][$this->_groupID] = 'test Group';
     $params['parents']["(SELECT api_key FROM civicrm_contact where id = 1)"] = "Test";
-    $group2 = $this->callAPIFailure('group', 'create', $params);
+    $this->callAPIFailure('group', 'create', $params);
     unset($params['parents']["(SELECT api_key FROM civicrm_contact where id = 1)"]);
-    $group2 = $this->callAPISuccess('group', 'create', $params);
-    $this->assertEquals(count($group2['values'][$group2['id']]['parents']), 1);
+    $this->callAPIFailure('group', 'create', $params, '\'test Group\' is not a valid option for field parents');
+  }
+
+  /**
+   * Test that ACLs are applied to group.get calls.
+   */
+  public function testGroupGetACLs() {
+    $this->createLoggedInUser();
+    CRM_Core_Config::singleton()->userPermissionClass->permissions = array('access CiviCRM');
+    $this->callAPISuccessGetCount('Group', array('check_permissions' => 1), 0);
+    $this->hookClass->setHook('civicrm_aclGroup', array($this, 'aclGroupAllGroups'));
+    unset(Civi::$statics['CRM_ACL_API']['group_permission']);
+    $this->callAPISuccessGetCount('Group', array('check_permissions' => 1), 1);
+  }
+
+  /**
+   * Implement hook to restrict to test group 1.
+   *
+   * @param string $type
+   * @param int $contactID
+   * @param string $tableName
+   * @param array $allGroups
+   * @param array $ids
+   */
+  public function aclGroupAllGroups($type, $contactID, $tableName, $allGroups, &$ids) {
+    $group = $this->callAPISuccess('Group', 'get', array('name' => 'Test Group 1'));
+    $ids = array_keys($group['values']);
   }
 
 }