Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kesin11/ts-junit2json
Convert JUnit XML format to JSON with TypeScript
https://github.com/kesin11/ts-junit2json
bigquery junit-xml
Last synced: 3 months ago
JSON representation
Convert JUnit XML format to JSON with TypeScript
- Host: GitHub
- URL: https://github.com/kesin11/ts-junit2json
- Owner: Kesin11
- License: mit
- Created: 2020-01-17T14:22:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-18T14:54:50.000Z (9 months ago)
- Last Synced: 2024-05-19T22:45:10.983Z (9 months ago)
- Topics: bigquery, junit-xml
- Language: TypeScript
- Homepage:
- Size: 1.12 MB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-junit2json
[](https://www.npmjs.com/package/junit2json)
[](https://jsr.io/@kesin11/junit2json)
ts-juni2json provides a converter that convert JUnit XML format to JSON. Also provides TypeScript types definition.
And also provide [CLI](#CLI) that can convert a JUnit XML to JSON.
# Purpose
ts-junit2json is created for uploading test result data to BigQuery.
Many languages and test frameworks supporting output test result data as JUnit XML format that de fact standard in today. On the other hand, BigQuery does not support to import XML but does support JSON.
You notice that you can upload test data to BigQuery with converting XML to JSON. ts-junit2json provides a simple JUnit XML to JSON converter for that purpose.
# What is difference for other XML to JSON tools?
The purpose of other similar tools is handling common XML format. As a result, output JSON structure is sometimes redundant and not suitable for store in BigQuery.
On the other hand, ts-junit2json only supports JUnit XML schema, but restructures original XML structure into a BigQuery friendly structure. Details are described below.
# Installing
```bash
npm install junit2json
```
# Usage
## Node.js
junit2json supports both ESModule and CommonJS.
```ts
import { parse } from 'junit2json' // ESM
// const { parse } = require('junit2json') // CommonJS
const main = async () => {
const xmlString = `
Error: Something wrong.
`
const output = await parse(xmlString)
console.log(JSON.stringify(output, null, 2))
}
main()
```
## Deno
junit2json also published to jsr.io as `@kesin11/junit2json`.
If you using Deno, you can import from jsr as below.
```ts
import { parse } from "jsr:@kesin11/junit2json";
```
# Output sample
```json
{
"name": "gcf_junit_xml_to_bq_dummy",
"tests": 2,
"failures": 1,
"time": 1.506,
"testsuite": [
{
"name": "__tests__/basic.test.ts",
"errors": 0,
"failures": 0,
"skipped": 0,
"timestamp": "2020-01-26T13:45:02",
"time": 1.019,
"tests": 1,
"testcase": [
{
"classname": "convert xml2js output basic",
"name": "convert xml2js output basic",
"time": 0.01
}
]
},
{
"name": "__tests__/snapshot.test.ts",
"errors": 0,
"failures": 1,
"skipped": 0,
"timestamp": "2020-01-26T13:45:02",
"time": 1.105,
"tests": 1,
"testcase": [
{
"classname": "parse snapshot nunit failure xml",
"name": "parse snapshot nunit failure xml",
"time": 0.013,
"failure": [
{
"inner": "Error: Something wrong."
}
]
}
]
}
]
}
```
# Filter some tags
If you want to filter some tags like `` or ``, you can use `replacer` function argument in [`JSON.stringify()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify).
```ts
const output = await parse(xmlString)
const replacer = (key: any, value: any) => {
if (key === 'system-out' || key === 'system-err') return undefined
return value
}
console.log(JSON.stringify(output, replacer, 2))
```
# Notice
ts-junit2json changes the structure of some tags for simpler and more consistent output.
- XML Tag inner text is set to value of 'inner' key.
- The only exceptions are `` and ``. These inner text is set to the string array.
- Example: [snapshot.test.ts.snap](./__tests__/__snapshots__/snapshot.test.ts.snap)
# CLI
```bash
npx junit2json junit.xml
# with full options
npx junit2json -p -f system-out,system-err junit.xml
```
```
junit2json
Convert JUnit XML format to JSON
Positionals:
path JUnit XML path [string]
Options:
--help Show help [boolean]
--version Show version number [boolean]
-p, --pretty Output pretty JSON [boolean]
-f, --filter-tags Filter XML tag names [string]
Examples:
junit2json -p -f system-out,system-err Output pretty JSON with filter
junit.xml and tags.
```
## CLI with `jq` examples
### Count testcases
```bash
npx junit2json junit.xml | jq .tests
```
### Show testsuite names
```bash
npx junit2json junit.xml | jq .testsuite[].name
```
### Show testcase classnames
```bash
npx junit2json junit.xml | jq .testsuite[].testcase[].classname
```
# References
JUnit XML format
- https://llg.cubic.org/docs/junit/
- https://github.com/junit-team/junit5/blob/main/platform-tests/src/test/resources/jenkins-junit.xsd
# API reference
https://jsr.io/@kesin11/junit2json/doc
# License
MIT