search

iblancasa / BackendSI2-IV

Proyecto para el desarrollo de backend para empresa Si2.info (asignatura Infraestructuras Virtuales GII UGR)
MIT License
8 stars 4 forks source link

readme

Backend server mensajería

==============

Join the chat at https://gitter.im/iblancasa/BackendSI2-IV

Proyecto para el desarrollo de backend de servicio de mensajería instantánea orientado a empresas.

Build Status

Asignatura "Infaestructuras Virtuales". Grado de Ingeniería Informática, Universidad de Granada

La aplicación desplegada y funcionando la puedes ver aquí Logo

=======

¿Qué hay desplegado?

Estamos trabajando en el backend. Actualmente, está desplegado un sistema que solo permite darte de alta en nuestra aplicación utilizando la autentificación de Google+.

======= Sitio web del proyecto

También disponemos de una cuenta de Twitter asociada, Twitter de BackendSI2-IV, donde publicaremos los cambios en el repositorio y del blog.

Contenedor Docker

Integrantes del grupo:

Si2.info es una empresa, dirigida por Ángel Moreno, que se dedica principalmente a desarrollo móvil y de webs. Propone el siguiente proyecto: Se trataría de construir el backend de un sistema de mensajería para móviles (tipo WhatsApp / Telegram), exponiendo un API que nos permita autenticar al usuario, crear grupos, mensajes 1 a 1, gestionar imágenes y otros archivos de medios, enviar notificaciones push (Android/iOS/Amazon SNS)... El servidor de Telegram, vamos (creo, no estoy seguro, que solo los clientes son libres, y lo que estamos buscando es crear un producto específico para determinados clientes, necesitamos un servidor). Incluso pensamos en algún tipo de "garantía de entrega", un "mensaje certificado", algún conector con un sistema de terceros que pueda hacer de "notario".

Podría ser tanto un proyecto de tipo nube creando un backend basado en alguna plataforma SaaS como un proyecto de tipo devops tomando cualquier sistema a medio desarrollar que necesitara una infraestructura virtual. El contacto de este proyecto es Ángel Moreno.

Extraído de aquí

=======

¿Cómo ejecuto la aplicación en mi máquina?

En primer lugar necesitarás obtener las claves necesarias para que tus usuarios puedan conectarse utilizando Google+.

Clona el repositorio en tu máquina

git clone https://github.com/iblancasa/BackendSI2-IV.git

Exporta las siguientes variables con sus valores correspondientes:

export PORT= #Puerto en el que se ejecuta la aplicación
export PASSWORDSERVER= #Contraseña del servidor (para sesiones)
export facebookclientID= #ID de cliente de tu aplicación Facebook
export facebookclientSecret= #Secreto de cliente de tu aplicación Facebook
export twitterconsumerKey= #Clave de consumidor de tu aplicación Twitter
export twitterconsumerSecret= #Clave de consumidor secreta de tu aplicación Twitter
export googleclientID= #ID de cliente de tu aplicación Google+
export googleclientSecret= #Secreto de cliente de tu aplicación Google+
export BD= #URL de la base de datos MongoDB
export IP= #IP de la máquina donde se está ejecutando el backend
export URLSERVICE= #URL donde se está ejecutando el Backend (si para acceder es necesario poner el puerto, hay que ponerlo también)

Instala las dependencias del proyecto. Ve a la carpeta donde clonaste el repositorio y ejecuta npm install.

Ejecuta el proyecto escribiendo en terminal nodejs .

=======

Despliegue en un PaaS: OpenShift

OpenShift

OpenShift es un PaaS que nos ofrece multitud de herramientas y varios beneficios que nos ayudarán a poner en marcha nuestra aplicación:

Permite la creación de nuevas aplicaciones de forma muy intuitiva y con una interfaz sencilla.

Integración continua con esta plataforma, asegurando la portabilidad de las aplicaciones

Reduce el tiempo para construir y desplegar nuestra aplicación de forma sencilla: dispone de varias regiones para desplegarla, mejorando la latencia. Posibilidad de escalar dependiendo del tráfico recibido

Podremos desplegar utilizando varios lenguajes. En nuestro caso, nos permite utilizar NodeJS

Dispone de MongoDB entre otras (MySQL, PostgreSQL o Amazon RDS), añadiéndola como un plugin.

En nuestro caso optamos por la cuenta "Free" de este PaaS, que nos da 512MB RAM y un 1GB de almacenamiento

Tras haber probado otros servicios como Heroku, nos decantamos por OpenShift debido a la facilidad que nos presenta para hacer cualquier tarea

A esto, se suma la posibilidad de acceder mediante SSH a la aplicación (cosa que Heroku no nos permitía). Añadir nuevos "addons" de forma gratuíta y utilizar un dominio propio sin tener que poner datos bancarios, cosa que sí ocurría con Heroku, son otras características importantes a tener en cuenta a la hora sde haber elegido este PaaS

=======

Despliegue en un IaaS: Azure

Azure

Azure nos ofrece:

Podremos utilizar una amplia gama de imágenes, con gran cantidad de sistema operativos y diversas versiones de estos

Ofrece un servicio con una disponibilidad del 99.95%, soporte técnico y una supervisión puntual del estado del servicio

Se puede ampliar o reducir rápidamente para adaptarse a cualquier demanda, de modo que solo paga por lo que usa.

Proporciona servicios de datos administrados de SQL y NoSQL o mucha compatiblidad con éstos. También se podrá sincronizar con directorios locales existentes.

Un inconveniente de usarlo lo podemos encontrar en la privacidad: Microsoft permite que el gobierno de los Estados Unidos tenga acceso a los datos almacenados incluso si el cliente no es estadounidense y los datos residen fuera de Estados Unidos, de acuerdo a la Ley USA PATRIOT

En nuestro caso ejecutaremos la apliación en una máquina de Ubuntu 14.04 (ubicada al Oeste de Europa) con 1 núcleo y 1,75 GB de memoria (Máquina tipo A1)

Para crearla simplemente ejecutamos: azure vm create mimaquina b39f27a8b8c64d52b05eac6a62ebad85__Ubuntu_DAILY_BUILD-trusty-14_04_1-LTS-amd64-server-20150113.1-en-us-30GB miusuario mipass --location "West Europe" --ssh

La arrancamos con azure vm start mimaquina y si queremos conectarnos mediante ssh: ssh miusuario@mimaquina.cloudapp.net

Escogemos Azure como nuestro IaaS por ser uno de los más extendidos, muy flexible y con una importante empresa tras este IaaS (Microsoft). Se suma a esto, el tener conocimientos previos sobre su uso, ya que se a trabajado en clase con éste y disponemos de una cuenta gratuíta (cedida por el profesor).

También se estudiaron otras alternativas:

=======

Integración continua: Travis

Travis

Para la integración continua hemos elegido Travis-CI

Travis es open source y provee integración continua hosteada, es decir, no tenemos que tener nuestros propios servidores.

Tiene una integración con GitHub muy sencilla. Después de configurarlo automaticamente puede construir las ramas de un repositorio. Además soporta despliegue para Openshift, Heroku, etc...

Se configura con un fichero llamado .travis.yml en el directorio raíz del proyecto. En él, describimos mediante lenguaje YAML lo que necesitamos que instale antes de ejecutar nuestros test, cómo debe ejecutarlos y qué hacer después de ello (pudiendo elegiur qué hacer en caso que los test se pasen de forma satisfactoria o no).

Proyectyo en Travis

El proceso que se sigue es el siguiente:

De esta forma, nos aseguramos que, hasta que no se hayan pasado los test, no se despliegue en el PaaS ni en el IaaS (cosa que ocurriría si hubiésemos linkeado el repositorio directamente con cualquiera de los dos).

=======

Por qué Ansible

Ansible

Ansible es una herramienta open source para automatizar tareas de forma simple, sus principales contricantes son Pupper, Chef y Salt. Chef se ha utilizado y es más complicado de usar que Ansible, y los resultados son iguales.

La instalación de Ansible se puede realizar a traves de pip, el manejador de paquetes de Python. La configuración de Ansible se realiza a traves de la sintaxis YAML, en ficheros de configuración llamados Playbooks.

Las ventajas que hemos observado son:

Como se ha comentado anteriormente, hemos probado otros sistemas y no nos han parecido tan interesantes como este. Chef, por ejemplo, nos proporcionaba algunos problemas en su instalación. Además, la necesidad de utilizar muchos directorios y ficheros, cuando con Ansible se necesita mucho menos.

Para ejecutar el provisionamiento de la aplicación, hay que exportar una variable de entorno llamada ANSIBLESSH y que es la contraseña de nuestro usuario de SSH (en caso que estés utilizando tu propia máquina, cambia también el script aprovisionamiento.sh para adecuarlo a tu máquina):

export ANSIBLESSH='pass'

Después ejecutaremos el script que ejecuta todo lo necesario para realizar el provisionamiento (también ejecutará el playbook de Ansible):_

./travisscripts/aprovisionamiento.sh

=======

Tests

Los tests los podemos encontrar en la carpeta test, fichero test.js. Para los tests hemos usado las bibliotecas Mocha, Chai, Mockgoose.

Mocha es un framework para NodeJS para hacer tests unitarios.

Chai es una biblioteca de aserciones (assertion library) para NodeJS y para el navegador. Nosotros la integramos con el framework Mocha. Chai nos ayuda a realizar aserciones contra nuestro código. Es muy completo ya que, sin necesidad de plugins, tiene tres estilos con los que podemos realizar las aserciones, podemos optar por el estilo TDD (Test-driven development) o BDD(Behavior-Driven Development).

Mockgoose es una biblioteca que nos permite comprobar los tests contra la base de datos sin tener que conectarnos a una base de datos actual, funciona como un wrapper e intercepta las llamadas a la base de datos de Mongoose.

Los tests se ejecutan con el comando npm test

=======

Aislamiento de recursos: Docker

Docker

Ir al Docker del proyecto

Por qué usamos Docker

Usamos Docker sobre otras opciones de contendores, como lxc por:

Cómo se ejecuta el contenedor

Para usar nuestro Docker primero hay que tener instalado Docker en nuestro ordenador:

apt-get update
apt-get install docker.io

Cuando queramos "arrancar" el servicio, ejecutaremos siendo superusuario:

docker -d

En caso de que falle y no arranque, avisándonos de un problema con /var/run/docker.pid, tendremos que borrarlo ( rm /var/run/docker.pid ) y volver a ejecutar la orden anterior.

Y en otro terminal, ejecutaremos:

docker pull iblancasa/backendsi2-iv

Que descargará nuestro Docker. Una vez finalizada la descarga, podremos ejecutar la aplicación ejecutando:

sudo docker run -i -t iblancasa/backendsi2-iv /bin/bash -c "ifconfig;nodejs /home"

Si solo queremos acceder al terminal (para, por ejemplo, ejecutar los test unitarios):

sudo docker run -i -t iblancasa/backendsi2-iv /bin/bash

Para facilitar la instalación/ejecución, el repositorio cuenta con un script de Bash que hay que ejecutar como superusuario y que arrancará el docker con la aplicación.

También será necesario que:

export DBHOST='hostBD'

=======

Herramientas utilizadas

Repositorios que han ayudado: