[tor-commits] [chutney/master] Merge remote-tracking branch 'tor-github/pr/11'

[teor at torproject.org]

commit 3f1002cab00c3587ce8d015612b6ed396cfd7446
Merge: 3f349e9 a113d6a
Author: teor <teor at torproject.org>
Date:   Tue Mar 19 15:08:52 2019 +1000

    Merge remote-tracking branch 'tor-github/pr/11'
    
    Merge READMEs from both sets of changes.

 README                     | 46 +++++++++++++++++++++++++++++++++++-----------
 tools/test-network-impl.sh |  5 ++++-
 2 files changed, 39 insertions(+), 12 deletions(-)

diff --cc README
index f7ec527,d2bcfad..93309cb
--- a/README
+++ b/README
@@@ -127,15 -135,38 +135,28 @@@ Bandwidth File Tests
    date +%s > /tmp/bwfile
    ./tools/test-network.sh --flavour bwfile
  
+ Multiple Tests:
+ 
+   Chutney can allow a certain number of failed tests. You can either set
+   CHUTNEY_ALLOW_FAILURES or use an --allow-failures command-line option to
+   control this.  Chutney will then reattempt the test, from bootstrap
+   through shutdown, until either it succeeds, or until it has failed
+   $CHUTNEY_ALLOW_FAILURES+1 times. The default value is zero, so the default
+   behavior will not change.
+ 
+   You can also use CHUTNEY_ROUNDS=N to run multiple verification rounds, or
+   CHUTNEY_CONNECTIONS=N to make multiple connections within each verification
+   round. Any round or connection failure will fail the current test.
+ 
  Waiting for the network:
  
-   The tools/test-network.sh script waits CHUTNEY_START_TIME seconds
-   (default: 60) before calling chutney verify, because that's the minimum
 -  The tools/test-network.sh script waits for all the tor nodes to bootstrap
 -  before calling chutney verify. If CHUTNEY_START_TIME is negative, the
 -  script leaves the network running, and exits immediately (without waiting
 -  for bootstrap, or verifying).
 -
 -  The wait_for_bootstrap command waits for up to CHUTNEY_START_TIME seconds,
 -  checking whether the logged bootstrapped status for every node is 100%. If
 -  it is, great: it succeeds. If not, it dumps the bootstrap statuses and
 -  exits. test-network.sh does not exit immediately if a tor node fails to
 -  bootstrap. Instead, it attempts to verify. We'll add an option to fail on
 -  tor bootstrap failure in #20473.
 -
 -  The default CHUTNEY_START_TIME is 40 seconds, because that's the minimum
--  amount of time it takes to bootstrap a consensus containing relays.
-   (It takes 5-10 seconds for the authorities to create the first consensus,
-   then 10 seconds for relays to bootstrap, submit their descriptors, and be
-   included in the next consensus.) If CHUTNEY_START_TIME is negative, the
-   script leaves the network running, and exits immediately (without verifying).
 -  (It takes 20 seconds for the authorities to create the first consensus,
 -  then 20 seconds for relays to bootstrap, submit their descriptors, and be
 -  included in the next consensus.)
++  The tools/test-network.sh script uses the chutney wait_for_bootstrap
++  command to wait for up to CHUTNEY_START_TIME seconds, checking whether the
++  logged bootstrapped status for every node is 100%. It it is, great: it
++  succeeds. If not, it dumps the bootstrap statuses and exits.
++  test-network.sh does not exit immediately if a tor node fails to bootstrap.
++  Instead, it attempts to verify. We'll add an option to fail on tor
++  bootstrap failure in #20473.
  
    Commands like "chutney verify" start immediately, and keep trying for
    CHUTNEY_BOOTSTRAP_TIME seconds (default: 60). If it hasn't been