commit 859bf025b0a9a2e0793f64ed3404db06051d15ae Author: Damian Johnson atagar@torproject.org Date: Fri Nov 4 16:36:54 2016 -0700
Fill in missing manual summaries
As tor adds new config options we want short, particularly human-readable summaries. Filling in the new additons.
We have a test that checks for this but it required the ONLINE integ target so really never gets run in practice. Replacing this with a unit test since honestly we don't need the downloaded information for this one. --- stem/settings.cfg | 11 ++++++----- test/integ/manual.py | 22 ---------------------- test/unit/manual.py | 19 +++++++++++++++++++ 3 files changed, 25 insertions(+), 27 deletions(-)
diff --git a/stem/settings.cfg b/stem/settings.cfg index b561f73..c57d823 100644 --- a/stem/settings.cfg +++ b/stem/settings.cfg @@ -117,9 +117,6 @@ manual.summary.AccelName OpenSSL engine name for crypto acceleration manual.summary.AccelDir Crypto acceleration library path manual.summary.AvoidDiskWrites Toggles if tor avoids frequently writing to disk manual.summary.CircuitPriorityHalflife Overwrite method for prioritizing traffic among relayed connections -manual.summary.DisableIOCP Disables use of the Windows IOCP networking API -manual.summary.UserspaceIOCPBuffers Disable kernel-space IOCP TCP buffers -manual.summary.UseFilteringSSLBufferevents Use SSL for a chain of bufferevents manual.summary.CountPrivateBandwidth Applies rate limiting to private IP addresses
# Client Config Options @@ -196,7 +193,6 @@ manual.summary.OptimisticData Use exits without confirmation that prior connecti manual.summary.Tor2webMode Establish non-anonymous hidden service connections manual.summary.Tor2webRendezvousPoints Rendezvous points to use for hidden services when in Tor2webMode manual.summary.UseMicrodescriptors Retrieve microdescriptors rather than server descriptors -manual.summary.UseNTorHandshake Use ntor for establishing circuits with relays manual.summary.PathBiasCircThreshold Number of circuits through a guard before applying bias checks manual.summary.PathBiasNoticeRate Fraction of circuits that must succeed before logging a notice manual.summary.PathBiasWarnRate Fraction of circuits that must succeed before logging a warning @@ -228,7 +224,8 @@ manual.summary.BridgeRelay Act as a bridge manual.summary.ContactInfo Contact information for this relay manual.summary.ExitRelay Allow relaying of exit traffic manual.summary.ExitPolicy Traffic destinations that can exit from this relay -manual.summary.ExitPolicyRejectPrivate Prevent exiting connection on the local network +manual.summary.ExitPolicyRejectPrivate Prevent exiting on the local network +manual.summary.ExitPolicyRejectLocalInterfaces More extensive prevention of exiting on the local network manual.summary.IPv6Exit Allow clients to use us for IPv6 traffic manual.summary.MaxOnionQueueDelay Duration to reject new onionskins if we have more than we can process manual.summary.MyFamily Other relays this operator administers @@ -266,6 +263,7 @@ manual.summary.HiddenServiceStatistics Toggles storing hidden service stats to d manual.summary.ExtraInfoStatistics Publishes statistic data in the extra-info documents manual.summary.ExtendAllowPrivateAddresses Allow circuits to be extended to the local network manual.summary.MaxMemInQueues Threshold at which tor will terminate circuits to avoid running out of memory +manual.summary.DisableOOSCheck Don't close connections when running out of sockets manual.summary.SigningKeyLifetime Duration the Ed25519 signing key is valid for manual.summary.OfflineMasterKey Don't generate the master secret key
@@ -302,6 +300,7 @@ manual.summary.AuthDirMaxServersPerAuthAddr Limit on the number of relays accept manual.summary.AuthDirFastGuarantee Advertised rate at which the Fast flag is granted manual.summary.AuthDirGuardBWGuarantee Advertised rate necessary to be a guard manual.summary.AuthDirPinKeys Don't accept descriptors with conflicting identity keypairs +manual.summary.AuthDirSharedRandomness Participates in shared randomness voting manual.summary.BridgePassword Password for requesting bridge information manual.summary.V3AuthVotingInterval Consensus voting interval manual.summary.V3AuthVoteDelay Wait time to collect votes of other authorities @@ -326,6 +325,8 @@ manual.summary.HiddenServiceMaxStreamsCloseCircuit Closes rendezvous circuits th manual.summary.RendPostPeriod Period at which the rendezvous service descriptors are refreshed manual.summary.HiddenServiceDirGroupReadable Group read permissions for the hidden service directory manual.summary.HiddenServiceNumIntroductionPoints Number of introduction points the hidden service will have +manual.summary.HiddenServiceSingleHopMode Allow non-anonymous single hop hidden services +manual.summary.HiddenServiceNonAnonymousMode Enables HiddenServiceSingleHopMode to be set
# Testing Network Options
diff --git a/test/integ/manual.py b/test/integ/manual.py index dbef86a..62222f5 100644 --- a/test/integ/manual.py +++ b/test/integ/manual.py @@ -246,28 +246,6 @@ class TestManual(unittest.TestCase): self.assertEqual(['tor - The second-generation onion router'], categories['NAME']) self.assertEqual(['tor [OPTION value]...'], categories['SYNOPSIS'])
- def test_has_all_summaries(self): - """ - Check that we have brief, human readable summaries for all of tor's - configuration options. If you add a new config entry then please take a sec - to write a little summary. They're located in 'stem/settings.cfg'. - """ - - if self.requires_downloaded_manual(): - return - - manual = stem.manual.Manual.from_man(self.man_path) - present = set(manual.config_options.keys()) - expected = set([key[15:] for key in stem.manual._config(lowercase = False) if key.startswith('manual.summary.')]) - - missing_options = present.difference(expected) - extra_options = expected.difference(present) - - if missing_options: - self.fail("Changed tor's man page? Please update Stem's settings.cfg with summaries of the following config options: %s" % ', '.join(missing_options)) - elif extra_options: - self.fail("Changed tor's man page? Please remove the following summaries from Stem's settings.cfg: %s" % ', '.join(extra_options)) - def test_has_all_tor_config_options(self): """ Check that all the configuration options tor supports are in the man page. diff --git a/test/unit/manual.py b/test/unit/manual.py index 9cbd6ad..65957c8 100644 --- a/test/unit/manual.py +++ b/test/unit/manual.py @@ -105,6 +105,25 @@ EXPECTED_CONFIG_OPTIONS['MaxAdvertisedBandwidth'] = stem.manual.ConfigOption(
class TestManual(unittest.TestCase): + def test_has_all_summaries(self): + """ + Check that we have brief, human readable summaries for all of tor's + configuration options. If you add a new config entry then please take a sec + to write a little summary. They're located in 'stem/settings.cfg'. + """ + + manual = stem.manual.Manual.from_cache() + present = set(manual.config_options.keys()) + expected = set([key[15:] for key in stem.manual._config(lowercase = False) if key.startswith('manual.summary.')]) + + missing_options = present.difference(expected) + extra_options = expected.difference(present) + + if missing_options: + self.fail("Ran cache_manual.py? Please update Stem's settings.cfg with summaries of the following config options: %s" % ', '.join(missing_options)) + elif extra_options: + self.fail("Ran cache_manual.py? Please remove the following summaries from Stem's settings.cfg: %s" % ', '.join(extra_options)) + def test_is_important(self): self.assertTrue(stem.manual.is_important('ExitPolicy')) self.assertTrue(stem.manual.is_important('exitpolicy'))