Permalink
Browse files

Add some man pages to document tests

  • Loading branch information...
1 parent c4e1224 commit bdde7266fa79a78419b6abaedcec8f1ad67dd0d7 @rescrv rescrv committed Mar 13, 2012
Showing with 145 additions and 1 deletion.
  1. +5 −1 doc/conf.py
  2. +64 −0 doc/man/hyperdex-replication-stress-test.rst
  3. +76 −0 doc/man/hyperdex-simple-consistency-stress-test.rst
View
@@ -214,7 +214,11 @@
# (source start file, name, description, authors, manual section).
man_pages = [
(u'man/hyperdex-daemon', u'hyperdex-daemon',
- u'HyperDex Daemon', [u'Robert Escriva'], 1)
+ u'HyperDex Daemon', [u'Robert Escriva'], 1),
+ (u'man/hyperdex-replication-stress-test', u'hyperdex-replication-stress-test',
+ u'HyperDex Replication Stress Test', [u'Robert Escriva'], 1),
+ (u'man/hyperdex-simple-consistency-stress-test', u'hyperdex-simple-consistency-stress-test',
+ u'HyperDex Simple Consistency Stress Test', [u'Robert Escriva'], 1)
]
# If true, show URL addresses after external links.
@@ -0,0 +1,64 @@
+:orphan:
+
+hyperdex-replication-stress-test manual page
+============================================
+
+Synopsis
+--------
+
+**hyperdex-replication-stress-test** [*options*]
+
+
+Description
+-----------
+
+:program:`hyperdex-replication-stress-test` puts the replication code through
+its paces. There are certain potential race conditions that this code is
+designed to expose. To execute the test, create a space with the following
+description::
+
+ space replication
+ dimensions A, B, C
+ key A auto 4 2
+ subspace B auto 4 2
+ subspace C auto 4 2
+
+The code will execute a number of operations in quick succession in a manner
+that bounces objects around the subspaces for ``B`` and ``C``. This test
+relies upon every host in the cluster being deployed with a single network
+thread (``--threads=1``).
+
+
+Options
+-------
+
+.. option:: -\?, --help
+
+ Show a help message.
+
+.. option:: -P, --prefix=number
+
+ The power of two used to indicate the size of the space.
+
+.. option:: -s, --space=space
+
+ The name of the space to operate on. By default "replication" is used.
+
+.. option:: -h, --host=IP
+
+ IP address to use when connecting to the coordinator
+
+.. option:: -p, --port=P
+
+ Port to use when connecting to the coordinator
+
+
+See also
+--------
+
+* :manpage:`hyperdex-binary-test(1)`
+* :manpage:`hyperdex-coordinator(1)`
+* :manpage:`hyperdex-coordinator-control(1)`
+* :manpage:`hyperdex-daemon(1)`
+* :manpage:`hyperdex-replication-stress-test(1)`
+* :manpage:`hyperdex-simple-consistency-stress-test(1)`
@@ -0,0 +1,76 @@
+:orphan:
+
+hyperdex-simple-consistency-stress-test manual page
+===================================================
+
+Synopsis
+--------
+
+**hyperdex-simple-consistency-stress-test** [*options*]
+
+
+Description
+-----------
+
+:program:`hyperdex-simple-consistency-stress-test` puts the fault tolerance code
+its paces. This code is designed to operate on the following space::
+
+ space consistency
+ dimensions n, repetition
+ key n auto 0 2
+
+The stress tester spawns a single writer thread which writes to keys in the
+range [0, window-size) in order with strictly increasing values for
+``repetition``. Multiple reader threads read in reverse order, looking out for
+a case in which the ``repetition`` value of successive keys goes backwards.
+
+It is expected that failures will be manually generated while running this test.
+Failures should be everything from forced process kills to unplugged ethernet
+cables.
+
+
+Options
+-------
+
+.. option:: -\?, --help
+
+ Show a help message.
+
+.. option:: -w, --window-size=keys
+
+ The number of sequential keys which will be used for the test. The smaller
+ this number, the more likely it is to trigger an error condition. Use the
+ largest value possible when hunting a bug.
+
+.. option:: -r, --repetitions=number
+
+ The number of repetitions to run before exiting. Each key in [0,
+ window-size) will be written this many times. A higher value runs for
+ longer.
+
+.. option:: -t, --threads=number
+
+ The number of reader threads which will check for inconsistencies.
+
+.. option:: -s, --space=space
+
+ The name of the space to operate on. By default "consistency" is used.
+
+.. option:: -h, --host=IP
+
+ IP address to use when connecting to the coordinator
+
+.. option:: -p, --port=P
+
+ Port to use when connecting to the coordinator
+
+
+See also
+--------
+
+* :manpage:`hyperdex-binary-test(1)`
+* :manpage:`hyperdex-coordinator(1)`
+* :manpage:`hyperdex-coordinator-control(1)`
+* :manpage:`hyperdex-daemon(1)`
+* :manpage:`hyperdex-replication-stress-test(1)`
+* :manpage:`hyperdex-simple-consistency-stress-test(1)`

0 comments on commit bdde726

Please sign in to comment.