Skip to content

Commit dee01c9

Browse files
author
Emile Joubert
committed
Update test readme
1 parent 2c26a56 commit dee01c9

File tree

1 file changed

+45
-25
lines changed

1 file changed

+45
-25
lines changed

README-TESTS

Lines changed: 45 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,42 +12,26 @@ The suites are:
1212
Server tests
1313
SSL tests
1414

15-
All the tests require a conforming server listening on localhost:5672
16-
(the default settings). For details on running specific tests, see
17-
below.
15+
The Server test suite cannot be launched from the public umbrella
16+
( http://hg.rabbitmq.com/rabbitmq-public-umbrella ). Attempting to launch
17+
this suite by executing the "test-server" ant target will fail, because
18+
test necessary prerequisites are not present in the public umbrella.
1819

19-
All the test suites can be run with the command ant test-suite. To run
20-
specific test suites see the instructions below.
20+
All other tests require a conforming server listening on localhost:5672
21+
(the default settings). SSL tests require a broker listening on the default
22+
SSL port. For details on running specific tests, see below.
2123

2224

2325
Running a Specific Test Suite
2426
=============================
2527

26-
To run a specific test suite, but not the others, you should execute
27-
one of the following in the top-level directory of the source tree:
28+
To run a specific test suite you should execute one of the following in the
29+
top-level directory of the source tree:
2830

2931
ant test-client
3032
ant test-functional
31-
ant test-server
3233
ant test-ssl
3334

34-
Note that to run the SSL tests, the RabbitMQ server should be
35-
configured to use SSL as per the SSL with RabbitMQ guide. The
36-
SSL_CERTS_DIR environment variable must point to a certificate
37-
folder containing a /client/ subfolder with a client certificate
38-
and the PASSWORD variable must point to the key password. The
39-
broker must be configured to validate client certificates.
40-
41-
The server and functional tests are meant to test a RabbitMQ broker.
42-
Broadly, they require a running RabbitMQ broker on the default
43-
host/port, the source code for rabbitmq-server in ../rabbitmq-server,
44-
and a test directory ../rabbitmq-test. These folders must each
45-
contain an appropriate Makefile. The test source can be scanned for
46-
instances of "Host.executeCommand" to find required Makefile targets.
47-
48-
Clustering tests require brokers on ports 5672 and 5673. Tests that
49-
require a clustered environment will be skipped if the second broker
50-
is absent.
5135

5236
For example, to run the client tests:
5337

@@ -76,3 +60,39 @@ BUILD SUCCESSFUL
7660

7761
If any tests are broken details can be found by viewing this file:
7862
build/TEST-com.rabbitmq.client.test.ClientTests.txt
63+
64+
65+
SSL Test Setup
66+
--------------
67+
68+
To run the SSL tests, the RabbitMQ server and Java client should be configured
69+
as per the SSL instructions on the RabbitMQ website. The SSL_CERTS_DIR
70+
environment variable must point to a certificate folder with the following
71+
minimal structure:
72+
73+
$SSL_CERTS_DIR
74+
|-- client
75+
| |-- keycert.p12
76+
| |-- cert.pem
77+
| \-- key.pem
78+
|-- server
79+
| |-- cert.pem
80+
| \-- key.pem
81+
\-- testca
82+
\-- cacert.pem
83+
84+
The PASSWORD environment variable must be set to the password of the keycert.p12
85+
PKCS12 keystore. The broker must be configured to validate client certificates.
86+
This will become minimal broker configuration file if $SSL_CERTS_DIR is replaced
87+
with the certificate folder:
88+
89+
%%%%% begin sample test broker configuration
90+
[{rabbit, [{ssl_listeners, [5671]},
91+
{ssl_options, [{cacertfile,"$SSL_CERTS_DIR/testca/cacert.pem"},
92+
{certfile,"$SSL_CERTS_DIR/server/cert.pem"},
93+
{keyfile,"$SSL_CERTS_DIR/server/key.pem"},
94+
{verify,verify_peer},
95+
{fail_if_no_peer_cert, false}]}]}].
96+
%%%%% end sample test broker configuration
97+
98+

0 commit comments

Comments
 (0)