Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ivangfr/spring-cloud-stream-solace-pubsub
The goal of this project is to play with Solace PubSub+. For it, we will implement a producer and consumer of different types of news about many countries and cities.
https://github.com/ivangfr/spring-cloud-stream-solace-pubsub
docker java jib solace-pubsub spring-boot spring-cloud-stream webflux
Last synced: 9 days ago
JSON representation
The goal of this project is to play with Solace PubSub+. For it, we will implement a producer and consumer of different types of news about many countries and cities.
- Host: GitHub
- URL: https://github.com/ivangfr/spring-cloud-stream-solace-pubsub
- Owner: ivangfr
- Created: 2021-09-08T12:35:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-17T10:38:46.000Z (3 months ago)
- Last Synced: 2024-08-17T11:40:49.701Z (3 months ago)
- Topics: docker, java, jib, solace-pubsub, spring-boot, spring-cloud-stream, webflux
- Language: Java
- Homepage:
- Size: 240 KB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# spring-cloud-stream-solace-pubsub
The goal of this project is to play with [`Solace PubSub+`](https://www.solace.dev/). For it, we will implement a producer and consumer of different types of `news` about many countries and cities.
## Proof-of-Concepts & Articles
On [ivangfr.github.io](https://ivangfr.github.io), I have compiled my Proof-of-Concepts (PoCs) and articles. You can easily search for the technology you are interested in by using the filter. Who knows, perhaps I have already implemented a PoC or written an article about what you are looking for.
## Additional Readings
- \[**Medium**\] [**Solace PubSub+ and Spring Boot: Implementing News Producer and Consumer Apps**](https://medium.com/@ivangfr/solace-pubsub-and-spring-boot-implementing-news-producer-and-consumer-apps-1f80cb3fed43)
- \[**Medium**\] [**Solace PubSub+ and Spring Boot: Implementing Unit Tests for News Producer and Consumer Apps**](https://medium.com/@ivangfr/solace-pubsub-and-spring-boot-implementing-unit-tests-for-news-producer-and-consumer-apps-6c1b8257f7a0)
- \[**Medium**\] [**Solace PubSub+ and Spring Boot: Implementing End-to-End Tests for News Producer and Consumer Apps**](https://medium.com/@ivangfr/solace-pubsub-and-spring-boot-implementing-end-to-end-tests-for-news-producer-and-consumer-apps-353e5b3843f4)
- \[**Medium**\] [**Solace PubSub+ and Spring Boot: Running News Producer and Consumer Apps in Minikube (Kubernetes)**](https://medium.com/@ivangfr/solace-pubsub-and-spring-boot-running-news-producer-and-consumer-apps-in-minikube-kubernetes-b9fb167a5bbc)
## Applications
- ### producer-service
[`Spring Boot`](https://docs.spring.io/spring-boot/index.html) application that exposes a REST API to submit `news` events. It published news to the following destination with format: `ps/news/{type}/{country}/{city}`
Endpoints
```
POST /api/news {"type": [SPORT|ECONOMY|HEALTH], "country": "...", "city": "...", "title": "..."}
POST /api/news/random {"number": ..., "delay": ...}
```
- ### consumer-service
`Spring Boot` application that consumes the `news` events published by `producer-service`.
## Prerequisites
- [`Java 21+`](https://www.oracle.com/java/technologies/downloads/#java21)
- [`Docker`](https://www.docker.com/)
## Start Environment
- Open a terminal and inside `spring-cloud-stream-solace-pubsub` root folder run:
```
docker compose up -d
```
- Wait for `solace` Docker container to be up and running. To check it, run:
```
docker compose ps
```
## Running Applications with Maven
- **producer-service**
- In a terminal, make sure you are in `spring-cloud-stream-solace-pubsub` root folder;
- Run the commands below to start the application:
```
./mvnw clean spring-boot:run --projects producer-service
```
- **consumer-service-1**
- It subscribes to all news from `Brazil`;
- Open a new terminal and navigate to `spring-cloud-stream-solace-pubsub` root folder;
- Run the commands below to start the application:
```
export NEWS_SUBSCRIPTION="ps/news/*/BR/>"
./mvnw clean spring-boot:run --projects consumer-service
```
- **consumer-service-2**
- It subscribes to all news related to `HEALTH`;
- Open a new terminal and navigate to `spring-cloud-stream-solace-pubsub` root folder;
- Run the commands below to start the application:
```
export SERVER_PORT=9082
export NEWS_SUBSCRIPTION="ps/news/HEALTH/>"
./mvnw spring-boot:run --projects consumer-service
```
## Running Applications as Docker containers
- ### Build Docker Images
- In a terminal, make sure you are inside `spring-cloud-stream-solace-pubsub` root folder;
- Run the following script to build the Docker images:
- JVM
```
./docker-build.sh
```
- Native (it's not implemented yet)
```
./docker-build.sh native
```
- ### Environment Variables
- **producer-service**
| Environment Variable | Description |
|----------------------|----------------------------------------------------------------------------------|
| `SOLACE_HOST` | Specify host of the `Solace PubSub+` message broker to use (default `localhost`) |
| `SOLACE_PORT` | Specify port of the `Solace PubSub+` message broker to use (default `55556`) |
- **consumer-service**
| Environment Variable | Description |
|----------------------|----------------------------------------------------------------------------------|
| `SOLACE_HOST` | Specify host of the `Solace PubSub+` message broker to use (default `localhost`) |
| `SOLACE_PORT` | Specify port of the `Solace PubSub+` message broker to use (default `55556`) |
- ### Run Docker Containers
- **producer-service**
Run the following command in a terminal:
```
docker run --rm --name producer-service \
-p 9080:9080 \
-e SOLACE_HOST=solace -e SOLACE_PORT=55555 \
--network=spring-cloud-stream-solace-pubsub_default \
ivanfranchin/producer-service:1.0.0
```
- **consumer-service-1**
- It subscribes to all news from `Brazil`;
- Open a new terminal and run the following command:
```
docker run --rm --name consumer-service-1 \
-p 9081:9081 \
-e SOLACE_HOST=solace -e SOLACE_PORT=55555 \
-e NEWS_SUBSCRIPTION="ps/news/*/BR/>" \
--network=spring-cloud-stream-solace-pubsub_default \
ivanfranchin/consumer-service:1.0.0
```
- **consumer-service-2**
- It subscribes to all news related to `HEALTH`;
- Open a new terminal and run the following command:
```
docker run --rm --name consumer-service-2 \
-p 9082:9081 \
-e SOLACE_HOST=solace -e SOLACE_PORT=55555 \
-e NEWS_SUBSCRIPTION="ps/news/HEALTH/>" \
--network=spring-cloud-stream-solace-pubsub_default \
ivanfranchin/consumer-service:1.0.0
```
## Playing around
In a terminal, submit the following POST requests to `producer-service` and check its logs and `consumer-service` logs.
> **Note**: [HTTPie](https://httpie.io/) is being used in the calls bellow
- Sending `news` one by one
- Just `consumer-service-1` should consume
```
http :9080/api/news type="SPORT" country="BR" city="SaoPaulo" title="..."
```
- Just `consumer-service-2` should consume
```
http :9080/api/news type="HEALTH" country="PT" city="Porto" title="..."
```
- Both `consumer-service-1` and `consumer-service-2` should NOT consume
```
http :9080/api/news type="ECONOMY" country="DE" city="Berlin" title="..."
```
- Both `consumer-service-1` and `consumer-service-2` should consume
```
http :9080/api/news type="HEALTH" country="BR" city="Brasilia" title="..."
```
- Sending a number of `news` randomly with a specified delay in seconds
```
http :9080/api/news/random number=10 delayInMillis=1000 --stream
```
## Useful Links
- **Solace**
`Solace` can be accessed at http://localhost:8080 and enter `admin` to both username and password
## Shutdown
- To stop applications, go to the terminals where they are running and press `Ctrl+C`;
- To stop and remove docker-compose containers, network and volumes, go to a terminal and, inside `spring-cloud-stream-solace-pubsub` root folder, run the following command:
```
docker compose down -v
```
## Running Test Cases
In a terminal, make sure you are inside `spring-cloud-stream-solace-pubsub` root folder
- **producer-service**
```
./mvnw clean test --projects producer-service
```
- **consumer-service**
```
./mvnw clean test --projects consumer-service
```
## Cleanup
To remove the Docker images created by this project, go to a terminal and, inside `spring-cloud-stream-solace-pubsub` root folder, run the following script:
```
./remove-docker-images.sh
```
## References
- https://tutorials.solace.dev/spring/spring-cloud-stream/
## Issues
The default `Solace` SMF port `55555` is not working, at least in my Mac machine. The problem is explained in [this issue](https://github.com/SolaceLabs/solace-single-docker-compose/issues/10). For now, I've changed the mapping port from `55555` to `55556`.