iteration 4 & last:
[plcapi.git] / TestPeers.py
1 #!/usr/bin/env python
2 ###
3 ##############################
4 ###
5 ### preparation / requirements
6 ###
7 ### two separate instances of myplc
8 ### for now they are located on the same box on lurch
9 ###
10 ### expectations :
11 ### your myplcs should more or less come out of the box, 
12 ### I prefer not to alter the default PLC_ROOT_USER value,
13 ### instead we create a PI account on the site_id=1
14 ###
15 ##############################
16
17 # support reloading without wiping everything off
18 # dunno how to do (defvar plc)
19
20 ## we use indexes 1 and 2 
21 try:
22     dir(plc)
23 except:
24     plc=[None,None,None]
25 ## the server objects
26 try:
27     dir(s)
28 except:
29     s=[None,None,None]
30 ## the authentication objects
31 ## our user
32 try:
33     dir(a)
34 except:
35     a=[None,None,None]
36 ## the builtin root user for bootstrapping
37 try:
38     dir(aa)
39 except:
40     aa=[None,None,None]
41
42 ####################
43 import xmlrpclib
44 import os
45
46 ####################
47 plc1={ 'plcname':'plc1 in federation',
48        'hostname':'lurch.cs.princeton.edu',
49        'url-format':'https://%s:443/PLCAPI/',
50        'builtin_admin_id':'root@localhost.localdomain',
51        'builtin_admin_password':'root',
52        'peer_admin_name':'plc1@planet-lab.org',
53        'peer_admin_password':'peer',
54        'node-format':'n1%02d.plc1.org',
55        'plainname' : 'one',
56        'slice-format' : 's1%02d',
57        }
58 plc2={ 'plcname':'plc2 in federation',
59        'hostname':'planetlab-devbox.inria.fr',
60        'url-format':'https://%s:443/PLCAPI/',
61        'builtin_admin_id':'root@localhost.localdomain',
62        'builtin_admin_password':'root',
63        'peer_admin_name':'plc2@planet-lab.org',
64        'peer_admin_password':'peer',
65        'node-format':'n2%02d.plc2.org',
66        'plainname' : 'two',
67        'slice-format' : 's2%02d',
68        }
69
70 ####################
71 # set initial conditions
72 def define_test (nodes,slices):
73     global number_nodes, number_slices
74     number_nodes=nodes
75     number_slices=slices
76
77 def fast():
78     define_test(1,1)
79     
80 define_test (nodes=5,slices=3)
81
82 # predefined stuff
83 system_slices_ids = (1,2)
84 def system_slices ():
85     return len(system_slices_ids)
86 # temporary - the myplc I use doesnt know about 'system' yet
87 def system_slivers ():
88 #    return len(system_slices_ids)
89     return 0
90
91 def total_slices ():
92     return number_slices+system_slices()
93 def total_slivers ():
94     return number_slices+system_slivers()
95
96 ####################
97 def peer_index(i):
98     return 3-i
99
100 def plc_name (i):
101     return plc[i]['plcname']
102
103 def site_name (i):
104     return 'site'+str(i)
105
106 def node_name (i,n):
107     return plc[i]['node-format']%n
108
109 def slice_name (i,n):
110     return plc[i]['plainname']+'_'+plc[i]['slice-format']%n
111
112 # to have indexes start at 1
113 def myrange (n):
114     return range (1,n+1,1)
115
116 def message (*args):
117     print "XXXXXXXXXXXXXXXXXXXX",
118     print args
119     
120 ####################
121 def test00_init (args=[1,2]):
122     global plc,s,a,aa
123     ## have you loaded this file already (support for reload)
124     if plc[1]:
125         pass
126     else:
127         plc=[None,plc1,plc2]
128         for i in args:
129             url=plc[i]['url-format']%plc[i]['hostname']
130             plc[i]['url']=url
131             s[i]=xmlrpclib.ServerProxy(url,allow_none=True)
132             print 'initializing s[%d]'%i,url
133             aa[i]={'Username':plc[i]['builtin_admin_id'],
134                    'AuthMethod':'password',
135                    'AuthString':plc[i]['builtin_admin_password'],
136                    'Role':'admin'}
137             print 'initialized aa[%d]'%i, aa[i]
138             a[i]={'Username':plc[i]['peer_admin_name'],
139                   'AuthMethod':'password',
140                   'AuthString':plc[i]['peer_admin_password'],
141                   'Role':'admin'}
142             print 'initialized a[%d]'%i, a[i]
143
144 def test00_print (args=[1,2]):
145     global plc,s,a,aa
146     for i in args:
147         print 's[%d]'%i,s[i]
148         print 'aa[%d]'%i, aa[i]
149         print 'a[%d]'%i, a[i]
150
151 def check_nodes (en,ef,args=[1,2]):
152     global plc,s,a
153     for i in args:
154         # use a single request and sort afterwards for efficiency
155         # could have used GetNodes's scope as well
156         all_nodes = s[i].GetNodes(a[i])
157         n = len ([ x for x in all_nodes if x['peer_id'] is None])
158         f = len ([ x for x in all_nodes if x['peer_id'] is not None])
159         print '%02d: Checking nodes: got %d local (e=%d) & %d foreign (e=%d)'%(i,n,en,f,ef)
160         assert n==en
161         assert f==ef
162
163 # expected : local slices, foreign slices
164 def check_slices (els,efs,args=[1,2]):
165     global plc,s,a
166     for i in args:
167         ls=len(s[i].GetSlices(a[i],{'peer_id':None}))
168         fs=len(s[i].GetSlices(a[i],{'~peer_id':None}))
169         print '%02d: Checking slices: got %d local (e=%d) & %d foreign (e=%d)'%(i,ls,els,fs,efs)
170         assert els==ls
171         assert efs==fs
172
173 def show_nodes (i,node_ids):
174     # same as above
175     all_nodes = s[i].GetNodes(a[i],node_ids)
176     loc_nodes = filter (lambda n: n['peer_id'] is None, all_nodes)
177     for_nodes = filter (lambda n: n['peer_id'] is not None, all_nodes)
178
179     for message,nodes in [ ['LOC',loc_nodes], ['FOR',for_nodes] ] :
180         if nodes:
181             print '[%s:%d] : '%(message,len(nodes)),
182             for node in nodes:
183                 print node['hostname']+' ',
184             print ''
185
186 def check_slice_nodes (expected_nodes, is_local_slice, args=[1,2]):
187     for ns in myrange(number_slices):
188         check_slice_nodes_n (ns,expected_nodes, is_local_slice, args)
189
190 def check_slice_nodes_n (ns,expected_nodes, is_local_slice, args=[1,2]):
191     global plc,s,a
192     for i in args:
193         peer=peer_index(i)
194         if is_local_slice:
195             sname=slice_name(i,ns)
196             slice=s[i].GetSlices(a[i],{'name':[sname],'peer_id':None})[0]
197             message='local'
198         else:
199             sname=slice_name(peer,ns)
200             slice=s[i].GetSlices(a[i],{'name':[sname],'~peer_id':None})[0]
201             message='foreign'
202         print '%02d: %s slice %s (e=%d) '%(i,message,sname,expected_nodes),
203         slice_node_ids=slice['node_ids']
204         print 'on nodes ',slice_node_ids
205         show_nodes (i,slice_node_ids)
206         assert len(slice_node_ids)==expected_nodes
207
208 # expected : nodes on local slice
209 def check_local_slice_nodes (expected, args=[1,2]):
210     check_slice_nodes(expected,True,args)
211
212 # expected : nodes on foreign slice
213 def check_foreign_slice_nodes (expected, args=[1,2]):
214     check_slice_nodes(expected,False,args)
215
216 def check_conf_files (args=[1,2]):
217     for nn in myrange(number_nodes):
218         check_conf_files_n (nn,args)
219
220 def check_conf_files_n (nn,args=[1,2]):
221     global plc,s,a
222     for i in args:
223         nodename=node_name(i,nn)
224         ndict= s[i].GetSlivers(a[i],[nodename])[0]
225         assert ndict['hostname'] == nodename
226         conf_files = ndict['conf_files']
227         print '%02d: %d conf_files in GetSlivers for node %s'%(i,len(conf_files),nodename)
228         for conf_file in conf_files:
229             print 'source=',conf_file['source'],'|',
230             print 'dest=',conf_file['dest'],'|',
231             print 'enabled=',conf_file['enabled'],'|',
232             print ''
233
234 import pprint
235 pp = pprint.PrettyPrinter(indent=3)
236
237 def check_slivers (esn,args=[1,2]):
238     for nn in myrange(number_nodes):
239         check_slivers_n (nn,esn,args)
240
241 # too verbose to check all nodes, let's check only the first one
242 def check_slivers_1 (esn,args=[1,2]):
243     check_slivers_n (1,esn,args)
244
245 def check_slivers_n (nn,esn,args=[1,2]):
246     global plc,s,a
247     for i in args:
248         nodename=node_name(i,nn)
249         ndict= s[i].GetSlivers(a[i],[nodename])[0]
250         assert ndict['hostname'] == nodename
251         slivers = ndict['slivers']
252         print '%02d: %d slivers (exp. %d) in GetSlivers for node %s'\
253               %(i,len(slivers),esn,nodename)
254         for sliver in slivers:
255             print '>>slivername = ',sliver['name']
256             pp.pprint(sliver)
257         assert len(slivers) == esn
258                 
259
260 ####################
261 def test00_admin_person (args=[1,2]):
262     global plc,s,a
263     for i in args:
264         email = plc[i]['peer_admin_name']
265         try:
266             p=s[i].GetPersons(a[i],[email])[0]
267             plc[i]['peer_admin_id']=p['person_id']
268         except:
269             person_id=s[i].AddPerson(aa[i],{'first_name':'Local', 'last_name':'PeerPoint', 'role_ids':[10],
270                                             'email':email,'password':plc[i]['peer_admin_password']})
271             print '%02d: created peer admin account %d, %s - %s'%(i,person_id,plc[i]['peer_admin_name'],plc[i]['peer_admin_password'])
272             plc[i]['peer_admin_id']=person_id
273
274 def test00_admin_enable (args=[1,2]):
275     global plc,s,a
276     for i in args:
277         s[i].AdmSetPersonEnabled(aa[i],plc[i]['peer_admin_id'],True)
278         s[i].AddRoleToPerson(aa[i],'admin',plc[i]['peer_admin_id'])
279         print '%02d: enabled+admin on account %d:%s'%(i,plc[i]['peer_admin_id'],plc[i]['peer_admin_name'])
280
281 ####################
282 def test01_site (args=[1,2]):
283     global plc,s,a
284     for i in args:
285         peer=peer_index(i)
286         ### create a site (required for creating a slice)
287         sitename=site_name(i)
288         abbrev_name="abbr"+str(i)
289         login_base=plc[i]['plainname']
290         ### should be enough - needs to check we can add/del slices
291         max_slices = number_slices 
292         try:
293             s[i].GetSites(a[i],{'login_base':login_base})[0]
294         except:
295             site_id=s[i].AddSite (a[i], {'name':plc_name(i),
296                                          'abbreviated_name': abbrev_name,
297                                          'login_base': login_base,
298                                          'is_public': True,
299                                          'url': 'http://%s.com/'%abbrev_name,
300                                          'max_slices':max_slices})
301         ### max_slices does not seem taken into account at that stage
302             s[i].UpdateSite(a[i],site_id,{'max_slices':max_slices})
303             print '%02d: Created site %d with max_slices=%d'%(i,site_id,max_slices)
304             plc[i]['site_id']=site_id
305
306 def test01_peer_person (args=[1,2]):
307     global plc,s,a
308     for i in args:
309         peer=peer_index(i)
310         email=plc[peer]['peer_admin_name']
311         try:
312             p=s[i].GetPersons(a[i],[email])[0]
313             plc[i]['peer_person_id']=p['person_id']
314         except:
315             person_id = s[i].AddPerson (a[i], {'first_name':'Peering(plain passwd)', 'last_name':plc_name(peer), 'role_ids':[3000],
316                                                'email':email,'password':plc[peer]['peer_admin_password']})
317             print '%02d:Created person %d as the peer person'%(i,person_id)
318             plc[i]['peer_person_id']=person_id
319
320 def test01_peer (args=[1,2]):
321     global plc,s,a
322     for i in args:
323         peer=peer_index(i)
324         peername = plc_name(peer)
325         try:
326             p=s[i].GetPeers (a[i], [peername])[0]
327             plc[i]['peer_id']=p['peer_id']
328         except:
329             peer_id=s[i].AddPeer (a[i], {'peername':peername,'peer_url':plc[peer]['url'],'person_id':plc[i]['peer_person_id']})
330             # NOTE : need to manually reset the encrypted password through SQL at this point
331             print '%02d:Created peer %d'%(i,peer_id)
332             plc[i]['peer_id']=peer_id
333             print "PLEASE manually set password for person_id=%d in DB%d"%(plc[i]['peer_person_id'],i)
334
335 def test01_peer_passwd (args=[1,2]):
336     global plc,s,a
337     for i in args:
338         # using an ad-hoc local command for now - never could get quotes to reach sql....
339         print "Attempting to set passwd for person_id=%d in DB%d"%(plc[i]['peer_person_id'],i),
340         retcod=os.system("ssh root@%s new_plc_api/person-password.sh %d"%(plc[i]['hostname'],plc[i]['peer_person_id']))
341         print '-> system returns',retcod
342     
343 ##############################
344 # this one gets cached 
345 def get_peer_id (i):
346     try:
347         return plc[i]['peer_id']
348     except:
349         peername = plc_name (peer_index(i))
350         peer_id = s[i].GetPeers(a[i],[peername])[0]['peer_id']
351         plc[i]['peer_id'] = peer_id
352         return peer_id
353
354 def test01_refresh (args=[1,2]):
355     global plc,s,a
356     for i in args:
357         print '%02d: Refreshing peer'%(i),
358         retcod=s[i].RefreshPeer(a[i],get_peer_id(i))
359         print 'got ',retcod
360
361 ####################
362 # retrieves node_id from hostname - checks for local nodes only
363 def get_local_node_id(i,nodename):
364     return s[i].GetNodes(a[i],[nodename],None,'local')[0]['node_id']
365
366 # clean all local nodes - foreign nodes are not supposed to be cleaned up manually
367 def clean_all_nodes (args=[1,2]):
368     global plc,s,a
369     for i in args:
370         print '%02d: Cleaning all nodes'%i
371         loc_nodes = s[i].GetNodes(a[i],None,None,'local')
372         for node in loc_nodes:
373             print '%02d: > Cleaning node %d'%(i,node['node_id'])
374             s[i].DeleteNode(a[i],node['node_id'])
375
376 def test02_node (args=[1,2]):
377     for nn in myrange(number_nodes):
378         test02_node_n (nn,args)
379
380 def test02_node_n (nn,args=[1,2]):
381     global plc,s,a
382     for i in args:
383         nodename = node_name(i,nn)
384         try:
385             get_local_node_id(i,nodename)
386         except:
387             n=s[i].AddNode(a[i],1,{'hostname': nodename})
388             print '%02d: Added node %d %s'%(i,n,node_name(i,i))
389
390 def test02_delnode (args=[1,2]):
391     for nn in myrange(number_nodes):
392         test02_delnode_n (nn,args)
393
394 def test02_delnode_n (nn,args=[1,2]):
395     global plc,s,a
396     for i in args:
397         nodename = node_name(i,nn)
398         node_id = get_local_node_id (i,nodename)
399         retcod=s[i].DeleteNode(a[i],nodename)
400         print '%02d: Deleted node %d, returns %s'%(i,node_id,retcod)
401
402 ####################
403 def clean_all_slices (args=[1,2]):
404     global plc,s,a
405     for i in args:
406         print '%02d: Cleaning all slices'%i
407         for slice in s[i].GetSlices(a[i],{'peer_id':None}):
408             slice_id = slice['slice_id']
409             if slice_id not in system_slices_ids:
410                 print '%02d: > Cleaning slice %d'%(i,slice_id)
411                 s[i].DeleteSlice(a[i],slice_id)
412
413 def get_local_slice_id (i,name):
414     return s[i].GetSlices(a[i],{'name':[name],'peer_id':None})[0]['slice_id']
415
416 def test03_slice (args=[1,2]):
417     for n in myrange(number_slices):
418         test03_slice_n (n,args)
419
420 def test03_slice_n (ns,args=[1,2]):
421     global plc,s,a
422     for i in args:
423         peer=peer_index(i)
424         plcname=plc_name(i)
425         slicename=slice_name(i,ns)
426         max_nodes=number_nodes
427         try:
428             s[i].GetSlices(a[i],[slicename])[0]
429         except:
430             slice_id=s[i].AddSlice (a[i],{'name':slicename,
431                                           'description':'slice %s on %s'%(slicename,plcname),
432                                           'url':'http://planet-lab.org/%s'%slicename,
433                                           'max_nodes':max_nodes,
434                                           'instanciation':'plc-instantiated',
435                                           })
436             print '%02d: created slice %d - max nodes=%d'%(i,slice_id,max_nodes)
437         
438
439 def test04_node_slice (is_local, add_if_true, args=[1,2]):
440     for ns in myrange(number_slices):
441         test04_node_slice_ns (ns,is_local, add_if_true, args)
442
443 def test04_node_slice_ns (ns,is_local, add_if_true, args=[1,2]):
444     test04_node_slice_nl_n (myrange(number_nodes),ns,is_local, add_if_true, args)
445
446 def test04_node_slice_nl_n (nnl,ns,is_local, add_if_true, args=[1,2]):
447     global plc,s,a
448     for i in args:
449         peer=peer_index(i)
450         slice_id = get_local_slice_id (i,slice_name (i,ns))
451         
452         if is_local:
453             hostnames=[node_name(i,nn) for nn in nnl]
454             nodetype='local'
455         else:
456             hostnames=[node_name(peer,nn) for nn in nnl]
457             nodetype='foreign'
458         if add_if_true:
459             s[i].AddSliceToNodes (a[i], slice_id,hostnames)
460             message="added"
461         else:
462             s[i].DeleteSliceFromNodes (a[i], slice_id,hostnames)
463             message="deleted"
464         print '%02d: %s in slice %d %s '%(i,message,slice_id,nodetype),
465         print hostnames
466
467 def test04_slice_add_lnode (args=[1,2]):
468     test04_node_slice (True,True,args)
469
470 def test04_slice_add_fnode (args=[1,2]):
471     test04_node_slice (False,True,args)
472
473 def test04_slice_del_lnode (args=[1,2]):
474     test04_node_slice (True,False,args)
475
476 def test04_slice_del_fnode (args=[1,2]):
477     test04_node_slice (False,False,args)
478
479 ####################
480 def test_all_init ():
481     message ("INIT")
482     test00_init ()
483     test00_print ()
484     test00_admin_person ()
485     test00_admin_enable ()
486     test01_peer_person ()
487     test01_peer ()
488     test01_peer_passwd ()
489
490     test01_site ()
491
492 def test_all_nodes ():
493
494     message ("RESETTING NODES")
495     clean_all_nodes ()
496     test01_refresh ()
497     check_nodes(0,0)
498     # create one node on each site
499     message ("CREATING NODES")
500     test02_node ()
501     check_nodes (number_nodes,0,)
502     test01_refresh ()
503     check_nodes (number_nodes,number_nodes,)
504
505     # check deletions
506     message ("DELETING NODES")
507     test02_delnode ([2])
508     check_nodes (number_nodes,number_nodes,[1])
509     check_nodes (0,number_nodes,[2])
510     test01_refresh ()
511     check_nodes (number_nodes,0,[1])
512     check_nodes (0,number_nodes,[2])
513
514     # recreate 
515     message ("RECREATING NODES")
516     test02_node ([2])
517     check_nodes (number_nodes,0,[1])
518     check_nodes (number_nodes,number_nodes,[2])
519     test01_refresh ()
520     check_nodes (number_nodes,number_nodes,)
521
522     # make sure node indexes differ
523     message ("DUMMY DEL/ADD for different indexes")
524     test02_delnode([2])
525     test02_node ([2])
526     check_nodes (number_nodes,number_nodes,)
527     test01_refresh ()
528     check_nodes (number_nodes,number_nodes,)
529
530 def populate ():
531     test02_node()
532     test03_slice([1])
533     test01_refresh ([1])
534     test04_slice_add_lnode([1])
535     test04_slice_add_fnode([1])
536     test01_refresh()
537
538 def test_all_addslices ():
539
540     # reset
541     message ("RESETTING SLICES TEST")
542     clean_all_nodes ()
543     test02_node ()
544     clean_all_slices ()
545     test01_refresh ()
546
547     # create slices on plc1
548     message ("CREATING SLICES on plc1")
549     test03_slice ([1])
550     # each site has 3 local slices and 0 foreign slice
551     check_slices (total_slices(),0,[1])
552     check_slices (system_slices(),0,[2])
553     test01_refresh ()
554     check_slices (total_slices(),0,[1])
555     check_slices (system_slices(),number_slices,[2])
556     # no slice has any node yet
557     check_local_slice_nodes(0,[1])
558     check_foreign_slice_nodes(0,[2])
559
560     # insert local nodes in local slice on plc1
561     message ("ADDING LOCAL NODES IN SLICES")
562     test04_slice_add_lnode ([1])
563     # of course the change is only local
564     check_local_slice_nodes (number_nodes,[1])
565     check_foreign_slice_nodes(0,[2])
566
567     # refreshing
568     test01_refresh ()
569     # remember that foreign slices only know about LOCAL nodes
570     # so refreshing does not do anything
571     check_local_slice_nodes (number_nodes,[1])
572     check_foreign_slice_nodes (0,[2])
573
574     # now we add foreign nodes into local slice
575     message ("ADDING FOREIGN NODES IN SLICES")
576     test04_slice_add_fnode ([1])
577     check_local_slice_nodes (2*number_nodes,[1])
578     check_foreign_slice_nodes (0,[2])
579
580     # refreshing
581     test01_refresh ()
582     # remember that foreign slices only know about LOCAL nodes
583     # so this does not do anything
584     check_local_slice_nodes (2*number_nodes,[1])
585     check_foreign_slice_nodes (number_nodes,[2])
586
587     check_slivers_1(total_slivers())
588
589 def test_all_delslices ():
590
591     message ("DELETING FOREIGN NODES FROM SLICES")
592     test04_slice_del_fnode([1])
593     check_local_slice_nodes (number_nodes,[1])
594     check_foreign_slice_nodes (number_nodes,[2])
595     # mmh?
596     check_slivers_1(total_slivers(),[1])
597
598     test01_refresh ()
599     check_local_slice_nodes (number_nodes,[1])
600     check_foreign_slice_nodes (0,[2])
601     
602     message ("DELETING LOCAL NODES FROM SLICES")
603     test04_slice_del_lnode([1])
604     check_local_slice_nodes (0,[1])
605     check_foreign_slice_nodes (0,[2])
606     test01_refresh ()
607     check_local_slice_nodes (0,[1])
608     check_foreign_slice_nodes (0,[2])
609
610     message ("CHECKING SLICES CLEAN UP")
611     clean_all_slices([1])
612     check_slices (system_slices(),0,[1])
613     check_slices (system_slices(),number_slices,[2])
614     test01_refresh ()
615     check_slices(system_slices(),0)
616
617 def test_all_slices ():
618     test_all_addslices ()
619     test_all_delslices ()
620     
621 def test_all ():
622     test_all_init ()
623     test_all_nodes ()
624     test_all_slices ()
625
626 if __name__ == '__main__':
627     test_all()
628