Skip to content

Latest commit

 

History

History
160 lines (110 loc) · 4.43 KB

CONTRIBUTING.md

File metadata and controls

160 lines (110 loc) · 4.43 KB
Raw

Contributing

Development Workflow

This project uses the most basic development workflow possible:

  • Identify a problem
  • Add a failing test or any other way to reproduce it
  • Fix it
  • Make sure all tests pass
  • Submit a pull request on GitHub explaining why the change it necessary and how to reproduce it
  • Wait for maintainer's feedback

That's about it.

Running Tests

Building Dependencies

Carthage bootstrap will clone and build the dependencies:

gmake bootstrap

Run a RabbitMQ Node in Docker

It is possible to run a preconfigured node, including a TLS setup, in Docker:

docker-compose build
docker-compose up

This will publish (forward) local ports 5672, 5671, 15672 to the container, so if there are any local RabbitMQ nodes running they must be stopped first to avoid port conflicts.

Run a Local RabbitMQ Node

There are two sets of tests that can be executed, each with its own XCode scheme:

  • Unit and integration tests (core tests) use the RMQClient scheme and can be executed against a RabbitMQ node with stock defaults (assuming that certain setup targets are executed, see below)
  • TLS tests use the RMQClient with TLS tests scheme and requires a RabbitMQ node configured in a particular way

The RabbitMQ node can be installed from Homebrew or by downloading and extracting a generic binary build.

Node Configuration for TLS Tests

To configure a node to run the TLS tests, configure the node to use the certificates and keys under TestCertificates. The certificates have a Subject Alternative Name of localhost which makes them not to be dependent on the host they were generated on.

The test suite also requires the x509 certificate authentication mechanism plugin to be enabled:

brew install rabbitmq
# target location will vary depending on how RabbitMQ was installed,
# the Homebrew Cellar location and so on
cp TestCertificates/* /usr/local/etc/rabbitmq/
rabbitmq-plugins enable rabbitmq_auth_mechanism_ssl --offline

Then restart RabbitMQ.

The following RabbitMQ configuration file is used by CI and can be used as example:

listeners.tcp.1 = 0.0.0.0:5672

listeners.ssl.default = 5671

# the paths must match those
ssl_options.cacertfile = /usr/local/etc/rabbitmq/ca_certificate.pem
ssl_options.certfile   = /usr/local/etc/rabbitmq/server_certificate.pem
ssl_options.keyfile    = /usr/local/etc/rabbitmq/server_key.pem
ssl_options.verify     = verify_peer
ssl_options.fail_if_no_peer_cert = false


auth_mechanisms.1 = PLAIN
auth_mechanisms.2 = AMQPLAIN
auth_mechanisms.3 = EXTERNAL

In case a different set of certificates is desired, it is highly recommended using tls-gen's basic profile.

Node Preconfiguration

To seed the node (pre-create certain virtual hosts, users, permissions):

# use RABBITMQCTL="/path/to/rabbitmqctl"
# Make variables to override RabbitMQ CLI tools to use
gmake set_up_test_vhosts RABBITMQCTL="/path/to/rabbitmqctl"
gmake set_up_test_users  RABBITMQCTL="/path/to/rabbitmqctl"

# This will set up the management plugin and configured it to use a short (1s) stats refresh interval.
#
# use RABBITMQCTL="/path/to/rabbitmqctl" and RABBITMQ_PLUGINS="/path/to/rabbitmq-plugins"
# Make variables to override RabbitMQ CLI tools to use
gmake before_build RABBITMQCTL="/path/to/rabbitmqctl" RABBITMQ_PLUGINS="/path/to/rabbitmq-plugins"

Test Targets

To run the core test suite:

# runs all tests with iOS and MacOS destinations
gmake tests

# iOS only
gmake tests_ios iOS_VERSION=14.4

# MacOS only
gmake tests_macos

or run the tests using the RMQClient scheme from XCode.

To run the TLS test suite:

# see the
gmake tests_with_tls

or run the tests using the RMQClient with TLS tests scheme in XCode.

Linting with SwiftLint

The test suite uses SwiftLint as a build phase. It must be installed in order for XCode to use it:

brew install swiftlint

In order to lint from the command line, use

swiftlint

The lint configuration can be found at .swiftlint.yml.