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