Skip to content

Commit 0047a4d

Browse files
committed
Document how to run tests in readme
With Docker.
1 parent bd2bcfd commit 0047a4d

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ repositories {
128128

129129
This project is managed by Maven, so use
130130

131-
./mvnw clean install -Dmaven.test.skip=true -P '!setup-test-node'
131+
./mvnw clean install -Dmaven.test.skip=true
132132

133133
to build it from source and install into the local repository.
134134

@@ -143,25 +143,25 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for an overview of the development proc
143143

144144
### Integration Tests
145145

146-
The integration tests assume a RabbitMQ node
147-
with [rabbitmq-jms-topic-exchange](https://github.com/rabbitmq/rabbitmq-server/tree/master/deps/rabbitmq_jms_topic_exchange/)
148-
listening on localhost:5672 (the default settings).
146+
#### Running Integration Tests with Docker
149147

150-
Connection recovery tests need `rabbitmqctl` to control the running node.
148+
Launch the broker:
151149

152-
Maven will start this node with the appropriate configuration by default when
153-
launching the `verify` command:
150+
docker run -it --rm --name rabbitmq -p 5672:5672 rabbitmq
154151

155-
./mvnw clean verify
152+
Enable the JMS Topic Exchange plugin:
156153

157-
You can also provide your own broker node. To disable the
158-
automatic test node setup, disable the `setup-test-node` Maven
159-
profile:
154+
docker exec rabbitmq rabbitmq-plugins enable rabbitmq_jms_topic_exchange
160155

161-
./mvn clean verify -P '!setup-test-node'
156+
Launch the tests:
162157

163-
The easiest way to run a test node is to clone
164-
[rabbitmq-jms-topic-exchange](https://github.com/rabbitmq/rabbitmq-server/tree/master/deps/rabbitmq_jms_topic_exchange) and use `make run-broker`.
158+
./mvnw verify -Drabbitmqctl.bin=DOCKER:rabbitmq
159+
160+
#### Running Integration Tests with a Local Broker
161+
162+
To launch the test suite (requires a local RabbitMQ node with JMS Topic Exchange plugin enabled):
163+
164+
./mvnw verify -Drabbitmqctl.bin=/path/to/rabbitmqctl
165165

166166
### JMS 1.1 Compliance Test Suite
167167

@@ -179,7 +179,7 @@ for the support timeline of this library.
179179

180180
## License and Copyright
181181

182-
(c) 2007-2021 VMware, Inc. or its affiliates.
182+
(c) 2007-2022 VMware, Inc. or its affiliates.
183183

184184
This package, the RabbitMQ JMS client library, is double-licensed
185185
under the Apache License version 2 ("ASL") and the Mozilla Public License

0 commit comments

Comments
 (0)