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                 (2, ['update']),
  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']),
  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 # 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
 339
 340 # Which DHT implementation to use.
 341 # It must be possile to do "from <DHT>.DHT import DHT" to get a class that
 342 # implements the IDHT interface.
 343 DHT = apt_dht_Khashmir
 344
 345 # Whether to only run the DHT (for providing only a bootstrap node)
 346 DHT-ONLY = %(DHT-ONLY)s
 347
 348 [apt_dht_Khashmir]
 349 # bootstrap nodes to contact to join the DHT
 350 BOOTSTRAP = %(BOOTSTRAP)s
 351
 352 # whether this node is a bootstrap node
 353 BOOTSTRAP_NODE = %(BOOTSTRAP_NODE)s
 354
 355 # Kademlia "K" constant, this should be an even number
 356 K = 8
 357
 358 # SHA1 is 160 bits long
 359 HASH_LENGTH = 160
 360
 361 # checkpoint every this many seconds
 362 CHECKPOINT_INTERVAL = 5m
 363
 364 # concurrent xmlrpc calls per find node/value request!
 365 CONCURRENT_REQS = 4
 366
 367 # how many hosts to post to
 368 STORE_REDUNDANCY = 3
 369
 370 # how many times in a row a node can fail to respond before it's booted from the routing table
 371 MAX_FAILURES = 3
 372
 373 # never ping a node more often than this
 374 MIN_PING_INTERVAL = 15m
 375
 376 # refresh buckets that haven't been touched in this long
 377 BUCKET_STALENESS = 1h
 378
 379 # expire entries older than this
 380 KEY_EXPIRE = 1h
 381
 382 # whether to spew info about the requests/responses in the protocol
 383 SPEW = yes
 384 """
 385
 386 def rmrf(top):
 387     """Remove all the files and directories below a top-level one.
 388
 389     @type top: C{string}
 390     @param top: the top-level directory to start at
 391
 392     """
 393
 394     for root, dirs, files in os.walk(top, topdown=False):
 395         for name in files:
 396             os.remove(os.path.join(root, name))
 397         for name in dirs:
 398             os.rmdir(os.path.join(root, name))
 399
 400 def join(dir):
 401     """Join together a list of directories into a path string.
 402
 403     @type dir: C{list} of C{string}
 404     @param dir: the path to join together
 405     @rtype: C{string}
 406     @return: the joined together path
 407
 408     """
 409
 410     joined = ''
 411     for i in dir:
 412         joined = os.path.join(joined, i)
 413     return joined
 414
 415 def makedirs(dir):
 416     """Create all the directories to make a path.
 417
 418     @type dir: C{list} of C{string}
 419     @param dir: the path to create
 420
 421     """
 422     if not os.path.exists(join(dir)):
 423         os.makedirs(join(dir))
 424
 425 def touch(path):
 426     """Create an empty file.
 427
 428     @type path: C{list} of C{string}
 429     @param path: the path to create
 430
 431     """
 432
 433     f = open(join(path), 'w')
 434     f.close()
 435
 436 def start(cmd, args, work_dir = None):
 437     """Fork and start a background process running.
 438
 439     @type cmd: C{string}
 440     @param cmd: the name of the command to run
 441     @type args: C{list} of C{string}
 442     @param args: the argument to pass to the command
 443     @type work_dir: C{string}
 444     @param work_dir: the directory to change to to execute the child process in
 445         (optional, defaults to the current directory)
 446     @rtype: C{int}
 447     @return: the PID of the forked process
 448
 449     """
 450
 451     new_cmd = [cmd] + args
 452     pid = os.spawnvp(os.P_NOWAIT, new_cmd[0], new_cmd)
 453     return pid
 454
 455 def stop(pid):
 456     """Stop a forked background process that is running.
 457
 458     @type pid: C{int}
 459     @param pid: the PID of the process to stop
 460     @rtype: C{int}
 461     @return: the return status code from the child
 462
 463     """
 464
 465     # First try a keyboard interrupt
 466     os.kill(pid, signal.SIGINT)
 467     for i in xrange(5):
 468         sleep(1)
 469         (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
 470         if r_pid:
 471             return r_value
 472
 473     # Try a keyboard interrupt again, just in case
 474     os.kill(pid, signal.SIGINT)
 475     for i in xrange(5):
 476         sleep(1)
 477         (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
 478         if r_pid:
 479             return r_value
 480
 481     # Try a terminate
 482     os.kill(pid, signal.SIGTERM)
 483     for i in xrange(5):
 484         sleep(1)
 485         (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
 486         if r_pid:
 487             return r_value
 488
 489     # Finally a kill, don't return until killed
 490     os.kill(pid, signal.SIGKILL)
 491     while not r_pid:
 492         sleep(1)
 493         (r_pid, r_value) = os.waitpid(pid, os.WNOHANG)
 494
 495     return r_value
 496
 497 def apt_get(num_down, cmd):
 498     """Start an apt-get process in the background.
 499
 500     The default argument specified to the apt-get invocation are
 501     'apt-get -d -q -c <conf_file>'. Any additional arguments (including
 502     the apt-get action to use) should be specified.
 503
 504     @type num_down: C{int}
 505     @param num_down: the number of the downloader to use
 506     @type cmd: C{list} of C{string}
 507     @param cmd: the arguments to pass to the apt-get process
 508     @rtype: C{int}
 509     @return: the PID of the background process
 510
 511     """
 512
 513     print '*************** apt-get (' + str(num_down) + ') ' + ' '.join(cmd) + ' ****************'
 514     apt_conf = join([down_dir(num_down), 'etc', 'apt', 'apt.conf'])
 515     dpkg_status = join([down_dir(num_down), 'var', 'lib', 'dpkg', 'status'])
 516     args = ['-d', '-c', apt_conf, '-o', 'Dir::state::status='+dpkg_status] + cmd
 517     pid = start('apt-get', args)
 518     return pid
 519
 520 def bootstrap_address(num_boot):
 521     """Determine the bootstrap address to use for a node.
 522
 523     @type num_boot: C{int}
 524     @param num_boot: the number of the bootstrap node
 525     @rtype: C{string}
 526     @return: the bootstrap address to use
 527
 528     """
 529
 530     return 'localhost:1' + str(num_boot) + '969'
 531
 532 def down_dir(num_down):
 533     """Determine the working directory to use for a downloader.
 534
 535     @type num_down: C{int}
 536     @param num_down: the number of the downloader
 537     @rtype: C{string}
 538     @return: the downloader's directory
 539
 540     """
 541
 542     return os.path.join(CWD,'downloader' + str(num_down))
 543
 544 def boot_dir(num_boot):
 545     """Determine the working directory to use for a bootstrap node.
 546
 547     @type num_boot: C{int}
 548     @param num_boot: the number of the bootstrap node
 549     @rtype: C{string}
 550     @return: the bootstrap node's directory
 551
 552     """
 553
 554     return os.path.join(CWD,'bootstrap' + str(num_boot))
 555
 556 def start_downloader(bootstrap_addresses, num_down, options = {},
 557                      mirror = 'ftp.us.debian.org/debian',
 558                      suites = 'main contrib non-free', clean = True):
 559     """Initialize a new downloader process.
 560
 561     The default arguments specified to the downloader invocation are
 562     the configuration directory, apt port, minport, maxport and the
 563     maximum upload rate.
 564     Any additional arguments needed should be specified by L{options}.
 565
 566     @type num_down: C{int}
 567     @param num_down: the number of the downloader to use
 568     @type options: C{dictionary}
 569     @param options: the dictionary of string formatting values for creating
 570         the apt-dht configuration file (see L{apt_dht_conf_template} above).
 571         (optional, defaults to only using the default arguments)
 572     @type mirror: C{string}
 573     @param mirror: the Debian mirror to use
 574         (optional, defaults to 'ftp.us.debian.org/debian')
 575     @type suites: C{string}
 576     @param suites: space separated list of suites to download
 577         (optional, defaults to 'main contrib non-free')
 578     @type clean: C{boolean}
 579     @param clean: whether to remove any previous downloader files
 580         (optional, defaults to removing them)
 581     @rtype: C{int}
 582     @return: the PID of the downloader process
 583
 584     """
 585
 586     assert num_down < 100
 587
 588     print '************************** Starting Downloader ' + str(num_down) + ' **************************'
 589
 590     downloader_dir = down_dir(num_down)
 591
 592     if clean:
 593         try:
 594             rmrf(downloader_dir)
 595         except:
 596             pass
 597
 598         # Create the directory structure needed by apt
 599         makedirs([downloader_dir, 'etc', 'apt', 'apt.conf.d'])
 600         makedirs([downloader_dir, 'var', 'lib', 'apt', 'lists', 'partial'])
 601         makedirs([downloader_dir, 'var', 'lib', 'dpkg'])
 602         makedirs([downloader_dir, 'var', 'cache', 'apt', 'archives', 'partial'])
 603         touch([downloader_dir, 'var', 'lib', 'apt', 'lists', 'lock'])
 604         touch([downloader_dir, 'var', 'lib', 'dpkg', 'lock'])
 605         touch([downloader_dir, 'var', 'lib', 'dpkg', 'status'])
 606         touch([downloader_dir, 'var', 'cache', 'apt', 'archives', 'lock'])
 607
 608         # Create apt's config files
 609         f = open(join([downloader_dir, 'etc', 'apt', 'sources.list']), 'w')
 610         f.write('deb http://localhost:1%02d77/%s/ stable %s\n' % (num_down, mirror, suites))
 611         f.close()
 612
 613         f = open(join([downloader_dir, 'etc', 'apt', 'apt.conf']), 'w')
 614         f.write('Dir "' + downloader_dir + '"')
 615         f.write(apt_conf_template)
 616         f.close()
 617
 618     defaults = {'PORT': '1%02d77' % num_down,
 619                 'CACHE_DIR': downloader_dir,
 620                 'DHT-ONLY': 'no',
 621                 'BOOTSTRAP': bootstrap_addresses,
 622                 'BOOTSTRAP_NODE': 'no'}
 623
 624     for k in options:
 625         defaults[k] = options[k]
 626     f = open(join([downloader_dir, 'apt-dht.conf']), 'w')
 627     f.write(apt_dht_conf_template % defaults)
 628     f.close()
 629
 630     pid = start('python', [join([sys.path[0], 'apt-dht.py']),
 631                            '--config-file=' + join([downloader_dir, 'apt-dht.conf']),
 632                            '--log-file=' + join([downloader_dir, 'apt-dht.log']),],
 633                 downloader_dir)
 634     return pid
 635
 636 def start_bootstrap(bootstrap_addresses, num_boot, options = [], clean = True):
 637     """Initialize a new bootstrap node process.
 638
 639     The default arguments specified to the apt-dht invocation are
 640     the state file and port to use. Any additional arguments needed
 641     should be specified by L{options}.
 642
 643     @type num_boot: C{int}
 644     @param num_boot: the number of the bootstrap node to use
 645     @type options: C{list} of C{string}
 646     @param options: the arguments to pass to the bootstrap node
 647         (optional, defaults to only using the default arguments)
 648     @type clean: C{boolean}
 649     @param clean: whether to remove any previous bootstrap node files
 650         (optional, defaults to removing them)
 651     @rtype: C{int}
 652     @return: the PID of the downloader process
 653
 654     """
 655
 656     assert num_boot < 10
 657
 658     print '************************** Starting Bootstrap ' + str(num_boot) + ' **************************'
 659
 660     bootstrap_dir = boot_dir(num_boot)
 661
 662     if clean:
 663         try:
 664             rmrf(bootstrap_dir)
 665         except:
 666             pass
 667
 668     makedirs([bootstrap_dir])
 669
 670     defaults = {'PORT': '1%d969' % num_boot,
 671                 'CACHE_DIR': bootstrap_dir,
 672                 'DHT-ONLY': 'yes',
 673                 'BOOTSTRAP': bootstrap_addresses,
 674                 'BOOTSTRAP_NODE': 'yes'}
 675
 676     for k in options:
 677         defaults[k] = options[k]
 678     f = open(join([bootstrap_dir, 'apt-dht.conf']), 'w')
 679     f.write(apt_dht_conf_template % defaults)
 680     f.close()
 681
 682     pid = start('python', [join([sys.path[0], 'apt-dht.py']),
 683                            '--config-file=' + join([bootstrap_dir, 'apt-dht.conf']),
 684                            '--log-file=' + join([bootstrap_dir, 'apt-dht.log']),],
 685                 bootstrap_dir)
 686
 687     return pid
 688
 689 def run_test(bootstraps, downloaders, apt_get_queue):
 690     """Run a single test.
 691
 692     @type bootstraps: C{dictionary} of {C{int}: C{list} of C{string}}
 693     @param bootstraps: the bootstrap nodes to start, keys are the bootstrap numbers and
 694         values are the list of options to invoke the bootstrap node with
 695     @type downloaders: C{dictionary} of {C{int}: (C{int}, C{list} of C{string})}
 696     @param downloaders: the downloaders to start, keys are the downloader numbers and
 697         values are the list of options to invoke the downloader with
 698     @type apt_get_queue: C{list} of (C{int}, C{list} of C{string})
 699     @param apt_get_queue: the apt-get downloader to use and commands to execute
 700     @rtype: C{list} of (C{float}, C{int})
 701     @return: the execution time and returned status code for each element of apt_get_queue
 702
 703     """
 704
 705     running_bootstraps = {}
 706     running_downloaders = {}
 707     running_apt_get = {}
 708     apt_get_results = []
 709
 710     try:
 711         boot_keys = bootstraps.keys()
 712         boot_keys.sort()
 713         bootstrap_addresses = bootstrap_address(boot_keys[0])
 714         for i in xrange(1, len(boot_keys)):
 715             bootstrap_addresses += '\n      ' + bootstrap_address(boot_keys[i])
 716
 717         for k, v in bootstraps.items():
 718             running_bootstraps[k] = start_bootstrap(bootstrap_addresses, k, v)
 719
 720         sleep(5)
 721
 722         for k, v in downloaders.items():
 723             running_downloaders[k] = start_downloader(bootstrap_addresses, k, v)
 724
 725         sleep(5)
 726
 727         for (num_down, cmd) in apt_get_queue:
 728             running_apt_get[num_down] = apt_get(num_down, cmd)
 729             start_time = time()
 730             (pid, r_value) = os.waitpid(running_apt_get[num_down], 0)
 731             elapsed = time() - start_time
 732             del running_apt_get[num_down]
 733             r_value = r_value / 256
 734             apt_get_results.append((elapsed, r_value))
 735
 736             if r_value == 0:
 737                 print '********** apt-get completed successfully in ' +  str(elapsed) + ' sec. *****************'
 738             else:
 739                 print '********** apt-get finished with status ' + str(r_value) + ' in ' +  str(elapsed) + ' sec. ************'
 740
 741             sleep(5)
 742
 743     except:
 744         print '************************** Exception occurred **************************'
 745         print_exc()
 746         print '************************** will attempt to shut down *******************'
 747
 748     print '*********************** shutting down the apt-gets *******************'
 749     for k, v in running_apt_get.items():
 750         try:
 751             print 'apt-get', k, stop(v)
 752         except:
 753             print '************************** Exception occurred **************************'
 754             print_exc()
 755
 756     sleep(5)
 757
 758     print '*********************** shutting down the downloaders *******************'
 759     for k, v in running_downloaders.items():
 760         try:
 761             print 'downloader', k, stop(v)
 762         except:
 763             print '************************** Exception occurred **************************'
 764             print_exc()
 765
 766     sleep(5)
 767
 768     print '************************** shutting down the bootstraps *******************'
 769     for k, v in running_bootstraps.items():
 770         try:
 771             print 'bootstrap', k, stop(v)
 772         except:
 773             print '************************** Exception occurred **************************'
 774             print_exc()
 775
 776     print '************************** Test Results *******************'
 777     i = -1
 778     for (num_down, cmd) in apt_get_queue:
 779         i += 1
 780         s = str(num_down) + ': "apt-get ' + ' '.join(cmd) + '" '
 781         if len(apt_get_results) > i:
 782             (elapsed, r_value) = apt_get_results[i]
 783             s += 'took ' + str(elapsed) + ' secs (' + str(r_value) + ')'
 784         else:
 785             s += 'did not complete'
 786         print s
 787
 788     return apt_get_results
 789
 790 def get_usage():
 791     """Get the usage information to display to the user.
 792
 793     @rtype: C{string}
 794     @return: the usage information to display
 795
 796     """
 797
 798     s = 'Usage: ' + sys.argv[0] + ' (all|<test>|help)\n\n'
 799     s += '  all    - run all the tests\n'
 800     s += '  help   - display this usage information\n'
 801     s += '  <test> - run the <test> test (see list below for valid tests)\n\n'
 802
 803     t = tests.items()
 804     t.sort()
 805     for k, v in t:
 806         s += 'test "' + str(k) + '" - ' + v[0] + '\n'
 807
 808     return s
 809
 810 if __name__ == '__main__':
 811     if len(sys.argv) != 2:
 812         print get_usage()
 813     elif sys.argv[1] == 'all':
 814         for k, v in tests.items():
 815             run_test(v[1], v[2], v[3])
 816     elif sys.argv[1] in tests:
 817         v = tests[sys.argv[1]]
 818         run_test(v[1], v[2], v[3])
 819     elif sys.argv[1] == 'help':
 820         print get_usage()
 821     else:
 822         print 'Unknown test to run:', sys.argv[1], '\n'
 823         print get_usage()
 824