Skip to content

Latest commit

 

History

History
205 lines (140 loc) · 7.24 KB

README.md

File metadata and controls

205 lines (140 loc) · 7.24 KB
Raw

Ujumbe

semantic-release

SMS Gateway that handles sending sms. This needs an SMTP server already setup.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Pre-requisites

Any editor of your choice can be used for this application.

  1. Python

    This project has been built with Python 3.8. Ensure that you install this version of Python as outlined in the link provided here

  2. Pip

    This is a package manager for Python applications and will be useful when handling dependencies for this application. Installations instructions can be found in the link int the title.

  3. Poetry

    An awesome dependency management tool for Python and is highly recommended. This is the preferred tool of choice for this project. This allows use to separate between dev dependencies and dependencies

  4. Docker

    This will be used when containerizing the application for running in a SOA(Service Oriented Architecture). This is used especially when deployment. Allows this application to run in any environment with minimal configuration.

  5. Twilio Account

    Twilio is the 3rd Party SMS client that is used to actually send out SMS messages. In order to send these messages with this application. One will need to setup a Twilio account and obtain the account sid, auth token and message sid and set them in the values: TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN and optionally, TWILIO_MESSAGE_SID as specified in the .env.example file. Twilio has been disabled by default and stubbed out in the application, but can be enabled using the TWILIO_ENABLED environment variable. Setting it to True enables using Twilio to send out the SMS messages.

  6. Sentry Account

    Sentry is used for error tracking and monitoring and can be used in this application. Once one creates an account with Sentry, proceed to add the sentry DSN value in the .env.example file as the SENTRY_DSN environment variable. Other values have been reasonably set, such as SENTRY_TRACES_SAMPLE_RATE and SENTRY_DEBUG_ENABLED, but can be modified. Additionally, Sentry is disabled by default with the environment variable SENTRY_DEBUG_ENABLED, but should be enabled in a production setting, if one wants to enable this during development, you can set this environment variable to True

First of, create a .env file from .env.example which will contain environment variables for configurations. This file is not checked into VCS(Version Control System).

Typically Application port will be set to a default of 5000, but if you prefer a different port to use, you can set that in the environment variable

Installing

You will first need to install the dependencies as specified in the pyproject file by running:

poetry install

Or

make install

This is a convenience wrapper around poetry install

The Makefile contains commands that are used in the project.

Running the application

In order to run the application, we need to first run docker containers specified in the docker compose file. This specifies services that are used by the application while it runs such as:

  1. Kafka
  2. Kafka Schema Registry
  3. Zookeeper
  4. Postgres
  5. Zipkin
  6. Grafana
  7. Redis

To get more details about the architecture of the project, consult the documentation as specified here.

Steps to run the project include:

  1. Start by first running the docker containers of the above services

    These services have been split into different profiles as stated in the doc here. In order to run all the services at once, one can use make to conveniently run all the services:

     make start-docker

  2. Next, run migration script to setup the database schema:

    make migrate-up

  3. Next, run the application with:

     make run

    Or

    make run-reload

    Runs the application watching for changes in the app directory

  4. Next, run the consumer workers/listeners which consume events from Kafka:

    make run-sms-received-consumer

    Runs the SMS received consumer

    on a different terminal, run the SMS submitted consumer:

    make run-sms-submitted-consumer

    on a different terminal, run the SMS Sent consumer:

    make run-sms-sent-consumer

To run the application in a docker container use the below commands:

docker build -t <NAME_OF_IMAGE>:<VERSION> . OR docker build -t <NAME_OF_IMAGE>:<VERSION> -f Dockerfile First build the image and tag it with a name, the suffix is optional, notice the dot (.)

Then now you can run the application in the container and expose ports to the host

docker run -it -p <HOST_PORT>:4000 <NAME_OF_IMAGE> Run the application container binding the container port to a host port.

The host port can be whatever you like as long as it is not a reserved host port (e.g, running linux services, if on Linux). However, the container port (6000) is a must as the container exposes that port (This can be changed from the Dockerfile)

Ideally, this will be a representation of what will run in production in a single container(pod) in a kubernetes cluster.

Running tests

The application tests can be found here split into sub folders for unit tests, integration tests and end-to-end tests. These tests can be run like below:

make test-unit

Runs unit tests

make test-integration

Runs integration tests

make test-e2e

Runs end-to-end tests Note, that running e2e tests is a little more complicated, as it involves spinning up docker containers, This is documented in the testing doc

make test

Runs all the tests

API Documentation

API Documentation is generated with OpenAPI and can be accessed on the URL http://127.0.0.1:5000/docs while running the application locally.

Built with

This application has been built with the following tools: