tests/phpunit/api/v3/TagTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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 /**
  32  *  Test APIv3 civicrm_tag_* functions
  33  *
  34  * @package CiviCRM_APIv3
  35  * @subpackage API_Core
  36  */
  37 class api_v3_TagTest extends CiviUnitTestCase {
  38   protected $_apiversion = 3;
  39   /**
  40    * @ids array of values to be cleaned up in the tear down
  41    */
  42   protected $ids = array();
  43   /**
  44    * Tag id.
  45    * @var integer
  46    */
  47   protected $tag = array();
  48
  49   protected $tagID;
  50
  51   public function setUp() {
  52     parent::setUp();
  53     $this->useTransaction(TRUE);
  54     $this->tag = $this->tagCreate();
  55     $this->ids['tag'][] = $this->tagID = $this->tag['id'];
  56   }
  57
  58   ///////////////// civicrm_tag_get methods
  59   /**
  60    * Test civicrm_tag_get with wrong params.
  61    */
  62   public function testGetWrongParams() {
  63     $params = array('name' => 'Wrong Tag Name');
  64     $result = $this->callAPISuccess('tag', 'get', $params);
  65     $this->assertEquals(0, $result['count']);
  66   }
  67
  68   /**
  69    * Test civicrm_tag_get - success expected.
  70    */
  71   public function testGet() {
  72     $params = array(
  73       'id' => $this->tagID,
  74       'name' => $this->tag['name'],
  75     );
  76     $result = $this->callAPIAndDocument('tag', 'get', $params, __FUNCTION__, __FILE__);
  77     $this->assertEquals($this->tag['description'], $result['values'][$this->tagID]['description']);
  78     $this->assertEquals($this->tag['name'], $result['values'][$this->tagID]['name']);
  79   }
  80
  81   /**
  82    * Test civicrm_tag_get - success expected.
  83    */
  84   public function testGetReturnArray() {
  85     $description = "Demonstrates use of Return as an array.";
  86     $subfile = "GetReturnArray";
  87
  88     $params = array(
  89       'id' => $this->tagID,
  90       'name' => $this->tag['name'],
  91       'return' => array('name'),
  92     );
  93     $result = $this->callAPIAndDocument('tag', 'get', $params, __FUNCTION__, __FILE__, $description, $subfile);
  94     $this->assertTrue(empty($result['values'][$this->tagID]['description']));
  95     $this->assertEquals($this->tag['name'], $result['values'][$this->tagID]['name']);
  96   }
  97
  98   ///////////////// civicrm_tag_create methods
  99
 100   /**
 101    * Test civicrm_tag_create with empty params.
 102    */
 103   public function testCreateEmptyParams() {
 104     $result = $this->callAPIFailure('tag', 'create', array(), 'Mandatory key(s) missing from params array: name');
 105   }
 106
 107   /**
 108    * Test civicrm_tag_create.
 109    */
 110   public function testCreatePasstagInParams() {
 111     $params = array(
 112       'tag' => 10,
 113       'name' => 'New Tag23',
 114       'description' => 'This is description for New Tag 02',
 115     );
 116     $result = $this->callAPISuccess('tag', 'create', $params);
 117     $this->assertEquals(10, $result['id']);
 118   }
 119
 120   /**
 121    * Test civicrm_tag_create - success expected.
 122    */
 123   public function testCreate() {
 124     $params = array(
 125       'name' => 'Super Heros',
 126       'description' => 'Outside undie-wearers',
 127     );
 128     $result = $this->callAPIAndDocument('tag', 'create', $params, __FUNCTION__, __FILE__);
 129     $this->assertNotNull($result['id']);
 130     $params['used_for'] = 'civicrm_contact';
 131     $this->getAndCheck($params, $result['id'], 'tag');
 132   }
 133
 134   /**
 135    * Test civicrm_tag_create activity tag- success expected.
 136    *
 137    * Test checks that used_for is set and not over-written by default on update.
 138    */
 139   public function testCreateEntitySpecificTag() {
 140     $params = array(
 141       'name' => 'New Tag4',
 142       'description' => 'This is description for New Activity tag',
 143       'used_for' => 'civicrm_activity',
 144     );
 145     $result = $this->callAPISuccess('tag', 'create', $params);
 146     $this->callAPISuccess('tag', 'get', array());
 147     $this->getAndCheck($params, $result['id'], 'tag', 0, __FUNCTION__ . ' tag first created');
 148     unset($params['used_for']);
 149     $params['id'] = $result['id'];
 150     $result = $this->callAPISuccess('tag', 'create', $params);
 151     $params['used_for'] = 'civicrm_activity';
 152     $this->getAndCheck($params, $result['id'], 'tag', 1, __FUNCTION__ . ' tag updated in line ' . __LINE__);
 153   }
 154   ///////////////// civicrm_tag_delete methods
 155
 156   /**
 157    * Test civicrm_tag_delete without tag id.
 158    */
 159   public function testDeleteWithoutTagId() {
 160     $result = $this->callAPIFailure('tag', 'delete', array(), 'Mandatory key(s) missing from params array: id');
 161   }
 162
 163   /**
 164    * Test civicrm_tag_delete .
 165    */
 166   public function testTagDeleteOldSyntax() {
 167     $params = array(
 168       'tag_id' => $this->tagID,
 169     );
 170     $result = $this->callAPISuccess('tag', 'delete', $params);
 171     unset($this->ids['tag']);
 172   }
 173
 174   /**
 175    * Test civicrm_tag_delete = $params['id'] is correct
 176    */
 177   public function testTagDeleteCorrectSyntax() {
 178     $params = array(
 179       'id' => $this->tagID,
 180     );
 181     $result = $this->callAPIAndDocument('tag', 'delete', $params, __FUNCTION__, __FILE__);
 182     unset($this->ids['tag']);
 183   }
 184
 185   public function testTagGetfields() {
 186     $description = "Demonstrate use of getfields to interrogate api.";
 187     $params = array('action' => 'create');
 188     $result = $this->callAPIAndDocument('tag', 'getfields', $params, __FUNCTION__, __FILE__, $description, NULL);
 189     $this->assertEquals('civicrm_contact', $result['values']['used_for']['api.default']);
 190   }
 191
 192   public function testTagGetList() {
 193     $description = "Demonstrates use of api.getlist for autocomplete and quicksearch applications.";
 194     $params = array(
 195       'input' => $this->tag['name'],
 196       'extra' => array('used_for'),
 197     );
 198     $result = $this->callAPIAndDocument('tag', 'getlist', $params, __FUNCTION__, __FILE__, $description);
 199     $this->assertEquals($this->tag['id'], $result['values'][0]['id']);
 200     $this->assertEquals($this->tag['description'], $result['values'][0]['description'][0]);
 201     $this->assertEquals($this->tag['used_for'], $result['values'][0]['extra']['used_for']);
 202   }
 203
 204 }