Merge lp:~hrvojem/percona-xtradb-cluster/kewpietest into lp:~percona-dev/percona-xtradb-cluster/5.5.20

[Hrvoje Matijakovic]

[Vadim Tkachenko (vadim-tk)]

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2012-02-17 18:41:32 +0000
+++ .bzrignore	2012-02-20 17:18:00 +0000
@@ -103,6 +103,7 @@
 CTestTestfile.cmake
 COPYING
 COPYING.LIB
+doc/build/*
 Docs/#manual.texi#
 Docs/INSTALL-BINARY
 Docs/Images/myaccess-odbc.txt
@@ -156,7 +157,6 @@
 INSTALL-WIN-SOURCE
 Logs/*
 MIRRORS
-Makefile
 Makefile.in
 Makefile.in'
 PENDING/*

=== added file 'doc/Makefile'
--- doc/Makefile	1970-01-01 00:00:00 +0000
+++ doc/Makefile	2012-02-20 17:18:00 +0000
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PerconaXtraDBCluster.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PerconaXtraDBCluster.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/PerconaXtraDBCluster"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PerconaXtraDBCluster"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

=== modified file 'doc/source/faq.rst'
--- doc/source/faq.rst	2012-02-04 01:22:23 +0000
+++ doc/source/faq.rst	2012-02-20 17:18:00 +0000
@@ -14,6 +14,19 @@
 A: When the node crashes, after the restart it will copy whole dataset from another node
 (if there were changes to data since crash). 
 
+Q: How can I check the Galera node health?
+==========================================
+A:  Your check should be simply: 
+
+.. code-block:: mysql
+
+    SELECT * FROM someinnodbtable WHERE id=1;
+
+3 different results are possible:
+   * You get the row with id=1 (node is healthy)
+   * Unknown error (node is online but Galera is not connected/synced with the cluster)
+   * Connection error (node is not online)
+
 Q: Is there a chance to have different table structure on the nodes? 
 =====================================================================
 What I mean is like having 4 nodes, 4 tables like sessions_a, sessions_b, sessions_c and sessions_d and have each only on one of the nodes? 

=== modified file 'doc/source/index.rst'
--- doc/source/index.rst	2012-02-04 01:22:23 +0000
+++ doc/source/index.rst	2012-02-20 17:18:00 +0000
@@ -76,6 +76,7 @@
   
    singlebox
    3nodesec2
+   kewpietests
    bugreport
 
 Percona XtraDB Cluster limitations

=== added file 'doc/source/kewpietests.rst'
--- doc/source/kewpietests.rst	1970-01-01 00:00:00 +0000
+++ doc/source/kewpietests.rst	2012-02-20 17:18:00 +0000
@@ -0,0 +1,35 @@
+===========================
+How to Execute Kewpie Tests
+===========================
+
+To use kewpie for testing it's recommended to use `this MP <https://code.launchpad.net/~patrick-crews/percona-xtradb-cluster/qp-integrate/+merge/93648>`_. As it removes dbqp and integrates kewpie (and cuts size down to 25MB from 400+).
+To execute tests: 
+
+.. code-block:: bash
+
+   cd kewpie ; ./kewpie.py [--force ] [--libeatmydata] [--wsrep-provider-path=...]
+                  
+The defaults are to run the cluster_basic and cluster_randgen suites against a 3 node cluster. Cluster_basic is used for small atomic tests like ADD/DROP single/multiple columns on a table and ensuring the change is replicated. cluster_randgen is used for high stress transactional loads.  There are single and multi-threaded variants.  The load is a mix of INSERT/UPDATE/DELETE/SELECT statements.  This includes both regular transactions, single queries, ROLLBACK's and SAVEPOINTs, and a mix of good and bad SQL statements.
+               
+To view all options, one may look at "./kewpie.py --help".  Basic documentation is also available as sphinx docs in kewpie/docs folder. Here are the some of the most used options:
+
+.. option:: --force 
+
+   Run all tests despite failures (default is to stop test execution on first failure)
+
+.. option:: --libeatmydata 
+
+   Use libeatmydata if installed. This can greatly speed up testing in many cases.  Can be used in conjunction with:
+
+.. option:: --libeatmydata-path to specify where the library is located.
+
+.. option:: --wsrep-provider-path  
+   
+   By default, we expect / look for it in /usr/lib/galera/libgalera_smm.so (where it ends up via 'make install'...at least on Ubuntu).  If one has an alternate library/location, specify it with this option.
+
+Any additional suites may be run this way: 
+
+.. code-block:: bash
+
+   ./kewpie.py [options] --suite=any/suitedir/from/kewpie/percona_tests
+   ./kewpie.py --suite=crashme