tests/phpunit/api/v3/GroupTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 require_once 'CiviTest/CiviUnitTestCase.php';
  29
  30 /**
  31  * Test class for Group API - civicrm_group_*
  32  *
  33  *  @package CiviCRM_APIv3
  34  */
  35
  36 class api_v3_GroupTest extends CiviUnitTestCase {
  37   protected $_apiversion;
  38   protected $_groupID;
  39
  40   function setUp() {
  41     $this->_apiversion = 3;
  42
  43     parent::setUp();
  44     $this->_groupID = $this->groupCreate();
  45   }
  46
  47   function tearDown() {
  48
  49     $this->groupDelete($this->_groupID);
  50   }
  51
  52   function testgroupCreateNoTitle() {
  53     $params = array(
  54       'name' => 'Test Group No title ',
  55       'domain_id' => 1,
  56       'description' => 'New Test Group Created',
  57       'is_active' => 1,
  58       'visibility' => 'Public Pages',
  59       'group_type' => array(
  60         '1' => 1,
  61         '2' => 1,
  62       ),
  63     );
  64
  65     $group = $this->callAPIFailure('group', 'create', $params, 'Mandatory key(s) missing from params array: title');
  66   }
  67
  68
  69   function testGetGroupWithEmptyParams() {
  70     $group = $this->callAPISuccess('group', 'get', $params = array());
  71
  72     $group = $group["values"];
  73     $this->assertNotNull(count($group));
  74     $this->assertEquals($group[$this->_groupID]['name'], "Test Group 1");
  75     $this->assertEquals($group[$this->_groupID]['is_active'], 1);
  76     $this->assertEquals($group[$this->_groupID]['visibility'], 'Public Pages');
  77   }
  78
  79   function testGetGroupParamsWithGroupId() {
  80     $params = array('id' => $this->_groupID);
  81     $group = $this->callAPISuccess('group', 'get', $params);
  82
  83     foreach ($group['values'] as $v) {
  84       $this->assertEquals($v['name'], "Test Group 1");
  85       $this->assertEquals($v['title'], 'New Test Group Created');
  86       $this->assertEquals($v['description'], 'New Test Group Created');
  87       $this->assertEquals($v['is_active'], 1);
  88       $this->assertEquals($v['visibility'], 'Public Pages');
  89     }
  90   }
  91
  92   function testGetGroupParamsWithGroupName() {
  93     $params = array(
  94       'name' => "Test Group 1",
  95     );
  96     $group = $this->callAPIAndDocument('group', 'get', $params, __FUNCTION__, __FILE__);
  97     $group = $group['values'];
  98
  99     foreach ($group as $v) {
 100       $this->assertEquals($v['id'], $this->_groupID);
 101       $this->assertEquals($v['title'], 'New Test Group Created');
 102       $this->assertEquals($v['description'], 'New Test Group Created');
 103       $this->assertEquals($v['is_active'], 1);
 104       $this->assertEquals($v['visibility'], 'Public Pages');
 105     }
 106   }
 107
 108   function testGetGroupParamsWithReturnName() {
 109     $params = array();
 110     $params['id'] = $this->_groupID;
 111     $params['return.name'] = 1;
 112     $group = $this->callAPISuccess('group', 'get', $params);
 113     $this->assertEquals($group['values'][$this->_groupID]['name'],
 114       "Test Group 1"
 115     );
 116   }
 117
 118   function testGetGroupParamsWithGroupTitle() {
 119     $params = array();
 120     $params['title'] = 'New Test Group Created';
 121     $group = $this->callAPISuccess('group', 'get', $params);
 122
 123     foreach ($group['values'] as $v) {
 124       $this->assertEquals($v['id'], $this->_groupID);
 125       $this->assertEquals($v['name'], "Test Group 1");
 126       $this->assertEquals($v['description'], 'New Test Group Created');
 127       $this->assertEquals($v['is_active'], 1);
 128       $this->assertEquals($v['visibility'], 'Public Pages');
 129     }
 130   }
 131
 132   function testGetNonExistingGroup() {
 133     $params = array();
 134     $params['title'] = 'No such group Exist';
 135     $group = $this->callAPISuccess('group', 'get', $params);
 136     $this->assertEquals(0, $group['count']);
 137   }
 138
 139   function testgroupdeleteParamsnoId() {
 140     $group = $this->callAPIFailure('group', 'delete', array(), 'Mandatory key(s) missing from params array: id');
 141   }
 142
 143   function testgetfields() {
 144     $description = "demonstrate use of getfields to interrogate api";
 145     $params = array('action' => 'create');
 146     $result = $this->callAPIAndDocument('group', 'getfields', $params, __FUNCTION__, __FILE__, $description, 'getfields', 'getfields');
 147     $this->assertEquals(1, $result['values']['is_active']['api.default']);
 148   }
 149 }
 150