Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

jest-allure2

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jest-allure2

Allure Reports for jest

  • 1.2.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
564
decreased by-9.18%
Maintainers
1
Weekly downloads
 
Created
Source

Jest-Allure2

An up to date Jest reporter that produces Allure 2 reports.

NPM

Continuous Integration Continuous Deployment Known Vulnerabilities XO code style semantic-release License: MIT

Allure Report

Originally forked from jest-allure, this project uses the latest allure configuration ^2.0.0-beta.6.

Allure Framework is a flexible lightweight multi-language test report tool that not only shows a very concise representation of what have been tested in a neat web report form, but allows everyone participating in the development process to extract maximum of useful information from everyday execution of tests.

Features:

  • Most robust Allure API currently available to Jest.

  • Support for new attachment types that were not supported on previous versions.

  • Allure result files are now JSON, replacing the legacy XML format.

Requirements

ResourceDescription
JestA delightful JavaScript testing framework.
Allure 2 CLI"A Java jar command line tool that turns Allure result files into beautiful Allure reports."

:rocket: Quick start

  1. Add this package
yarn add --dev jest-allure2
  1. Update jest.setup.js
var {registerAllure} = require('jest-allure2')

registerAllure()
  1. Run tests
yarn test
  1. Generate the Allure report
allure generate

Advanced features

Add descriptions, screenshots, steps, severity and lots of other fancy details to the report.

The global variable will have a new allure object available with the following methods:

    allure.description(description: string): this;
    allure.severity(severity: Severity): this;
    allure.epic(epic: string): this;
    allure.feature(feature: string): this;
    allure.story(story: string): this;
    allure.step(name: string, status: string | (args:[any]) => string): this;
    allure.environment(name: string, value: string): this;
    allure.attachment(name: string, buffer: any, type: string): this;
    allure.label(name: string, value: string): this;
    allure.tag(name: string): this;
    allure.parameter(name: string, value: string): this;
    allure.issue(id: string): this;
    allure.tms(id: string): this;

Example

// Test subject
function sum(a: number, b: number): number {
  return a + b
}

// Tests
describe("Number functions", () => {
    beforeEach('Setup', ()=>{
        allure.severity(Severity.Critical)
        allure.feature(Feature.Billing)
        allure.story("BILL-217")
    })

    test("sum performs addition functionality", () => {
        allure.description("Tests should be ran when billing functionality is changed.")

        allure.step("Two integers can be added together.", () => {
            allure.parameter('a', 3)
            allure.parameter('b', 4)
            expect(sum(3,4)).toBe(7)
        })

        allure.step("Two floats can be added together", () => {
            allure.parameter('a', 3.141)
            allure.parameter('b', 2.571)
            expect(sum(3.141, 2.571)).toBe(5.712)
        })

        allure.step("Two objects can be added together", () => {
            const a = {"a": 1}
            const b = {"b": 2}

            allure.parameter('a', a)
            allure.parameter('b', b)
            expect(sum(a, b)).toMatchSnapshot()
        })
    });
});

:gear: Options

The main export registerAllure() accepts three optional configuration arguments:

ParameterDescriptionDefault
resultsDirFile path where result files are written."allure-results"
environmentInfoKey value pairs that will appear under the environment section of the Allure report{}
testMapperDecorator that receives Allure test result objects.undefined
// jest.setup.js
var resultsDir = 'allure-results'
var environmentInfo = {"Username": "User-1331", "password": "password-1331"}
var testMapper = results => {
    if (result.status == Status.SKIPPED) {
        result.fullName = `(WAS SKIPPED) ${result.fullName}`
    }
    return result
}

registerAllure(resultsDir, environmentInfo, testMapper)

Keywords

FAQs

Package last updated on 22 Jun 2020

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

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc