Skip to content

Commit 5f1a4de

Browse files
It's now possible to use CLI tools from a binary release
1 parent 26a5b43 commit 5f1a4de

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ Here's the recommended workflow:
7676
If what you are going to work on is a substantial change, please first
7777
ask the core team for their opinion on the [RabbitMQ users mailing list][rmq-users].
7878

79+
### Running Tests
80+
81+
See [RUNNING_TESTS.md](/RUNNING_TESTS.md).
82+
7983
## Code of Conduct
8084

8185
See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).

RUNNING_TESTS.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ build.sh
3030
This will complete the code AMQP 0-9-1 protocol code generation and build all projects. After this open the solution in Visual Studio.
3131

3232

33-
## Running Tests
33+
## Test Environment Requirements
3434

3535
Tests can be run from Visual Studio using the NUnit Test Adapter. Note that it
3636
may take some time for the adapter to discover tests in the assemblies.
@@ -40,9 +40,17 @@ defaults, and the tests will need to be able to run commands against the
4040
[`rabbitmqctl`](https://www.rabbitmq.com/rabbitmqctl.8.html) tool for that node.
4141
Two options to accomplish this are covered below.
4242

43-
### Using RabbitMQ Umbrella Repository
43+
### Option One: Using a RabbitMQ Release
4444

45-
1. Team RabbitMQ uses [rabbitmq-public-umbrella](https://github.com/rabbitmq/rabbitmq-public-umbrella), which sets up a local RabbitMQ server [built from source](https://www.rabbitmq.com/build-server.html):
45+
It is possible to install and run a node using any [binary build](https://www.rabbitmq.com/download.html) suitable
46+
for the platform. Its [CLI tools]() then must be added to `PATH` so that `rabbitmqctl` (`rabbitmqctl.bat` on Windows)
47+
can be invoked directly without using an absolute file path.
48+
49+
50+
### Option Two: Using RabbitMQ Umbrella Repository
51+
52+
Team RabbitMQ uses [rabbitmq-public-umbrella](https://github.com/rabbitmq/rabbitmq-public-umbrella),
53+
which makes it easy to run a RabbitMQ node [built from source](https://www.rabbitmq.com/build-server.html):
4654

4755
```
4856
git clone https://github.com/rabbitmq/rabbitmq-public-umbrella umbrella
@@ -60,15 +68,15 @@ It is possible to override the location using `RABBITMQ_RABBITMQCTL_PATH`:
6068
RABBITMQ_RABBITMQCTL_PATH=/path/to/rabbitmqctl dotnet test projects/Unit
6169
```
6270

63-
### Using a Docker Container
71+
### Option Three: Using a Docker Container
6472

6573
It is also possible to run a RabbitMQ node in a [Docker](https://www.docker.com/) container. Set the environment variable `RABBITMQ_RABBITMQCTL_PATH` to `DOCKER:<container_name>` (for example `DOCKER:rabbitmq01`). This tells the unit tests to run the `rabbitmqctl` commands through Docker, in the format `docker exec rabbitmq01 rabbitmqctl <args>`:
6674

6775
``` shell
6876
docker run -d --hostname rabbitmq01 --name rabbitmq01 -p 15672:15672 -p 5672:5672 rabbitmq:3-management
6977
```
7078

71-
### Running All Tests
79+
## Running All Tests
7280

7381
Then, to run the tests use:
7482

@@ -82,7 +90,7 @@ On MacOS, Linux, BSD use:
8290
run-test.sh
8391
```
8492

85-
### Running Individual Suites or Test Casess
93+
## Running Individual Suites or Test Casess
8694

8795
Running individual tests and fixtures on Windows is trivial using the Visual Studio test runner.
8896
To run a specific tests fixture on MacOS or Linux, use the NUnit filter expressions to select the tests to be run:

0 commit comments

Comments
 (0)