f66c7fbc544074a805f2f63b6db6e2956f80ad18
[quix0rs-apt-p2p.git] / test.py
1 #!/usr/bin/env python
2
3 """Automated tests of the apt-dht functionality.
4
5 This script runs several automatic tests of some of the functionality in
6 the apt-dht program.
7
8 @type tests: C{dictionary}
9 @var tests: all of the tests that can be run.
10     The keys are the test names (strings) which are used on the command-line
11     to identify the tests (can not be 'all' or 'help'). The values are tuples
12     with four elements: a description of the test (C{string}), the bootstrap
13     nodes to start (C{dictionary}), the downloaders to start (C{dictionary},
14     and the apt-get commands to run (C{list}).
15     
16     The bootstrap nodes keys are integers, which must be in the range 1-9.
17     The values are the dictionary of string formatting values for creating
18     the apt-dht configuration file (see L{apt_dht_conf_template} below).
19     
20     The downloaders keys are also integers in the range 1-99. The values are
21     the dictionary of string formatting values for creating the apt-dht
22     configuration file (see L{apt_dht_conf_template} below).
23     
24     The apt-get commands' list elements are tuples with 2 elements: the
25     downloader to run the command on, and the list of command-line
26     arguments to specify to the apt-get program.
27     
28 @type CWD: C{string}
29 @var CWD: the working directory the script was run from
30 @type apt_conf_template: C{string}
31 @var apt_conf_template: the template to use for the apt.conf file
32
33 """
34
35 from time import sleep, time
36 import sys, os, signal
37 from traceback import print_exc
38 from os.path import exists
39
40 tests = {'1': ('Start a single bootstrap and downloader, test updating and downloading ' +
41              'using HTTP only.',
42              {1: {}},
43              {1: {}},
44              [(1, ['update']), 
45               (1, ['install', 'aboot-base']),
46               (1, ['install', 'aap-doc']),
47               (1, ['install', 'ada-reference-manual']),
48               (1, ['install', 'aspectj-doc']),
49               (1, ['install', 'fop-doc']),
50               (1, ['install', 'jswat-doc']),
51               (1, ['install', 'asis-doc']),
52               (1, ['install', 'bison-doc']),
53               (1, ['install', 'crash-whitepaper']),
54               (1, ['install', 'doc-iana']),
55               ]),
56
57          '2': ('Start a single bootstrap and 2 downloaders to test downloading from a peer.',
58                {1: {}},
59                {1: {},
60                 2: {}},
61                [(1, ['update']),
62                 (1, ['install', 'aboot-base']),
63                 (1, ['install', 'aap-doc']),
64                 (1, ['install', 'ada-reference-manual']),
65                 (1, ['install', 'fop-doc']),
66                 (1, ['install', 'jswat-doc']),
67                 (1, ['install', 'bison-doc']),
68                 (1, ['install', 'crash-whitepaper']),
69                 (2, ['update']),
70                 (2, ['install', 'aboot-base']),
71                 (2, ['install', 'aap-doc']),
72                 (2, ['install', 'ada-reference-manual']),
73                 (2, ['install', 'fop-doc']),
74                 (2, ['install', 'jswat-doc']),
75                 (2, ['install', 'bison-doc']),
76                 (2, ['install', 'crash-whitepaper']),
77                 ]),
78                 
79          '3': ('Start a single bootstrap and 6 downloaders, to test downloading' +
80                ' speeds from each other.',
81                {1: {}},
82                {1: {},
83                 2: {},
84                 3: {},
85                 4: {},
86                 5: {},
87                 6: {}},
88                [(1, ['update']),
89                 (1, ['install', 'aboot-base']),
90                 (1, ['install', 'ada-reference-manual']),
91                 (1, ['install', 'fop-doc']),
92                 (1, ['install', 'doc-iana']),
93                 (2, ['update']),
94                 (2, ['install', 'aboot-base']),
95                 (2, ['install', 'ada-reference-manual']),
96                 (2, ['install', 'fop-doc']),
97                 (2, ['install', 'doc-iana']),
98                 (3, ['update']),
99                 (3, ['install', 'aboot-base']),
100                 (3, ['install', 'ada-reference-manual']),
101                 (3, ['install', 'fop-doc']),
102                 (3, ['install', 'doc-iana']),
103                 (4, ['update']),
104                 (4, ['install', 'aboot-base']),
105                 (4, ['install', 'ada-reference-manual']),
106                 (4, ['install', 'fop-doc']),
107                 (4, ['install', 'doc-iana']),
108                 (5, ['update']),
109                 (5, ['install', 'aboot-base']),
110                 (5, ['install', 'ada-reference-manual']),
111                 (5, ['install', 'fop-doc']),
112                 (5, ['install', 'doc-iana']),
113                 (6, ['update']),
114                 (6, ['install', 'aboot-base']),
115                 (6, ['install', 'ada-reference-manual']),
116                 (6, ['install', 'fop-doc']),
117                 (6, ['install', 'doc-iana']),
118                 ]),
119
120          '4': ('Start a single bootstrap and 1 downloader, requesting the same' +
121                ' packages multiple times to test caching.',
122                {1: {}},
123                {1: {}},
124                [(1, ['update']),
125                 (1, ['install', 'aboot-base']),
126                 (1, ['install', 'ada-reference-manual']),
127                 (1, ['install', 'fop-doc']),
128                 (1, ['install', 'doc-iana']),
129                 (1, ['update']),
130                 (1, ['install', 'aboot-base']),
131                 (1, ['install', 'ada-reference-manual']),
132                 (1, ['install', 'fop-doc']),
133                 (1, ['install', 'doc-iana']),
134                 (1, ['update']),
135                 (1, ['install', 'aboot-base']),
136                 (1, ['install', 'ada-reference-manual']),
137                 (1, ['install', 'fop-doc']),
138                 (1, ['install', 'doc-iana']),
139                 ]),
140                 
141          '5': ('Start a single bootstrap and 6 downloaders, update all to test' +
142                ' that they can all see each other.',
143                {1: {}},
144                {1: ([], {'suites': 'contrib non-free'}),
145                 2: ([], {'suites': 'contrib non-free'}),
146                 3: ([], {'suites': 'contrib non-free'}),
147                 4: ([], {'suites': 'contrib non-free'}),
148                 5: ([], {'suites': 'contrib non-free'}),
149                 6: ([], {'suites': 'contrib non-free'})},
150                [(1, ['update']),
151                 (2, ['update']),
152                 (3, ['update']),
153                 (4, ['update']),
154                 (5, ['update']),
155                 (6, ['update']),
156                 ]),
157
158         '6': ('Test caching with multiple apt-get updates.',
159              {1: {}},
160              {1: {}},
161              [(1, ['update']), 
162               (1, ['update']),
163               (1, ['update']),
164               (1, ['update']),
165               ]),
166
167         '7': ('Test pipelining of multiple simultaneous downloads.',
168              {1: {}},
169              {1: {}},
170              [(1, ['update']), 
171               (1, ['install', 'aboot-base', 'aap-doc', 'ada-reference-manual',
172                    'aspectj-doc', 'fop-doc', 'jswat-doc', 'asis-doc',
173                    'bison-doc', 'crash-whitepaper', 'doc-iana',
174                    'bash-doc', 'apt-howto-common', 'autotools-dev',
175                    'aptitude-doc-en', 'armagetron-common', 'asr-manpages',
176                    'atomix-data', 'alcovebook-sgml-doc', 'alamin-doc',
177                    'aegis-doc', 'afbackup-common', 'airstrike-common',
178                    ]),
179               ]),
180
181         '8': ('Test pipelining of multiple simultaneous downloads with many peers.',
182              {1: {}},
183              {1: {},
184               2: {},
185               3: {},
186               4: {},
187               5: {},
188               6: {}},
189              [(1, ['update']), 
190               (1, ['install', 'aboot-base', 'aap-doc', 'ada-reference-manual',
191                    'aspectj-doc', 'fop-doc', 'jswat-doc', 'asis-doc',
192                    'bison-doc', 'crash-whitepaper', 'doc-iana',
193                    'bash-doc', 'apt-howto-common', 'autotools-dev',
194                    'aptitude-doc-en', 'armagetron-common', 'asr-manpages',
195                    'atomix-data', 'alcovebook-sgml-doc', 'alamin-doc',
196                    'aegis-doc', 'afbackup-common', 'airstrike-common',
197                    ]),
198               (2, ['update']), 
199               (2, ['install', 'aboot-base', 'aap-doc', 'ada-reference-manual',
200                    'aspectj-doc', 'fop-doc', 'jswat-doc', 'asis-doc',
201                    'bison-doc', 'crash-whitepaper', 'doc-iana',
202                    'bash-doc', 'apt-howto-common', 'autotools-dev',
203                    'aptitude-doc-en', 'armagetron-common', 'asr-manpages',
204                    'atomix-data', 'alcovebook-sgml-doc', 'alamin-doc',
205                    'aegis-doc', 'afbackup-common', 'airstrike-common',
206                    ]),
207               (3, ['update']), 
208               (3, ['install', 'aboot-base', 'aap-doc', 'ada-reference-manual',
209                    'aspectj-doc', 'fop-doc', 'jswat-doc', 'asis-doc',
210                    'bison-doc', 'crash-whitepaper', 'doc-iana',
211                    'bash-doc', 'apt-howto-common', 'autotools-dev',
212                    'aptitude-doc-en', 'armagetron-common', 'asr-manpages',
213                    'atomix-data', 'alcovebook-sgml-doc', 'alamin-doc',
214                    'aegis-doc', 'afbackup-common', 'airstrike-common',
215                    ]),
216               (4, ['update']), 
217               (4, ['install', 'aboot-base', 'aap-doc', 'ada-reference-manual',
218                    'aspectj-doc', 'fop-doc', 'jswat-doc', 'asis-doc',
219                    'bison-doc', 'crash-whitepaper', 'doc-iana',
220                    'bash-doc', 'apt-howto-common', 'autotools-dev',
221                    'aptitude-doc-en', 'armagetron-common', 'asr-manpages',
222                    'atomix-data', 'alcovebook-sgml-doc', 'alamin-doc',
223                    'aegis-doc', 'afbackup-common', 'airstrike-common',
224                    ]),
225               (5, ['update']), 
226               (5, ['install', 'aboot-base', 'aap-doc', 'ada-reference-manual',
227                    'aspectj-doc', 'fop-doc', 'jswat-doc', 'asis-doc',
228                    'bison-doc', 'crash-whitepaper', 'doc-iana',
229                    'bash-doc', 'apt-howto-common', 'autotools-dev',
230                    'aptitude-doc-en', 'armagetron-common', 'asr-manpages',
231                    'atomix-data', 'alcovebook-sgml-doc', 'alamin-doc',
232                    'aegis-doc', 'afbackup-common', 'airstrike-common',
233                    ]),
234               (6, ['update']), 
235               (6, ['install', 'aboot-base', 'aap-doc', 'ada-reference-manual',
236                    'aspectj-doc', 'fop-doc', 'jswat-doc', 'asis-doc',
237                    'bison-doc', 'crash-whitepaper', 'doc-iana',
238                    'bash-doc', 'apt-howto-common', 'autotools-dev',
239                    'aptitude-doc-en', 'armagetron-common', 'asr-manpages',
240                    'atomix-data', 'alcovebook-sgml-doc', 'alamin-doc',
241                    'aegis-doc', 'afbackup-common', 'airstrike-common',
242                    ]),
243               ]),
244
245          }
246
247 assert 'all' not in tests
248 assert 'help' not in tests
249
250 CWD = os.getcwd()
251 apt_conf_template = """
252 {
253   // Location of the state dir
254   State "var/lib/apt/"
255   {
256      Lists "lists/";
257      xstatus "xstatus";
258      userstatus "status.user";
259      cdroms "cdroms.list";
260   };
261
262   // Location of the cache dir
263   Cache "var/cache/apt/" {
264      Archives "archives/";
265      srcpkgcache "srcpkgcache.bin";
266      pkgcache "pkgcache.bin";
267   };
268
269   // Config files
270   Etc "etc/apt/" {
271      SourceList "sources.list";
272      Main "apt.conf";
273      Preferences "preferences";
274      Parts "apt.conf.d/";
275   };
276
277   // Locations of binaries
278   Bin {
279      methods "/usr/lib/apt/methods/";
280      gzip "/bin/gzip";
281      gpg  "/usr/bin/gpgv";
282      dpkg "/usr/bin/dpkg --simulate";
283      dpkg-source "/usr/bin/dpkg-source";
284      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
285      apt-get "/usr/bin/apt-get";
286      apt-cache "/usr/bin/apt-cache";
287   };
288 };
289
290 /* Options you can set to see some debugging text They correspond to names
291    of classes in the source code */
292 Debug
293 {
294   pkgProblemResolver "false";
295   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
296   pkgAcquire "false";
297   pkgAcquire::Worker "false";
298   pkgAcquire::Auth "false";
299   pkgDPkgPM "false";
300   pkgDPkgProgressReporting "false";
301   pkgOrderList "false";
302   BuildDeps "false";
303
304   pkgInitialize "false";   // This one will dump the configuration space
305   NoLocking "false";
306   Acquire::Ftp "false";    // Show ftp command traffic
307   Acquire::Http "false";   // Show http command traffic
308   Acquire::Debtorrent "false";   // Show http command traffic
309   Acquire::gpgv "false";   // Show the gpgv traffic
310   aptcdrom "false";        // Show found package files
311   IdentCdrom "false";
312
313 }
314 """
315 apt_dht_conf_template = """
316 [DEFAULT]
317
318 # Port to listen on for all requests (TCP and UDP)
319 PORT = %(PORT)s
320     
321 # Directory to store the downloaded files in
322 CACHE_DIR = %(CACHE_DIR)s
323     
324 # Other directories containing packages to share with others
325 # WARNING: all files in these directories will be hashed and available
326 #          for everybody to download
327 # OTHER_DIRS = 
328     
329 # User name to try and run as
330 # USERNAME = 
331
332 # Whether it's OK to use an IP addres from a known local/private range
333 LOCAL_OK = yes
334
335 # Which DHT implementation to use.
336 # It must be possile to do "from <DHT>.DHT import DHT" to get a class that
337 # implements the IDHT interface.
338 DHT = apt_dht_Khashmir
339
340 # Whether to only run the DHT (for providing only a bootstrap node)
341 DHT-ONLY = %(DHT-ONLY)s
342
343 [apt_dht_Khashmir]
344 # bootstrap nodes to contact to join the DHT
345 BOOTSTRAP = %(BOOTSTRAP)s
346
347 # whether this node is a bootstrap node
348 BOOTSTRAP_NODE = %(BOOTSTRAP_NODE)s
349
350 # Kademlia "K" constant, this should be an even number
351 K = 8
352
353 # SHA1 is 160 bits long
354 HASH_LENGTH = 160
355
356 # checkpoint every this many seconds
357 CHECKPOINT_INTERVAL = 15m
358
359 # concurrent xmlrpc calls per find node/value request!
360 CONCURRENT_REQS = 4
361
362 # how many hosts to post to
363 STORE_REDUNDANCY = 3
364
365 # how many times in a row a node can fail to respond before it's booted from the routing table
366 MAX_FAILURES = 3
367
368 # never ping a node more often than this
369 MIN_PING_INTERVAL = 15m
370
371 # refresh buckets that haven't been touched in this long
372 BUCKET_STALENESS = 1h
373
374 # time before expirer starts running
375 KEINITIAL_DELAY = 15s
376
377 # time between expirer runs
378 KE_DELAY = 20m
379
380 # expire entries older than this
381 KE_AGE = 1h
382
383 # whether to spew info about the requests/responses in the protocol
384 SPEW = yes
385 """
386
387 def rmrf(top):
388     """Remove all the files and directories below a top-level one.
389     
390     @type top: C{string}
391     @param top: the top-level directory to start at
392     
393     """
394     
395     for root, dirs, files in os.walk(top, topdown=False):
396         for name in files:
397             os.remove(os.path.join(root, name))
398         for name in dirs:
399             os.rmdir(os.path.join(root, name))
400
401 def join(dir):
402     """Join together a list of directories into a path string.
403     
404     @type dir: C{list} of C{string}
405     @param dir: the path to join together
406     @rtype: C{string}
407     @return: the joined together path
408     
409     """
410     
411     joined = ''
412     for i in dir:
413         joined = os.path.join(joined, i)
414     return joined
415
416 def makedirs(dir):
417     """Create all the directories to make a path.
418     
419     @type dir: C{list} of C{string}
420     @param dir: the path to create
421     
422     """
423     if not os.path.exists(join(dir)):
424         os.makedirs(join(dir))
425
426 def touch(path):
427     """Create an empty file.
428     
429     @type path: C{list} of C{string}
430     @param path: the path to create
431     
432     """
433     
434     f = open(join(path), 'w')
435     f.close()
436
437 def start(cmd, args, work_dir = None):
438     """Fork and start a background process running.
439     
440     @type cmd: C{string}
441     @param cmd: the name of the command to run
442     @type args: C{list} of C{string}
443     @param args: the argument to pass to the command
444     @type work_dir: C{string}
445     @param work_dir: the directory to change to to execute the child process in
446         (optional, defaults to the current directory)
447     @rtype: C{int}
448     @return: the PID of the forked process
449     
450     """
451     
452     new_cmd = [cmd] + args
453     pid = os.spawnvp(os.P_NOWAIT, new_cmd[0], new_cmd)
454     return pid
455
456 def stop(pid):
457     """Stop a forked background process that is running.
458     
459     @type pid: C{int}
460     @param pid: the PID of the process to stop
461     @rtype: C{int}
462     @return: the return status code from the child
463     
464     """
465
466     # First try a keyboard interrupt
467     os.kill(pid, signal.SIGINT)
468     for i in xrange(5):
469         sleep(1)
470         (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
471         if r_pid:
472             return r_value
473     
474     # Try a keyboard interrupt again, just in case
475     os.kill(pid, signal.SIGINT)
476     for i in xrange(5):
477         sleep(1)
478         (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
479         if r_pid:
480             return r_value
481
482     # Try a terminate
483     os.kill(pid, signal.SIGTERM)
484     for i in xrange(5):
485         sleep(1)
486         (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
487         if r_pid:
488             return r_value
489
490     # Finally a kill, don't return until killed
491     os.kill(pid, signal.SIGKILL)
492     while not r_pid:
493         sleep(1)
494         (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
495
496     return r_value
497
498 def apt_get(num_down, cmd):
499     """Start an apt-get process in the background.
500
501     The default argument specified to the apt-get invocation are
502     'apt-get -d -q -c <conf_file>'. Any additional arguments (including
503     the apt-get action to use) should be specified.
504     
505     @type num_down: C{int}
506     @param num_down: the number of the downloader to use
507     @type cmd: C{list} of C{string}
508     @param cmd: the arguments to pass to the apt-get process
509     @rtype: C{int}
510     @return: the PID of the background process
511     
512     """
513     
514     print '************************** apt-get (' + str(num_down) + ') ' + ' '.join(cmd) + ' **************************'
515     apt_conf = join([down_dir(num_down), 'etc', 'apt', 'apt.conf'])
516     dpkg_status = join([down_dir(num_down), 'var', 'lib', 'dpkg', 'status'])
517     args = ['-d', '-c', apt_conf, '-o', 'Dir::state::status='+dpkg_status] + cmd
518     pid = start('apt-get', args)
519     return pid
520
521 def bootstrap_address(num_boot):
522     """Determine the bootstrap address to use for a node.
523     
524     @type num_boot: C{int}
525     @param num_boot: the number of the bootstrap node
526     @rtype: C{string}
527     @return: the bootstrap address to use
528     
529     """
530     
531     return 'localhost:1' + str(num_boot) + '969'
532
533 def down_dir(num_down):
534     """Determine the working directory to use for a downloader.
535     
536     @type num_down: C{int}
537     @param num_down: the number of the downloader
538     @rtype: C{string}
539     @return: the downloader's directory
540     
541     """
542     
543     return os.path.join(CWD,'downloader' + str(num_down))
544
545 def boot_dir(num_boot):
546     """Determine the working directory to use for a bootstrap node.
547     
548     @type num_boot: C{int}
549     @param num_boot: the number of the bootstrap node
550     @rtype: C{string}
551     @return: the bootstrap node's directory
552     
553     """
554     
555     return os.path.join(CWD,'bootstrap' + str(num_boot))
556
557 def start_downloader(bootstrap_addresses, num_down, options = {},
558                      mirror = 'ftp.us.debian.org/debian', 
559                      suites = 'main contrib non-free', clean = True):
560     """Initialize a new downloader process.
561
562     The default arguments specified to the downloader invocation are
563     the configuration directory, apt port, minport, maxport and the
564     maximum upload rate. 
565     Any additional arguments needed should be specified by L{options}.
566     
567     @type num_down: C{int}
568     @param num_down: the number of the downloader to use
569     @type options: C{dictionary}
570     @param options: the dictionary of string formatting values for creating
571         the apt-dht configuration file (see L{apt_dht_conf_template} above).
572         (optional, defaults to only using the default arguments)
573     @type mirror: C{string}
574     @param mirror: the Debian mirror to use
575         (optional, defaults to 'ftp.us.debian.org/debian')
576     @type suites: C{string}
577     @param suites: space separated list of suites to download
578         (optional, defaults to 'main contrib non-free')
579     @type clean: C{boolean}
580     @param clean: whether to remove any previous downloader files
581         (optional, defaults to removing them)
582     @rtype: C{int}
583     @return: the PID of the downloader process
584     
585     """
586     
587     assert num_down < 100
588     
589     print '************************** Starting Downloader ' + str(num_down) + ' **************************'
590
591     downloader_dir = down_dir(num_down)
592     
593     if clean:
594         try:
595             rmrf(downloader_dir)
596         except:
597             pass
598     
599         # Create the directory structure needed by apt
600         makedirs([downloader_dir, 'etc', 'apt', 'apt.conf.d'])
601         makedirs([downloader_dir, 'var', 'lib', 'apt', 'lists', 'partial'])
602         makedirs([downloader_dir, 'var', 'lib', 'dpkg'])
603         makedirs([downloader_dir, 'var', 'cache', 'apt', 'archives', 'partial'])
604         touch([downloader_dir, 'var', 'lib', 'apt', 'lists', 'lock'])
605         touch([downloader_dir, 'var', 'lib', 'dpkg', 'lock'])
606         touch([downloader_dir, 'var', 'lib', 'dpkg', 'status'])
607         touch([downloader_dir, 'var', 'cache', 'apt', 'archives', 'lock'])
608
609         # Create apt's config files
610         f = open(join([downloader_dir, 'etc', 'apt', 'sources.list']), 'w')
611         f.write('deb http://localhost:1%02d77/%s/ stable %s\n' % (num_down, mirror, suites))
612         f.close()
613
614         f = open(join([downloader_dir, 'etc', 'apt', 'apt.conf']), 'w')
615         f.write('Dir "' + downloader_dir + '"')
616         f.write(apt_conf_template)
617         f.close()
618
619     defaults = {'PORT': '1%02d77' % num_down,
620                 'CACHE_DIR': downloader_dir,
621                 'DHT-ONLY': 'no',
622                 'BOOTSTRAP': bootstrap_addresses,
623                 'BOOTSTRAP_NODE': 'no'}
624
625     for k in options:
626         defaults[k] = options[k]
627     f = open(join([downloader_dir, 'apt-dht.conf']), 'w')
628     f.write(apt_dht_conf_template % defaults)
629     f.close()
630     
631     pid = start('python', [join([sys.path[0], 'apt-dht.py']),
632                            '--config-file=' + join([downloader_dir, 'apt-dht.conf']),
633                            '--log-file=' + join([downloader_dir, 'apt-dht.log']),],
634                 downloader_dir)
635     return pid
636
637 def start_bootstrap(bootstrap_addresses, num_boot, options = [], clean = True):
638     """Initialize a new bootstrap node process.
639
640     The default arguments specified to the apt-dht invocation are
641     the state file and port to use. Any additional arguments needed 
642     should be specified by L{options}.
643     
644     @type num_boot: C{int}
645     @param num_boot: the number of the bootstrap node to use
646     @type options: C{list} of C{string}
647     @param options: the arguments to pass to the bootstrap node
648         (optional, defaults to only using the default arguments)
649     @type clean: C{boolean}
650     @param clean: whether to remove any previous bootstrap node files
651         (optional, defaults to removing them)
652     @rtype: C{int}
653     @return: the PID of the downloader process
654     
655     """
656     
657     assert num_boot < 10
658
659     print '************************** Starting Bootstrap ' + str(num_boot) + ' **************************'
660
661     bootstrap_dir = boot_dir(num_boot)
662     
663     if clean:
664         try:
665             rmrf(bootstrap_dir)
666         except:
667             pass
668
669     makedirs([bootstrap_dir])
670
671     defaults = {'PORT': '1%d969' % num_boot,
672                 'CACHE_DIR': bootstrap_dir,
673                 'DHT-ONLY': 'yes',
674                 'BOOTSTRAP': bootstrap_addresses,
675                 'BOOTSTRAP_NODE': 'yes'}
676
677     for k in options:
678         defaults[k] = options[k]
679     f = open(join([bootstrap_dir, 'apt-dht.conf']), 'w')
680     f.write(apt_dht_conf_template % defaults)
681     f.close()
682     
683     pid = start('python', [join([sys.path[0], 'apt-dht.py']),
684                            '--config-file=' + join([bootstrap_dir, 'apt-dht.conf']),
685                            '--log-file=' + join([bootstrap_dir, 'apt-dht.log']),],
686                 bootstrap_dir)
687
688     return pid
689
690 def run_test(bootstraps, downloaders, apt_get_queue):
691     """Run a single test.
692     
693     @type bootstraps: C{dictionary} of {C{int}: C{list} of C{string}}
694     @param bootstraps: the bootstrap nodes to start, keys are the bootstrap numbers and
695         values are the list of options to invoke the bootstrap node with
696     @type downloaders: C{dictionary} of {C{int}: (C{int}, C{list} of C{string})}
697     @param downloaders: the downloaders to start, keys are the downloader numbers and
698         values are the list of options to invoke the downloader with
699     @type apt_get_queue: C{list} of (C{int}, C{list} of C{string})
700     @param apt_get_queue: the apt-get downloader to use and commands to execute
701     @rtype: C{list} of (C{float}, C{int})
702     @return: the execution time and returned status code for each element of apt_get_queue
703     
704     """
705     
706     running_bootstraps = {}
707     running_downloaders = {}
708     running_apt_get = {}
709     apt_get_results = []
710
711     try:
712         boot_keys = bootstraps.keys()
713         boot_keys.sort()
714         bootstrap_addresses = bootstrap_address(boot_keys[0])
715         for i in xrange(1, len(boot_keys)):
716             bootstrap_addresses += '\n      ' + bootstrap_address(boot_keys[i])
717             
718         for k, v in bootstraps.items():
719             running_bootstraps[k] = start_bootstrap(bootstrap_addresses, k, v)
720         
721         sleep(5)
722         
723         for k, v in downloaders.items():
724             running_downloaders[k] = start_downloader(bootstrap_addresses, k, v)
725     
726         sleep(5)
727         
728         for (num_down, cmd) in apt_get_queue:
729             running_apt_get[num_down] = apt_get(num_down, cmd)
730             start_time = time()
731             (pid, r_value) = os.waitpid(running_apt_get[num_down], 0)
732             elapsed = time() - start_time
733             del running_apt_get[num_down]
734             r_value = r_value / 256
735             apt_get_results.append((elapsed, r_value))
736
737             if r_value == 0:
738                 print '********************** apt-get completed successfully in ' +  str(elapsed) + ' sec. **************************'
739             else:
740                 print '********************** apt-get finished with status ' + str(r_value) + ' in ' +  str(elapsed) + ' sec. **************************'
741         
742             sleep(5)
743             
744     except:
745         print '************************** Exception occurred **************************'
746         print_exc()
747         print '************************** will attempt to shut down *******************'
748         
749     print '*********************** shutting down the apt-gets *******************'
750     for k, v in running_apt_get.items():
751         try:
752             print 'apt-get', k, stop(v)
753         except:
754             print '************************** Exception occurred **************************'
755             print_exc()
756
757     sleep(5)
758
759     print '*********************** shutting down the downloaders *******************'
760     for k, v in running_downloaders.items():
761         try:
762             print 'downloader', k, stop(v)
763         except:
764             print '************************** Exception occurred **************************'
765             print_exc()
766
767     sleep(5)
768
769     print '************************** shutting down the bootstraps *******************'
770     for k, v in running_bootstraps.items():
771         try:
772             print 'bootstrap', k, stop(v)
773         except:
774             print '************************** Exception occurred **************************'
775             print_exc()
776
777     print '************************** Test Results *******************'
778     i = -1
779     for (num_down, cmd) in apt_get_queue:
780         i += 1
781         s = str(num_down) + ': "apt-get ' + ' '.join(cmd) + '" '
782         if len(apt_get_results) > i:
783             (elapsed, r_value) = apt_get_results[i]
784             s += 'took ' + str(elapsed) + ' secs (' + str(r_value) + ')'
785         else:
786             s += 'did not complete'
787         print s
788     
789     return apt_get_results
790
791 def get_usage():
792     """Get the usage information to display to the user.
793     
794     @rtype: C{string}
795     @return: the usage information to display
796     
797     """
798     
799     s = 'Usage: ' + sys.argv[0] + ' (all|<test>|help)\n\n'
800     s += '  all    - run all the tests\n'
801     s += '  help   - display this usage information\n'
802     s += '  <test> - run the <test> test (see list below for valid tests)\n\n'
803     
804     t = tests.items()
805     t.sort()
806     for k, v in t:
807         s += 'test "' + str(k) + '" - ' + v[0] + '\n'
808     
809     return s
810
811 if __name__ == '__main__':
812     if len(sys.argv) != 2:
813         print get_usage()
814     elif sys.argv[1] == 'all':
815         for k, v in tests.items():
816             run_test(v[1], v[2], v[3])
817     elif sys.argv[1] in tests:
818         v = tests[sys.argv[1]]
819         run_test(v[1], v[2], v[3])
820     elif sys.argv[1] == 'help':
821         print get_usage()
822     else:
823         print 'Unknown test to run:', sys.argv[1], '\n'
824         print get_usage()
825