Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/riih/dart_test_reporter
This repository contains various tools and utilities for generating and deploy reports for Dart applications. https://pub.dev/packages/allure_report https://pub.dev/packages/allure_server_cli
https://github.com/riih/dart_test_reporter
allure-framework allure-report allure-server allure2 dart dartlang
Last synced: 5 days ago
JSON representation
This repository contains various tools and utilities for generating and deploy reports for Dart applications. https://pub.dev/packages/allure_report https://pub.dev/packages/allure_server_cli
- Host: GitHub
- URL: https://github.com/riih/dart_test_reporter
- Owner: rIIh
- License: mit
- Created: 2024-06-09T13:52:57.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-11-06T16:11:55.000Z (about 2 months ago)
- Last Synced: 2024-12-18T06:29:10.065Z (5 days ago)
- Topics: allure-framework, allure-report, allure-server, allure2, dart, dartlang
- Language: Dart
- Homepage: https://riih.github.io/dart_test_reporter/
- Size: 2.45 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Test Reporting utilities
This repository contains various tools and utilities for generating and deploy reports for Dart applications
[Allure Demo - GH Pages](https://riih.github.io/dart_test_reporter/)
## Concept
Dart test core packages does not provide a way to inject custom reporting logic when you call `dart test`.
To workaround this problem there is `test_reporter` cli tool which wraps `dart test` process and processes events from it.
`test_reporter` uses dynamic package loading with Isolates. You can write your own reporter package and provide it to `test_reporter`. See [allure_report](packages/allure_report/) for example.
## [Test Reporter](packages/test_reporter/)
### Wrapping test command
Prepend your test command with `test_reporter`
```bash
dart run test_reporter -- dart test
```
You can use it with Flutter tests
```bash
dart run test_reporter -- flutter test
```
You can pass arguments to dart/flutter tests as is
```bash
dart run test_reporter -- flutter test --tags golden --coverage
```
## [`allure_report` - Allure Report Adapter](packages/allure_report/)
### Usage
1. Add `allure_report` and `test_reporter` to your dependencies.
```yaml
dev_dependencies:
# reporter
allure_report: ^1.0.0
test_reporter: ^1.0.0
```
2. Create `reporter.dart` in `test` directory. If no file created, **Basic Console Reporter** will be used.
```dart
import 'package:allure_report/allure_report.dart';
import 'package:test_reporter/test_reporter.dart';
TestReporter create() {
return AllureReporter();
}
```
3. Run test_reporter command with your tests
```bash
dart run test_reporter -- dart test
```
```bash
dart run test_reporter -- flutter test
```
### Output
Allure results are placed in `allure-results` folder in project root folder.
> [!WARNING]
> Full Allure format is not supported. Not all features are available at the moment.
>
> Full spec support is needs further development
## [Allure Server CLI](packages/allure_server_cli/)
`allures` is meant to be used to upload reports to OSS [Allure Server](https://github.com/kochetkov-ma/allure-server)
See [Allure Server repository](https://github.com/kochetkov-ma/allure-server) to find instructions to build it up and running.
### Install
```bash
dart pub global activate allure_server_cli
```
Command will be available with name `allures`
```bash
allures --help
```
### Usage
To upload results to Allure server you should zip results to ZIP Archive
```
zip -r allure-results.zip allure-results/
```
Then you can upload report to Allure server with nex command
```bash
allures --host http://localhost:8080 report --upload allure-results.zip --path develop
```
See help for additional usage info
```bash
allures --help
```
## Disclaimer
> [!WARNING]
> It is hobby-time project created for research of possibility to integrate Dart tests with Allure Reporting Framework.
>
> I am not currently supposed to support it as full-feature set by only myself. It depends on demand and user activity.
>
> Feel free to contribute :-)