![example workflow](https://github.com/net-amqp-rabbitmq/net-amqp-rabbitmq/actions/workflows/linux-builds.yml/badge.svg)
[![Coverage Status](https://coveralls.io/repos/net-amqp-rabbitmq/net-amqp-rabbitmq/badge.png)](https://coveralls.io/r/net-amqp-rabbitmq/net-amqp-rabbitmq)

# NOTICE

This module has been in a pretty rough state of repair for a few years. I've been slowly cleaning it up and working on it as time allows.
With version `2.40011`, I feel like we may be in pretty good shape. OpenSSL v3 is supported now, and `rabbitmq-c` is updated to `v0.14.0`.

> [!IMPORTANT]
> I could really use a hand with peer review on some of this cleanup. If you, or someone you know, is excited about security and is competent to review C code, [please see this GitHub Discussion](https://github.com/net-amqp-rabbitmq/net-amqp-rabbitmq/discussions/247#discussion-6849541). Thank you.

# Install

` cpanm Net::AMQP::RabbitMQ`

or

`cpan Net::AMQP::RabbitMQ`

# Documentation

<https://metacpan.org/pod/Net::AMQP::RabbitMQ>

or once installed `perldoc Net::AMQP::RabbitMQ`

# Tests

There are several environment variables you can set that influence the tests.

<https://metacpan.org/pod/Net::AMQP::RabbitMQ#RUNNING-THE-TEST-SUITE>

# For developers/authors

Once you have cloned the repo, you will need to download the submodules.

```sh
git submodule init
git submodule update
```

This module uses [Carton](https://metacpan.org/pod/Carton) for Perl dependencies. Please first install Carton, and then install Perl dependencies using:

```sh
carton install
```

When running your own tests, for quick access to a testing RabbitMQ service, consider [CloudAMQP](https://cloudamqp.com).

There are a few convenience scripts to help you out:

- `local-tests-no-ssl` - Convenience script to run tests on a local network without SSL at all.
- `run-one-test` - This script helps you quickly run a single test while working on this project.
- `ci/run-ci-tests.sh` - This script is what we run in GitHub Actions, it'll help you run the full suite. This script will likely only run on GNU/Linux, and depending on your RabbitMQ server's capacity it could take in excess of two hours to run completely.

# To build a release

```sh
make distclean
perl Makefile.PL
make manifest
make dist
```

## Known challenges

- In order to run test `024_boolean_header_fields.t`, you need to have the web client for RabbitMQ enabled, and your test user must have access to it. This is because this test uses the web client to test specific use cases which require a literal Boolean type (which Perl lacks).

# Special note for macOS

You need `pkg-config` working, especially for openssl. There are so many different
ways to install dependencies, and so many different paths for them, it is becoming
very difficult to guess where they will be.

As a result, we're shifting to using `pkg-config` for this. Please make sure
that if you're running into any problems of missing symbols or misplaced files,
that you check this _first_.

# OpenSSL Compatibility

To date, OpenSSL v3 is supported.