testres-db

testres-db

is a tool and library to import test results to a single SQLite database for further analysis your efficiency of testing, find bottlenecks, improve test execution and get better vizualization of a testing process in your project.

You might consider using one of these three tools:

• Command Line Shell For SQLite
• Datasette
• The Jupyter Notebook

Below there are some examples of queries:

~$ sqlite testres-db.sqlite
SQLite version 2.8.17
Enter ".help" for instructions
sqlite> SELECT * FROM testrun TR JOIN test T ON TR.test_id = T.test_id JOIN status ST ON TR.status_id = ST.status_id WHERE ST.name = 'PASSED';
sqlite> SELECT * FROM testrun TR JOIN test T ON TR.test_id = T.test_id JOIN suite S ON T.suite_id = S.suite_id JOIN report R ON TR.report_id = R.report_id JOIN status ST ON TR.status_id = ST.status_id WHERE ST.name = 'PASSED';

Building

$ go get ./...
$ go test -v ./...
$ go build ./...

How-To Use

There is a way to obtain test results from continuous integration services and test results systems. Unfortunately not all such systems supports such ability.

First of all you should make sure test reports is available after every build on continuous integration. For example GitLab CI allows to store JUnit reports as artifacts when Travis CI is not.

Secondly you should describe configuration file in YAML format which contains information about your project.

projects:
- name: criu
  backends:
   - type: jenkins
     branch: master
     pipeline: ""
     base: https://ci.openvz.org/
     username: anonymous
     secret: anonymous

By default testres-db uses testres-db.yaml as a configuration file and testres.sqlite as an SQLite database file. You can change default values using command-line options.

$ testres-db -init -db testres.sqlite
$ testres-db -import -db testres.sqlite -config testres-db.yaml

Supported backends

Azure DevOps

Generate access token in profile.

Circle CI

Circle CI supports storing test results in two formats: JUnit XML and Cucumber JSON. Access token is not required to query info for public projects, to access to a private projects follow steps in documentation to obtain API token.

Example of configuration file for Helios project:

projects:
- name: helios
  backends:
   - type: circleci
     branch: master
     base: https://circleci.com/
     project: spotify/helios
     username: <username>
     secret: <token>

Cirrus CI

Cirrus CI allows to store test report files in JUnit formats. Access to Cirrus CI API may require access token. You can generate it in profile. Note: by default Cirrus CI persists caches and logs for 90 days.

GitLab

Gitlab supports publishing JUnit reports. Follow instructions in documentation to setup it up. In general case to enable the JUnit reports in merge requests, you need to add artifacts:reports:junit in .gitlab-ci.yml, and specify the path(s) of the generated test reports. Access to Gitlab API may require access token with api capability. To generate access token please refer to documentation. expire_in allows you to specify how long artifacts should live before they expire and therefore deleted, counting from the time they are uploaded and stored on GitLab. If the expiry time is not defined, it defaults to the instance wide setting (30 days by default, forever on GitLab.com).

Example of configuration file for a Gitlab project:

projects:
- name: test-project
  backends:
   - type: gitlab
     branch: master
     base: https://gitlab.com/
     project: ligurio/test-project
     username: <username>
     secret: <token>

Jenkins

Jenkins supports publishing test results in JUnit format, but not all Jenkins instances supports it. To check this you may point your browser to a link <Jenkins URL>/job/<Job Name>/lastCompletedBuild/testReport/api/xml. Browser will show XML document in case of success. Access to Jenkins API may require access token, please refer to documentation to obtain it.

See also

• resultsdb
• TestArchiver - tools for serialising test results to SQL database.
• testmine - test result aggregator and analysis tool.
• res - intermediate representation for test results.

Contribution

There are numerous awesome Continuous Integration services which are not integrated with testres-db. Feel free to make a patches and bring support for them.

Authors

Developed with passion by Sergey Bronnikov and great open source contributors.