Download the PHP package alxvng/qatracker without Composer
On this page you can find all versions of the php package alxvng/qatracker. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download alxvng/qatracker
More information about alxvng/qatracker
Files in alxvng/qatracker
Package qatracker
Short Description QATracker is a tool to collect, store and render quality assurance indicators.
License MIT
Informations about the package qatracker
QATracker
QATracker is a tool to collect, store and render quality assurance indicators.
For example, you can run on your project some static code analysis tools like phploc or phpcpd then collect some metrics
throught exported files. This specific collected data are stored in an other file that you can push to your repository if you want.
Demo
You can view an example of a report here : Demo
Requirements
You can view the requirements on packagist website : https://packagist.org/packages/alxvng/qatracker
Installation
If necessary, remove the previous installation :
Install the phar (master):
If you prefer more stable version, checkout the last stable release at https://github.com/alxvgt/qatracker/releases
Usage
How to run qatracker :
First time
- Run your favorite QA tools and produce log files
- Run qatracker, if no configuration file is detected, the tool generate a sample for you.
- Adapt the generated sample file to your metrics logs, then run again the tool.
- An html page report will be generated, you can open it in your favorite browser. You can see the report but empty charts (not enough values collected).
Note : at least two collects of metrics are needed to display an historization chart.
Periodic usage
- Run your favorite QA tools and produce log files, again
- Run again qatracker, it collect new metrics from the same qa tools log files paths that you have already configured then, it generate a new report with old and new values.
- Now you can see the history of your favorite metrics. Enjoy !
Configuration config.yaml
You need to put your own configuration in order to build your own indicators and reports. The configuration is based on two objects :
- dataSerie : this object enables you to pick/fetch data in any file you want. Each run of qatracker run each dataSerie provider and store in a file the currated data.
- chart : this object associate a dataSerie to a chart in the final report
Example:
You can see the default config file at .qatracker.dist/config.yaml
dataSeries
You need to follow this structure and replace variable between brackets :
Available provider classes:
- Alxvng\QATracker\DataProvider\XPathProvider : pick a unique data in a xml file
- Alxvng\QATracker\DataProvider\XPathSumProvider : pick many data in a xml file and reduce it with a sum
- Alxvng\QATracker\DataProvider\XPathCountProvider : count nodes retrieved by the expresion in the xml file
- Alxvng\QATracker\DataProvider\XPathAverageProvider : pick many data in a xml file and compute the average
- Alxvng\QATracker\DataProvider\JsonPathProvider : pick a unique data in a json file
- Alxvng\QATracker\DataProvider\JsonPathSumProvider : pick many data in a json file and reduce it with a sum
- Alxvng\QATracker\DataProvider\JsonPathCountProvider : count nodes retrieved by the expresion in the json file
- Alxvng\QATracker\DataProvider\JsonPathAverageProvider : pick many data in a json file and compute the average
Example:
charts
You need to follow this structure and replace variable between brackets :
Graph type classes : You can find all available graph options in the library documentation : https://www.goat1000.com/svggraph.php#graph-types
Data serie id : You should refer to a data serie defined in the previous section.
Graph settings : You can find all available graph options in the library documentation : https://goat1000.com/svggraph-options.php
Example:
Compose your configuration with imports
You can compose the main config.yaml
with others config files by using imports
directive.
The imported files are processed first then the content of config.yaml
Docs & QA
Some informations about this tool are available here : Docs
Contributing
You can contribute to this project by adding issue or pull request. In order to start the project, you can follow some instructions below :
Requirements
- docker >= 19.03.5
- docker-compose >= 1.25.0
Installation
First, fork this repository. Then, follow some instructions below.
You are now connected to the container and you can start working on the project
All versions of qatracker with dependencies
ext-xml Version *
ext-json Version *
symfony/console Version ^5.0
goat1000/svggraph Version ^3.5
twig/twig Version ^3.0
symfony/string Version ^5.0
symfony/yaml Version ^5.0
symfony/filesystem Version ^5.0
symfony/finder Version ^5.0
flow/jsonpath Version ^0.5.0