Socket
Book a DemoInstallSign in
Socket

jasmine-ctrf-json-reporter

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jasmine-ctrf-json-reporter

A Jasmine JSON test results reporter that follows the CTRF schema

0.0.5
latest
npmnpm
Version published
Weekly downloads
4.2K
4.87%
Maintainers
1
Weekly downloads
 
Created
Source

Jasmine JSON test results report

Save Jasmine test results as a JSON file

A jasmine JSON test reporter to create test reports that follow the CTRF standard.

Common Test Report Format ensures the generation of uniform JSON test reports, independent of programming languages or test framework in use.

Features

  • Generate JSON test reports that are CTRF compliant
  • Straightforward integration with jasmine

What is CTRF?

CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.

Consistency Across Tools: Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.

Language and Framework Agnostic: It provides a universal reporting schema that works seamlessly with any programming language and testing framework.

Facilitates Better Analysis: With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.

{
  "results": {
    "tool": {
      "name": "jasmine"
    },
    "summary": {
      "tests": 1,
      "passed": 1,
      "failed": 0,
      "pending": 0,
      "skipped": 0,
      "other": 0,
      "start": 1706828654274,
      "stop": 1706828655782
    },
    "tests": [
      {
        "name": "ctrf should generate the same report with any tool",
        "status": "passed",
        "duration": 100
      }
    ],
    "environment": {
      "appName": "MyApp",
      "buildName": "MyBuild",
      "buildNumber": "1"
    }
  }
}

Installation

npm install --save-dev jasmine-ctrf-json-reporter

Add the reporter to your spec/helpers file:

const CtrfReporter = require('jasmine-ctrf-json-reporter')

jasmine.getEnv().addReporter(new CtrfReporter({}))

Run your tests:

npx jasmine

You'll find a JSON file named ctrf-report.json in the ctrf directory.

Reporter Options

The reporter supports several configuration options:

jasmine.getEnv().addReporter(
  new CtrfReporter({
    outputFile: 'custom-name.json', // Optional: Output file name. Defaults to 'ctrf-report.json'.
    outputDir: 'custom-directory', // Optional: Output directory path. Defaults to 'ctrf'.
    appName: 'MyApp', // Optional: Specify the name of the application under test.
    appVersion: '1.0.0', // Optional: Specify the version of the application under test.
    osPlatform: 'linux', // Optional: Specify the OS platform.
    osRelease: '18.04', // Optional: Specify the OS release version.
    osVersion: '5.4.0', // Optional: Specify the OS version.
    buildName: 'MyApp Build', // Optional: Specify the build name.
    buildNumber: '100', // Optional: Specify the build number.
  })
)

Test Object Properties

The test object in the report includes the following CTRF properties:

NameTypeRequiredDetails
nameStringRequiredThe name of the test.
statusStringRequiredThe outcome of the test. One of: passed, failed, skipped, pending, other.
durationNumberRequiredThe time taken for the test execution, in milliseconds.
messageStringOptionalThe failure message if the test failed.
traceStringOptionalThe stack trace captured if the test failed.

Support Us

If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.

FAQs

Package last updated on 16 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.