tests/phpunit/api/v3/NoteTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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  * Class contains api test cases for "civicrm_note"
  30  * @group headless
  31  */
  32 class api_v3_NoteTest extends CiviUnitTestCase {
  33
  34   protected $_apiversion;
  35   protected $_contactID;
  36   protected $_params;
  37   protected $_noteID;
  38   protected $_note;
  39
  40   public function setUp() {
  41
  42     $this->_apiversion = 3;
  43     // Connect to the database.
  44     parent::setUp();
  45     $this->useTransaction(TRUE);
  46
  47     $this->_contactID = $this->organizationCreate(NULL);
  48
  49     $this->_params = array(
  50       'entity_table' => 'civicrm_contact',
  51       'entity_id' => $this->_contactID,
  52       'note' => 'Hello!!! m testing Note',
  53       'contact_id' => $this->_contactID,
  54       'modified_date' => '2011-01-31',
  55       'subject' => 'Test Note',
  56     );
  57     $this->_note = $this->noteCreate($this->_contactID);
  58     $this->_noteID = $this->_note['id'];
  59   }
  60
  61   ///////////////// civicrm_note_get methods
  62
  63   /**
  64    * Check retrieve note with empty parameter array.
  65    *
  66    * Error expected
  67    */
  68   public function testGetWithEmptyParams() {
  69     $this->callAPISuccess('note', 'get', array());
  70   }
  71
  72   /**
  73    * Check retrieve note with missing parameters.
  74    *
  75    * Error expected
  76    */
  77   public function testGetWithoutEntityId() {
  78     $params = array(
  79       'entity_table' => 'civicrm_contact',
  80     );
  81     $this->callAPISuccess('note', 'get', $params);
  82   }
  83
  84   /**
  85    * Check civicrm_note get.
  86    */
  87   public function testGet() {
  88     $entityId = $this->_noteID;
  89     $params = array(
  90       'entity_table' => 'civicrm_contact',
  91       'entity_id' => $entityId,
  92     );
  93     $this->callAPIAndDocument('note', 'get', $params, __FUNCTION__, __FILE__);
  94   }
  95
  96   /**
  97    * Check create with empty parameter array.
  98    *
  99    * Error Expected
 100    */
 101   public function testCreateWithEmptyNoteField() {
 102     $this->_params['note'] = "";
 103     $this->callAPIFailure('note', 'create', $this->_params,
 104       'Mandatory key(s) missing from params array: note'
 105     );
 106   }
 107
 108   /**
 109    * Check create with partial params.
 110    *
 111    * Error expected
 112    */
 113   public function testCreateWithoutEntityId() {
 114     unset($this->_params['entity_id']);
 115     $this->callAPIFailure('note', 'create', $this->_params,
 116       'Mandatory key(s) missing from params array: entity_id');
 117   }
 118
 119   /**
 120    * Check create with partially empty params.
 121    *
 122    * Error expected
 123    */
 124   public function testCreateWithEmptyEntityId() {
 125     $this->_params['entity_id'] = "";
 126     $this->callAPIFailure('note', 'create', $this->_params,
 127       'Mandatory key(s) missing from params array: entity_id');
 128   }
 129
 130   /**
 131    * Check civicrm note create.
 132    */
 133   public function testCreate() {
 134
 135     $result = $this->callAPIAndDocument('note', 'create', $this->_params, __FUNCTION__, __FILE__);
 136     $this->assertEquals($result['values'][$result['id']]['note'], 'Hello!!! m testing Note');
 137     $this->assertEquals(date('Y-m-d', strtotime($this->_params['modified_date'])), date('Y-m-d', strtotime($result['values'][$result['id']]['modified_date'])));
 138
 139     $this->assertArrayHasKey('id', $result);
 140     $note = array(
 141       'id' => $result['id'],
 142     );
 143     $this->noteDelete($note);
 144   }
 145
 146   public function testCreateWithApostropheInString() {
 147     $params = array(
 148       'entity_table' => 'civicrm_contact',
 149       'entity_id' => $this->_contactID,
 150       'note' => "Hello!!! ' testing Note",
 151       'contact_id' => $this->_contactID,
 152       'modified_date' => '2011-01-31',
 153       'subject' => "With a '",
 154       'sequential' => 1,
 155     );
 156     $result = $this->callAPISuccess('Note', 'Create', $params);
 157     $this->assertAPISuccess($result);
 158     $this->assertEquals($result['values'][0]['note'], "Hello!!! ' testing Note");
 159     $this->assertEquals($result['values'][0]['subject'], "With a '");
 160     $this->assertArrayHasKey('id', $result);
 161
 162     //CleanUP
 163     $note = array(
 164       'id' => $result['id'],
 165     );
 166     $this->noteDelete($note);
 167   }
 168
 169   /**
 170    * Check civicrm_note_create - tests used of default set to .
 171    */
 172   public function testCreateWithoutModifiedDate() {
 173     unset($this->_params['modified_date']);
 174     $apiResult = $this->callAPISuccess('note', 'create', $this->_params);
 175     $this->assertAPISuccess($apiResult);
 176     $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($apiResult['values'][$apiResult['id']]['modified_date'])));
 177     $this->noteDelete(array(
 178       'id' => $apiResult['id'],
 179     ));
 180   }
 181
 182   /**
 183    * Check update with empty parameter array.
 184    *
 185    * Please don't copy & paste this - is of marginal value
 186    * better to put time into the function on Syntax Conformance class that tests this
 187    */
 188   public function testUpdateWithEmptyParams() {
 189     $this->callAPIFailure('note', 'create', array());
 190   }
 191
 192   /**
 193    * Check update with missing parameter (contact id).
 194    *
 195    * Error expected
 196    */
 197   public function testUpdateWithoutContactId() {
 198     $params = array(
 199       'entity_id' => $this->_contactID,
 200       'entity_table' => 'civicrm_contact',
 201     );
 202     $this->callAPIFailure('note', 'create', $params,
 203       'Mandatory key(s) missing from params array: note'
 204     );
 205   }
 206
 207   /**
 208    * Check civicrm_note update.
 209    */
 210   public function testUpdate() {
 211     $params = array(
 212       'id' => $this->_noteID,
 213       'contact_id' => $this->_contactID,
 214       'note' => 'Note1',
 215       'subject' => 'Hello World',
 216     );
 217
 218     // Update Note.
 219     $this->callAPISuccess('note', 'create', $params);
 220     $note = $this->callAPISuccess('Note', 'Get', array());
 221     $this->assertEquals($note['id'], $this->_noteID);
 222     $this->assertEquals($note['values'][$this->_noteID]['entity_id'], $this->_contactID);
 223     $this->assertEquals($note['values'][$this->_noteID]['entity_table'], 'civicrm_contact');
 224     $this->assertEquals('Hello World', $note['values'][$this->_noteID]['subject']);
 225     $this->assertEquals('Note1', $note['values'][$this->_noteID]['note']);
 226   }
 227
 228   /**
 229    * Check delete with empty parameters array.
 230    *
 231    * Error expected.
 232    */
 233   public function testDeleteWithEmptyParams() {
 234     $this->callAPIFailure('note', 'delete', array(), 'Mandatory key(s) missing from params array: id');
 235   }
 236
 237   /**
 238    * Check delete with wrong id.
 239    *
 240    * Error expected
 241    */
 242   public function testDeleteWithWrongID() {
 243     $params = array(
 244       'id' => 99999,
 245     );
 246     $this->callAPIFailure('note', 'delete', $params, 'Error while deleting Note');
 247   }
 248
 249   /**
 250    * Check civicrm_note delete.
 251    */
 252   public function testDelete() {
 253     $additionalNote = $this->noteCreate($this->_contactID);
 254
 255     $params = array(
 256       'id' => $additionalNote['id'],
 257     );
 258
 259     $this->callAPIAndDocument('note', 'delete', $params, __FUNCTION__, __FILE__);
 260   }
 261
 262 }
 263
 264 /**
 265  * Test civicrm note create() using example code.
 266  */
 267 function testNoteCreateExample() {
 268   require_once 'api/v3/examples/Note/Create.php';
 269   $result = Note_get_example();
 270   $expectedResult = Note_get_expectedresult();
 271   $this->assertEquals($result, $expectedResult);
 272 }