summaryrefslogtreecommitdiff
path: root/doc/book/src/PythonBrokerTest.xml
blob: 06c62167c6896547025d932382e1fd473ca31f27 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<?xml version="1.0" encoding="utf-8"?>
<chapter xmlns:html="http://www.w3.org/1999/xhtml">
  <title>
    Apache Qpid : PythonBrokerTest
  </title>
  <section role="h2" id="PythonBrokerTest-PythonBrokerSystemTestSuite">
    <title>
      Python Broker System Test Suite
    </title>
    <para>
      This is a suite of python client tests that exercise and verify
      broker functionality. Python allows us to rapidly develop client
      test scenarios and provides a 'neutral' set of tests that can run
      against any AMQP-compliant broker.
    </para>
    <para>
      The python/tests directory contains a collection of python
      modules, each containing several unittest classes, each
      containing a set of test methods that represent some test
      scenario. Test classes inherit qpid.TestBas from
      qpid/testlib.py, it inherits unittest.TestCase
      but adds some qpid-specific setUp/tearDown and
      convenience functions.
    </para>
    <para>
      TODO: get pydoc generated up to qpid wiki or website
      automatically?
    </para>
    <section role="h3" id="PythonBrokerTest-Runningthetests">
      <title>
	Running the tests
      </title>
      <para>
	Simplest way to run the tests:
      </para>
      <itemizedlist>
	<listitem>
	  <para>Run a broker on the default port
	  </para>
	</listitem>
	<listitem>
	  <para>
	    ./run_tests
	  </para>
	</listitem>
      </itemizedlist>
      <para>
	For additional options: ./run_tests --help
      </para>
      <!--h3-->
    </section>

    <section role="h3" id="PythonBrokerTest-Expectedfailures">
      <title>
	Expected failures
      </title>
      <para>
	Until we complete functionality, tests may fail because the
	tested functionality is missing in the broker. To skip
	expected failures in the C++ or Java brokers:
      </para>
      <programlisting>
./run_tests -I cpp_failing.txt
./run_tests -I java_failing.txt
      </programlisting>
      <para>
	If you fix a failure, please remove it from the corresponding
	list.
      </para>

      <!--h3-->
    </section>

    <!--h2-->
  </section>

</chapter>