Documentacion del hito 2

En este hito se ha realizado el desarrollo del microservicio de sensores. Este hace uso de un servicio REST en el cual procesa una petición y emite una respuesta. Esta respuesta se envía a través de HTTP en formato JSON.

Para el almacenamiento de los objetos el microservicio hace uso de una base de datos MySQL. Será en esta misma base de datos donde el resto de microservicios se conecten y hagan persistencia de sus objetos. Como PaaS se ha decidido utilizar Heroku por ser un servicio gratuito y fácil de utilizar.

Ejecución

Para la ejecución del servicio se hace uso de los siguientes ficheros:

• Procfile: Es el archivo que lanza Heroku para lanzar la aplicación. Las líneas del Procfile constan de un tipo de proceso a la izquierda y un comando a la derecha. En este proyecto se utiliza solamente, web: node server.js, la cual indica que en la web se va a lanzar el fichero server.js que contiene la ejecución del servicio. También se pueden definir los tipos de proceso release, worker, etc. donde encuadrar los comandos que se ejecutan en otras fases de desarrollo del servicio.
• package.json y package-lock.json: Son los ficheros que indican las dependencias que se deben instalar para que el servicio funcione. En package.json además podemos encontrar el comando a utiizar en la inicialización del servicio y del test que debe realizar para su despliegue. Utilizan el tipo de fichero .json. Otras sentencias de estos ficheros hacen referencia al nombre del fichero, versión, etc.
• .travis.yml: Es el fichero que configura el test que va a realizar el programa antes de su despliegue. En este se indica el lenguaje utilizado, los paquetes que debe instalar para ello y cómo debe ejecutarse. En el caso de este proyecto debe instalarse mocha para realizar el test. Este se ejecuta mediante el script npm test. Utiliza el tipo de fichero YAML. Se puede configurar además el nombre del servicio, el proveedor del despliegue, etc.

Despliegue en GitHub

Para poder desplegar la aplicación en GitHub se ha definido en Heroku que se haga cuando se hace un “push” sobre el repositorio de GitHub. Para ello además debe de pasar los test de Travis.

Funcionalidad

Se ha implementado en este hito las siguientes funcionalidades:

• Creación de sensores
• Listado de sensores
• Generación gráfica del sensor en formato SVG

Estructura de los sensores

Los sensores poseen los siguientes campos en la base de datos:

• Identificador. Es la clave primaria por la que se identifican
• Tipo de sensor. Indica la medición que realiza. Estos pueden ser de los siguientes tipos:
  • Temperatura ambiente
  • Humedad
  • Presión atmosférica
  • Velocidad del viento
  • Luminiscencia

Direcciones implementadas

Se han implementado las siguientes direcciones para la realización de las funcionalidades:

• /: Es la página principal del microservicio. Devuelve la ruta del microservicio. (Solo admite el método GET.)
• /about: Es la página de informacion del microservicio. Devuelve información sobre el autor. (Solo admite el método GET.)
• /chart: Depende su funcionalidad según el método utilizado:
  • Con el método GET sirve para obtener un sensor con el id indicado.
  • Con el método PUT sirve para crear un sensor con el tipo indicado.
  • Con el método POST sirve para modificar un sensor con el id indicado.
  • Con el método DELETE sirve para eliminar un sensor con el id indicado.
• /charts: Depende su funcionalidad según el método utilizado:
  • Con el método GET sirve para obtener todos los sensores.
  • Con el método DELETE sirve para eliminar todos los sensores.

Pruebas realizadas

Se han desarrollado una serie de tests para comprobar que la implementación del microservicio es correcta:

• Tests sobre las direcciones URL para comprobar que las respuestas que emiten son las correctas. Se comprueban de esta manera el estado y el tipo de mensaje de la respuesta.
• Tests sobre la funcionalidad para comprobar que lo que realiza el microservicio es correcto.

Para la realización de estos tests se ha hecho uso del framework “supertest” a través de mocha.