testRest.php
20.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
<?php
require_once (KT_DIR . '/tests/test.php');
require_once (KT_DIR . '/ktapi/ktapi.inc.php');
/**
* These are the unit tests for the main KTAPI class
*
*/
class RESTTestCase extends KTUnitTestCase {
/**
* @var object $ktapi The main ktapi object
*/
var $ktapi;
/**
* @var object $session The KT session object
*/
var $session;
/**
* @var string $rootUrl The root server url for the rest web service
*/
var $rootUrl;
/**
* This method sets up the server url
*
*/
public function setUp()
{
$url = KTUtil::kt_url();
$this->rootUrl = $url.'/ktwebservice/KTWebService.php?';
}
/**
* This method is a placeholder
*/
public function tearDown()
{
}
/**
* Test login
*/
public function testLogin()
{
// Login and authenticate
$url = $this->rootUrl.'method=login&password=admin&username=admin';
$response = $this->call($url);
$response = $response['response'];
$session_id = $response['results'];
$this->assertEqual($response['status_code'], 0);
$this->assertTrue(!empty($response['results']));
// Logout
$url = $this->rootUrl.'method=logout&session_id='.$session_id;
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
}
/**
* Test the successful running of a method
*/
public function testFolderDetails()
{
// Login and authenticate
$url = $this->rootUrl.'method=login&password=admin&username=admin';
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
$session_id = $response['results'];
$url = $this->rootUrl.'method=get_folder_detail&session_id='.$session_id.'&folder_id=1';
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
$this->assertTrue(!empty($response['results']));
$this->assertEqual($response['results']['folder_name'], 'Root Folder');
$this->assertEqual($response['results']['permissions'], 'RWA');
// Logout
$url = $this->rootUrl.'method=logout&session_id='.$session_id;
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
}
/**
* Test incorrect authentication and no authentication
*/
public function testAuthenticationError()
{
// Incorrect password
$url = $this->rootUrl.'method=login&password=random&username=admin';
$response = $this->call($url);
$response = $response['response'];
$this->assertNotEqual($response['status_code'], 0);
$this->assertTrue(empty($response['results']));
$this->assertTrue(!empty($response['message']));
// No session set up - use a random session id
$url = $this->rootUrl.'method=get_folder_detail&session_id=09sfirandom3828492&folder_id=1';
$response = $this->call($url);
$response = $response['response'];
$this->assertNotEqual($response['status_code'], 0);
$this->assertTrue(empty($response['results']));
$this->assertTrue(!empty($response['message']));
}
/**
* Test incorrect method error and the error response on incorrect parameters
*/
public function testMethodErrors()
{
$url = $this->rootUrl.'method=incorrect_method¶meter=something';
$response = $this->call($url);
$response = $response['response'];
$this->assertNotEqual($response['status_code'], 0);
$this->assertTrue(empty($response['results']));
$this->assertTrue(!empty($response['message']));
$url = $this->rootUrl.'method=get_folder_detail¶meter=something';
$response = $this->call($url);
$response = $response['response'];
$this->assertNotEqual($response['status_code'], 0);
$this->assertTrue(empty($response['results']));
$this->assertTrue(!empty($response['message']));
}
/**
* Tests finding of a folder or folder detail by name
* Runs the following sub-tests:
* . Root folder Folder by Name (root folder test)
* . Folder Detail by Name in root folder (no duplicate names)
* . Folder Detail by name in subfolder of root folder (no duplicate names)
* . Folder by Name in subfolder of root folder (no duplicate names)
* . Folder by Name in root folder (duplicate names)
* . Folder Detail by name in subfolder of root folder (duplicate names)
* . Folder by name in subfolder of root folder (duplicate names)
*/
public function testGetFolderByName()
{
// Login and authenticate
$url = $this->rootUrl.'method=login&password=admin&username=admin';
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
$session_id = $response['results'];
// set up
$root_folder_id = array();
$sub_folder_id = array();
$folders[0][1] = 'Root Folder';
// Create a sub folder in the root folder
$parentId = 1;
$folderName = 'Test api sub-folder ONE';
$url = $this->rootUrl.'method=create_folder&session_id=' . $session_id . '&folder_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$root_folder_id[] = $response['results']['id'];
$folders[$parentId][$response['results']['id']] = $folderName;
$this->assertEqual($response['status_code'], 0);
// Create a second sub folder in the root folder
$parentId = 1;
$folderName = 'Test api sub-folder TWO';
$url = $this->rootUrl.'method=create_folder&session_id=' . $session_id . '&folder_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$root_folder_id[] = $response['results']['id'];
$folders[$parentId][$response['results']['id']] = $folderName;
$this->assertEqual($response['status_code'], 0);
// Create a sub folder in the first sub folder
$parentId = $root_folder_id[0];
$folderName = 'Test api sub-folder THREE';
$url = $this->rootUrl.'method=create_folder&session_id=' . $session_id . '&folder_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$sub_folder_id[0][] = $response['results']['id'];
$folders[$parentId][$response['results']['id']] = $folderName;
$this->assertEqual($response['status_code'], 0);
// Create a sub folder within the first sub folder which shares a name with one of the root sub folders
$parentId = $sub_folder_id[0][0];
$folderName = 'Test api sub-folder TWO';
$url = $this->rootUrl.'method=create_folder&session_id=' . $session_id . '&folder_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$sub_folder_id[0][] = $response['results']['id'];
$folders[$parentId][$response['results']['id']] = $folderName;
$this->assertEqual($response['status_code'], 0);
// Create a second sub folder in the first sub folder
$parentId = $root_folder_id[0];
$folderName = 'Test api sub-folder FOUR';
$url = $this->rootUrl.'method=create_folder&session_id=' . $session_id . '&folder_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$sub_folder_id[0][] = $response['results']['id'];
$folders[$parentId][$response['results']['id']] = $folderName;
$this->assertEqual($response['status_code'], 0);
// Create a sub folder within the second sub folder
$parentId = $root_folder_id[1];
$folderName = 'Test api sub-folder FIVE';
$url = $this->rootUrl.'method=create_folder&session_id=' . $session_id . '&folder_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$sub_folder_id[1][] = $response['results']['id'];
$folders[$parentId][$response['results']['id']] = $folderName;
$this->assertEqual($response['status_code'], 0);
// Create a sub folder within the second sub folder which shares a name with a sub folder in the first sub folder
$parentId = $sub_folder_id[1][0];
$folderName = 'Test api sub-folder THREE';
$url = $this->rootUrl.'method=create_folder&session_id=' . $session_id . '&folder_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$sub_folder_id[1][] = $response['results']['id'];
$folders[$parentId][$response['results']['id']] = $folderName;
$this->assertEqual($response['status_code'], 0);
// NOTE default parent is 1, so does not need to be declared when searching the root folder, but we use it elsewhere
// Fetching of root folder
$parentId = 0;
$folderName = 'Root Folder';
$url = $this->rootUrl.'method=get_folder_detail_by_name&session_id=' . $session_id . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
$this->assertFalse(!empty($response['message']));
if (($response['status_code'] == 0)) {
$this->assertEqual($folders[$parentId][$response['results']['id']], $folderName);
}
// Folder Detail by Name in root folder (no duplicate names)
$parentId = 1;
$folderName = 'Test api sub-folder ONE';
// no parent required
$url = $this->rootUrl.'method=get_folder_detail_by_name&session_id=' . $session_id . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
$this->assertFalse(!empty($response['message']));
if (($response['status_code'] == 0)) {
$this->assertEqual($folders[$parentId][$response['results']['id']], $folderName);
}
// Folder Detail by Name in sub folder of root folder (no duplicate names)
$parentId = $root_folder_id[0];
$folderName = 'Test api sub-folder FOUR';
$url = $this->rootUrl.'method=get_folder_detail_by_name&session_id=' . $session_id . '&parent_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
$this->assertFalse(!empty($response['message']));
if (($response['status_code'] == 0)) {
$this->assertEqual($folders[$parentId][$response['results']['id']], $folderName);
}
// Folder Detail by Name in root folder (duplicate names)
$parentId = 1;
$folderName = 'Test api sub-folder TWO';
$url = $this->rootUrl.'method=get_folder_detail_by_name&session_id=' . $session_id . '&parent_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
$this->assertFalse(!empty($response['message']));
if (($response['status_code'] == 0)) {
$this->assertEqual($folders[$parentId][$response['results']['id']], $folderName);
}
// Folder Detail by Name in sub folder of root folder (duplicate names)
$parentId = $root_folder_id[0];
$folderName = 'Test api sub-folder THREE';
$url = $this->rootUrl.'method=get_folder_detail_by_name&session_id=' . $session_id . '&parent_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$this->assertEqual($response['status_code'], 0);
$this->assertFalse(!empty($response['message']));
if (($response['status_code'] == 0)) {
$this->assertEqual($folders[$parentId][$response['results']['id']], $folderName);
}
// Negative test with non duplicated folder - look for folder in location it does not exist
$parentId = $root_folder_id[0];
$folderName = 'Test api sub-folder ONE';
$url = $this->rootUrl.'method=get_folder_detail_by_name&session_id=' . $session_id . '&parent_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
$this->assertNotEqual($response['status_code'], 0);
$this->assertTrue(!empty($response['message']));
$this->assertNotEqual($folders[$parentId][$response['results']['id']], $folderName);
// Negative test with duplicated folder - look for folder with incorrect parent id, result should not match expected folder
$parentId = 1;
$actualParentId = $sub_folder_id[0][0];
$folderName = 'Test api sub-folder TWO';
$url = $this->rootUrl.'method=get_folder_detail_by_name&session_id=' . $session_id . '&parent_id=' . $parentId . '&folder_name=' . urlencode($folderName);
$response = $this->call($url);
$response = $response['response'];
// we should get a result
$this->assertEqual($response['status_code'], 0);
$this->assertFalse(!empty($response['message']));
// but not the one we wanted
$url = $this->rootUrl.'method=get_folder_detail_by_name&session_id=' . $session_id . '&parent_id=' . $actualParentId . '&folder_name=' . urlencode($folderName);
$expectedResponse = $this->call($url);
$expectedResponse = $expectedResponse['response'];
$this->assertNotEqual($response['results']['id'], $expectedResponse['results']['id']);
// Clean up - delete all of the folders
foreach ($root_folder_id as $folder_id) {
$url = $this->rootUrl.'method=delete_folder&session_id=' . $session_id . '&folder_id=' . $folder_id . '&reason=Testing%20Webservice';
$this->call($url);
}
foreach ($sub_folder_id as $_folder_id_) {
foreach ($_folder_id_ as $folder_id) {
$url = $this->rootUrl.'method=delete_folder&session_id=' . $session_id . '&folder_id=' . $folder_id . '&reason=Testing%20Webservice';
$this->call($url);
}
}
// Logout
$url = $this->rootUrl.'method=logout&session_id='.$session_id;
$response = $this->call($url);
$response = $response['response'];
}
/**
* Convert xml into an array structure
*
* @param unknown_type $contents
* @param unknown_type $get_attributes
* @param unknown_type $priority
* @return unknown
*/
private function xml2array($contents, $get_attributes = 1, $priority = 'tag')
{
if (!function_exists('xml_parser_create'))
{
return array ();
}
$parser = xml_parser_create('');
xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, "UTF-8");
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
xml_parse_into_struct($parser, trim($contents), $xml_values);
xml_parser_free($parser);
if (!$xml_values)
return; //Hmm...
$xml_array = array ();
$parents = array ();
$opened_tags = array ();
$arr = array ();
$current = & $xml_array;
$repeated_tag_index = array ();
foreach ($xml_values as $data)
{
unset ($attributes, $value);
extract($data);
$result = array ();
$attributes_data = array ();
if (isset ($value))
{
if ($priority == 'tag')
$result = $value;
else
$result['value'] = $value;
}
if (isset ($attributes) and $get_attributes)
{
foreach ($attributes as $attr => $val)
{
if ($priority == 'tag')
$attributes_data[$attr] = $val;
else
$result['attr'][$attr] = $val; //Set all the attributes in a array called 'attr'
}
}
if ($type == "open")
{
$parent[$level -1] = & $current;
if (!is_array($current) or (!in_array($tag, array_keys($current))))
{
$current[$tag] = $result;
if ($attributes_data)
$current[$tag . '_attr'] = $attributes_data;
$repeated_tag_index[$tag . '_' . $level] = 1;
$current = & $current[$tag];
}
else
{
if (isset ($current[$tag][0]))
{
$current[$tag][$repeated_tag_index[$tag . '_' . $level]] = $result;
$repeated_tag_index[$tag . '_' . $level]++;
}
else
{
$current[$tag] = array (
$current[$tag],
$result
);
$repeated_tag_index[$tag . '_' . $level] = 2;
if (isset ($current[$tag . '_attr']))
{
$current[$tag]['0_attr'] = $current[$tag . '_attr'];
unset ($current[$tag . '_attr']);
}
}
$last_item_index = $repeated_tag_index[$tag . '_' . $level] - 1;
$current = & $current[$tag][$last_item_index];
}
}
elseif ($type == "complete")
{
if (!isset ($current[$tag]))
{
$current[$tag] = $result;
$repeated_tag_index[$tag . '_' . $level] = 1;
if ($priority == 'tag' and $attributes_data)
$current[$tag . '_attr'] = $attributes_data;
}
else
{
if (isset ($current[$tag][0]) and is_array($current[$tag]))
{
$current[$tag][$repeated_tag_index[$tag . '_' . $level]] = $result;
if ($priority == 'tag' and $get_attributes and $attributes_data)
{
$current[$tag][$repeated_tag_index[$tag . '_' . $level] . '_attr'] = $attributes_data;
}
$repeated_tag_index[$tag . '_' . $level]++;
}
else
{
$current[$tag] = array (
$current[$tag],
$result
);
$repeated_tag_index[$tag . '_' . $level] = 1;
if ($priority == 'tag' and $get_attributes)
{
if (isset ($current[$tag . '_attr']))
{
$current[$tag]['0_attr'] = $current[$tag . '_attr'];
unset ($current[$tag . '_attr']);
}
if ($attributes_data)
{
$current[$tag][$repeated_tag_index[$tag . '_' . $level] . '_attr'] = $attributes_data;
}
}
$repeated_tag_index[$tag . '_' . $level]++; //0 and 1 index is already taken
}
}
}
elseif ($type == 'close')
{
$current = & $parent[$level -1];
}
}
return ($xml_array);
}
/**
* Use curl to run the webservice function
*
* @param unknown_type $url
* @return unknown
*/
private function call($url) {
$c = curl_init($url);
curl_setopt($c, CURLOPT_RETURNTRANSFER, 1);
$xml = curl_exec($c);
curl_close($c);
$xmlArray = $this->xml2array($xml);
return $xmlArray;
}
}
?>