Welcome to the org.fiware.qa.documentation.measurements wiki!

This software module performs data analysis of scraped web pages of the FIWARE Catalogue to assess their compliance with the Compliance Guide.

Information across component lifecycle

Development environment

Prerequisites

• Ubuntu, for Java coding Windows as well
• Eclipse IDE
• JDK 1.8

Run in a development environment

• Checkout this repository
• Navigate to the class org.fiware.qa.documentation.measurements.Runner and execute it via Eclipse IDE

Deploy dockerized microservice

• run build.sh, this should build a Docker image and start the service container (default port 9009)
• validate service: run smoketest.sh

Software architecture considerations

Currently, this software module uses the local text file items.json as input. However, the module has Jersey packaging and needs to have a REST interface to exchange data. Currently, we work on the core measurment logic. This module is also thought to be a template for measurements of other types.

RESTful API (in work)

• GET /update Update internal data representation from the scraper service
• GET log/ENABLER-NAME gets logfile for latest measurment (TXT)
• GET scoring gets overall labeling score matrix with labels (CSV) as displayed here https://github.com/sigspl/org.fiware.qa.documentation.measurements/blob/master/enablers_data.csv
• GET label/ENABLER-NAME gets just the computed label token for a given Enabler e.g. "A+++"

Interface with the Scraper module

From the Scraper module, this service acquires on start the recent version of scraped data.