currents convert

CLI tool for converting reports from various formats to Currents-compatible format

currents convert allows converting test reports created by various frameworks to a format compatible with Currents API. A typical workflow is:

• Run tests using your preferred framework and save the results in a file

• Convert the report using currents convert command

• Upload the report to Currents using currents upload command

Supported formats

The command converts files of one of the supported format, generated by the one of the supported frameworks.

Support frameworks

Format	Framework	Supported
JUnit XML	Postman	✅
JUnit XML	Vitest	👷🏾‍♀️ work in progress
JUnit XML	NodeJS Testing	👷🏾‍♀️ work in progress
JUnit XML	Cypress	👷🏾‍♀️ work in progress
JUnit XML	WebdriverIO	👷🏾‍♀️ work in progress

If you're interested in enabling support for more frameworks, please get in touch with our support team.

Usage

npx currents convert \
  --input-format=<format> \
  --input-file=<pattern> \
  --output-dir=<path> \
  --framework=<string> \
  --framework-version=<string>

npx currents convert \
  --input-format=junit \
  --input-file=./tests.xml \ 
  --output-dir=.currents/report-01 \ 
  --framework=postman \
  --framework-version=v11.20
# Reading the configuration
[currents] Convertion files: tests.xml
# Creating the config.json file...
# Converting files to internal Currents format
[currents] Conversion completed, report saved to: .currents/report-01

Configuration

currents convert options apart from --framework-version are required. Use --help flag to list the available options.

• --input-format

  • The format of the input test reports. Use the --help flag to see the supported formats

  • Type: junit

• --input-file

  • The pattern to search for test reports

  • Type: string

• -o, --output-dir

  • The directory to save the converted test reports

  • Type: string

• --framework

  • The testing framework used to generate the test reports

  • Type: postmane

• --framework-version

  • The version of the testing framework used to generate the test reports

  • Type: string

• --debug

  • Enable debug logs

  • Environment variable: DEBUG=currents*

  • Type: boolean