tests/phpunit/api/v3/TagTest.php

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