1. This is chutney. It doesn't do much so far. It isn't ready for prime-time.
  2. If it breaks, you get to keep all the pieces.
  3. It is supposed to be a good tool for:
  4. - Configuring a testing tor network
  5. - Launching and monitoring a testing tor network
  6. - Running tests on a testing tor network
  7. Right now it only sorta does these things.
  8. You will need:
  9. - Python 2.7, or a supported Python 3,
  10. - (we support Python versions that are still getting updates), and
  11. - Tor binaries.
  12. Chutney checks for Tor binaries in this order:
  13. - If you run chutney's tools/ from a tor build directory,
  14. (or set the environment variable $TOR_DIR to a tor build directory,)
  15. chutney will automatically detect the tor binaries, or
  16. - If you put the location of the 'tor' and 'tor-gencert' binaries in the
  17. environment variables $CHUTNEY_TOR and $CHUTNEY_TOR_GENCERT, respectively,
  18. chutney will use those binaries, or
  19. - You will need tor and tor-gencert installed somewhere in your path.
  20. Stuff to try:
  21. Automated Setup, Verification, and Shutdown:
  22. ./tools/ --flavor basic-min
  23. ./tools/ --coverage
  24. ./tools/ --tor-path <tor-build-directory>
  25. ./tools/ --tor <name-or-path> --tor-gencert <name-or-path>
  26. (--tor-path and $TOR_DIR override --tor and --tor-gencert.)
  27. (The script tries hard to find tor.)
  28. ./tools/ --chutney-path <chutney-directory>
  29. (The script is pretty good at finding chutney.)
  30. ./tools/ --allow-failures <N>
  31. looks for some tor binaries (either in a nearby build
  32. directory or in your $PATH), configures a comprehensive tor test network,
  33. launches it, then verifies data transmission through it, and cleans up after
  34. itself. Relative paths are supported.
  35. You can modify its configuration using command-line arguments, or use the
  36. chutney environmental variables documented below:
  37. Verification Options:
  38. # repeats bootstrap and verify
  39. --allow-failures CHUTNEY_ALLOW_FAILURES=N
  40. # repeats verify
  41. --rounds CHUTNEY_ROUNDS=N
  42. # makes multiple connections within verify
  43. --connections CHUTNEY_CONNECTIONS=N
  44. Timing Options:
  45. --start-time CHUTNEY_START_TIME=N
  46. --bootstrap-time CHUTNEY_BOOTSTRAP_TIME=N
  47. --stop-time CHUTNEY_STOP_TIME=N
  48. Traffic Options:
  50. --hs-multi-client CHUTNEY_HS_MULTI_CLIENT=N
  51. Address/DNS Options:
  54. # Chutney uses /etc/resolv.conf if none of these options are set
  55. --dns-conf CHUTNEY_DNS_CONF=PATH
  56. --offline CHUTNEY_DNS_CONF=/dev/null
  57. # Use tor's compile-time default for ServerDNSResolvConfFile
  58. --dns-conf-default CHUTNEY_DNS_CONF=""
  59. Warning Options:
  60. --all-warnings CHUTNEY_WARNINGS_IGNORE_EXPECTED=false
  62. --no-warnings CHUTNEY_WARNINGS_SKIP=true
  63. --only-warnings CHUTNEY_WARNINGS_ONLY=true
  64. Expert Options:
  65. --debug CHUTNEY_DEBUG=true
  66. --coverage USE_COVERAGE_BINARY=true
  67. --dry-run NETWORK_DRY_RUN=true
  68. --quiet ECHO=true
  69. --controlling-pid CHUTNEY_CONTROLLING_PID=N
  70. --net-dir CHUTNEY_DATA_DIR=PATH
  71. (These are advanced options: in the past, they have had long-standing bugs.)
  72. Standard Actions:
  73. ./chutney configure networks/basic
  74. ./chutney start networks/basic
  75. ./chutney status networks/basic
  76. ./chutney wait_for_bootstrap networks/basic
  77. ./chutney verify networks/basic
  78. ./chutney hup networks/basic
  79. ./chutney stop networks/basic
  80. Bandwidth Tests:
  81. ./chutney configure networks/basic-min
  82. ./chutney start networks/basic-min
  83. ./chutney status networks/basic-min
  84. # Send 100MB of data per client connection
  85. CHUTNEY_DATA_BYTES=104857600 ./chutney verify networks/basic-min
  86. ./chutney stop networks/basic-min
  87. If chutney sends at least 5 MB of data, and it takes at least one second,
  88. verify produces performance figures for:
  89. - Single Stream Bandwidth: the speed of the slowest stream, end-to-end
  90. - Overall tor Bandwidth: the sum of the bandwidth across each tor instance
  91. The overall bandwidth approximates the CPU-bound tor performance on the
  92. current machine, assuming tor, chutney, and the OS are multithreaded, and
  93. network performance is infinite.
  94. Connection Tests:
  95. ./chutney configure networks/basic-025
  96. ./chutney start networks/basic-025
  97. ./chutney status networks/basic-025
  98. # Make 5 simultaneous connections from each client through a random exit
  99. CHUTNEY_CONNECTIONS=5 ./chutney verify networks/basic-025
  100. ./chutney stop networks/basic-025
  101. # Run 5 sequential verification rounds
  102. CHUTNEY_ROUNDS=5 ./tools/ --flavour basic
  103. HS Connection Tests:
  104. ./chutney configure networks/hs-025
  105. ./chutney start networks/hs-025
  106. ./chutney status networks/hs-025
  107. CHUTNEY_HS_MULTI_CLIENT=1 ./chutney verify networks/hs-025
  108. # Make a connection from each client to each hs
  109. # Default behavior is one client connects to each HS
  110. ./chutney stop networks/hs-025
  111. Bandwidth File Tests:
  112. ./tools/ --flavour bwfile
  113. # Warning: Can't open bandwidth file at configured location: /tmp/bwfile
  114. # Create a bwfile with no bandwidths, that is valid for a few days
  115. date +%s > /tmp/bwfile
  116. ./tools/ --flavour bwfile
  117. Multiple Tests:
  118. Chutney can allow a certain number of failed tests. You can either set
  119. CHUTNEY_ALLOW_FAILURES or use an --allow-failures command-line option to
  120. control this. Chutney will then reattempt the test, from bootstrap
  121. through shutdown, until either it succeeds, or until it has failed
  122. $CHUTNEY_ALLOW_FAILURES+1 times. The default value is zero, so the default
  123. behavior will not change.
  124. You can also use CHUTNEY_ROUNDS=N to run multiple verification rounds, or
  125. CHUTNEY_CONNECTIONS=N to make multiple connections within each verification
  126. round. Any round or connection failure will fail the current test.
  127. Waiting for the network:
  128. The tools/ script uses the chutney wait_for_bootstrap
  129. command to wait for up to CHUTNEY_START_TIME seconds (default: 60), checking
  130. whether the logged bootstrapped status for every node is 100%. It it is,
  131. great: it succeeds. If not, it dumps the bootstrap statuses and exits.
  132. does not exit immediately if a tor node fails to bootstrap.
  133. Instead, it attempts to verify. We'll add an option to fail on tor
  134. bootstrap failure in #20473.
  135. Commands like "chutney verify" start immediately, and keep trying for
  136. CHUTNEY_BOOTSTRAP_TIME seconds (default: 60). If it hasn't been
  137. successful after that time, it fails. If CHUTNEY_BOOTSTRAP_TIME is negative,
  138. the script leaves the network running, and exits after CHUTNEY_START_TIME
  139. (without verifying).
  140. The tools/ script waits CHUTNEY_STOP_TIME seconds
  141. after verifying, then exits (default: immediately). If CHUTNEY_STOP_TIME is
  142. negative, the script leaves the network running, and exits after verifying.
  143. If none of these options are negative, tells the tor
  144. processes to exit after it exits, using CHUTNEY_CONTROLLING_PID. To disable
  145. this functionality, set CHUTNEY_CONTROLLING_PID to 1 or less.
  146. Changing the network address:
  147. Chutney defaults to binding to localhost. To change the IPv4 bind address,
  148. set the CHUTNEY_LISTEN_ADDRESS environment variable. Similarly, change
  149. CHUTNEY_LISTEN_ADDRESS_V6 for IPv6: it defaults to "no IPv6 address".
  150. Setting it to some interface's IP address allows us to make the simulated
  151. Tor network available on the network.
  152. IPv6 support for both Tor and Chutney is a work in progress. Currently,
  153. chutney verifies IPv6 client, bridge client (?), hidden service, and exit
  154. connections. It does not use IPv6 SOCKSPorts or HiddenServicePorts.
  155. Using DNS:
  156. Chutney verify uses IP addresses by default. It does not need to look up
  157. any hostnames. We recommend that chutney users disable DNS using --offline
  158. or CHUTNEY_DNS_CONF=/dev/null , because any DNS failures causes tests to
  159. fail. Chutney's DNS queries also produce external traffic in a predictable
  160. pattern.
  161. If you want to use a hostname with CHUTNEY_LISTEN_ADDRESS[_V6], or you want
  162. to run tests that use DNS, set CHUTNEY_DNS_CONF to the path to a file in
  163. resolv.conf format. Chutney's default of /etc/resolv.conf should be fine for
  164. most UNIX-based operating systems. If your tor is compiled with a different
  165. default, use --dns-resolv-conf-default or CHUTNEY_DNS_CONF="".
  166. When the CHUTNEY_DNS_CONF file does not exist, or is a broken symlink,
  167. chutney uses /dev/null instead. This is a workaround for bugs in tor's
  168. use of eventdns. For example, macOS deletes the resolv.conf file when it
  169. thinks the network is down: this can make tor exits reject all traffic,
  170. even if a working DNS server is running on
  171. When tor has no working name servers (including --offline mode), it can
  172. crash on SETCONF. (Chutney does not use SETCONF, but some external tor
  173. controllers do.) To avoid this crash, set CHUTNEY_DNS_CONF to a file
  174. containing a working name server address. For your convenience, chutney
  175. provides a local resolv.conf file containing IPv4, IPv6, and "localhost".
  176. Use --dns-conf resolv.conf (relative paths work).
  177. The configuration files:
  178. networks/basic holds the configuration for the network you're configuring
  179. above. It refers to some torrc template files in torrc_templates/.
  180. The working files:
  181. chutney sticks its working files, including all data directories, log
  182. files, etc, in ./net/. Each tor instance gets a subdirectory of net/nodes.
  183. You can override the directory "./net" with the CHUTNEY_DATA_DIR
  184. environment variable.
  185. Test scripts:
  186. The test scripts are stored in the "scripts/chutney_tests" directory. These
  187. Python files must define a "run_test(network)" function. Files starting with
  188. an underscore ("_") are ignored.
  189. Test scripts can be run using the following syntax:
  190. ./chutney <script-name> networks/<network-name>
  191. The chutney verify command is implemented using a test script.
  192. Test scripts in the test directory with the same name as standard commands
  193. are run instead of that standard command. This allows expert users to replace
  194. the standard chutney commands with modified versions.