Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simbadltd/k6-junit
k6 JUnit summary exporter libray
https://github.com/simbadltd/k6-junit
Last synced: 3 months ago
JSON representation
k6 JUnit summary exporter libray
- Host: GitHub
- URL: https://github.com/simbadltd/k6-junit
- Owner: simbadltd
- License: mit
- Created: 2022-01-26T06:38:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-02T16:44:26.000Z (over 1 year ago)
- Last Synced: 2024-01-25T06:12:08.827Z (10 months ago)
- Language: JavaScript
- Size: 151 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-k6 - k6-junit - k6 JUnit summary exporter libray. (Tools)
README
# k6-junit
[](https://www.npmjs.org/package/k6-junit)
[](https://github.com/simbadltd/k6-junit/actions/workflows/default.yml)
k6 JUnit summary exporter library.
## Usage
``` javascript
import {jUnit} from "k6-junit";
// ...
export function handleSummary(data) {
console.log('Preparing the end-of-test summary...');
return {
"./test-results.xml": jUnit(data)
};
}
```
### Typescript integration
Based on [k6-template-typescript](https://github.com/grafana/k6-template-typescript).
Add dev-dependency to `package.json`:
```json
{
"devDependencies": {
"k6-junit": "X.X.X"
}
}
```
Resolve `k6-junit` package as internal dependecy in `webpack.config.js`:
```javascript
// ...
module.exports = {
// ...
externals: [
function ({context, request}, c) {
if (request.startsWith('k6') || request.startsWith('https://')) {
return request === 'k6-junit' ? c() : c(null, 'commonjs ' + request);
}
return c();
},
],
// ...
}
```
### Using without transpiling
In case when it is necessary to avoid transpiling to js and run k6 right on typescript tests, you should modify import statement:
```javascript
import {jUnit} from "./node_modules/k6-junit/index.js";
```
### Configuration
Since your project may have its own features there is a possibility to adjust behaviour
to your needs. There are several configuration parameters available. Please, see their
reference below:
| Parameter Name | Description | Default value |
|-----------------------|------------------------------------------------------------------------------------------------|----------------------------|
| includeThresholds | Allows you to control the inclusion of Threshold metrics during the export | true |
| testCasePassCondition | Allows you to control the logic which decides whether testCase passed or not | passed > 0 && failed === 0 |
| maxGroupNestingLevel | Defines the maximum level of group nesting, more nested groups will be flattened as test-cases | 1 |
If you need to override default values, please call `jUnit` function with `cfg`
argument defined. So that, your specific configuration will be used by the library.
``` javascript
import {jUnit} from "k6-junit";
// ...
return {
"./test-results.xml": jUnit(data, {
includeThresholds: false,
testCasePassCondition: (passed, failed) => passed > 0 && failed <= passed,
maxGroupNestingLevel: 2
})
};
// ...
```
## Example k6 JSON Summary
```json
{
"metrics": {
"http_req_duration": {
"avg": 123.456,
"max": 123.456,
"med": 123.456,
"min": 123.456,
"p(90)": 123.456,
"p(95)": 123.456,
"thresholds": {
"p(90) < 100": false,
"p(95) < 130": true
}
}
},
"root_group": {
"name": "",
"path": "",
"id": "d41d8cd98f00b204e9800998ecf8427e",
"groups": [
{
"name": "Register New User",
"path": "::Register New User",
"id": "ef69e341fa4ed9426351b0cf6861b7ac",
"groups": [],
"checks": [
{
"passes": 1,
"fails": 0,
"name": "Access token:[empty]",
"path": "::Register New User::Access token:[empty]",
"id": "0de369f3d729210fd6916a3a19b78660"
},
{
"path": "::Register New User::Sign-up confirmation is successful",
"id": "c1575f06e564d14c750ade1e016a4f44",
"passes": 0,
"fails": 1,
"name": "Sign-up confirmation is successful"
}
]
}
],
"checks": [
{
"name": "200 OK",
"path": "::200 OK",
"id": "a6e8273230e2df18dd7e2067b12fc13c",
"passes": 5,
"fails": 70
}
]
}
}
```
```xml
```
## LICENSE
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.