https://github.com/craigatk/projektor

View and share your test reports quickly and easily with Projektor
https://github.com/craigatk/projektor

reporting testing

Last synced: 5 months ago
JSON representation

View and share your test reports quickly and easily with Projektor

• Host: GitHub
• URL: https://github.com/craigatk/projektor
• Owner: craigatk
• License: mit
• Created: 2019-12-05T12:24:09.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2026-01-13T12:19:22.000Z (5 months ago)
• Last Synced: 2026-01-13T15:28:23.400Z (5 months ago)
• Topics: reporting, testing
• Language: Kotlin
• Homepage: https://projektor.dev
• Size: 98.1 MB
• Stars: 48
• Watchers: 2
• Forks: 20
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Projektor

| Project                | Tests                                                                                                                                                                                                      | Coverage                                                                                                                                                                                                                      |

|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| Server & Gradle plugin | [![Test results](https://projektorlive.herokuapp.com/repo/craigatk/projektor/badge/tests)](https://projektorlive.herokuapp.com/repo/craigatk/projektor/run/latest)                                         | [![Code coverage percentage](https://projektorlive.herokuapp.com/repo/craigatk/projektor/badge/coverage)](https://projektorlive.herokuapp.com/repository/craigatk/projektor/coverage)                                         |

| UI                     | [![Test results](https://projektorlive.herokuapp.com/repo/craigatk/projektor/project/ui-jest/badge/tests)](https://projektorlive.herokuapp.com/repo/craigatk/projektor/project/ui-jest/run/latest)         | [![Code coverage percentage](https://projektorlive.herokuapp.com/repo/craigatk/projektor/project/ui-jest/badge/coverage)](https://projektorlive.herokuapp.com/repository/craigatk/projektor/project/ui-jest/coverage)         |

| Node publisher         | [![Test results](https://projektorlive.herokuapp.com/repo/craigatk/projektor/project/node-script/badge/tests)](https://projektorlive.herokuapp.com/repo/craigatk/projektor/project/node-script/run/latest) | [![Code coverage percentage](https://projektorlive.herokuapp.com/repo/craigatk/projektor/project/node-script/badge/coverage)](https://projektorlive.herokuapp.com/repository/craigatk/projektor/project/node-script/coverage) |

For detailed instructions to get started with Projektor, please see the full project documentation at https://projektor.dev

## Test reports

Tests failing on your machine and need help debugging them? Or tests are passing local but failing in CI and

CI doesn't record the test report? Debugging tests in these scenarios can be time consuming and painful,

especially if you don't have the full context of the test failure.

Access and share your full test reports quickly and easily with Projektor.

![Projektor test report](images/all-tests-passing.png "Projektor test report")

Projektor shows a summary of all the tests executed as part of your test run:

https://projektorlive.herokuapp.com/tests/RQ99P3LRZJSX

The summary includes things like number of tests executed, how many passed or failed, etc.

And if there are any failures, those failure details are shown first on the dashboard:

![Projektor dashboard failed test](images/projektor-dashboard-failed-test.png "Projektor dashboard failed test")

To help debug failures in any environment (especially CI), Projektor gives you access

to the system out and system err from each test:

![Projektor system out](images/test-system-output.png "Projektor system out")

https://projektorlive.herokuapp.com/tests/V1BMYK93MTNR/suite/65/systemOut

## Code coverage stats

Projektor can capture and visualize code coverage stats from any project that can output code coverage data in 

Jacoco (Gradle, sbt, etc.), Kover, Clover (Jest, Cypress, etc.), and Cobertura formats.

Projektor calculates overall code coverage stats for the project as well as per-module coverage breakdowns

for Gradle multi-project builds:

![Projektor overall code coverage](images/code-coverage-overall-and-group.png "Projektor overall code coverage")

Drilling down further, Projektor can show file-level coverage stats, including which lines are covered, partially covered, or fully missed.

![Projektor code coverage files](images/code-coverage-files.png "Projektor code coverage files")

For example https://projektorlive.herokuapp.com/tests/RQ99P3LRZJSX/coverage/server-app/files

Projektor can also graph your project's code coverage over time, giving you the opportunity to see

how the code coverage is trending:

![Projektor code coverage graph](images/projektor-code-coverage-graph.png "Projektor code coverage graph")

More details about using code coverage with Projektor are at https://projektor.dev/docs/code-coverage/

## Performance test results

Projektor can record and graph your

![Projektor performance test results graph](images/projektor-performance-graph-full.png "Projektor performance test results graph")

More details on performance test results with Projektor are at https://projektor.dev/docs/performance-test/

## GitHub pull request comments

Projektor can comment directly on your pull request with direct links to the test report, code coverage data - 

including the change in coverage percentage in the PR.

![Projektor pull request comment](images/pr-comment-increased-coverage.png "Projektor pull request comment")

Details on how to set this up are at https://projektor.dev/docs/github-pull-request/

## Changelog

### Projektor server

[Projektor server changelog](CHANGELOG.md)

### Projektor Gradle plugin

[Projektor Gradle plugin changelog](https://projektor.dev/docs/gradle-plugin/#changelog)

### Projektor Node script

[Projektor Node script changelog](https://projektor.dev/docs/node-script/#changelog)

## Development

For information on how Projektor is developed, how to build it from source and deploy it yourself, and other

development information, please see [the development guide](DEVELOPMENT.md)

## Contributors

A big thank you to the contributors to this project!

* Aaron Zirbes - [aaronzirbes](https://github.com/aaronzirbes)

* Alex Hatzenbuhler - [ahatzz11](https://github.com/ahatzz11)

* Andy Rudge - [arudge](https://github.com/arudge)

* Connor Hasting - [CodedChai](https://github.com/CodedChai)