Vai al contenuto principale

CucumberJS JSON Reporter

wdio-cucumberjs-json-reporter è un pacchetto di terze parti, per ulteriori informazioni consultare GitHub | npm

Un reporter WDIO che crea file JSON CucumberJS per WebdriverIO v8 e versioni superiori.

NPM

Cosa fa​

Questo reporter genererà un file JSON Cucumber per ogni feature che viene testata. Il file JSON può essere utilizzato con qualsiasi report che si desidera utilizzare come ad esempio multiple-cucumber-html-reporter.

Aggiungerà anche metadati sull'istanza in esecuzione al file delle feature e, ultimo ma non meno importante, darà la possibilità di aggiungere allegati all'output JSON.

Installazione​

Il modo più semplice è mantenere wdio-cucumberjs-json-reporter come devDependency nel tuo package.json.

{
  "devDependencies": {
    "wdio-cucumberjs-json-reporter": "^5.0.0"
  }
}

Puoi farlo semplicemente con:

npm install wdio-cucumberjs-json-reporter --save-dev

così verrà aggiunto automaticamente al tuo package.json

Le istruzioni su come installare WebdriverIO si trovano qui.

Configurazione​

Configura la directory di output e la lingua nel tuo file wdio.conf.js:

export const config = {
    // ...
    reporters: [
        // Così con le opzioni predefinite, vedi le opzioni di seguito
        'cucumberjs-json',

        // OPPURE così se vuoi impostare la cartella e la lingua
        [ 'cucumberjs-json', {
                jsonFolder: '.tmp/new/',
                language: 'en',
            },
        ],
    ],
  // ...
}

NON USARE ENTRAMBI I MODI PER AGGIUNGERE IL REPORTER, QUESTO È SOLO UN ESEMPIO!

Opzioni​

jsonFolder​

  • Tipo: String
  • Obbligatorio: No
  • Default: .tmp/json/

La directory in cui verranno archiviati i file JSON generati da questo report, relativamente a dove viene avviato lo script.

N.B.: Se utilizzi uno script npm dalla riga di comando, come ad esempio npm run test, il jsonFolder sarà relativo al percorso da cui viene eseguito lo script. L'esecuzione dalla root del tuo progetto creerà anche il jsonFolder nella root del tuo progetto.

language​

  • Tipo: String
  • Obbligatorio: No
  • Default: en

La lingua in cui sono scritti gli scenari Gherkin (predefinito inglese). L'elenco dei codici lingua e le relative parole chiave si trovano qui.

disableHooks​

  • Tipo: boolean
  • Obbligatorio: No
  • Default: false

I dettagli degli hook non faranno parte della generazione se questa proprietà è impostata su true.

reportFilePerRetry​

  • Tipo: boolean
  • Obbligatorio: No
  • Default: true

Quando una specifica viene riprovata, il report verrà aggiunto al file di report esistente dai tentativi precedenti se questa proprietà è impostata su false.

Esempio: ['cucumberjs-json', { jsonFolder: '.tmp/new/', language: 'en', disableHooks:true}]

Metadati​

Nota:
Questo attualmente non è supportato se stai utilizzando WebdriverIO V6, WebdriverIO V5 lo supporta ancora e WebdriverIO V7 lo supporta nuovamente

Come detto, questo report può memorizzare automaticamente i metadati della macchina/dispositivo corrente su cui è stata eseguita la feature.

Per personalizzarlo puoi aggiungerlo aggiungendo il seguente oggetto alle tue capabilities

// Example wdio.conf.js
export const config = {
    //..
    capabilities: [
        {
            browserName: 'chrome',
            // Add this
            'cjson:metadata': {
                // For a browser
                browser: {
                    name: 'chrome',
                    version: '58',
                },
                // for an app
                app: {
                  name: 'name.of.app.ipa',
                  version: '1.2.3',
                },
                device: 'MacBook Pro 15',
                platform: {
                    name: 'OSX',
                    version: '10.12.6'
                }
            },
        },
    ],
};

L'oggetto metadata deve avere il prefisso cjson, altrimenti non funzionerà!

Valori dei metadati​

metadata.app.name​

  • Tipo: string

es.: Il nome dell'app.

metadata.app.version​

  • Tipo: string

es.: La versione dell'app.

metadata.browser.name​

  • Tipo: string
  • Valori possibili: internet explorer | edge | chrome | firefox | safari

metadata.browser.version​

  • Tipo: string

es.: La versione del browser, può essere aggiunta manualmente o recuperata durante l'esecuzione dei test per ottenere il numero di versione esatto.

metadata.device​

  • Tipo: string

es.: Un nome che rappresenta il tipo di dispositivo. Ad esempio, se lo esegui su una macchina virtuale, puoi inserire qui Virtual Machine, o il nome del mobile, come ad esempio iPhone 7 Plus.

metadata.platform.name​

  • Tipo: string
  • Valori possibili: windows | osx | linux | ubuntu | android | ios

metadata.platform.version​

  • Tipo: string

es.: La versione della piattaforma

Se non fornisci l'oggetto browser nei metadati, questo modulo lo determinerà automaticamente per te. Sovrascriverà sempre con il valore più recente che può determinare.

Se non fornisci l'oggetto device e/o l'oggetto platform, verrà impostato di default su not known

Se non fornisci un browser.name o un browser.version, il modulo cercherà di determinarlo automaticamente.

Allegato​

Hai la possibilità di allegare dati al file JSON in tutti questi hook / step:

  • Before(All)
  • After(All)
  • Given
  • When
  • Then
  • And

L'unica cosa che devi fornire è il seguente codice nei tuoi file di step.

Per ES Modules (ESM)

import cucumberJson from 'wdio-cucumberjs-json-reporter';

// Allega una stringa (se non viene fornito alcun tipo, verrà automaticamente impostato a `text/plain`)
cucumberJson.attach('just a string');
cucumberJson.attach('just a second string', 'text/plain');

// Allega JSON
cucumberJson.attach({"json-string": true}, 'application/json');

// Allega uno screenshot in un hook before
cucumberJson.attach(await browser.takeScreenshot(), 'image/png');

Per CommonJS (CJS)

const { attach } = require("wdio-cucumberjs-json-reporter");

// Allega una stringa (se non viene fornito alcun tipo, verrà automaticamente impostato a `text/plain`)
attach('just a string');
attach('just a second string', 'text/plain');

// Allega JSON
attach({"json-string": true}, 'application/json');

// Allega uno screenshot in un hook before
attach(await browser.takeScreenshot(), 'image/png');

Usalo con multiple-cucumber-html-reporter​

Il modulo precedente per WebdriverIO V4, wdio-multiple-cucumber-html-reporter, aveva una connessione integrata con il modulo multiple-cucumber-html-reporter. Questo non è il caso per questo reporter perché la nuova configurazione di WebdriverIO V5 è basata su un'istanza che non mi permette di utilizzare gli hook onPrepare e onComplete.

Se vuoi comunque utilizzare il modulo multiple-cucumber-html-reporter puoi aggiungere quanto segue al tuo file di configurazione.

  • Installa il modulo con

    npm install multiple-cucumber-html-reporter --save-dev

  • Aggiungi questo al tuo file di configurazione

    import fs from 'node:fs/promises'
    // Import the module
    import { generate } from 'multiple-cucumber-html-reporter'

    // Example wdio.conf.js
    export const config = {
      //..

      // =====
      // Hooks
      // =====
      /**
       * Gets executed once before all workers get launched.
       */
      onPrepare: () => {
        // Remove the `.tmp/` folder that holds the json and report files
        return fs.rm('.tmp/', { recursive: true });
      },
      /**
       * Gets executed after all workers got shut down and the process is about to exit.
       */
      onComplete: () => {
        // Generate the report when it all tests are done
        generate({
          // Required
          // This part needs to be the same path where you store the JSON files
          // default = '.tmp/json/'
          jsonDir: '.tmp/json/',
          reportPath: '.tmp/report/',
          // for more options see https://github.com/wswebcreation/multiple-cucumber-html-reporter#options
        });
      }
    }

Versioni WebdriverIO precedenti​

QUESTO MODULO PUÒ FUNZIONARE SOLO CON WebdriverIO V8+!
Per V6 controlla la documentazione qui e usa la versione 2.0.4
Per V5 controlla la documentazione qui e usa la versione 1.3.0

QUESTO MODULO NON È UN SOSTITUTO DI wdio-multiple-cucumber-html-reporter. QUEL MODULO SUPPORTA SOLO WEBDRIVERIO V4 E CREA ANCHE UN REPORT. QUESTO MODULO CREA SOLO UN JSON, NON UN REPORT!!

Welcome! How can I help?

WebdriverIO AI Copilot