Skip to content

Latest commit

 

History

History
90 lines (69 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

90 lines (69 loc) · 3.56 KB
Raw

Contribution guidelines

Backend Architecture

The backend follows the Clean Architecture principles.

Structure

  • leaktopus/domain - Contains the domain use cases, interfaces (aka contracts), entities - the core of the business logic.
  • leaktopus/details - Contains the implementations of the domain's interfaces, routing, asynchoronous tasks, and the database models.
  • leaktopus/services - A glue between the domain and the details. Contains the services that are used by the domain use cases using the implementations from the details directory.
  • leaktopus/app.py - The main application file. Contains the Flask app initialization and the routing.
  • leaktopus/factory.py - The factory that creates the project services based on the settings in settings.py.

Common Language (Semantics)

  • usecase - A single action that the user can perform. It usually includes a set of actions that are performed in a specific order.
  • entrypoint - Where we initiate our details and execute a use case.
  • task - A background job that is executed asynchronously. For example: a celery task, a thread.
  • service - A glue between the domain's interfaces and the details' implementations. It is used by the use cases to execute the details' implementations.

Development Environment Setup

If you wish to contribute to Leaktopus or run it in development mode, please follow this section.

Customized Docker compose for development

The dev version of docker-compose shares the volumes with the host machine for easy debugging and development.

docker-compose -f docker-compose.dev.yml -f docker-compose.override.yml up

Without Docker (Manual)

Prerequisites

  • Python > 3.7
  • Pip
  • Node > 17.x

Backend

cd leaktopus_backend

# Required for using our .env file.
pip install python-dotenv

# Install all the dependencies.
pip install -r requirements.txt

# Run the application locally.
FLASK_APP="`pwd`/leaktopus/app.py" FLASK_DEBUG=1 flask run -p 8000

# To debug celery worker add these lines to the setting.py file.
import dotenv
dotenv.load_dotenv('./.env')

Automated Tests

Leaktopus has a set of automated tests.

Unit-tests

  • Executed on every push to the repository.
  • Can be run manually via your IDE or using pytest.

Integration-tests

  • Are not executed automatically on every push to the repository.
  • Can be run manually via your IDE or using pytest, but note that some environment variables might be required for the execution.

E2E-tests

  • Are not executed automatically on every push to the repository.

  • Using a dummy Github repository for the tests.

  • Requires a full environment to run, therefore recommended to be executed from the "worker" docker container:

    docker-compose -f docker-compose.dev.yml exec worker pytest leaktopus/tests/e2e

Frontend

cd leaktopus_frontend

npm install
npm run serve

Development/Monitoring Services

In addition to the services mentioned on the README.md file, the following services can be used for development and advanced monitoring purposes:

Service Port Documentation
Flower 5555 https://flower.readthedocs.io/en/latest/
Redis Commander 8081 https://github.com/joeferner/redis-commander

See docker-compose.override.example.yml for deployment examples.