-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathRestDemo.py
More file actions
1207 lines (928 loc) · 55.3 KB
/
Copy pathRestDemo.py
File metadata and controls
1207 lines (928 loc) · 55.3 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
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import collections
import inspect
import logging
import logging.config
import sys
import time
from builtins import input
from configparser import ConfigParser
from model import RestLink
from model.QueryDocument import Sort, ExpSet, FtExp, FacetDefinition
from network import RestClient
from network.RestClient import MEDIA_TYPE_DM_JSON
from util import ResourceUtility
from util.DemoUtil import format_json
from util.DemoUtil import print_properties
from util.DemoUtil import print_resource_properties
__author__ = 'wangc31'
DEMO_CABINET = 'demo-cabinet'
DEMO_NEW_FOLDER = 'demo-new-folder'
DEMO_UPDATE_FOLDER = 'demo-update-folder'
DEMO_TEMP_FOLDER = 'demo-temp-folder'
DEMO_NEW_SYSOBJECT = 'demo-new-sysobj'
DEMO_UPDATE_SYSOBJECT = 'demo-update-sysobj'
DEMO_NEW_DOCUMENT = 'demo-doc'
DEMO_CHECK_IN_WITHOUT_CONTENT = 'demo-check-in-without-content'
DEMO_CHECK_IN_WITH_CONTENT = 'demo-check-in-with-content'
DEMO_NEW_USER = 'demo-py-client-user'
DEMO_UPDATE_USER = 'demo-py-client-user-updated'
DEMO_NEW_GROUP = 'demo-py-client-group'
DEMO_ANOTHER_NEW_GROUP = 'demo-py-client-another-group'
DEMO_UPDATE_GROUP = 'demo-py-client-group-updated'
DEMO_SHARABLE_OBJECT = 'demo_sharable_obj'
DEMO_ANOTHER_SHARABLE_OBJECT = 'demo_another_sharable_obj'
DEMO_LIGHT_WEITHT_OBJECT = 'demo_lightweight_obj'
DEMO_OBJECT_TO_ATTACH = 'obj_to_attach'
VERSION_72 = '7.2'
VERSION_73 = '7.3'
logger = logging.getLogger(__name__)
Demo = collections.namedtuple('Demo', ['version', 'description', 'callable'])
class RestDemo:
def __init__(self, prompt):
self.prompt = prompt
self._init_logger()
self._init_client()
self._init_demo_items()
def _init_demo_items(self):
try:
demos = tuple(
Demo(self._get_method_version(method), self._get_method_doc(method), method) for name, method in
(inspect.getmembers(self, predicate=inspect.ismethod))
if str(name).startswith('demo'))
product_version = float(self.client.get_product_info().get('properties').get('major'))
print('This is Documentum REST {}'.format(product_version))
self._populate_demo_items(demos, product_version)
except Exception as e:
logger.info('Error occurs... Quit demo.\n{}'.format(e))
sys.exit(0)
@staticmethod
def _get_method_version(demo):
return inspect.getdoc(demo).split('\n')[1].split(':')[1].strip()
@staticmethod
def _get_method_doc(demo):
return inspect.getdoc(demo).split('\n')[0]
def _populate_demo_items(self, demos, product_version):
items = [demo
for demo in demos
if float(demo.version) <= product_version]
# hardcode quit and reset at the top
items.insert(0, Demo(self._get_method_version(self.quit), self._get_method_doc(self.quit), self.quit))
items.insert(1, Demo(self._get_method_version(self.reset_environment),
self._get_method_doc(self.reset_environment), self.reset_environment))
self.choices = {i: item
for i, item in enumerate(items)}
def _init_client(self):
config_parser = ConfigParser()
config_parser.read("resources/rest.properties")
self.REST_URI = config_parser.get("environment", "rest.host")
rest_uri = self.prompt.rest_entry(self.REST_URI)
if rest_uri:
self.REST_URI = rest_uri
self.REST_REPOSITORY = config_parser.get("environment", "rest.repository")
rest_repo = self.prompt.rest_repo(self.REST_REPOSITORY)
if rest_repo:
self.REST_REPOSITORY = rest_repo
self.REST_USER = config_parser.get("environment", "rest.username")
rest_user = self.prompt.rest_user(self.REST_USER)
if rest_user:
self.REST_USER = rest_user
self.REST_PWD = config_parser.get("environment", "rest.password")
rest_pwd = self.prompt.rest_pwd(self.REST_PWD)
if rest_pwd:
self.REST_PWD = rest_pwd
self.client = RestClient.RestClient(self.REST_USER, self.REST_PWD, self.REST_URI, self.REST_REPOSITORY)
def _init_logger(self):
logging.getLogger("requests").setLevel(logging.WARNING)
is_debug = self.prompt.demo_logging()
if is_debug == 'yes':
level = 'DEBUG'
else:
level = 'INFO'
logging.config.dictConfig({
'version': 1,
'disable_existing_loggers': False,
'handlers': {
'default': {
'level': level,
'class': 'logging.StreamHandler',
},
},
'loggers': {
'': {
'handlers': ['default'],
'level': 'DEBUG',
'propagate': True
}
}
})
@staticmethod
def quit():
"""Quit the demo
version: 7.2"""
logger.info("\nQuit the demo.")
sys.exit(0)
def create_demo_cabinet(self):
logger.debug("\n+++++++++++++++++++++++++++++++Create temp cabinet Start+++++++++++++++++++++++++++++++")
self.client.create_cabinet(ResourceUtility.generate_cabinet(object_name=DEMO_CABINET))
logger.debug("+++++++++++++++++++++++++++++++Create temp cabinet End+++++++++++++++++++++++++++++++")
def demo_user_group_member_crud(self):
"""
REST user, group and member CRUD
version:7.3
"""
logger.info("\n+++++++++++++++++++++++++++++++User CRUD Start+++++++++++++++++++++++++++++++")
logger.info('Create user %s in repository %s' % (DEMO_NEW_USER, self.REST_REPOSITORY))
new_user = self.client.create_user(ResourceUtility.generate_user(user_name=DEMO_NEW_USER,
user_login_name=DEMO_NEW_USER))
print_resource_properties(logger, new_user, 'user_name', 'r_object_id')
logger.info('Update user %s in repository %s' % (DEMO_NEW_USER, self.REST_REPOSITORY))
new_user = self.client.update(new_user, ResourceUtility.generate_user(user_login_name=DEMO_UPDATE_USER))
print_resource_properties(logger, new_user, 'user_name', 'r_object_id')
logger.info('Refresh user %s in repository %s' % (DEMO_NEW_USER, self.REST_REPOSITORY))
self.client.refresh(new_user)
print_resource_properties(logger, new_user, 'user_name', 'r_object_id')
logger.info('Get user %s in repository %s' % (DEMO_NEW_USER, self.REST_REPOSITORY))
new_user = self.client.get_user(DEMO_NEW_USER)
print_resource_properties(logger, new_user, 'user_name', 'r_object_id')
logger.info("\n+++++++++++++++++++++++++++++++Group and Group Member CRUD Start+++++++++++++++++++++++++++++++")
logger.info('Create group %s in repository %s' % (DEMO_NEW_GROUP, self.REST_REPOSITORY))
new_group = self.client.create_group(ResourceUtility.generate_group(group_name=DEMO_NEW_GROUP))
print_resource_properties(logger, new_group, 'group_name', 'r_object_id')
logger.info('Update group %s in repository %s' % (DEMO_NEW_GROUP, self.REST_REPOSITORY))
new_group = self.client.update(new_group, ResourceUtility.generate_group(group_display_name=DEMO_UPDATE_USER))
print_resource_properties(logger, new_group, 'group_name', 'r_object_id')
logger.info('Add user %s in the group %s\n' % (DEMO_NEW_USER, DEMO_NEW_GROUP))
self.client.add_user_to_group(new_group, new_user)
logger.info('Remove user %s in the group %s\n' % (DEMO_NEW_USER, DEMO_NEW_GROUP))
self.client.remove_user_from_group(new_group, DEMO_NEW_USER)
logger.info('Create another group %s in repository %s\n' % (DEMO_ANOTHER_NEW_GROUP, self.REST_REPOSITORY))
another_new_group = self.client.create_group(
ResourceUtility.generate_group(group_name=DEMO_ANOTHER_NEW_GROUP))
logger.info('Add group %s in the group %s\n' % (DEMO_ANOTHER_NEW_GROUP, DEMO_NEW_GROUP))
self.client.add_group_to_group(new_group, another_new_group)
logger.info('Remove group %s in the group %s\n' % (DEMO_ANOTHER_NEW_GROUP, DEMO_NEW_GROUP))
self.client.remove_group_from_group(new_group, DEMO_ANOTHER_NEW_GROUP)
logger.info('Delete user %s in repository %s\n' % (DEMO_NEW_USER, self.REST_REPOSITORY))
self.client.delete(new_user)
logger.info('Delete group %s in repository %s\n' % (DEMO_NEW_GROUP, self.REST_REPOSITORY))
self.client.delete(new_group)
logger.info('Delete group %s in repository %s\n' % (DEMO_ANOTHER_NEW_GROUP, self.REST_REPOSITORY))
self.client.delete(another_new_group)
def demo_folder_crud(self):
"""
REST folder CRUD
version:7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++Folder CRUD Start+++++++++++++++++++++++++++++++")
logger.info('Get cabinet %s...' % DEMO_CABINET)
cabinet = self.client.get_cabinet(DEMO_CABINET)
logger.info('Create new folder %s in cabinet %s...' % (DEMO_NEW_FOLDER, DEMO_CABINET))
new_folder = self.client.create_folder(cabinet, ResourceUtility.generate_folder(object_name=DEMO_NEW_FOLDER))
print_resource_properties(logger, new_folder, 'object_name', 'r_object_id')
logger.info('Update folder %s in cabinet %s...' % (DEMO_NEW_FOLDER, DEMO_CABINET))
new_folder = self.client.update(new_folder, ResourceUtility.generate_folder(object_name=DEMO_UPDATE_FOLDER))
print_resource_properties(logger, new_folder, 'object_name', 'r_object_id')
logger.info('Get folder %s in cabinet %s...' % (DEMO_UPDATE_FOLDER, DEMO_CABINET))
new_folder = self.client.get_folder(cabinet, DEMO_UPDATE_FOLDER)
print_resource_properties(logger, new_folder, 'object_name', 'r_object_id')
logger.info('Delete folder %s' % DEMO_UPDATE_FOLDER)
self.client.delete(new_folder)
logger.info("+++++++++++++++++++++++++++++++Folder CRUD End+++++++++++++++++++++++++++++++")
def demo_sysobject_crud(self):
"""
REST sysObject CRUD
version: 7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++Object CRUD Start+++++++++++++++++++++++++++++++")
logger.info('Get cabinet %s...' % DEMO_CABINET)
cabinet = self.client.get_cabinet(DEMO_CABINET)
logger.info('Create temp folder %s in cabinet %s...' % (DEMO_TEMP_FOLDER, DEMO_CABINET))
temp_folder = self.client.create_folder(cabinet, ResourceUtility.generate_folder(object_name=DEMO_TEMP_FOLDER))
print_resource_properties(logger, temp_folder, 'object_name', 'r_object_id')
logger.info('Create new sysobject %s in folder %s...' % (DEMO_NEW_SYSOBJECT, DEMO_TEMP_FOLDER))
new_sysobj = self.client.create_sysobj(temp_folder,
ResourceUtility.generate_sysobject(object_name=DEMO_NEW_SYSOBJECT))
print_resource_properties(logger, new_sysobj, 'object_name', 'r_object_id')
logger.info('Update sysobject %s in folder %s...' % (DEMO_UPDATE_SYSOBJECT, DEMO_TEMP_FOLDER))
new_sysobj = self.client.update(new_sysobj,
ResourceUtility.generate_sysobject(object_name=DEMO_UPDATE_SYSOBJECT))
print_resource_properties(logger, new_sysobj, 'object_name', 'r_object_id')
logger.info('Refresh sysobject %s in folder %s...' % (DEMO_UPDATE_SYSOBJECT, DEMO_TEMP_FOLDER))
new_sysobj = self.client.refresh(new_sysobj)
print_resource_properties(logger, new_sysobj, 'object_name', 'r_object_id')
logger.info('Get sysobject %s in folder %s...' % (DEMO_UPDATE_SYSOBJECT, DEMO_TEMP_FOLDER))
new_sysobj = self.client.get_sysobject(temp_folder, DEMO_UPDATE_SYSOBJECT)
print_resource_properties(logger, new_sysobj, 'object_name', 'r_object_id')
logger.info('Delete sysobject %s' % DEMO_UPDATE_SYSOBJECT)
self.client.delete(new_sysobj)
logger.info('Delete folder %s' % DEMO_TEMP_FOLDER)
self.client.delete(temp_folder)
logger.info("+++++++++++++++++++++++++++++++Object CRUD End+++++++++++++++++++++++++++++++")
def demo_content_management(self):
"""REST content management
version: 7.2"""
logger.info("\n+++++++++++++++++++++++++++++++Content Management Start+++++++++++++++++++++++++++++++")
logger.info('Get cabinet %s...' % DEMO_CABINET)
cabinet = self.client.get_cabinet(DEMO_CABINET)
logger.info('Create temp folder %s in cabinet %s...' % (DEMO_TEMP_FOLDER, DEMO_CABINET))
temp_folder = self.client.create_folder(cabinet, ResourceUtility.generate_folder(object_name=DEMO_TEMP_FOLDER))
logger.info('Create new document %s with content...' % DEMO_NEW_DOCUMENT)
new_doc = self.client.create_document(temp_folder,
ResourceUtility.generate_document(object_name=DEMO_NEW_DOCUMENT),
'It\'s created by python client', params={'format': 'crtext'})
print_resource_properties(logger, new_doc, 'object_name', 'r_object_id')
logger.info('Get primary content of %s...' % DEMO_NEW_DOCUMENT)
primary_content = self.client.get_primary_content(new_doc, params={'media-url-policy': 'all'})
print_resource_properties(logger, primary_content, 'object_name', 'r_object_id', 'format_name',
'full_content_size')
logger.info('All media URLs for primary content of %s...' % DEMO_NEW_DOCUMENT)
for link in primary_content.all_links():
logger.info(str(link) + '\n')
logger.info('Create new html rendition for document %s...' % DEMO_NEW_DOCUMENT)
new_content = self.client.create_content(new_doc, content='This is html rendition.', content_type='text/html',
params={'primary': 'false'})
print_resource_properties(logger, new_content, 'object_name', 'r_object_id', 'format_name', 'full_content_size')
logger.info('Create new rendition with large file for document %s...' % DEMO_NEW_DOCUMENT)
path = self.prompt.content_file()
if path:
logger.info('Start to create document with file %s', path)
try:
with open(path, 'rb') as f:
new_content = self.client.create_content(new_doc, content=f,
content_type=RestClient.MEDIA_TYPE_OCTET_STREAM,
params={'primary': 'false'})
print_resource_properties(logger, new_content, 'object_name', 'r_object_id', 'format_name',
'full_content_size')
except IOError:
logger.info('The file %s does not exist or can not be opened.' % path)
else:
logger.info('Skip create new rendition with large file for document %s...' % DEMO_NEW_DOCUMENT)
logger.info('Get contents for document %s...' % DEMO_NEW_DOCUMENT)
contents = self.client.get_contents(new_doc)
logger.info('All renditions for document %s...' % DEMO_NEW_DOCUMENT)
for rendition in contents.get_entries():
logger.info(str(rendition.get('content')) + '\n')
logger.info('Delete document %s' % DEMO_NEW_DOCUMENT)
self.client.delete(new_doc)
logger.info('Delete folder %s' % DEMO_TEMP_FOLDER)
self.client.delete(temp_folder)
logger.info("+++++++++++++++++++++++++++++++Content Management End+++++++++++++++++++++++++++++++")
def demo_version_management(self):
"""
REST version management
version:7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++Version Management Start+++++++++++++++++++++++++++++++")
logger.info('Get cabinet %s...' % DEMO_CABINET)
cabinet = self.client.get_cabinet(DEMO_CABINET)
logger.info('Create temp folder %s in cabinet %s...' % (DEMO_TEMP_FOLDER, DEMO_CABINET))
temp_folder = self.client.create_folder(cabinet, ResourceUtility.generate_folder(object_name=DEMO_TEMP_FOLDER))
logger.info('Create new document %s with content...' % DEMO_NEW_DOCUMENT)
doc = self.client.create_document(temp_folder, ResourceUtility.generate_document(object_name=DEMO_NEW_DOCUMENT))
print_resource_properties(logger, doc, 'object_name', 'r_object_id', 'r_version_label')
logger.info('Check out document...')
doc = self.client.check_out(doc)
print_resource_properties(logger, doc, 'object_name', 'r_object_id', 'r_version_label')
logger.info('Cancel check out')
self.client.cancel_check_out(doc)
logger.info('Refresh document...')
doc = self.client.refresh(doc)
print_resource_properties(logger, doc, 'object_name', 'r_object_id', 'r_version_label')
logger.info('Check out document...')
doc = self.client.check_out(doc)
print_resource_properties(logger, doc, 'object_name', 'r_object_id', 'r_version_label')
logger.info('Check in minor with new name...')
doc = self.client.check_in_minor(doc,
ResourceUtility.generate_document(object_name=DEMO_CHECK_IN_WITHOUT_CONTENT))
print_resource_properties(logger, doc, 'object_name', 'r_object_id', 'r_version_label')
logger.info('Check out document...')
doc = self.client.check_out(doc)
print_resource_properties(logger, doc, 'object_name', 'r_object_id', 'r_version_label')
logger.info('Check in minor with content')
doc = self.client.check_in_minor(doc, new_obj=None, content='I am new content.')
print_resource_properties(logger, doc, 'object_name', 'r_object_id', 'r_version_label')
logger.info('Check out document...')
doc = self.client.check_out(doc)
print_resource_properties(logger, doc, 'object_name', 'r_object_id', 'r_version_label')
logger.info('Check in major with new name and content')
doc = self.client.check_in_major(doc,
new_obj=ResourceUtility.generate_document(
object_name=DEMO_CHECK_IN_WITH_CONTENT),
content='I am new content again.')
print_resource_properties(logger, doc, 'object_name', 'r_object_id', 'r_version_label')
logger.info('Delete document %s' % DEMO_NEW_DOCUMENT)
self.client.delete(doc, {'del-version': 'all'})
logger.info('Delete folder %s' % DEMO_TEMP_FOLDER)
self.client.delete(temp_folder)
logger.info("+++++++++++++++++++++++++++++++Version Management End+++++++++++++++++++++++++++++++")
def demo_batch(self):
"""
REST batch
version:7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++Batch Start+++++++++++++++++++++++++++++++")
batch_caps = self.client.get_batch_capabilities()
logger.info("\nBatchable resource:")
for batchable in batch_caps.get('batchable-resources'):
logger.info(" " + batchable)
logger.info("\nNon-batchable resource:")
for non_batchable in batch_caps.get('non-batchable-resources'):
logger.info(" " + non_batchable)
logger.info("\nsequence: " + batch_caps.get("sequence"))
logger.info("\ntransactions: " + batch_caps.get("transactions"))
cabinets_uri = self.client.get_cabinets().find_link(RestLink.REL_SELF).href
operation_1 = ResourceUtility.generate_batch_operation('id1', 'get cabinets', cabinets_uri, 'GET',
Accept=MEDIA_TYPE_DM_JSON)
users_uri = self.client.get_users(self.client.get_current_repository()).find_link(RestLink.REL_SELF).href
operation_2 = ResourceUtility.generate_batch_operation('id2', 'get users', users_uri, 'GET',
Accept=MEDIA_TYPE_DM_JSON)
cabinet_uri = self.client.get_cabinet(DEMO_CABINET).find_link(RestLink.REL_SELF).href
operation_3 = ResourceUtility.generate_batch_operation('id3', 'get cabinet', cabinet_uri, 'GET',
Accept=MEDIA_TYPE_DM_JSON)
cabinet_folders_uri = self.client.get_cabinet(DEMO_CABINET).find_link(RestLink.REL_FOLDERS).href
operation_4 = ResourceUtility.generate_batch_operation('id4', 'create folder in cabinet', cabinet_folders_uri,
'POST',
entity=ResourceUtility.generate_folder(
object_name='folder for batch').representation(),
Accept=MEDIA_TYPE_DM_JSON)
batch = ResourceUtility.generate_batch_request(operation_1, operation_2, operation_3, operation_4)
logger.info("\nCreate batch:\n")
for operation in batch.get('operations'):
logger.info("------------------")
print_properties(logger, operation, 'id', 'description')
print_properties(logger, operation.get('request'), 'method', 'uri')
batch_results = self.client.create_batch(batch)
logger.info("\nThe batch results:\n")
for result in batch_results.get('operations'):
logger.info("------------------")
print_properties(logger, result, 'id', 'description', 'state')
logger.info("\n+++++++++++++++++++++++++++++++Batch End+++++++++++++++++++++++++++++++")
def demo_dql(self):
"""
REST DQL
version: 7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++DQL Start+++++++++++++++++++++++++++++++")
logger.info('Query \'select * from dm_user\' with items-per-page=3,page=2...')
results = self.client.dql('select * from dm_user', {'items-per-page': '2', 'page': '2'})
logger.info('Object names in page %d...', 2)
for result in results.get_entries():
logger.info(result.get('content').get('properties').get('user_name'))
logger.info('')
logger.info('Navigate to next page...')
results = self.client.next_page(results)
if results is None:
logger.info('Next page does not exist.')
else:
logger.info('Object names in page %d...', 3)
for result in results.get_entries():
logger.info(result.get('content').get('properties').get('user_name'))
logger.info("+++++++++++++++++++++++++++++++DQL End+++++++++++++++++++++++++++++++")
def demo_simple_search(self):
"""
REST search with URL parameters
version:7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++Simple Search Start+++++++++++++++++++++++++++++++")
logger.info('Simple search with keyword emc and parameters items-per-page=3,page=2,inline=true...')
results = self.client.simple_search('emc', {'items-per-page': '2', 'page': '1', 'inline': 'true'})
logger.info('Object names in page %d...', 2)
for result in results.get_entries():
logger.info(result.get('content').get('properties').get('object_name'))
logger.info('Navigate to next page...')
results = self.client.next_page(results)
if results is None:
logger.info('Next page does not exist.')
else:
logger.info('Object names in page %d...', 3)
for result in results.get_entries():
logger.info(result.get('content').get('properties').get('object_name'))
logger.info("+++++++++++++++++++++++++++++++Simple Search End+++++++++++++++++++++++++++++++")
def demo_aql_search(self):
"""
REST search with AQL
version:7.3
"""
logger.info("\n+++++++++++++++++++++++++++++++AQL Search Start+++++++++++++++++++++++++++++++")
query_doc = ResourceUtility.generate_query_document(types=['dm_sysobject'], columns=['object_name'],
sorts=[Sort('object_name', True, 'en', True)],
expression_set=ExpSet('AND', FtExp('emc or rest')))
logger.info('AQL search for keyword emc and parameters items-per-page=3,page=2,inline=true...')
results = []
try:
results = self.client.aql_search(query_doc.dump(), {'items-per-page': '2', 'page': '1', 'inline': 'true'})
except IOError:
logger.info('Fail to search with AQL.')
logger.info('Object names in page %d...', 2)
for result in results.get_entries():
logger.info(result.get('content').get('properties').get('object_name'))
logger.info('Navigate to next page...')
results = self.client.next_page(results)
if results is None:
logger.info('Next page does not exist.')
else:
logger.info('Object names in page %d...', 3)
for result in results.get_entries():
logger.info(result.get('content').get('properties').get('object_name'))
# add facet definitions in search criteria
self.step_separator('Facet against attribute {}'.format('r_object_type'))
query_doc.facet_definitions = [
FacetDefinition(facet_id='facet_r_object_type', attributes=['r_object_type'])]
try:
results = self.client.aql_search(query_doc.dump(), {'items-per-page': '2', 'page': '1', 'inline': 'true'})
except IOError:
logger.info('Fail to search with AQL.')
logger.info('Facet results:')
for facet in results.get('facets')[0].get('facet-value'):
logger.info('group for %s has %s results and the navigation link is %s',
facet.get('facet-value-constraint'), facet.get('facet-value-count'),
facet.get('link').get('href'))
logger.info("\n+++++++++++++++++++++++++++++++AQL Search End+++++++++++++++++++++++++++++++")
def demo_saved_search(self):
"""
REST Saved Search
version: 7.3
"""
logger.info("\n+++++++++++++++++++++++++++++++Saved Search Start+++++++++++++++++++++++++++++++")
self.step_separator('Create a saved search...')
query_doc = ResourceUtility.generate_query_document(types=['dm_sysobject'], columns=['object_name'],
sorts=[Sort('object_name', True, 'en', True)],
expression_set=ExpSet('AND', FtExp('emc or rest')))
new_saved_search = ResourceUtility.generate_saved_search('New saved search',
'This is a new saved search for demo', True,
query_doc=query_doc)
saved_search = self.client.create_saved_search(new_saved_search)
properties = saved_search.get('properties')
logger.info('New saved search is created at {}.\n name:{},\n description: {},\n is_public: {}'.format(
properties.get('r_creation_date'), properties.get('object_name'), properties.get('title'),
properties.get('r_is_public')))
self.step_separator("Get saved searches...")
saved_searches = self.client.get_saved_searches()
if len(saved_searches.get_entries()) > 0:
logger.info('Saved searches: ')
for saved_search in saved_searches.get_entries():
logger.info(saved_search.get('title'))
self.step_separator('Get one saved search "{0}"...'.format(saved_searches.get_entry(0).get('title')))
saved_search = self.client.get_saved_search(saved_searches.get_entry(0).get('title'))
properties = saved_search.get('properties')
logger.info(
'name: {},\n public: {},\n has results: {}'.format(properties.get('object_name'),
properties.get('r_is_public'),
properties.get('has_results')))
logger.info('saved AQL is:\n {}'.format(format_json(saved_search.get('query-document')), indent=4))
self.step_separator('Update the saved search...')
update_saved_search = ResourceUtility.generate_saved_search('New saved search',
'This is a new saved search for demo', False,
query_doc=query_doc)
saved_search = self.client.update(saved_search, update_saved_search)
properties = saved_search.get('properties')
logger.info('New saved search is created at {}.\n name:{},\n description: {},\n is_public: {}'.format(
properties.get('r_creation_date'), properties.get('object_name'), properties.get('title'),
properties.get('r_is_public')))
self.step_separator('Execute the saved search...')
results = self.client.execute_saved_search(saved_search,
{'items-per-page': '2', 'page': '1', 'inline': 'true'})
logger.info('Object names in page %d...', 2)
for result in results.get_entries():
logger.info(result.get('content').get('properties').get('object_name'))
self.step_separator('Get saved results...')
# noinspection PyBroadException
try:
self.client.get_saved_results(saved_search)
except:
logger.info('The saved results are disabled by default.')
self.step_separator('Enable saved results...')
results = self.client.enable_saved_results(saved_search)
for result in results.get_entries():
logger.info(result.get('title'))
self.step_separator('Get saved results after it is enabled...')
results = self.client.get_saved_results(saved_search, {'items-per-page': '2', 'page': '1', 'inline': 'true'})
logger.info('Object names in page %d...', 2)
for result in results.get_entries():
logger.info(result.get('content').get('properties').get('object_name'))
self.step_separator('Disable saved results...')
self.client.disable_saved_results(saved_search)
self.step_separator('Get saved results again after it is disabled...')
# noinspection PyBroadException
try:
self.client.get_saved_results(saved_search)
except:
logger.info('The saved results are disabled again - no results')
self.step_separator('Delete saved search...')
self.client.delete(saved_search)
logger.info("\n+++++++++++++++++++++++++++++++Saved Search End+++++++++++++++++++++++++++++++")
def demo_search_template(self):
"""
REST Search Template
version:7.3
"""
logger.info("\n+++++++++++++++++++++++++++++++Search Template Start+++++++++++++++++++++++++++++++")
self.step_separator('Create a search template...')
query_doc = ResourceUtility.generate_query_document(types=['dm_sysobject'], columns=['object_name'],
sorts=[Sort('object_name', True, 'en', True)],
expression_set=ExpSet('AND', FtExp('emc or rest',
is_template=True)))
new_search_template = ResourceUtility.generate_search_template('New search template',
'This is a new search template for demo', True,
query_doc=query_doc)
search_template = self.client.create_search_template(new_search_template)
properties = search_template.get('properties')
logger.info('New search template is created at {}.\n name:{},\n description: {},\n is_public: {}'.format(
properties.get('r_creation_date'), properties.get('object_name'), properties.get('subject'),
properties.get('r_is_public')))
logger.info('Get search templates...')
search_templates = self.client.get_search_templates()
if len(search_templates.get_entries()) > 0:
logger.info('Saved searches: ')
for search_template in search_templates.get_entries():
logger.info(search_template.get('title'))
self.step_separator('Get one search template "{0}"...'.format(search_templates.get_entry(0).get('title')))
search_template = self.client.get_search_template(search_templates.get_entry(0).get('title'))
properties = search_template.get('properties')
logger.info(
'name: {},\n public: {},\n description: {}'.format(properties.get('object_name'),
properties.get('r_is_public'),
properties.get('subject')))
logger.info('\nexternal variables:')
for v in search_template.get('external-variables'):
logger.info(
'id: {},\nvariable type: {},\ndata type: {},\nvalue: {}'.format(v.get('id'), v.get('variable-type'),
v.get('data-type'),
v.get('variable-value')))
logger.info(
'saved AQL is:\n {}'.format(
format_json(search_template.get('query-document-template')), indent=4))
self.step_separator('Execute the search template...')
input_variables = ResourceUtility.generate_search_template_variables(search_template.get('external-variables'),
self.prompt.search_template_var)
results = self.client.execute_search_template(search_template, variables=input_variables,
params={'items-per-page': '2', 'page': '1', 'inline': 'true'})
logger.info('Object names in page %d...', 2)
for result in results.get_entries():
logger.info(result.get('content').get('properties').get('object_name'))
self.step_separator('Delete the search template...')
self.client.delete(search_template)
logger.info("\n+++++++++++++++++++++++++++++++Search Template End+++++++++++++++++++++++++++++++")
def demo_type(self):
"""
REST type
version:7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++Type Start+++++++++++++++++++++++++++++++")
logger.info('Get types resource...')
dm_types = self.client.get_types()
if len(dm_types.get_entries()) > 0:
logger.info('Types are \n')
for dm_type in dm_types.get_entries():
logger.info(dm_type.get('title'))
logger.info('\nGet single dm_document type resource...')
dm_type = self.client.get_type('dm_document')
logger.info('Type name: %s, Type label: %s, Type category: %s', dm_type.get('name'), dm_type.get('label'),
dm_type.get('category'))
logger.info("\n+++++++++++++++++++++++++++++++Type End+++++++++++++++++++++++++++++++")
def demo_value_assistance(self):
"""
REST value assistance
version:7.3
"""
logger.info("\n+++++++++++++++++++++++++++++++Value Assistance Start+++++++++++++++++++++++++++++++")
logger.info('Get the value assistance of the type...')
dm_type_str = self.prompt.type_fixed_va()
if dm_type_str:
dm_type = self.client.get_type(dm_type_str)
if dm_type:
included_property = self.prompt.attribute_fixed_va(dm_type_str)
value_assistance = self.client.get_value_assistance(dm_type,
ResourceUtility.generate_assist_value_request(),
included_property)
for va in value_assistance.get('properties').items():
logger.info('Attribute %s allow-user-values: %s' % (va[0], va[1].get('allow-user-values')))
for value in va[1].get('values'):
logger.info('Allowed value is %s, label is %s' % (value.get('value'), value.get('label')))
else:
logger.info('Skip get value assistance as type specified does not exist.')
else:
logger.info('Skip get value assistance.')
# E.G. city_type.city depends on city_type.country
# country China has cities Shanghai, Beijing, Chongqing, Grangzhou, Shenzhen and Tianjing
dm_type_str = self.prompt.type_dep_va()
if dm_type_str:
dm_type = self.client.get_type(dm_type_str)
for attr in dm_type.get('properties'):
logger.info('Attribute %s.%s has dependency %s' % (
dm_type.get('name'), attr.get('name'), attr.get('dependencies')))
attr_name = self.prompt.attribute_va(dm_type_str)
dependency_attr_name = self.prompt.attribute_dep_va(dm_type_str, attr_name)
dependency_attr_value = self.prompt.attribute_dep_value_va(dependency_attr_name)
properties = {dependency_attr_name: dependency_attr_value}
value_assistance = self.client.get_value_assistance(dm_type,
ResourceUtility.generate_assist_value_request(
**properties),
attr_name)
logger.info('Attribute %s.%s allows values:' % (dm_type_str, attr_name))
for value in value_assistance.get('properties').get('city').get('values'):
logger.info('%s, label: %s' % (value.get('value'), value.get('label')))
else:
logger.info('Skip get value assistance dependencies.')
logger.info("\n+++++++++++++++++++++++++++++++Value Assistance End+++++++++++++++++++++++++++++++")
def demo_relation_crud(self):
"""
REST relation CRUD
version:7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++Relation CRUD Start+++++++++++++++++++++++++++++++")
logger.info('Get relations in repository %s...' % self.REST_REPOSITORY)
self.client.get_relations()
logger.info('Create relation in repository %s...' % self.REST_REPOSITORY)
logger.info('Get cabinet %s...' % DEMO_CABINET)
cabinet = self.client.get_cabinet(DEMO_CABINET)
logger.info('Create new sysobject as relation parent...')
parent = self.client.create_sysobj(cabinet,
ResourceUtility.generate_sysobject(object_name='relation-parent'))
print_resource_properties(logger, parent, 'object_name', 'r_object_id')
logger.info('Create new sysobject as relation child...')
child = self.client.create_sysobj(cabinet,
ResourceUtility.generate_sysobject(object_name='relation-child'))
print_resource_properties(logger, child, 'object_name', 'r_object_id')
logger.info('Create new relation...')
new_relation = self.client.create_relation(ResourceUtility.generate_relation(relation_name='peer',
parent_id=parent.get(
'properties').get(
'r_object_id'),
child_id=child.get(
'properties').get(
'r_object_id'),
))
print_resource_properties(logger, new_relation, 'object_name', 'r_object_id')
logger.info('Delete the new relation...')
self.client.delete(new_relation)
logger.info('Get relation types...')
relation_types = self.client.get_relation_types()
if len(relation_types.get_entries()) > 0:
logger.info('Types are \n')
for relation_type in relation_types.get_entries():
logger.info(relation_type.get('title'))
if len(relation_types.get_entries()) > 0:
logger.info('Get relation type resource...')
title = relation_types.get_entry(0).get('title')
relation_type = self.client.get_relation_type(title)
logger.info('The relation type %s is returned; \nits link is %s',
relation_type.get('properties').get('relation_name'),
relation_type.find_link(RestLink.REL_SELF).href)
logger.info("\n+++++++++++++++++++++++++++++++Relation CRUD End+++++++++++++++++++++++++++++++")
def demo_format(self):
"""
REST formats
version: 7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++Format CRUD Start+++++++++++++++++++++++++++++++")
logger.info('Get formats in repository %s...' % self.REST_REPOSITORY)
formats = self.client.get_formats({'items-per-page': 5})
if len(formats.get_entries()) > 0:
logger.info('Formats are \n')
for dm_format in formats.get_entries():
logger.info(dm_format.get('title'))
if len(formats.get_entries()) > 0:
logger.info('\nGet single format in repository %s...' % self.REST_REPOSITORY)
title = formats.get_entry(0).get('title')
dm_format = self.client.get_format(title)
logger.info('The format name is %s, description is %s', dm_format.get('properties').get('name'),
dm_format.get('properties').get('description'))
logger.info("\n+++++++++++++++++++++++++++++++Format CRUD End+++++++++++++++++++++++++++++++")
def demo_network_location(self):
"""
REST network locations
version:7.2
"""
logger.info("\n+++++++++++++++++++++++++++++++Network location Start+++++++++++++++++++++++++++++++")
logger.info('Get network locations in repository %s...' % self.REST_REPOSITORY)
locations = self.client.get_network_locations()
if len(locations.get_entries()) > 0:
logger.info('Locations are \n')
for location in locations.get_entries():
logger.info(location.get('title'))
if len(locations.get_entries()) > 0:
logger.info('Get single network location in repository %s...' % self.REST_REPOSITORY)
title = locations.get_entry(0).get('title')
location = self.client.get_network_location(title)
logger.info('The single network location %s is returned; \nits link is %s',
location.get('properties').get('object_name'), location.find_link(RestLink.REL_SELF).href)
logger.info("\n+++++++++++++++++++++++++++++++Network location End+++++++++++++++++++++++++++++++")
def demo_lightweight_object(self):
"""REST lightweight object
version:7.3
"""
logger.info(
"\n+++++++++++++++++++++++++++++++Lightweight object Start+++++++++++++++++++++++++++++++")
sharable_types = self.client.get_types({'filter': 'type_category=2'})
logger.info('\nSharable types:')
for entry in sharable_types.get_entries():
logger.info(entry.get('title'))
lightweight_types = self.client.get_types({'filter': 'type_category=4'})
logger.info('\nLightweight types:')
for entry in lightweight_types.get_entries():
logger.info(entry.get('title'))
cabinet = self.client.get_cabinet(DEMO_CABINET)
sharable_type = self.prompt.sharable_type()
if not sharable_type:
logger.info('Skip lightweight object demo.')
else:
logger.info('Create object %s of sharable type %s...' % (DEMO_SHARABLE_OBJECT, sharable_type))
sharable_obj = self.client.create_sysobj(cabinet,
ResourceUtility.generate_sysobject(
sharable_type,
object_name=DEMO_SHARABLE_OBJECT,
title='demo_sharable_type'))
lightweight_type = self.prompt.lightweight_type()
logger.info('Create object %s of lightweight type %s...' % (DEMO_LIGHT_WEITHT_OBJECT, lightweight_type))
lw_obj = self.client.create_sysobj(sharable_obj,
ResourceUtility.generate_sysobject(lightweight_type,
object_name=DEMO_LIGHT_WEITHT_OBJECT),
RestLink.REL_LIGHTWEIGHT_OBJECTS)
logger.info('Materialize the lightweight object %s...\n' % lw_obj.get('properties').get('object_name'))
materialized_object = self.client.materialize(lw_obj)
if materialized_object.find_link(RestLink.REL_DEMATERIALIZE) is not None:
logger.info('Materializing succeeds...\n')
logger.info('Dematerialize the lightweight object %s...\n' % lw_obj.get('properties').get('object_name'))
self.client.dematerialize(materialized_object)
lw_obj = self.client.refresh(lw_obj)
if lw_obj.find_link(RestLink.REL_MATERIALIZE) is not None:
logger.info('Dematerializing succeeds...\n')
logger.info(
'Create another object %s of sharable type %s...\n' % (DEMO_ANOTHER_SHARABLE_OBJECT, sharable_type))
another_sharable_obj = self.client \
.create_sysobj(cabinet,
ResourceUtility.generate_sysobject(sharable_type,
object_name=DEMO_ANOTHER_SHARABLE_OBJECT,
title='demo_sharable_type'))
logger.info('Reparent the lightweight object %s to the new sharable object %s...\n' % (
lw_obj.get('properties').get('object_name'),
another_sharable_obj.get('properties').get('object_name')))
self.client.reparent(lw_obj, another_sharable_obj)
new_parent = self.client.get_sharable_parent(lw_obj)
if new_parent.get('properties').get('r_object_id') == another_sharable_obj.get('properties').get(
'r_object_id'):
logger.info('Reparent succeeds...\n')
self.client.delete(lw_obj)
self.client.delete(sharable_obj)
self.client.delete(another_sharable_obj)
logger.info("\n+++++++++++++++++++++++++++++++Lightweight object End+++++++++++++++++++++++++++++++")
def demo_aspect(self):
"""
REST aspect
version:7.3
"""
logger.info("\n+++++++++++++++++++++++++++++++Aspect Start+++++++++++++++++++++++++++++++")
logger.info('Get all aspects...')
aspects = self.client.get_aspects()
for entry in aspects.get_entries():
logger.info('Aspect name: %s', entry.get('title'))
aspect_type = self.prompt.aspect_type()
if aspect_type:
cabinet = self.client.get_cabinet(DEMO_CABINET)
logger.info('Create object %s to attach aspect...', DEMO_OBJECT_TO_ATTACH)
obj = self.client.create_sysobj(cabinet,