https://github.com/allure-framework/allure-karma
Allure adapter to karma test runner
https://github.com/allure-framework/allure-karma
Last synced: about 2 months ago
JSON representation
Allure adapter to karma test runner
- Host: GitHub
- URL: https://github.com/allure-framework/allure-karma
- Owner: allure-framework
- Created: 2013-11-29T11:00:31.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-01-30T11:11:23.000Z (over 5 years ago)
- Last Synced: 2024-10-30T00:55:04.265Z (7 months ago)
- Language: JavaScript
- Size: 55.7 KB
- Stars: 9
- Watchers: 11
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# karma-allure-reporter
> Reporter for the Allure XML format. It allows to make detailed report
## Installation
You can install `karma-allure-reporter` into your project as devDependency with:
```bash
npm install karma-allure-reporter --save-dev
```
## Configuration
Add allure into `reporters` section.
```js
// karma.conf.js
module.exports = function(config) {
config.set({
reporters: ['progress', 'allure'],
// the default configuration
allureReport: {
reportDir: '', // By default files will be save in the base dir
useBrowserName: true // add browser name to report and classes names
}
});
};
```
You can pass list of reporters as a CLI argument too:
```bash
karma start --reporters allure,dots
```
## API
With allure reporter you get some functions for provide additional info about tests. All functions available as methods
of the global `allure` object.
* `description(description)` assign a description to current testcase
* `severity(severity)` assign a severity to current testcase. Possible values enumerated as properties,
eg. `allure.severity.BLOCKER`. All securities by descending of their importance:
* BLOCKER
* CRITICAL
* NORMAL
* MINOR
* TRIVIAL
* `createStep(name, stepFunction)` defines test step. Returns wrapped function which reports
about every step calling. Step function can be nested within one another. It is most powerful feature of allure, because
it allow to write self-documented tests which report about every its step.
See the [docs] in core project for more information about these features and their purpose.
## Example
There is an [example project], where you may look to allure-reporter in action.
----
For more information about Allure see the [allure core] project.
For more information about Karma see the [Karma homepage].
[Karma homepage]: http://karma-runner.github.com
[allure core]: https://github.com/allure-framework/allure
[example project]: https://github.com/allure-examples/allure-karma-example
[docs]: https://github.com/allure-framework/allure/blob/master/docs/dictionary.md