Contenidos

1. Servicio de mensajes
2. Documentación OpenAPI
3. Estado de badges
4. Deploy
   1. Heroku
   2. Local
      1. Usando Docker
      2. Usando poetry
5. Tests
6. Configuración variables de entorno

Servicio de mensajes

• Se encarga de la mensajería entre usuarios.
• Base de datos no relacional: ya que no existen muchas relaciones entre las entidades. Una conversación entre dos usuarios consiste simplemente en una lista de mensajes.

En este link se puede acceder al repositorio.

Documentación OpenAPI

La documentación referida a la especificación OpenAPI del servicio se puede encontrar en https://rostov-messages-server.herokuapp.com/docs, la cual fue generada automáticamente por FastAPI.

Estado de badges

Aclaración: Pipeline incluye linter-tests (coverage)-deploy

Deploy

Heroku

El deploy hacia Heroku se encuentra automatizado dentro del pipeline de GitHub Actions usando la imagen de Docker del servicio en desarrollo. En particular, se necesitan las siguientes variables de entorno para generar el deploy automático.

Local

Usando Docker

Se cuenta con soporte para utilizar Docker de manera de no instalar todas las dependencias necesarias para el proyecto directamente. Las instrucciones se encuentran acá.

Usando poetry

En caso de optar por levantar el proyecto de manera local, se puede usar poetry para instalar las dependencias. Tener en cuenta que se necesita MongoDB instalado previamente para la base de datos. Las instrucciones se encuentran acá

Tests

La ejecución de los tests se encuentra automatizada a la hora de deployar mediante el pipeline de GitHub Actions. Al mismo tiempo, si se requiere correr los tests de manera local, se puede ejecutar con poetry run pytest (recordar que se necesita MongoDB instalado previamente), o directamente utilizar Docker con sus instrucciones.

Configuración variables de entorno

Las variables de entornos utilizadas, ya sea configuradas de manera local, mediante los secrets de GitHub, o config var en Heroku; son las siguientes:

• MONGO_URL: URL de la base de datos MongoDB, requerida como config var en Heroku, como action secret y como variable de entorno local.
• DD_API_KEY: API key de DataDog, requerida como config var en Heroku.
• DD_DYNO_HOST: sirve agrupar hosts en DataDog, requerida como config var en Heroku.
• DD_TAGS: tags para DataDog, requerida como config var en Heroku.
• API_KEY: API key del servicio para realizar requests al mismo, requerida tanto como variable de entorno local y en Heroku.
• NOTIFS_API_KEY: API key del servicio de notificaciones para realizar requests al mismo, requerida tanto como variable de entorno local y en Heroku.
• TESTING: denota una especie de entorno de desarrollo, para poder testear fácilmente usando mocks de los servicios externos que lo requieran.
• HEROKU_API_KEY: API key de la cuenta utilizada para deployar en Heroku, requerida como action secret.
• HEROKU_APP_NAME: nombre de la app en Heroku, requerida como action secret.
• HEROKU_EMAIL: mail de la cuenta de Heroku utilizada para el deploy, requerida como action secret.
• CODECOV_TOKEN: token de codecov, requerido para subir reportes de coverage mediante el pipeline de GitHub Actions.

---