Eine CLI zum Generieren eines JUnit-XML-Berichts aus der JSON-Ausgabe von Dart-Tests und Bibliotheken zum Parsen von Test-JSON in für Entwickler geeignete Modelle
Aus öffentlichen Paketdaten erstellte Orientierung.
Ein Befehlszeilenwerkzeug und eine Reihe von Bibliotheken, das Dart-Test-JSON-Ausgaben in das JUnit-XML-Format umwandelt, ideal für die Integration in CI/CD. Es bietet auch strukturierte Modelle, um Testergebnisse auf benutzerfreundliche Weise zu analysieren. Für Teams konzipiert, die Flutter- oder Dart-Projekte verwenden und standardisierte Testberichte über Plattformen wie Android, iOS, Web, macOS, Windows und Linux benötigen. Das Paket vereinfacht die Analyse von Testergebnissen und verbessert die Sichtbarkeit in automatisierten Pipelines.
Anwendungsfälle
CI/CD-Testberichterstattung
Integration mit Jenkins oder GitHub Actions
Standardisierte Testberichte generieren
Programmatische Analyse von Testergebnissen
Plattformübergreifende Testüberprüfung
Verbesserung der Lesbarkeit von Testergebnissen
Hauptmerkmale
Konvertiert Test-JSON in JUnit-XML
Bietet dev-freundliche Testresultatmodelle
Unterstützt mehrere Plattformen
Einfache CLI-Integration
Erweiterbare Analyse-Tools
Klare, strukturierte Ausgabe
Geeignet für
Teams, die Flutter und Dart verwenden
CI/CD-Pipeline-Entwickler
Test-Automatisierungsingenieure
Projekte mit JUnit-Kompatibilität
Entwickler, die strukturierte Testdaten benötigen
Hinweise
Erfordert Dart-Test-JSON-Eingabe
Erfordert Einrichtung in CI-Arbeitsabläufen
Beschränkt auf den Testbericht-Anwendungsfall
Keine Unterstützung für Echtzeit-Tests
Abhängig von der Ausgabe eines externen Testframeworks
Original-README
Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.
better_test_reporter
Introduction
This is an application/library heavily inspired by
dart-junitreport and
dart-testreport. It takes what was
done in those two packages and brings them under a single umbrella, updates to
null-safety, and makes various code style improvements.
The purpose of this package is three-fold:
Firstly, it provides models by which output from the test json
reporter
can be decoded.
Secondly, it provides a processor that will take a full json
report from the test json reporter and generate a more developer-friendly report
model structure that is agnostic to the protocol version of the test json
reporter.
Thirdly, it is a command-line application(report_to_junit) that
can be used to take in a full json report from the test json reporter and
generate a junit XML report(usable by many CI tools)
Experimental nature
This package is still experimental as we continue to build out more functionality. It's current state is barebones as we investigate ways to make the junit output more useful and ways to produce better testing reports for use outside of just junit.
Getting Started
In order to start using the report_to_junit command, install the latest
better_test_reporter as a global package via pub.dev.
pub global activate better_test_reporter
Options
Details on all options for report_to_junit can be found by running report_to_junit --help
> report_to_junit --help
-i, --input the path to the 'json' file containing the output of 'pub run test'.
if missing, <stdin> will be used
-o, --output the path of the to be generated junit xml file.
if missing, <stdout> will be used
-b, --base the part to strip from the 'path' elements in the source
(defaults to the current working directory)
-p, --package the part to prepend to the 'path' elements in the source
(defaults to "")
-t, --timestamp the timestamp to be used in the report
- 'now' will use the current date/time
- 'none' will suppress timestamps altogether
- a date formatted 'yyyy-MM-ddThh:mm:ss' will be used as UTC date/time
- if no value is provided
- if'--input' is specified the file modification date/time is used
- otherwise the current date/time is used
-h, --help display this help text
Misc
Differences from original implementation in dart-junitreport and dart-testreport
When generating the XML for a problem during a test, dart-junitreport had a
special case for only one problem occurred. The multiple problem case also
handled the case for a single problem. We found the special case for a single
problem unneeded and a little buggy, so it was removed in
better_test_reporter.
When parsing the test reporter json into a report,
dart-testreport set tests as not hidden if they encountered any problems while
running. In better_test_reporter, the hidden attribute on a test will be
purely based on whether the test was explicitly hidden based on the
TestDoneEvent json. That said, we maintained the hidden behavior for the
output junit xml by shifting that decision out of the report and up to whatever
consumes the report.
When generating the XML for a test case, better_test_reporter defaults to
stripping the current working directory out of the classname.