Action schedule API modifications

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

diff --git a/tests/phpunit/api/v3/EntityTagTest.php b/tests/phpunit/api/v3/EntityTagTest.php
index ef387e106ebcfa7fb0fda248a82aee4f0123648f..1e6a0e77a0c9a8c91f2b0f016b7641dad85f0cd8 100644 (file)
--- a/tests/phpunit/api/v3/EntityTagTest.php
+++ b/tests/phpunit/api/v3/EntityTagTest.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.4                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2013                                |
  +--------------------------------------------------------------------+
@@ -42,60 +42,55 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
   protected $_householdID;
   protected $_organizationID;
   protected $_tagID;
-  protected $_apiversion;
+  protected $_apiversion = 3;
   protected $_tag;
+  protected $_entity = 'entity_tag';
   public $_eNoticeCompliant = TRUE;
 
   function setUp() {
     parent::setUp();
-    $this->_apiversion = 3;
 
-    $this->quickCleanup(array('civicrm_tag', 'civicrm_entity_tag'));
-
-    $this->_individualID = $this->individualCreate(NULL);
-    $this->_tag = $this->tagCreate(NULL);
+    $this->_individualID = $this->individualCreate();
+    $this->_tag = $this->tagCreate();
     $this->_tagID = $this->_tag['id'];
-    $this->_householdID = $this->houseHoldCreate(NULL);
-    $this->_organizationID = $this->organizationCreate(NULL);
+    $this->_householdID = $this->houseHoldCreate();
+    $this->_organizationID = $this->organizationCreate();
   }
 
-  function tearDown() {}
+  function tearDown() {
+    $this->quickCleanup(array('civicrm_tag', 'civicrm_entity_tag'));
+  }
 
   function testAddEmptyParams() {
-    $params = array('version' => $this->_apiversion);
-    $individualEntity = $this->callAPIFailure('entity_tag', 'create', $params);
-    $this->assertEquals($individualEntity['error_message'], 'contact_id is a required field');
+    $individualEntity = $this->callAPIFailure('entity_tag', 'create', $params = array(),
+      'contact_id is a required field'
+    );
   }
 
   function testAddWithoutTagID() {
     $params = array(
       'contact_id' => $this->_individualID,
-      'version' => $this->_apiversion,
     );
-    $individualEntity = $this->callAPIFailure('entity_tag', 'create', $params);
-    $this->assertEquals($individualEntity['error_message'], 'tag_id is a required field');
+    $individualEntity = $this->callAPIFailure('entity_tag', 'create', $params,
+      'tag_id is a required field'
+    );
   }
 
   function testAddWithoutContactID() {
     $params = array(
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
-    $individualEntity = $this->callAPIFailure('entity_tag', 'create', $params);
-    $this->assertEquals($individualEntity['error_message'], 'contact_id is a required field');
+    $individualEntity = $this->callAPIFailure('entity_tag', 'create', $params,
+      'contact_id is a required field');
   }
 
   function testContactEntityTagCreate() {
     $params = array(
       'contact_id' => $this->_individualID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
 
-    $result = civicrm_api('entity_tag', 'create', $params);
-    $this->documentMe($params, $result, __FUNCTION__, __FILE__);
-
-    $this->assertAPISuccess($result);
+    $result = $this->callAPIAndDocument('entity_tag', 'create', $params, __FUNCTION__, __FILE__);
     $this->assertEquals($result['added'], 1);
   }
 
@@ -106,55 +101,36 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
     $params         = array(
       'contact_id' => $individualId,
       'tag_id' => $tagID,
-      'version' => $this->_apiversion,
     );
 
-    $result = civicrm_api('entity_tag', 'create', $params);
+    $result = $this->callAPISuccess('entity_tag', 'create', $params);
 
-    $this->assertAPISuccess($result);
     $this->assertEquals($result['added'], 1);
 
     $params = array(
       'contact_id_i' => $individualId,
       'contact_id_o' => $organizationId,
       'tag_id' => $tagID,
-      'version' => $this->_apiversion,
     );
 
-    $result = civicrm_api('entity_tag', 'create', $params);
-    $this->assertAPISuccess($result);
+    $result = $this->callAPISuccess('entity_tag', 'create', $params);
     $this->assertEquals($result['added'], 1);
     $this->assertEquals($result['not_added'], 1);
   }
 
   ///////////////// civicrm_entity_tag_get methods
-  function testGetWrongParamsType() {
+  function testGetNoEntityID() {
     $ContactId = $this->_individualID;
     $tagID     = $this->_tagID;
     $params    = array(
       'contact_id' => $ContactId,
       'tag_id' => $tagID,
-      'version' => $this->_apiversion,
     );
 
-    $individualEntity = civicrm_api('entity_tag', 'create', $params);
-    $this->assertEquals($individualEntity['is_error'], 0);
+    $individualEntity = $this->callAPISuccess('entity_tag', 'create', $params);
     $this->assertEquals($individualEntity['added'], 1);
-
-    $paramsEntity = "wrong params";
-    $entity = civicrm_api('entity_tag', 'get', $paramsEntity);
-
-    $this->assertEquals($entity['is_error'], 1,
-      "In line " . __LINE__
-    );
-    $this->assertEquals($entity['error_message'], 'Input variable `params` is not an array');
-  }
-
-  function testIndividualEntityTagGetWithoutContactID() {
-    $paramsEntity = array('version' => $this->_apiversion);
-    $entity = $this->callAPIFailure('entity_tag', 'get', $paramsEntity);
-    $this->assertNotNull($entity['error_message']);
-    $this->assertEquals($entity['error_message'], 'Mandatory key(s) missing from params array: entity_id');
+    $result = $this->callAPISuccess($this->_entity, 'get', array('sequential' => 1, 'tag_id' => $tagID));
+    $this->assertEquals($ContactId, $result['values'][0]['entity_id']);
   }
 
   function testIndividualEntityTagGet() {
@@ -163,24 +139,15 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
     $params    = array(
       'contact_id' => $contactId,
       'tag_id' => $tagID,
-      'version' => $this->_apiversion,
     );
 
-    $individualEntity = civicrm_api('entity_tag', 'create', $params);
-    $this->assertEquals($individualEntity['is_error'], 0);
+    $individualEntity = $this->callAPIAndDocument('entity_tag', 'create', $params, __FUNCTION__, __FILE__);
     $this->assertEquals($individualEntity['added'], 1);
 
     $paramsEntity = array(
       'contact_id' => $contactId,
-      'version' => $this->_apiversion,
     );
-    $entity = civicrm_api('entity_tag', 'get', $paramsEntity);
-  }
-
-  function testHouseholdEntityGetWithoutContactID() {
-    $paramsEntity = array('version' => $this->_apiversion);
-    $entity = $this->callAPIFailure('entity_tag', 'get', $paramsEntity);
-    $this->assertNotNull($entity['error_message']);
+    $entity = $this->callAPISuccess('entity_tag', 'get', $paramsEntity);
   }
 
   function testHouseholdEntityGet() {
@@ -189,21 +156,10 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
     $params    = array(
       'contact_id' => $ContactId,
       'tag_id' => $tagID,
-      'version' => $this->_apiversion,
     );
 
-    $householdEntity = civicrm_api('entity_tag', 'create', $params);
-    $this->assertEquals($householdEntity['is_error'], 0);
+    $householdEntity = $this->callAPISuccess('entity_tag', 'create', $params);
     $this->assertEquals($householdEntity['added'], 1);
-
-    $paramsEntity = array('contact_id' => $ContactId);
-    $entity = civicrm_api('entity_tag', 'get', $paramsEntity);
-  }
-
-  function testOrganizationEntityGetWithoutContactID() {
-    $paramsEntity = array('version' => $this->_apiversion);
-    $entity = $this->callAPIFailure('entity_tag', 'get', $paramsEntity);
-    $this->assertNotNull($entity['error_message']);
   }
 
   function testOrganizationEntityGet() {
@@ -212,43 +168,39 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
     $params    = array(
       'contact_id' => $ContactId,
       'tag_id' => $tagID,
-      'version' => $this->_apiversion,
     );
 
-    $organizationEntity = civicrm_api('entity_tag', 'create', $params);
-    $this->assertEquals($organizationEntity['is_error'], 0);
+    $organizationEntity = $this->callAPISuccess('entity_tag', 'create', $params);
     $this->assertEquals($organizationEntity['added'], 1);
 
     $paramsEntity = array('contact_id' => $ContactId);
-    $entity = civicrm_api('entity_tag', 'get', $paramsEntity);
+    $entity = $this->callAPISuccess('entity_tag', 'get', $paramsEntity);
   }
 
-  ///////////////// civicrm_entity_tag_remove methods
-  function testEntityTagRemoveNoTagId() {
+  ///////////////// civicrm_entity_tag_Delete methods
+  function testEntityTagDeleteNoTagId() {
     $entityTagParams = array(
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
     $this->entityTagAdd($entityTagParams);
 
     $params = array(
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
-      'version' => $this->_apiversion,
     );
 
-    $result = $this->callAPIFailure('entity_tag', 'delete', $params);
-    $this->assertEquals($result['error_message'], 'tag_id is a required field');
+    $result = $this->callAPIFailure('entity_tag', 'delete', $params,
+      'tag_id is a required field'
+    );
   }
 
-  function testEntityTagRemoveINDHH() {
+  function testEntityTagDeleteINDHH() {
     $entityTagParams = array(
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
     $this->entityTagAdd($entityTagParams);
 
@@ -256,12 +208,10 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
 
-    $result = civicrm_api('entity_tag', 'delete', $params);
+    $result = $this->callAPISuccess('entity_tag', 'delete', $params);
 
-    $this->assertAPISuccess($result);
     $this->assertEquals($result['removed'], 2);
   }
 
@@ -270,27 +220,23 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
     $this->entityTagAdd($entityTagParams);
 
     $params = array(
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
 
-    $result = civicrm_api('entity_tag', 'delete', $params);
-    $this->documentMe($params, $result, __FUNCTION__, __FILE__);
+    $result = $this->callAPIAndDocument('entity_tag', 'delete', $params, __FUNCTION__, __FILE__);
     $this->assertEquals($result['removed'], 1);
   }
 
-  function testEntityTagRemoveHHORG() {
+  function testEntityTagDeleteHHORG() {
     $entityTagParams = array(
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
     $this->entityTagAdd($entityTagParams);
 
@@ -298,123 +244,31 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
       'contact_id_h' => $this->_householdID,
       'contact_id_o' => $this->_organizationID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
 
-    $result = civicrm_api('entity_tag', 'delete', $params);
+    $result = $this->callAPISuccess('entity_tag', 'delete', $params);
     $this->assertEquals($result['removed'], 1);
     $this->assertEquals($result['not_removed'], 1);
   }
 
-  ///////////////// civicrm_entity_tag_display methods
-  function testEntityTagDisplayWithContactId() {
-    $entityTagParams = array(
-      'contact_id' => $this->_individualID,
-      'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
-    );
-    $this->entityTagAdd($entityTagParams);
-
-    $params = array(
-      'contact_id' => $this->_individualID,
-      'version' => $this->_apiversion,
-    );
-
-    $result = civicrm_api3_entity_tag_display($params);
-    $this->assertEquals($this->_tag['values'][$this->_tag['id']]['name'], $result);
-  }
-
   ///////////////// civicrm_tag_entities_get methods
 
-
-
-  ///////////////// civicrm_entity_tag_common methods
-  function testCommonAddEmptyParams() {
-    $params = array(
-      'version' => $this->_apiversion,
-    );
-    $individualEntity = _civicrm_api3_entity_tag_common($params, 'add');
-    $this->assertEquals($individualEntity['is_error'], 1);
-    $this->assertEquals($individualEntity['error_message'], 'contact_id is a required field');
-  }
-
-  function testCommonAddWithoutTagID() {
-    $params = array(
-      'contact_id' => $this->_individualID,
-      'version' => $this->_apiversion,
-    );
-    $individualEntity = _civicrm_api3_entity_tag_common($params, 'add');
-    $this->assertEquals($individualEntity['is_error'], 1);
-    $this->assertEquals($individualEntity['error_message'], 'tag_id is a required field');
-  }
-
-  function testCommonAddWithoutContactID() {
-    $params = array(
-      'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
-    );
-    $individualEntity = _civicrm_api3_entity_tag_common($params, 'add');
-    $this->assertEquals($individualEntity['is_error'], 1);
-    $this->assertEquals($individualEntity['error_message'], 'contact_id is a required field');
-  }
-
   function testCommonContactEntityTagAdd() {
     $params = array(
       'contact_id' => $this->_individualID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
 
-    $individualEntity = _civicrm_api3_entity_tag_common($params, 'add');
-    $this->assertEquals($individualEntity['is_error'], 0);
+    $individualEntity = $this->callAPISuccess('entity_tag', 'create', $params);
     $this->assertEquals($individualEntity['added'], 1);
   }
 
-  function testEntityTagCommonRemoveNoContactId() {
-    $entityTagParams = array(
-      'contact_id_i' => $this->_individualID,
-      'contact_id_h' => $this->_householdID,
-      'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
-    );
-    $this->entityTagAdd($entityTagParams);
 
-    $params = array(
-      'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
-    );
-
-    $result = _civicrm_api3_entity_tag_common($params, 'remove');
-    $this->assertAPIFailure($result);
-    $this->assertEquals($result['error_message'], 'contact_id is a required field');
-  }
-
-  function testEntityTagCommonRemoveNoTagId() {
-    $entityTagParams = array(
-      'contact_id_i' => $this->_individualID,
-      'contact_id_h' => $this->_householdID,
-      'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
-    );
-    $this->entityTagAdd($entityTagParams);
-
-    $params = array(
-      'contact_id_i' => $this->_individualID,
-      'contact_id_h' => $this->_householdID,
-      'version' => $this->_apiversion,
-    );
-
-    $result = _civicrm_api3_entity_tag_common($params, 'remove');
-    $this->assertAPIFailure($result);
-    $this->assertEquals($result['error_message'], 'tag_id is a required field');
-  }
-
-  function testEntityTagCommonRemoveINDHH() {
+  function testEntityTagCommonDeleteINDHH() {
     $entityTagParams = array(
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
     $this->entityTagAdd($entityTagParams);
 
@@ -422,40 +276,34 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
 
-    $result = _civicrm_api3_entity_tag_common($params, 'remove');
-
-    $this->assertAPISuccess($result);
+    $result = $this->callAPISuccess('entity_tag', 'delete', $params);
     $this->assertEquals($result['removed'], 2);
   }
 
-  function testEntityTagCommonRemoveHH() {
+  function testEntityTagCommonDeleteHH() {
     $entityTagParams = array(
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
     $this->entityTagAdd($entityTagParams);
 
     $params = array(
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
 
-    $result = _civicrm_api3_entity_tag_common($params, 'remove');
+    $result = $this->callAPISuccess('entity_tag', 'delete', $params);
     $this->assertEquals($result['removed'], 1);
   }
 
-  function testEntityTagCommonRemoveHHORG() {
+  function testEntityTagCommonDeleteHHORG() {
     $entityTagParams = array(
       'contact_id_i' => $this->_individualID,
       'contact_id_h' => $this->_householdID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
     $this->entityTagAdd($entityTagParams);
 
@@ -463,10 +311,9 @@ class api_v3_EntityTagTest extends CiviUnitTestCase {
       'contact_id_h' => $this->_householdID,
       'contact_id_o' => $this->_organizationID,
       'tag_id' => $this->_tagID,
-      'version' => $this->_apiversion,
     );
 
-    $result = _civicrm_api3_entity_tag_common($params, 'remove');
+    $result = $this->callAPISuccess('entity_tag', 'delete', $params);
     $this->assertEquals($result['removed'], 1);
     $this->assertEquals($result['not_removed'], 1);
   }