3 """Automated tests of the apt-dht functionality.
5 This script runs several automatic tests of some of the functionality in
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}).
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).
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).
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.
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
35 from time import sleep, time
36 import sys, os, signal
37 from traceback import print_exc
38 from os.path import exists
40 tests = {'1': ('Start a single bootstrap and downloader, test updating and downloading ' +
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']),
57 '2': ('Start a single bootstrap and 2 downloaders to test downloading from a peer.',
63 (1, ['install', 'aboot-base']),
64 (2, ['install', 'aboot-base']),
65 (1, ['install', 'aap-doc']),
66 (1, ['install', 'ada-reference-manual']),
67 (1, ['install', 'fop-doc']),
68 (1, ['install', 'jswat-doc']),
69 (1, ['install', 'bison-doc']),
70 (1, ['install', 'crash-whitepaper']),
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']),
79 '3': ('Start a single bootstrap and 6 downloaders, to test downloading' +
80 ' speeds from each other.',
89 (1, ['install', 'aboot-base']),
90 (1, ['install', 'ada-reference-manual']),
91 (1, ['install', 'fop-doc']),
92 (1, ['install', 'doc-iana']),
94 (2, ['install', 'aboot-base']),
95 (2, ['install', 'ada-reference-manual']),
96 (2, ['install', 'fop-doc']),
97 (2, ['install', 'doc-iana']),
99 (3, ['install', 'aboot-base']),
100 (3, ['install', 'ada-reference-manual']),
101 (3, ['install', 'fop-doc']),
102 (3, ['install', 'doc-iana']),
104 (4, ['install', 'aboot-base']),
105 (4, ['install', 'ada-reference-manual']),
106 (4, ['install', 'fop-doc']),
107 (4, ['install', 'doc-iana']),
109 (5, ['install', 'aboot-base']),
110 (5, ['install', 'ada-reference-manual']),
111 (5, ['install', 'fop-doc']),
112 (5, ['install', 'doc-iana']),
114 (6, ['install', 'aboot-base']),
115 (6, ['install', 'ada-reference-manual']),
116 (6, ['install', 'fop-doc']),
117 (6, ['install', 'doc-iana']),
120 '4': ('Start a single bootstrap and 1 downloader, requesting the same' +
121 ' packages multiple times to test caching.',
125 (1, ['install', 'aboot-base']),
126 (1, ['install', 'ada-reference-manual']),
127 (1, ['install', 'fop-doc']),
128 (1, ['install', 'doc-iana']),
130 (1, ['install', 'aboot-base']),
131 (1, ['install', 'ada-reference-manual']),
132 (1, ['install', 'fop-doc']),
133 (1, ['install', 'doc-iana']),
135 (1, ['install', 'aboot-base']),
136 (1, ['install', 'ada-reference-manual']),
137 (1, ['install', 'fop-doc']),
138 (1, ['install', 'doc-iana']),
141 '5': ('Start a single bootstrap and 6 downloaders, update all to test' +
142 ' that they can all see each other.',
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'})},
158 '6': ('Test caching with multiple apt-get updates.',
167 '7': ('Test pipelining of multiple simultaneous downloads.',
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',
181 '8': ('Test pipelining of multiple simultaneous downloads with many peers.',
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',
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',
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',
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',
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',
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',
247 assert 'all' not in tests
248 assert 'help' not in tests
251 apt_conf_template = """
253 // Location of the state dir
258 userstatus "status.user";
259 cdroms "cdroms.list";
262 // Location of the cache dir
263 Cache "var/cache/apt/" {
264 Archives "archives/";
265 srcpkgcache "srcpkgcache.bin";
266 pkgcache "pkgcache.bin";
271 SourceList "sources.list";
273 Preferences "preferences";
277 // Locations of binaries
279 methods "/usr/lib/apt/methods/";
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";
290 /* Options you can set to see some debugging text They correspond to names
291 of classes in the source code */
294 pkgProblemResolver "false";
295 pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
297 pkgAcquire::Worker "false";
298 pkgAcquire::Auth "false";
300 pkgDPkgProgressReporting "false";
301 pkgOrderList "false";
304 pkgInitialize "false"; // This one will dump the configuration space
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
315 apt_dht_conf_template = """
318 # Port to listen on for all requests (TCP and UDP)
321 # Directory to store the downloaded files in
322 CACHE_DIR = %(CACHE_DIR)s
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
329 # User name to try and run as
332 # Whether it's OK to use an IP addres from a known local/private range
335 # Unload the packages cache after an interval of inactivity this long.
336 # The packages cache uses a lot of memory, and only takes a few seconds
337 # to reload when a new request arrives.
338 UNLOAD_PACKAGES_CACHE = 5m
340 # Refresh the DHT keys after this much time has passed.
341 # This should be a time slightly less than the DHT's KEY_EXPIRE value.
344 # Which DHT implementation to use.
345 # It must be possile to do "from <DHT>.DHT import DHT" to get a class that
346 # implements the IDHT interface.
347 DHT = apt_dht_Khashmir
349 # Whether to only run the DHT (for providing only a bootstrap node)
350 DHT-ONLY = %(DHT-ONLY)s
353 # bootstrap nodes to contact to join the DHT
354 BOOTSTRAP = %(BOOTSTRAP)s
356 # whether this node is a bootstrap node
357 BOOTSTRAP_NODE = %(BOOTSTRAP_NODE)s
359 # Kademlia "K" constant, this should be an even number
362 # SHA1 is 160 bits long
365 # checkpoint every this many seconds
366 CHECKPOINT_INTERVAL = 5m
368 # concurrent xmlrpc calls per find node/value request!
371 # how many hosts to post to
374 # How many values to attempt to retrieve from the DHT.
375 # Setting this to 0 will try and get all values (which could take a while if
376 # a lot of nodes have values). Setting it negative will try to get that
377 # number of results from only the closest STORE_REDUNDANCY nodes to the hash.
378 # The default is a large negative number so all values from the closest
379 # STORE_REDUNDANCY nodes will be retrieved.
380 RETRIEVE_VALUES = -10000
382 # how many times in a row a node can fail to respond before it's booted from the routing table
385 # never ping a node more often than this
386 MIN_PING_INTERVAL = 15m
388 # refresh buckets that haven't been touched in this long
389 BUCKET_STALENESS = 1h
391 # expire entries older than this
394 # whether to spew info about the requests/responses in the protocol
399 """Remove all the files and directories below a top-level one.
402 @param top: the top-level directory to start at
406 for root, dirs, files in os.walk(top, topdown=False):
408 os.remove(os.path.join(root, name))
410 os.rmdir(os.path.join(root, name))
413 """Join together a list of directories into a path string.
415 @type dir: C{list} of C{string}
416 @param dir: the path to join together
418 @return: the joined together path
424 joined = os.path.join(joined, i)
428 """Create all the directories to make a path.
430 @type dir: C{list} of C{string}
431 @param dir: the path to create
434 if not os.path.exists(join(dir)):
435 os.makedirs(join(dir))
438 """Create an empty file.
440 @type path: C{list} of C{string}
441 @param path: the path to create
445 f = open(join(path), 'w')
448 def start(cmd, args, work_dir = None):
449 """Fork and start a background process running.
452 @param cmd: the name of the command to run
453 @type args: C{list} of C{string}
454 @param args: the argument to pass to the command
455 @type work_dir: C{string}
456 @param work_dir: the directory to change to to execute the child process in
457 (optional, defaults to the current directory)
459 @return: the PID of the forked process
463 new_cmd = [cmd] + args
464 pid = os.spawnvp(os.P_NOWAIT, new_cmd[0], new_cmd)
468 """Stop a forked background process that is running.
471 @param pid: the PID of the process to stop
473 @return: the return status code from the child
477 # First try a keyboard interrupt
478 os.kill(pid, signal.SIGINT)
481 (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
485 # Try a keyboard interrupt again, just in case
486 os.kill(pid, signal.SIGINT)
489 (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
494 os.kill(pid, signal.SIGTERM)
497 (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
501 # Finally a kill, don't return until killed
502 os.kill(pid, signal.SIGKILL)
505 (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
509 def apt_get(num_down, cmd):
510 """Start an apt-get process in the background.
512 The default argument specified to the apt-get invocation are
513 'apt-get -d -q -c <conf_file>'. Any additional arguments (including
514 the apt-get action to use) should be specified.
516 @type num_down: C{int}
517 @param num_down: the number of the downloader to use
518 @type cmd: C{list} of C{string}
519 @param cmd: the arguments to pass to the apt-get process
521 @return: the PID of the background process
525 print '*************** apt-get (' + str(num_down) + ') ' + ' '.join(cmd) + ' ****************'
526 apt_conf = join([down_dir(num_down), 'etc', 'apt', 'apt.conf'])
527 dpkg_status = join([down_dir(num_down), 'var', 'lib', 'dpkg', 'status'])
528 args = ['-d', '-c', apt_conf, '-o', 'Dir::state::status='+dpkg_status] + cmd
529 pid = start('apt-get', args)
532 def bootstrap_address(num_boot):
533 """Determine the bootstrap address to use for a node.
535 @type num_boot: C{int}
536 @param num_boot: the number of the bootstrap node
538 @return: the bootstrap address to use
542 return 'localhost:1' + str(num_boot) + '969'
544 def down_dir(num_down):
545 """Determine the working directory to use for a downloader.
547 @type num_down: C{int}
548 @param num_down: the number of the downloader
550 @return: the downloader's directory
554 return os.path.join(CWD,'downloader' + str(num_down))
556 def boot_dir(num_boot):
557 """Determine the working directory to use for a bootstrap node.
559 @type num_boot: C{int}
560 @param num_boot: the number of the bootstrap node
562 @return: the bootstrap node's directory
566 return os.path.join(CWD,'bootstrap' + str(num_boot))
568 def start_downloader(bootstrap_addresses, num_down, options = {},
569 mirror = 'ftp.us.debian.org/debian',
570 suites = 'main contrib non-free', clean = True):
571 """Initialize a new downloader process.
573 The default arguments specified to the downloader invocation are
574 the configuration directory, apt port, minport, maxport and the
576 Any additional arguments needed should be specified by L{options}.
578 @type num_down: C{int}
579 @param num_down: the number of the downloader to use
580 @type options: C{dictionary}
581 @param options: the dictionary of string formatting values for creating
582 the apt-dht configuration file (see L{apt_dht_conf_template} above).
583 (optional, defaults to only using the default arguments)
584 @type mirror: C{string}
585 @param mirror: the Debian mirror to use
586 (optional, defaults to 'ftp.us.debian.org/debian')
587 @type suites: C{string}
588 @param suites: space separated list of suites to download
589 (optional, defaults to 'main contrib non-free')
590 @type clean: C{boolean}
591 @param clean: whether to remove any previous downloader files
592 (optional, defaults to removing them)
594 @return: the PID of the downloader process
598 assert num_down < 100
600 print '************************** Starting Downloader ' + str(num_down) + ' **************************'
602 downloader_dir = down_dir(num_down)
610 # Create the directory structure needed by apt
611 makedirs([downloader_dir, 'etc', 'apt', 'apt.conf.d'])
612 makedirs([downloader_dir, 'var', 'lib', 'apt', 'lists', 'partial'])
613 makedirs([downloader_dir, 'var', 'lib', 'dpkg'])
614 makedirs([downloader_dir, 'var', 'cache', 'apt', 'archives', 'partial'])
615 touch([downloader_dir, 'var', 'lib', 'apt', 'lists', 'lock'])
616 touch([downloader_dir, 'var', 'lib', 'dpkg', 'lock'])
617 touch([downloader_dir, 'var', 'lib', 'dpkg', 'status'])
618 touch([downloader_dir, 'var', 'cache', 'apt', 'archives', 'lock'])
620 # Create apt's config files
621 f = open(join([downloader_dir, 'etc', 'apt', 'sources.list']), 'w')
622 f.write('deb http://localhost:1%02d77/%s/ stable %s\n' % (num_down, mirror, suites))
625 f = open(join([downloader_dir, 'etc', 'apt', 'apt.conf']), 'w')
626 f.write('Dir "' + downloader_dir + '"')
627 f.write(apt_conf_template)
630 defaults = {'PORT': '1%02d77' % num_down,
631 'CACHE_DIR': downloader_dir,
633 'BOOTSTRAP': bootstrap_addresses,
634 'BOOTSTRAP_NODE': 'no'}
637 defaults[k] = options[k]
638 f = open(join([downloader_dir, 'apt-dht.conf']), 'w')
639 f.write(apt_dht_conf_template % defaults)
642 pid = start('python', [join([sys.path[0], 'apt-dht.py']),
643 '--config-file=' + join([downloader_dir, 'apt-dht.conf']),
644 '--log-file=' + join([downloader_dir, 'apt-dht.log']),],
648 def start_bootstrap(bootstrap_addresses, num_boot, options = [], clean = True):
649 """Initialize a new bootstrap node process.
651 The default arguments specified to the apt-dht invocation are
652 the state file and port to use. Any additional arguments needed
653 should be specified by L{options}.
655 @type num_boot: C{int}
656 @param num_boot: the number of the bootstrap node to use
657 @type options: C{list} of C{string}
658 @param options: the arguments to pass to the bootstrap node
659 (optional, defaults to only using the default arguments)
660 @type clean: C{boolean}
661 @param clean: whether to remove any previous bootstrap node files
662 (optional, defaults to removing them)
664 @return: the PID of the downloader process
670 print '************************** Starting Bootstrap ' + str(num_boot) + ' **************************'
672 bootstrap_dir = boot_dir(num_boot)
680 makedirs([bootstrap_dir])
682 defaults = {'PORT': '1%d969' % num_boot,
683 'CACHE_DIR': bootstrap_dir,
685 'BOOTSTRAP': bootstrap_addresses,
686 'BOOTSTRAP_NODE': 'yes'}
689 defaults[k] = options[k]
690 f = open(join([bootstrap_dir, 'apt-dht.conf']), 'w')
691 f.write(apt_dht_conf_template % defaults)
694 pid = start('python', [join([sys.path[0], 'apt-dht.py']),
695 '--config-file=' + join([bootstrap_dir, 'apt-dht.conf']),
696 '--log-file=' + join([bootstrap_dir, 'apt-dht.log']),],
701 def run_test(bootstraps, downloaders, apt_get_queue):
702 """Run a single test.
704 @type bootstraps: C{dictionary} of {C{int}: C{list} of C{string}}
705 @param bootstraps: the bootstrap nodes to start, keys are the bootstrap numbers and
706 values are the list of options to invoke the bootstrap node with
707 @type downloaders: C{dictionary} of {C{int}: (C{int}, C{list} of C{string})}
708 @param downloaders: the downloaders to start, keys are the downloader numbers and
709 values are the list of options to invoke the downloader with
710 @type apt_get_queue: C{list} of (C{int}, C{list} of C{string})
711 @param apt_get_queue: the apt-get downloader to use and commands to execute
712 @rtype: C{list} of (C{float}, C{int})
713 @return: the execution time and returned status code for each element of apt_get_queue
717 running_bootstraps = {}
718 running_downloaders = {}
723 boot_keys = bootstraps.keys()
725 bootstrap_addresses = bootstrap_address(boot_keys[0])
726 for i in xrange(1, len(boot_keys)):
727 bootstrap_addresses += '\n ' + bootstrap_address(boot_keys[i])
729 for k, v in bootstraps.items():
730 running_bootstraps[k] = start_bootstrap(bootstrap_addresses, k, v)
734 for k, v in downloaders.items():
735 running_downloaders[k] = start_downloader(bootstrap_addresses, k, v)
739 for (num_down, cmd) in apt_get_queue:
740 running_apt_get[num_down] = apt_get(num_down, cmd)
742 (pid, r_value) = os.waitpid(running_apt_get[num_down], 0)
743 elapsed = time() - start_time
744 del running_apt_get[num_down]
745 r_value = r_value / 256
746 apt_get_results.append((elapsed, r_value))
749 print '********** apt-get completed successfully in ' + str(elapsed) + ' sec. *****************'
751 print '********** apt-get finished with status ' + str(r_value) + ' in ' + str(elapsed) + ' sec. ************'
756 print '************************** Exception occurred **************************'
758 print '************************** will attempt to shut down *******************'
760 print '*********************** shutting down the apt-gets *******************'
761 for k, v in running_apt_get.items():
763 print 'apt-get', k, stop(v)
765 print '************************** Exception occurred **************************'
770 print '*********************** shutting down the downloaders *******************'
771 for k, v in running_downloaders.items():
773 print 'downloader', k, stop(v)
775 print '************************** Exception occurred **************************'
780 print '************************** shutting down the bootstraps *******************'
781 for k, v in running_bootstraps.items():
783 print 'bootstrap', k, stop(v)
785 print '************************** Exception occurred **************************'
788 print '************************** Test Results *******************'
790 for (num_down, cmd) in apt_get_queue:
792 s = str(num_down) + ': "apt-get ' + ' '.join(cmd) + '" '
793 if len(apt_get_results) > i:
794 (elapsed, r_value) = apt_get_results[i]
795 s += 'took ' + str(elapsed) + ' secs (' + str(r_value) + ')'
797 s += 'did not complete'
800 return apt_get_results
803 """Get the usage information to display to the user.
806 @return: the usage information to display
810 s = 'Usage: ' + sys.argv[0] + ' (all|<test>|help)\n\n'
811 s += ' all - run all the tests\n'
812 s += ' help - display this usage information\n'
813 s += ' <test> - run the <test> test (see list below for valid tests)\n\n'
818 s += 'test "' + str(k) + '" - ' + v[0] + '\n'
822 if __name__ == '__main__':
823 if len(sys.argv) != 2:
825 elif sys.argv[1] == 'all':
826 for k, v in tests.items():
827 run_test(v[1], v[2], v[3])
828 elif sys.argv[1] in tests:
829 v = tests[sys.argv[1]]
830 run_test(v[1], v[2], v[3])
831 elif sys.argv[1] == 'help':
834 print 'Unknown test to run:', sys.argv[1], '\n'