[tor-commits] [stem/master] Merging testrc.sample with settings.cfg

[atagar at torproject.org]

commit 5e29e28d16dc050d4cc5dcac9ae92d20935651d7
Author: Damian Johnson <atagar at torproject.org>
Date:   Sat Oct 13 16:34:47 2012 -0700

    Merging testrc.sample with settings.cfg
    
    We run the tests all the time but never with a configuration file so
    deemphasising the capability by merging the sample rc file with the
    settings.cfg (which is actually... well, used). If someone really wants to
    configure the tests this way then they might as well look at the settings.cfg
    anyway since it'll provide the full range of options.
---
 test/settings.cfg  |   71 +++++++++++++++++++++++++++++++++++++++++++++++++---
 test/testrc.sample |   56 -----------------------------------------
 2 files changed, 67 insertions(+), 60 deletions(-)

diff --git a/test/settings.cfg b/test/settings.cfg
index 44e28ab..9aadcda 100644
--- a/test/settings.cfg
+++ b/test/settings.cfg
@@ -1,10 +1,73 @@
 # Testing Configuration
 #
-# The following are globally accessable configuration attributes used by stem's
-# unit and integration tests. Top level configuraion categories are...
+# The following are configurations used by stem's testing framework. You can
+# overwrite any of these my making your own configuratino file and using the
+# '--config' option of run_tests.py...
 #
-# target.* - Attributes of the integration testing targets. This helps
-#            determine what is ran when the user runs with '--target'.
+#   run_tests.py --config my_testrc --unit
+#
+# The commonly customized options are...
+#
+# argument.*
+#   Default test runner arguments. You can set these to always run with
+#   particular arguments.
+#
+# integ.test_directory
+#   Path used for our data directory and any temporary test resources. Relative
+#   paths are expanded in reference to the location of 'run_tests.py'.
+#   
+#   If set then the directory's contents are reused for future tests (so we
+#   have a faster startup and lower load on authorities). If set to an empty
+#   value then this makes a fresh data directory for each test run.
+#
+# integ.log
+#   Path runtime logs are placed. Relative paths are expanded in reference to
+#   'run_tests.py'. Logging is disabled if set ot an empty value.
+#
+# integ.target.online
+#   Runs tests with network activity. If set then we'll wait for tor to fully
+#   bootstrap when starting, which won't happen without a network connection.
+#
+# integ.target.relative_data_dir
+#   Uses a relative path for the tor data directory if set.
+#
+# integ.target.run.*
+#   Runs the integration test suite for all of the given connection and
+#   authentication configurations. If the 'all' option is set then the other
+#   flags are ignored.
+
+argument.unit false
+argument.integ false
+argument.test
+argument.log
+argument.tor tor
+argument.no_color false
+
+integ.test_directory ./test/data
+integ.log ./test/data/log
+
+integ.target.online false
+integ.target.relative_data_dir false
+integ.target.chroot false
+integ.target.run.none false
+integ.target.run.open true
+integ.target.run.password false
+integ.target.run.cookie false
+integ.target.run.muiltipe false
+integ.target.run.socket false
+integ.target.run.scookie false
+integ.target.run.ptrace false
+integ.target.run.all false
+
+# The following are less testing framework attributes that aren't as commonly
+# reconfigured.
+#
+# msg.*
+#   Rendered text.
+#
+# target.*
+#   Attributes of the integration testing targets. This helps determine what is
+#   ran when the user runs with '--target'.
 
 msg.help
 |Usage runTests.py [OPTION]
diff --git a/test/testrc.sample b/test/testrc.sample
deleted file mode 100644
index 444d7f2..0000000
--- a/test/testrc.sample
+++ /dev/null
@@ -1,56 +0,0 @@
-# Integration Test Settings
-#
-# argument.unit
-# argument.integ
-# argument.log
-# argument.tor
-# argument.no_color
-#   Default values for runner arguments.
-#
-# integ.test_directory
-#   Path used for our data directory and any temporary test resources. Relative
-#   paths are expanded in reference to the location of 'run_tests.py'.
-#   
-#   If set then the directory's contents are reused for future tests (so we
-#   have a faster startup and lower load on authorities). If set to an empty
-#   value then this makes a fresh data directory for each test run.
-#
-# integ.log
-#   Path runtime logs are placed. Relative paths are expanded in reference to
-#   'run_tests.py'. Logging is disabled if set ot an empty value.
-#
-# integ.target.online
-#   Runs tests with network activity. If set then we'll wait for tor to fully
-#   bootstrap when starting, which won't happen without a network connection.
-#
-# integ.target.relative_data_dir
-#   Uses a relative path for the tor data directory if set.
-#
-# integ.target.run.*
-#   Runs the integration test suite for all of the given connection and
-#   authentication configurations. If the 'all' option is set then the other
-#   flags are ignored.
-
-argument.unit false
-argument.integ false
-argument.test
-argument.log
-argument.tor tor
-argument.no_color false
-
-integ.test_directory ./test/data
-integ.log ./test/data/log
-
-integ.target.online false
-integ.target.relative_data_dir false
-integ.target.chroot false
-integ.target.run.none false
-integ.target.run.open true
-integ.target.run.password false
-integ.target.run.cookie false
-integ.target.run.muiltipe false
-integ.target.run.socket false
-integ.target.run.scookie false
-integ.target.run.ptrace false
-integ.target.run.all false
-