npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jasmine-ctrf-json-reporter

v0.0.5

Published

A Jasmine JSON test results reporter that follows the CTRF schema

Downloads

10,344

Readme

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:

| Name | Type | Required | Details | | ---------- | ------ | -------- | ----------------------------------------------------------------------------------- | | name | String | Required | The name of the test. | | status | String | Required | The outcome of the test. One of: passed, failed, skipped, pending, other. | | duration | Number | Required | The time taken for the test execution, in milliseconds. | | message | String | Optional | The failure message if the test failed. | | trace | String | Optional | The 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.