forked from cloudinary/cloudinary_php
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathMetadataTest.php
More file actions
624 lines (562 loc) · 20.2 KB
/
Copy pathMetadataTest.php
File metadata and controls
624 lines (562 loc) · 20.2 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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
<?php
namespace Cloudinary;
use Cloudinary;
use Cloudinary\Api\Response;
use Exception;
use PHPUnit\Framework\TestCase;
/**
* Class MetadataTest
*
* @package Cloudinary
*/
class MetadataTest extends TestCase
{
private static $metadata_fields = [];
private static $external_id_general;
private static $external_id_string;
private static $external_id_int;
private static $external_id_date;
private static $external_id_enum;
private static $external_id_enum_2;
private static $external_id_set;
private static $external_id_set_2;
private static $external_id_set_3;
private static $external_id_delete;
private static $external_id_delete_2;
private static $external_id_date_validation;
private static $external_id_date_validation_2;
private static $external_id_int_validation;
private static $external_id_int_validation_2;
private static $datasource_entry_external_id;
private static $datasource_single;
private static $datasource_multiple;
/**
* @var Api $api
*/
private $api;
public static function setUpBeforeClass()
{
if (!Cloudinary::config_get("api_secret")) {
self::markTestSkipped('Please setup environment for Api test to run');
}
Curl::$instance = new Curl();
$id = UNIQUE_TEST_ID;
// External IDs for metadata fields that should be created and later deleted
self::$metadata_fields[] = self::$external_id_general = 'metadata_external_id_general_' . $id;
self::$metadata_fields[] = self::$external_id_date = 'metadata_external_id_date_' . $id;
self::$metadata_fields[] = self::$external_id_enum_2 = 'metadata_external_id_enum_2_' . $id;
self::$metadata_fields[] = self::$external_id_set = 'metadata_external_id_set_' . $id;
self::$metadata_fields[] = self::$external_id_set_2 = 'metadata_external_id_set_2_' . $id;
self::$metadata_fields[] = self::$external_id_set_3 = 'metadata_external_id_set_3_' . $id;
self::$metadata_fields[] = self::$external_id_delete_2 = 'metadata_deletion_2_' . $id;
self::$metadata_fields[] = self::$external_id_date_validation = 'metadata_date_validation_' . $id;
self::$metadata_fields[] = self::$external_id_date_validation_2 = 'metadata_date_validation_2_' . $id;
self::$metadata_fields[] = self::$external_id_int_validation = 'metadata_int_validation_' . $id;
self::$metadata_fields[] = self::$external_id_int_validation_2 = 'metadata_int_validation_2_' . $id;
// External IDs for metadata fields that will be accessed through a mock (and should not be deleted or created)
self::$external_id_string = 'metadata_external_id_string_' . $id;
self::$external_id_int = 'metadata_external_id_int_' . $id;
self::$external_id_enum = 'metadata_external_id_enum_' . $id;
self::$external_id_delete = 'metadata_deletion_' . $id;
// Sample datasource data
self::$datasource_entry_external_id = 'metadata_datasource_entry_external_id' . $id;
self::$datasource_single = [
[
'value' => 'v1',
'external_id' => self::$datasource_entry_external_id,
]
];
self::$datasource_multiple = [
[
'value' => 'v2',
'external_id' => self::$datasource_entry_external_id,
],
[
'value' => 'v3'
],
[
'value' => 'v4'
],
];
$metadata_fields_to_create = [
[
'external_id' => self::$external_id_general,
'type' => 'string'
],
[
'external_id' => self::$external_id_enum_2,
'type' => 'enum',
'datasource' => [
'values' => self::$datasource_multiple
]
],
[
'external_id' => self::$external_id_set_2,
'type' => 'set',
'datasource' => [
'values' => self::$datasource_multiple
]
],
[
'external_id' => self::$external_id_set_3,
'type' => 'set',
'datasource' => [
'values' => self::$datasource_multiple
]
],
[
'external_id' => self::$external_id_delete_2,
'type' => 'integer'
]
];
$api = new Api();
try {
foreach ($metadata_fields_to_create as $metadata_field_to_create) {
self::create_metadata_field_for_test($api, $metadata_field_to_create);
}
} catch (Exception $e) {
self::fail(
'Exception thrown while adding metadata field in MetadataFieldsTest::setUpBeforeClass() - ' .
$e->getMessage()
);
}
}
protected function setUp()
{
$this->api = new Api();
}
public function tearDown()
{
Curl::$instance = new Curl();
}
public static function tearDownAfterClass()
{
Curl::$instance = new Curl();
$api = new Api();
foreach (self::$metadata_fields as $externalId) {
try {
$api->delete_metadata_field($externalId);
} catch (Exception $e) {
}
}
}
/**
* Private helper method to create metadata fields for this test
*
* @param Api $api An instance of the Admin API
* @param array $field The field to add
*
* @return Response
*
* @throws Api\GeneralError
*/
private static function create_metadata_field_for_test(Api &$api, $field)
{
if (!isset($field['label'])) {
$field['label'] = $field['external_id'];
}
return $api->add_metadata_field($field);
}
/**
* Asserts that a given object fits the generic structure of a metadata field
*
* @see https://cloudinary.com/documentation/admin_api#generic_structure_of_a_metadata_field Generic structure of a metadata field in API reference
*
* @param Response $metadataField The object to test
* @param string $type The type of metadata field we expect
* @param array $values An associative array where the key is the name of the parameter to check and the
* value is the value
*/
private function assert_metadata_field(Response $metadataField, $type = null, $values = array())
{
$this->assertInternalType('string', $metadataField['external_id']);
if ($type) {
$this->assertEquals($type, $metadataField['type']);
} else {
$this->assertContains($metadataField['type'], ['string', 'integer', 'date', 'enum', 'set']);
}
$this->assertInternalType('string', $metadataField['label']);
$this->assertInternalType('boolean', $metadataField['mandatory']);
$this->assertArrayHasKey('default_value', $metadataField);
$this->assertArrayHasKey('validation', $metadataField);
if (in_array($metadataField['type'], ['enum', 'set'])) {
$this->assert_metadata_field_datasource($metadataField['datasource']);
}
foreach ($values as $key => $value) {
$this->assertEquals($value, $metadataField[$key]);
}
}
/**
* Asserts that a given object fits the generic structure of a metadata field datasource
*
* @see https://cloudinary.com/documentation/admin_api#datasource_values Datasource values in Admin API
*
* @param $dataSource
*/
private function assert_metadata_field_datasource($dataSource)
{
$this->assertNotEmpty($dataSource);
$this->assertArrayHasKey('values', $dataSource);
if (!empty($dataSource['values'])) {
$this->assertInternalType('string', $dataSource['values'][0]['value']);
$this->assertInternalType('string', $dataSource['values'][0]['external_id']);
if (!empty($dataSource['values'][0]['state'])) {
$this->assertContains($dataSource['values'][0]['state'], ['active', 'inactive']);
}
}
}
/**
* Test getting a list of all metadata fields
*
* @throws Api\GeneralError
*/
public function test_list_metadata_fields()
{
Curl::mockApi($this);
$this->api->list_metadata_fields();
assertUrl($this, '/metadata_fields');
assertGet($this);
$this->assertEmpty(Curl::$instance->fields());
}
/**
* Test getting a metadata field by external id
*
* @throws Api\GeneralError
*/
public function test_get_metadata_field()
{
$result = $this->api->metadata_field_by_field_id(self::$external_id_general);
$this->assert_metadata_field($result, 'string', ['label' => self::$external_id_general]);
}
/**
* Test creating a string metadata field
*
* @throws Api\GeneralError
*/
public function test_create_string_metadata_field()
{
Curl::mockApi($this);
$this->api->add_metadata_field([
'external_id' => self::$external_id_string,
'label' => self::$external_id_string,
'type' => 'string'
]);
assertUrl($this, '/metadata_fields');
assertPost($this);
assertEncodedRequestFields(
$this,
array(
'type' => 'string',
'external_id' => self::$external_id_string,
'label' => self::$external_id_string
)
);
}
/**
* Test creating an integer metadata field
*
* @throws Api\GeneralError
*/
public function test_create_int_metadata_field()
{
Curl::mockApi($this);
$this->api->add_metadata_field([
'external_id' => self::$external_id_int,
'label' => self::$external_id_int,
'type' => 'integer'
]);
assertUrl($this, '/metadata_fields');
assertPost($this);
assertEncodedRequestFields(
$this,
array(
'type' => 'integer',
'external_id' => self::$external_id_int,
'label' => self::$external_id_int
)
);
}
/**
* Test creating a date metadata field
*
* @throws Api\GeneralError
*/
public function test_create_date_metadata_field()
{
$result = $this->api->add_metadata_field([
'external_id' => self::$external_id_date,
'label' => self::$external_id_date,
'type' => 'date'
]);
$this->assert_metadata_field($result, 'date', [
'label' => self::$external_id_date,
'external_id' => self::$external_id_date,
'mandatory' => false
]);
}
/**
* Test creating an Enum metadata field
*
* @throws Api\GeneralError
*/
public function test_create_enum_metadata_field()
{
Curl::mockApi($this);
$this->api->add_metadata_field([
'datasource' => [
'values' => self::$datasource_single
],
'external_id' => self::$external_id_enum,
'label' => self::$external_id_enum,
'type' => 'enum'
]);
assertUrl($this, '/metadata_fields');
assertPost($this);
assertEncodedRequestFields(
$this,
array(
'datasource' => [
'values' => self::$datasource_single
],
'external_id' => self::$external_id_enum,
'label' => self::$external_id_enum,
'type' => 'enum'
)
);
}
/**
* Test creating a set metadata field
*
* @throws Api\GeneralError
*/
public function test_create_set_metadata_field()
{
$result = $this->api->add_metadata_field([
'datasource' => [
'values' => self::$datasource_multiple
],
'external_id' => self::$external_id_set,
'label' => self::$external_id_set,
'type' => 'set'
]);
$this->assert_metadata_field($result, 'set', [
'label' => self::$external_id_set,
'external_id' => self::$external_id_set,
'mandatory' => false
]);
}
/**
* Update a metadata field by external id
*
* @throws Api\GeneralError
*/
public function test_update_metadata_field()
{
$newLabel = 'update_metadata_test_new_label' . self::$external_id_general;
$newDefaultValue = 'update_metadata_test_new_default_value' . self::$external_id_general;
// Call the API to update the metadata field
// Will also attempt to update some fields that cannot be updated (external_id and type) which will be ignored
$result = $this->api->update_metadata_field(
self::$external_id_general,
[
'external_id' => self::$external_id_set,
'label' => $newLabel,
'type' => 'integer',
'mandatory' => true,
'default_value' => $newDefaultValue
]
);
$this->assert_metadata_field($result, 'string', [
'external_id' => self::$external_id_general,
'label' => $newLabel,
'default_value' => $newDefaultValue,
'mandatory' => true,
]);
}
/**
* Update a metadata field datasource
*
* @throws Api\GeneralError
*/
public function test_update_metadata_field_datasource()
{
$result = $this->api->update_metadata_field_datasource(
self::$external_id_enum_2,
self::$datasource_single
);
$this->assert_metadata_field_datasource($result);
assertArrayContainsArray(
$this,
$result['values'],
self::$datasource_single[0],
'The updated metadata field does not contain the updated datasource'
);
$this->assertCount(count(self::$datasource_multiple), $result['values']);
$this->assertEquals(self::$datasource_single[0]['value'], $result['values'][0]['value']);
}
/**
* Test deleting a metadata field definition by its external id.
*
* @throws Api\GeneralError
*/
public function test_delete_metadata_field()
{
Curl::mockApi($this);
$this->api->delete_metadata_field(self::$external_id_delete);
assertUrl($this, '/metadata_fields/' . self::$external_id_delete);
assertDelete($this);
assertEncodedRequestFields($this, array());
}
/**
* Test deleting a metadata field definition then attempting to create a new one with the same external id which
* should fail.
*
* @throws Api\GeneralError
*/
public function test_delete_metadata_field_does_not_release_external_id()
{
$this->api->delete_metadata_field(self::$external_id_delete_2);
$this->setExpectedException(
'\Cloudinary\Api\BadRequest',
'external id ' . self::$external_id_delete_2 . ' already exists'
);
$this->api->add_metadata_field([
'external_id' => self::$external_id_delete_2,
'label' => self::$external_id_delete_2,
'type' => 'integer'
]);
}
/**
* Delete entries in a metadata field datasource
*
* @throws Api\GeneralError
*/
public function test_delete_metadata_field_data_source()
{
$result = $this->api->delete_datasource_entries(
self::$external_id_set_2,
[
self::$datasource_entry_external_id
]
);
$this->assert_metadata_field_datasource($result);
$this->assertCount(count(self::$datasource_multiple) - 1, $result['values']);
$values = array_map(function ($datasource_entity) {
return $datasource_entity['value'];
}, $result['values']);
$this->assertContains(self::$datasource_multiple[1]['value'], $values);
$this->assertContains(self::$datasource_multiple[2]['value'], $values);
}
/**
* Test date field validation
*
* @throws Api\GeneralError
*/
public function test_date_field_default_value_validation()
{
$pastDate = date('Y-m-d', time() - 60 * 60 * 24 * 3);
$yesterdayDate = date('Y-m-d', time() - 60 * 60 * 24);
$todayDate = date('Y-m-d');
$futureDate = date('Y-m-d', time() + 60 * 60 * 24 * 3);
$lastThreeDaysValidation = [
'rules' => [
[
'type' => 'greater_than',
'equals' => false,
'value' => $pastDate
],
[
'type' => 'less_than',
'equals' => false,
'value' => $todayDate
],
],
'type' => 'and'
];
// Test entering a metadata field with date validation and a valid default value
$metadata_field = [
'external_id' => self::$external_id_date_validation,
'label' => self::$external_id_date_validation,
'type' => 'date',
'default_value' => $yesterdayDate,
'validation' => $lastThreeDaysValidation
];
$result = $this->api->add_metadata_field($metadata_field);
$this->assert_metadata_field($result, 'date', [
'validation' => $lastThreeDaysValidation,
'default_value' => $metadata_field['default_value'],
]);
// Test entering a metadata field with date validation and an invalid default value
$metadata_field = [
'external_id' => self::$external_id_date_validation_2,
'label' => self::$external_id_date_validation_2,
'type' => 'date',
'default_value' => $futureDate,
'validation' => $lastThreeDaysValidation
];
$this->setExpectedException('\Cloudinary\Api\BadRequest');
$this->api->add_metadata_field($metadata_field);
}
/**
* Test integer field validation
*
* @throws Api\GeneralError
*/
public function test_integer_field_validation()
{
$validation = [
'type' => 'less_than',
'equals' => true,
'value' => 5
];
// Test entering a metadata field with integer validation and a valid default value
$metadata_field = [
'external_id' => self::$external_id_int_validation,
'label' => self::$external_id_int_validation,
'type' => 'integer',
'default_value' => 5,
'validation' => $validation
];
$result = $this->api->add_metadata_field($metadata_field);
$this->assert_metadata_field($result, 'integer', [
'validation' => $validation,
'default_value' => $metadata_field['default_value'],
]);
// Test entering a metadata field with integer validation and an invalid default value
$metadata_field = [
'external_id' => self::$external_id_int_validation_2,
'label' => self::$external_id_int_validation_2,
'type' => 'integer',
'default_value' => 6,
'validation' => $validation
];
$this->setExpectedException('\Cloudinary\Api\BadRequest');
$this->api->add_metadata_field($metadata_field);
}
/**
* Restore a deleted entry in a metadata field datasource
*
* @throws Api\GeneralError
*/
public function test_restore_metadata_field_datasource()
{
// Begin by deleting a datasource entry
$result = $this->api->delete_datasource_entries(
self::$external_id_set_3,
[
self::$datasource_entry_external_id
]
);
$this->assert_metadata_field_datasource($result);
$this->assertCount(2, $result['values']);
// Restore datasource entry
$result = $this->api->restore_metadata_field_datasource(
self::$external_id_set_3,
[
self::$datasource_entry_external_id
]
);
$this->assert_metadata_field_datasource($result);
$this->assertCount(3, $result['values']);
}
}