Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fridujo/rabbitmq-mock
Mock for RabbitMQ Java amqp-client
https://github.com/fridujo/rabbitmq-mock
amqp amqp-client hacktoberfest java mock rabbitmq rabbitmq-java testing
Last synced: 1 day ago
JSON representation
Mock for RabbitMQ Java amqp-client
- Host: GitHub
- URL: https://github.com/fridujo/rabbitmq-mock
- Owner: fridujo
- License: apache-2.0
- Created: 2018-05-07T12:26:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T06:17:10.000Z (7 months ago)
- Last Synced: 2024-04-16T18:20:47.050Z (7 months ago)
- Topics: amqp, amqp-client, hacktoberfest, java, mock, rabbitmq, rabbitmq-java, testing
- Language: Java
- Homepage:
- Size: 384 KB
- Stars: 173
- Watchers: 9
- Forks: 33
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# RabbitMQ-mock
[](https://github.com/fridujo/rabbitmq-mock/actions)
[](https://codecov.io/gh/fridujo/rabbitmq-mock/)
[](https://search.maven.org/artifact/com.github.fridujo/rabbitmq-mock)
[](https://jitpack.io/#fridujo/rabbitmq-mock)
[](https://opensource.org/licenses/Apache-2.0)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Ffridujo%2Frabbitmq-mock?ref=badge_shield)
Mock for RabbitMQ Java [amqp-client](https://github.com/rabbitmq/rabbitmq-java-client).
> Compatible with versions **4.0.0** to **5+** of [**com.rabbitmq:amqp-client**](https://github.com/rabbitmq/rabbitmq-java-client)
> Compatible with versions **3.6.3** to **4.0.0** with the [`com.github.fridujo.rabbitmq.mock.compatibility` package](src/main/java/com/github/fridujo/rabbitmq/mock/compatibility/MockConnectionFactoryFactory.java).
### Motivation
This project aims to emulate RabbitMQ behavior for test purposes, through `com.rabbitmq.client.ConnectionFactory` with [`MockConnectionFactory`](src/main/java/com/github/fridujo/rabbitmq/mock/MockConnectionFactory.java).
However today, you will have more robust results using a real RabbitMQ instance through the use of [Testcontainers](https://java.testcontainers.org/modules/rabbitmq/).
If Docker is not an acceptable option, you can still rely on **RabbitMQ-mock**.
## Example Use
Replace the use of `com.rabbitmq.client.ConnectionFactory` by [`MockConnectionFactory`](src/main/java/com/github/fridujo/rabbitmq/mock/MockConnectionFactory.java)
```java
ConnectionFactory factory = new MockConnectionFactory();
try (Connection conn = factory.newConnection()) {
try (Channel channel = conn.createChannel()) {
GetResponse response = channel.basicGet(queueName, autoAck);
byte[] body = response.getBody();
long deliveryTag = response.getEnvelope().getDeliveryTag();
// Do what you need with the body
channel.basicAck(deliveryTag, false);
}
}
```
More details in [integration-test](src/test/java/com/github/fridujo/rabbitmq/mock/IntegrationTest.java)
### With Spring
Change underlying RabbitMQ ConnectionFactory by [`MockConnectionFactory`](src/main/java/com/github/fridujo/rabbitmq/mock/MockConnectionFactory.java)
```java
@Configuration
@Import(AppConfiguration.class)
class TestConfiguration {
@Bean
ConnectionFactory connectionFactory() {
return new CachingConnectionFactory(new MockConnectionFactory());
}
}
```
More details in [integration-test](src/test/java/com/github/fridujo/rabbitmq/mock/spring/SpringIntegrationTest.java)
## Contribute
Any contribution is greatly appreciated. Please check out the [guide](CONTRIBUTING.md) for more details.
[](https://gitpod.io/#github.com/fridujo/rabbitmq-mock.git)
## Getting Started
### Maven
Add the following dependency to your **pom.xml**
```xml
com.github.fridujo
rabbitmq-mock
${rabbitmq-mock.version}
test
```
### Gradle
Add the following dependency to your **build.gradle**
```groovy
repositories {
mavenCentral()
}
// ...
dependencies {
// ...
testCompile('com.github.fridujo:rabbitmq-mock:$rabbitmqMockVersion')
// ...
}
```
### Building from Source
You need [JDK-17(https://adoptium.net/temurin/releases/?version=17&package=jdk) to build RabbitMQ-Mock. The project can be built with Maven using the following command.
```
./mvnw install
```
Tests are split in:
* **unit tests** covering features and borderline cases: `mvn test`
* **integration tests**, seatbelts for integration with Spring and Spring-Boot. These tests use the **maven-invoker-plugin** to launch the same project (in [src/it/spring_boot](src/it/spring_boot)) with different versions of the dependencies: `mvn integration-test`
* **mutation tests**, to help understand what is missing in test assertions: `mvn org.pitest:pitest-maven:mutationCoverage`
### Using the latest SNAPSHOT
The master of the project pushes SNAPSHOTs in Sonatype's repo.
To use the latest master build add Sonatype OSS snapshot repository, for Maven:
```
...
sonatype-oss-spanshots
https://oss.sonatype.org/content/repositories/snapshots
```
For Gradle:
```groovy
repositories {
// ...
maven {
url "https://oss.sonatype.org/content/repositories/snapshots"
}
}
```
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Ffridujo%2Frabbitmq-mock?ref=badge_large)