resus-reporters v0.9.2

Jest reporter

Jest test results processor for generating a summary in HTML

Installation

  npm install resus-reporters --save-dev

Usage

Configure Jest to process the test results by adding the following entry to the Jest config (jest.config.json):

"jest": {
  ...,
  "reporters": [
    "default",
    "resus-reporters"
  ],
  ...
}

As you run Jest from within the terminal, a file called jest_html_reporters.html will be created within your root folder containing information about your tests.

Available Options

The options below are specific to the reporter.

example add config options

...,
"reporters": [
  "default",
  ["resus-reporters", {
    "publicPath": "./html-report",
    "filename": "report.html",
    "expand": true
  }]
]

2.x updates

• Collapsable Test Groups

This feature regrading to #, if a test file has many test cases, here will show a Merge Data checkbox on the expanded table. You can check it to merge data and set the merge level to control how to combine those data.

For Example

• Attach screenshot to report

This feature regrading to #, this package will a new method named addAttach.

/**
 *
 * @param {Buffer | string} attach
 * @param {string} description of the picture
 */
const addAttach = async (attach, description) => { ... }

There are two params of this method, description is easy to understand. The param attach referring to the image, you can pass a buffer or string, if it was a buffer the package will help you create a dir named resus-cli-reporters-attach and save that buffer as a jpg image in it under the publicPath. if you have already saved the image, just pass the image's path as the attach param. Here is an Example with puppeteer.

// Example attach with **buffer**
const { addAttach } = require('resus-reporters/helper')
const puppeteer = require('puppeteer')

describe('just examples', () => {
  test('test buffer', async () => {
    const browser = await puppeteer.launch()
    const page = await browser.newPage()
    await page.goto('https://www.google.com')
    const data = await page.screenshot()
    await browser.close()
    await addAttach(data, 'test google 1')

    expect(1).toBe(1)
  })
})

// Example attach with **string**
const { addAttach } = require('resus-reporters/helper')
const puppeteer = require('puppeteer')
const path = require('path')

describe('just examples', () => {
  test('case string', async () => {
    const browser = await puppeteer.launch()
    const page = await browser.newPage()
    const filePath = path.resolve(__dirname, './test.jpg')
    await page.goto('https://www.google.com')
    const data = await page.screenshot({path: filePath})
    await browser.close()
    await addAttach(filePath, 'test google 2')

    expect(1).toBe(2)
  })
})

it will show like this

• Attach a message to the report

This feature is in regards to # & #. It allows you to add a message or log something to the html report with addMsg()

/**
 *
 * @param {string} message
 */
const addMsg = async (message) => { ... }

Only one parameter is required. If you stringify an object like this JSON.stringify(object, null, 2), the object will be prettified

Here is an Example with Nightmare.

const { addAttach, addMsg } = require('resus-reporters/helper')
const Nightmare = require('nightmare')
 
describe('Yet another example', () => {
  test('Both addAttach & addMsg with failure', async () => {
    const nightmare = Nightmare({ show: true })
    await addMsg(JSON.stringify({won: 1, too: 2}, null, 2))
    await nightmare
      .goto('https://duckduckgo.com')
    const s1 = await nightmare.screenshot();  
    await addAttach(s1, 'test duckduckgo 1')
    await nightmare.end();
    await addMsg(JSON.stringify(process, null, 2))
    expect(2).toEqual(1);
  }, 20000);  
  test('addMsg with success', async () => {
    await addMsg(JSON.stringify({free: 3, for: 4}, null, 2))
    expect(2).toEqual(2);
  });    
});

Message still displays without screenshots and with a successful test