Welcome to ARAS’s documentation!¶
You can visualize the build status here and the code quality here.
Synopsis¶
A lot of software analysis tools are available to monitor the various aspects of a system. One interesting facet is the design quality. A good design leads to evolvability, maintainability of the system, its availability, its security and cost reduction. When there is a lack of design, or the system is made up by poor design choices, the architecture of the system could be subjected to architectural anomalies: ARAS offers a service to run static analyses on software and inspect the retrieved results, to support developers and mainteiners during the quest for those anomalies. In particular, ARAS aim is to expose the existing software Arcan as a web service. Arcan, which is a static analysis tool, analyses compiled Java projects in order to detect architectural flaws, in particular the ones called Architectural Smells (AS). At the moment Arcan offers a desktop user interface and runs locally. ARAS will not extend Arcan domain features, but it will use it as a black-box.
Architecture overview¶
The following section gives a brief overview on the architecture.
The components which are already available are:
- analyses-configurator-service
- analyses-executor-service
- notifications-service
- projects-service
- reports-service
- config-server
- eureka-server
- gateway
Moreover, the infrastructure provides Apache Kafka (with Zookeeper) as message broker shared among services.
Analyses configurator service¶
The analyses-configurator-service is a SpringBoot-based microservice that relies on a MongoDB storage engine. It encapsulates the logic to manage analysis configurations. It also exposes a RESTful API and publishes/consumes notable events to/from Kafka.
Analyses executor service¶
The analyses-executor-service is a SpringBoot-based microservice that relies on a MongoDB storage engine. It encapsulates the logic to manage analysis scheduling and execution. Moreover, it also exposes a RESTful API and publishes/consumes notable events to/from Kafka.
Notifications service¶
The analyses-executor-service is a SpringBoot-based microservice that relies on a MongoDB storage engine. It encapsulates the logic to manage and send notifications. It also exposes a RESTful API and publishes and consumes notable events to/from Kafka.
Projects service¶
The analyses-configurator-service is a SpringBoot-based microservice that relies on a MongoDB storage engine. It encapsulates the logic to manage projects and their versions. It also exposes a RESTful API and publishes/consumes notable events to/from Kafka.
Reports service¶
The analyses-configurator-service is a SpringBoot-based microservice that relies on a MongoDB storage engine. It encapsulates the logic to manage reports. It also exposes a RESTful API and publishes/consumes notable events to/from Kafka.
Config server¶
The config-server is a SpringBoot-based application which acts as a configuration server. It holds configuration files for all the services.
Eureka server¶
The eureka-sever is a SpringBoot-based application which acts as a service registry enabling service discovery for the whole architecture.
Gateway¶
The gateway is a SpringBoot-based application which acts as an API Gateway. It is the entrypoint for the clients. It performs to downstream services. Hereafter, the gateway will exploit a User Account and Authentication (UAA) Server to perform authentication and authorization checks.
Development¶
The development environment is provided through Docker containers.
The docker-compose.yml file contains the common services definition between production and development.
The docker-compose.override.yml file holds the additional definitions for the development.
Subsequently, a docker-compose.prod.yml file will be added in order to provide
production configurations for a Docker swarm mode deploy.
How to run¶
Minimum requirements:
- Docker Engine 17.09.0+
- Docker Compose 1.8+
Since there are shared dependencies among services, it is strongly suggested (read it as you have to) start them in a specific sequence.
First, copy .env.example to .env and substitute the values accordingly to your needs.
Execute the following steps:
$ docker-compose build
$ docker-compose up -d config-server kafka
$ docker-compose up -d eureka-server
$ docker-compose up -d notifications-service analyses-configurator-service analyses-executor-service projects-service reports-service gateway