@bugbeater/reporter

Overview

This project...

Setup

1. Install package with

   yarn add @bugbeater/reporter

   npm install @bugbeater/reporter

2. You must to add Test Case IDs to your tests. You can do this by adding the following to your tests title:

• For Jest:

  import { describe, test } from '@jest/globals';
  
  describe('Jest example describe', () => {
    test('@TC-4 jest example test', async () => {
      await new Promise((resolve) => setTimeout(resolve, 1000));
      expect(false).toBeTruthy();
    });
  
    test('@TC-5 jest example test', async () => {
      await new Promise((resolve) => setTimeout(resolve, 1000));
      expect(true).toBeTruthy();
    });
  
    test('@TC-6 jest example test', async () => {
      await new Promise((resolve) => setTimeout(resolve, 1000));
      expect(true).toBeTruthy();
    });
  });

• For Playwright:

  import { expect, test } from '@playwright/test';
  
  test.describe('Playwright', () => {
    test('@TC-4 has title', async () => {
      await new Promise((resolve) => setTimeout(resolve, 2000));
      expect(true).toBeFalsy();
    });
  
    test('@TC-5 get started link', async () => {
      await new Promise((resolve) => setTimeout(resolve, 2000));
      expect(false).toBeFalsy();
    });
  
    test.skip('@TC-6 is awesome', async () => {
      await new Promise((resolve) => setTimeout(resolve, 2000));
      expect(false).toBeFalsy();
    });
  });
  ```

3. Configure you tests to use the reporter.

• With Jest, add the following to your jest.config.js file:

module.exports = {
 ...
 reporters: [
   'default',
   ['@bugbeater/reporter/jest.js', {
     apiKey: process.env.BUGBEATER_API_KEY,
     baseUrl: process.env.BUGBEATER_BASE_URL,
     environments: ['dev', 'staging'],
   }],
 ],
 ...
}

• With Playwright, add the following to your playwright.config.js file:

  import { defineConfig } from '@playwright/test';
  import dotenv from 'dotenv';
  dotenv.config();
  
  export default defineConfig({
    reporter: [
      ['list'],
      [
        '@bugbeater/reporter/playwright.js',
        {
          apiKey: process.env.BUGBEATER_API_KEY,
          baseUrl: process.env.BUGBEATER_BASE_URL,
          environments: ['dev', 'staging'],
        },
      ],
    ],
  });

4. Set the following environment variables (or use a .env file):

• BUGBEATER_API_KEY: Your Bugbeater API key.
• BUGBEATER_BASE_URL: The base URL of Bugbeater main API.
• DEBUG: Set to bugbeater:reporter:* to enable debug logs. Example: bugbeater:reporter:*. See debug for more information.
• BUGBEATER_ENVIRONMENTS: A comma separated list of environments to report to. If not set, it will be empty. Example: "dev,staging,prod".

  Note: you can pass environment variables into reporter through the reporter options instead of using environment variables. Reporter options take precedence over environment variables.

License

This project is licensed under the terms of the license found in the LICENSE file.