README.md

Butterfly

_{Created by DStack Group with ❤️.}

Butterfly is a set of microservices that communicate via Apache Kafka and REST APIs which aims to simplify how different project notifications are handled. This project has been developed by the DStack team during the Software Engineering course of the University of Padova.

---

Table of Contents

• Requirements
• References
• Test everything
• Run everything
• Dev Scripts
• Exposed services
• Modules
• Wiki Links
• Create Issues
• FAQ
• Team
• License

Requirements

Here's a list of tools you should have installed on your PC:

• docker 18.09.*
• docker-compose 1.24.*

References

Here you can find the project requirements and details.

Test everything

./run.sh --build test

Run everything

./run.sh prod

Dev Scripts

Usage:
./run.sh [OPTIONS] COMMAND

A single entry point for building, running, stopping and testing Butterfly.

Options:
  -b|--build            If specified, it creates the Java services' jar executables.
  -h|--help             Show this help.

Commands:
  install               Install Java services' and User Manager' dependencies.
  prod                  Executes the services in production mode.
  dev                   Executes the services in development mode and spins up
                        utility services too. The utility services are:
                        - pgadmin [localhost:8080];
                        - openapi [localhost:8082].
  prune                 Deletes all the docker virtual networks, volumes and stops
                        the services if they're currently running.
  stop                  Stops the services if they're running.
  ps                    Shows the list of services running.
  logs                  Fetches the logs for a service.
  test                  Executes the test battery.
  sonarcloud            Collects code metrics and uploads them on SonarCloud.

Exposed services

Service	Port	Root Endpoint
gitlab-producer	3000	/webhooks/gitlab
redmine-producer	4000	/webhooks/redmine
sonarqube-producer	6000	/webhooks/sonarqube
user-manager-rest-api	5000	/
slack-account-configurator	5200	/slack/events
pgadmin	8080	/
openapi	8082	/

Modules

• gitlab-producer
• redmine-producer
• sonarqube-producer
• middleware-dispatcher
• email-consumer
• telegram-consumer
• slack-consumer
• slack-account-configurator
• user-manager-rest-api
• user-manager-database
• buttercli

Wiki Links

Here are some in-depth documentation about Butterfly's internals (written in Italian):

• Message Structures
• User Manager

Create Issues

This repository supports 3 types of issues:

• Bug report: Create a report to help us improve and correct a bug in the code;
• Documentation error report: Create a report to help us improve and correct an error in documents;
• Feature request: Suggest an idea for this project.

FAQ

1. Q How to solve the error "driver failed programming external connectivity on endpoint"?

Example error

ERROR: for zookeeper Cannot start service zookeeper: driver failed programming external connectivity on endpoint zookeeper (c6225dbb06a1d8b2109f5156bd145e2e61d49278e1a3216d44a515f60f1a7b70): Error starting userland proxy: mkdir /port/tcp:0.0.0.0:2181:tcp:172.31.0.2:2181: input/output error

ERROR: for zookeeper Cannot start service zookeeper: driver failed programming external connectivity on endpoint zookeeper (c6225dbb06a1d8b2109f5156bd145e2e61d49278e1a3216d44a515f60f1a7b70): Error starting userland proxy: mkdir /port/tcp:0.0.0.0:2181:tcp:172.31.0.2:2181: input/output error ERROR: Encountered errors while bringing up the project.

• A: just restart Docker, it's a known issue, especially on Windows

Team

DStack is:

• Alberto Schiabel
• Elton Stafa
• Eleonora Signor
• Enrico Trinco
• Federico Rispo
• Harwinder Singh
• Niccolò Vettorello

License

This project is MIT licensed.