@testomatio/reporter 0.4.5 → 0.5.0-beta.3

package/.eslintrc.js

@@ -3,36 +3,32 @@ module.exports = {
     commonjs: true,
     es6: true,
     node: true,
+    mocha: true,
   },
-  extends: ["airbnb-base"],
+  extends: ['airbnb-base', 'prettier'],
   globals: {
-    Atomics: "readonly",
-    SharedArrayBuffer: "readonly",
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly',
   },
   parserOptions: {
     ecmaVersion: 2018,
   },
   rules: {
-    "arrow-parens": 0,
-    "no-underscore-dangle": 0,
-    "class-methods-use-this": 0,
-    "no-restricted-syntax": 0,
+    'max-len': ['error', { code: 120 }],
+    'arrow-parens': 0,
+    'no-underscore-dangle': 0,
+    'class-methods-use-this': 0,
+    'no-restricted-syntax': 0,
     quotes: 0,
-    "no-console": 0,
-    "object-curly-newline": 0,
-    "consistent-return": 0,
-    "func-names": 0,
-    "prefer-const": 0,
-    "comma-dangle": 0,
-    "no-param-reassign": 0,
-    "operator-linebreak": 0,
-    "prefer-destructuring": 0,
-    "global-require": 0,
-    "no-use-before-define": 0,
-    "no-plusplus": 0,
-    "no-continue": 0,
-    "import/no-unresolved": 0,
-    "implicit-arrow-linebreak": 0,
+    'no-console': 0,
+    'no-continue': 0,
+    'no-use-before-define': 0,
+    'object-curly-newline': 0,
+    'consistent-return': 0,
+    'no-param-reassign': 0,
+    'operator-linebreak': 0,
+    'prefer-destructuring': 0,
+    'no-plusplus': 0,
     camelcase: 0,
   },
 };

package/.github/workflows/node.js.yml

@@ -24,6 +24,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           node-version: ${{ matrix.node-version }}
-          cache: "npm"
+          cache: 'npm'
       - run: npm i
       - run: npm run lint
+      - run: npm run test

package/.prettierrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  printWidth: 120,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  quoteProps: 'as-needed',
+  trailingComma: 'all',
+  bracketSpacing: true,
+  arrowParens: 'avoid',
+  endOfLine: 'lf',
+};

package/Changelog.md

@@ -1,21 +1,25 @@
+# 0.4.6
+
+- Fixed CodeceptJS reporter to report tests failed in hooks
+
 # 0.4.5
 
-* Fixed "Total XX artifacts publicly uploaded to S3 bucket" when no S3 bucket is configured
-* Improved S3 connection error messages
+- Fixed "Total XX artifacts publicly uploaded to S3 bucket" when no S3 bucket is configured
+- Improved S3 connection error messages
 
 # 0.4.4
 
-* Fixed returning 0 exit code when a process fails when running tests in parallel via `start-test-run`. Previously was using the last exit code returned by a process. Currently prefers the highest exit code that was returned by a process.
+- Fixed returning 0 exit code when a process fails when running tests in parallel via `start-test-run`. Previously was using the last exit code returned by a process. Currently prefers the highest exit code that was returned by a process.
 
 # 0.4.3
 
-* Added `TESTOMATIO_DISABLE_ARTIFACTS` env variable to disable publishing artifacts.
+- Added `TESTOMATIO_DISABLE_ARTIFACTS` env variable to disable publishing artifacts.
 
 # 0.4.2
 
-* print version of reporter
-* print number of uploaded artifacts
-* print access mode for uploaded artifacts
+- print version of reporter
+- print number of uploaded artifacts
+- print access mode for uploaded artifacts
 
 # 0.4.1
 
@@ -28,19 +32,19 @@ global.testomatioArtifacts.push('file/to/upload.png');
 
 # 0.4.0
 
-* Playwright: Introduced playwright/test support with screenshots and video artifacts
+- Playwright: Introduced playwright/test support with screenshots and video artifacts
 
 > Known issues: reporting using projects configured in Playwright does not work yet
 
-* CodeceptJS: added video uploads
+- CodeceptJS: added video uploads
 
 # 0.3.16
 
-* CodeceptJS: fixed reporting tests with empty steps (on retry)
+- CodeceptJS: fixed reporting tests with empty steps (on retry)
 
 # 0.3.15
 
-* Finish Run via API:
+- Finish Run via API:
 
 ```
 TESTOMATIO={apiKey} TESTOMATIO_RUN={runId} npx @testomatio/reporter@latest --finish
@@ -48,7 +52,7 @@ TESTOMATIO={apiKey} TESTOMATIO_RUN={runId} npx @testomatio/reporter@latest --fin
 
 # 0.3.14
 
-* Create an empty Run via API:
+- Create an empty Run via API:
 
 ```
 TESTOMATIO={apiKey} npx @testomatio/reporter@latest --launch
@@ -56,14 +60,14 @@ TESTOMATIO={apiKey} npx @testomatio/reporter@latest --launch
 
 # 0.3.13
 
-* Checking for a valid report URL
-* Sending unlimited data on test report
+- Checking for a valid report URL
+- Sending unlimited data on test report
 
 # 0.3.12
 
-* Fixed submitting arbitrary data on a test run
-* Jest: fixed sending errors with stack traces
-* Cypress: fixed sending reports
+- Fixed submitting arbitrary data on a test run
+- Jest: fixed sending errors with stack traces
+- Cypress: fixed sending reports
 
 # 0.3.11
 

package/README.md

@@ -1,60 +1,64 @@
 # @testomatio/reporter
 
-Send test run reports to your testomat.io project. Get the API key from testomat.
+Library for sending test run reports to your [testomat.io](https://testomat.io) project.
 
-You can refer sample tests from example folder of this repo. This is a basic example. If you need something full fledged you can refer this [example repo](https://github.com/testomatio/examples)
+## Installation
+
+Get the `{API_KEY}` from testomat.
+
+You can refer sample tests from example folder of this repo. This is a basic example. If you need something full fledged you can refer this [example repo](https://github.com/testomatio/examples).
 
 Add `@testomatio/reporter` package to your project:
 
-```
+```bash
 npm i @testomatio/reporter --save
 ```
 
-For testcafe use testcafe reporter
+For testcafe use testcafe reporter:
 
-```
+```bash
 npm i testcafe-reporter-testomatio
 ```
 
-## CodeceptJS
+## Usage
+
+### CodeceptJS
 
 Make sure you load all your tests using [check-test](https://github.com/testomatio/check-tests#cli).
 
-Add plugin to [codecept conf](https://github.com/testomatio/reporter/blob/master/example/codecept/codecept.conf.js#L23)
+Add plugin to [codecept conf](https://github.com/testomatio/reporter/blob/master/example/codecept/codecept.conf.js#L23):
 
-```js
+```javascript
 plugins: {
   testomatio: {
     enabled: true,
     require: '@testomatio/reporter/lib/adapter/codecept',
-    apiKey: process.env.API_KEY || 'API_KEY', // pass in api key via config or env variable
+    apiKey: process.env.TESTOMATIO || 'API_KEY', // pass in api key via config or env variable
   }
 }
 ```
 
-> **Get the API_KEY from your testomat console**
+Run the following command from you project folder:
 
-Run tests with
-
-```
-TESTOMATIO=<API_KEY> npx codeceptjs run`
+```bash
+TESTOMATIO={API_KEY} npx codeceptjs run
 ```
 
-### CodeceptJS Parallel Run
+#### CodeceptJS Parallel Run
 
-If tests run parallel, like workers in codeceptJS use `start-test-run` command to get proper reports
+If tests run parallel, like workers in CodeceptJS use `start-test-run` command to get proper reports:
 
-```
-TESTOMATIO=<API_KEY> npx start-test-run -c 'npx codeceptjs run-workers 2'
+```bash
+TESTOMATIO={API_KEY} npx start-test-run -c 'npx codeceptjs run-workers 2'
 ```
 
 > Specify a command to run with `-c` option in `start-test-run`
 
-## Playwright
+### Playwright
 
 Add a reporter to Playwright config:
 
-```
+```javascript
   reporter: [
     ['list'],
     ['@testomatio/reporter/lib/adapter/playwright.js', {
@@ -63,119 +67,147 @@ Add a reporter to Playwright config:
   ]
 ```
 
-Execute tests providing Api Key as TESTOMATIO environment variables:
+Run the following command from you project folder:
 
-```
-TESTOMATIO=<API_KEY> npx playwright test
+```bash
+TESTOMATIO={API_KEY} npx playwright test
 ```
 
-## Mocha
+### Mocha
 
-Load the test using using `check-test` if not done already. Get the test id from testomat account and add it to your mocha test like in this [example](https://github.com/testomatio/reporter/blob/master/example/mocha/test/index.test.js#L4)
+Load the test using using `check-test` if not done already. Get the test id from testomat account and add it to your mocha test like in this [example](https://github.com/testomatio/reporter/blob/master/example/mocha/test/index.test.js#L4).
 
-run the following command from you project folder
+Run the following command from you project folder:
 
-```sh
-mocha --reporter ./node_modules/testomat-reporter/lib/adapter/mocha.js  --reporter-options apiKey=API_KEY
+```bash
+mocha --reporter ./node_modules/testomat-reporter/lib/adapter/mocha.js --reporter-options apiKey={API_KEY}
 ```
 
-## Jest
+### Jest
 
-Load the test using using `check-test` . Add the test id to your tests like in this [example](https://github.com/testomatio/reporter/blob/master/example/jest/index.test.js#L1)
+Load the test using using `check-test`. Add the test id to your tests like in this [example](https://github.com/testomatio/reporter/blob/master/example/jest/index.test.js#L1).
 
-Add the following line to [jest.config.js](https://github.com/testomatio/reporter/blob/master/example/jest/jest.config.js#L100)
+Add the following line to [jest.config.js](https://github.com/testomatio/reporter/blob/master/example/jest/jest.config.js#L100):
 
-`reporters: ['default', ['../../lib/adapter/jest.js', { apiKey: API_KEY }]],`
+```javascript
+reporters: ['default', ['../../lib/adapter/jest.js', { apiKey: {API_KEY} }]],
+```
 
 Run your tests.
 
-## Cucumber
+### Cucumber
 
-Load you test using [`check-cucumber`](https://github.com/testomatio/check-cucumber)
+Load you test using [`check-cucumber`](https://github.com/testomatio/check-cucumber).
 
-Run cucumber test with this formatter and API key in environment in `TESTOMATIO`
+Run the following command from you project folder:
 
-```sh
-TESTOMATIO=api_key ./node_modules/.bin/cucumber-js --format ./node_modules/@testomatio/reporter/lib/adapter/cucumber.js
+```bash
+TESTOMATIO={API_KEY} ./node_modules/.bin/cucumber-js --format ./node_modules/@testomatio/reporter/lib/adapter/cucumber.js
 ```
 
-## TestCafe
+### TestCafe
 
-Load the test using using `check-test` .
+Load the test using using `check-test`.
 
-run the following command from you project folder
+Run the following command from you project folder:
 
-```sh
-TESTOMATIO={apiKey} npx testcafe chrome -r testomatio
+```bash
+TESTOMATIO={API_KEY} npx testcafe chrome -r testomatio
 ```
 
-## Protractor
+### Cypress
+
+Load the test using using `check-test`.
 
-Load the test using using `check-test` .
+Register our `cypress-plugin` in `cypress/plugins/index.js`:
 
-Add the following line to [conf.js](https://github.com/angular/protractor/blob/5.4.1/example/conf.js)
+```javascript
+const testomatioReporter = require('@testomatio/reporter/lib/adapter/cypress-plugin');
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+
+  testomatioReporter(on, config);
+
+  return config;
+};
+```
 
-```js
-const JasmineReporter = require("@testomatio/reporter/lib/adapter/jasmine");
+Run the following command from you project folder:
+
+```bash
+TESTOMATIO={API_KEY} npx cypress run
+```
+
+### Protractor
+
+Load the test using using `check-test`.
+
+Add the following line to [conf.js](https://github.com/angular/protractor/blob/5.4.1/example/conf.js):
+
+```javascript
+const JasmineReporter = require('@testomatio/reporter/lib/adapter/jasmine');
 
 exports.config = {
   onPrepare: () => {
-    jasmine
-      .getEnv()
-      .addReporter(new JasmineReporter({ apiKey: process.env.TESTOMATIO }));
+    jasmine.getEnv().addReporter(new JasmineReporter({ apiKey: process.env.TESTOMATIO }));
   },
 };
 ```
 
-run the following command from you project folder
+Run the following command from you project folder:
 
-```sh
-TESTOMATIO={apiKey}  npx @testomatio/reporter@latest -c 'npx protractor conf.js'
+```bash
+TESTOMATIO={API_KEY} npx @testomatio/reporter@latest -c 'npx protractor conf.js'
 ```
 
-# Advanced Usage
+## Advanced Usage
 
-## Adding Report to Run by ID
+### Adding Report to Run by ID
 
 This feature is widely used when a run is executed on CI.
 A run is created before the test is started and it is marked as `scheduled`. Then
-a report is assigned to that run using `TESTOMATIO_RUN` environment variable and ID of a run:
+a report is assigned to that run using `TESTOMATIO_RUN` environment variable and `{RUN_ID}` of a run:
 
-```sh
-TESTOMATIO={apiKey} TESTOMATIO_RUN={runId} <actual run command>
+```bash
+TESTOMATIO={API_KEY} TESTOMATIO_RUN={RUN_ID} <actual run command>
 ```
 
-## Setting Report Title
+### Setting Report Title
 
 Give a title to your reports by passing it as environment variable to `TESTOMATIO_TITLE`.
 
-```sh
-TESTOMATIO={apiKey} TESTOMATIO_TITLE="title for the report" <actual run command>
+```bash
+TESTOMATIO={API_KEY} TESTOMATIO_TITLE="title for the report" <actual run command>
 ```
 
-## Adding Report to RunGroup
+### Adding Report to RunGroup
 
 Create/Add run to group by providing `TESTOMATIO_RUNGROUP_TITLE`:
 
 ```sh
-TESTOMATIO={apiKey} TESTOMATIO_RUNGROUP_TITLE="Build ${BUILD_ID}" <actual run command>
+TESTOMATIO={API_KEY} TESTOMATIO_RUNGROUP_TITLE="Build ${BUILD_ID}" <actual run command>
 ```
 
-## Adding Environments to Run
+### Adding Environments to Run
 
 Add environments to run by providing `TESTOMATIO_ENV` as comma seperated values:
 
-```sh
-TESTOMATIO={apiKey} TESTOMATIO_ENV="Windows, Chrome" <actual run command>
+```bash
+TESTOMATIO={API_KEY} TESTOMATIO_ENV="Windows, Chrome" <actual run command>
 ```
 
-## Attaching Test Artifacts
+### Attaching Test Artifacts
 
 To save a test artifacts (screenshots and videos) of a failed test use S3 storage.
 Please note, that the **storage is not connected to Testomatio**.
 This allows you to store your artifacts on your own account and not expose S3 credentials.
 
-To save screenshots provide a configuration for S3 bucket via environment variables.
+To save screenshots provide a configuration for S3 bucket via environment variables:
 
 - **S3_REGION** - Region your bucket lies.
 - **S3_BUCKET** - Bucket name.
@@ -183,20 +215,20 @@ To save screenshots provide a configuration for S3 bucket via environment variab
 - **S3_SECRET_ACCESS_KEY** - Secret.
 - **S3_ENDPOINT** - for providers other than AWS
 
-By default tests artifacts are uploaded to bucket with `public-read` permission. 
-In this case uploaded files will be publicly accessible in Internet. 
-These public links will be used by Testomat.io to display images and videos.
+By default tests artifacts are uploaded to bucket with `public-read` permission.
+In this case uploaded files will be publicly accessible in Internet.
+These public links will be used by [testomat.io](https://testomat.io) to display images and videos.
 
-To upload files with `private` access bucket add `TESTOMATIO_PRIVATE_ARTIFACTS=1` environment value. 
-Then update provide the same S3 credentials in "Settings > Artifacts" section of a Testomat.io project,
-so Testomat.io could connect to the same bucket and fetch uploaded artifacts. 
+To upload files with `private` access bucket add `TESTOMATIO_PRIVATE_ARTIFACTS=1` environment value.
+Then update provide the same S3 credentials in "Settings > Artifacts" section of a [testomat.io](https://testomat.io) project,
+so [testomat.io](https://testomat.io) could connect to the same bucket and fetch uploaded artifacts.
 Links to files will be pre-signed and expires automatically in 10 minutes.
 
-Example upload configuration in environment variables
+Example upload configuration in environment variables:
 
 ##### AWS
 
-```
+```bash
 TESTOMATIO_PRIVATE_ARTIFACTS=1
 S3_ACCESS_KEY_ID=11111111111111111111
 S3_SECRET_ACCESS_KEY=2222222222222222222222222222222222222222222
@@ -206,7 +238,7 @@ S3_REGION=us-west-1
 
 ##### DigitalOcean
 
-```
+```bash
 TESTOMATIO_PRIVATE_ARTIFACTS=1
 S3_ENDPOINT=https://ams3.digitaloceanspaces.com
 S3_ACCESS_KEY_ID=11111111111111111111
@@ -217,7 +249,7 @@ S3_REGION=ams3
 
 ##### Minio
 
-```
+```bash
 S3_ENDPOINT=http://company.storage.com
 S3_ACCESS_KEY_ID=minio
 S3_SECRET_ACCESS_KEY=minio123
@@ -227,19 +259,18 @@ S3_FORCE_PATH_STYLE=true
 
 > It is important to add S3_FORCE_PATH_STYLE var for minio setup
 
-
 For local testing, it is recommended to store this configuration in `.env` file and load it with [dotenv](https://www.npmjs.com/package/dotenv) library.
 
 On CI set environment variables in CI config.
 
 Test artifacts are automatically uploaded for these test runners:
 
-* CodeceptJS 
-* Playwright
+- CodeceptJS
+- Playwright
 
 To manually attach an artifact and upload it for a test use `global.testomatioArtifacts` array:
 
-```js
+```javascript
 // attach a picture inside a test
 global.testomatioArtifacts.push('img/file.png');
 // attach a picture and add a name to it
@@ -250,28 +281,26 @@ Artifacts will be uploaded for the current test when it is finished.
 
 To disable uploading artifacts add `TESTOMATIO_DISABLE_ARTIFACTS` environment variable:
 
-```
+```bash
 TESTOMATIO_DISABLE_ARTIFACTS=1
 ```
 
+### Starting an Empty Run
 
-## Starting an Empty Run
+If you want to create a run and obtain its `{RUN_ID}` from [testomat.io](https://testomat.io) you can use `--launch` option:
 
-If you want to create a run and obtain its RunID from Testomat.io you can use `--launch` option:
-
-```sh
-TESTOMATIO={apiKey} npx @testomatio/reporter@latest --launch
+```bash
+TESTOMATIO={API_KEY} npx @testomatio/reporter@latest --launch
 ```
 
-This command will return RunID which you can pass to other testrunner processes.
+This command will return `{RUN_ID}` which you can pass to other testrunner processes.
 
 > When executed with `--launch` a command provided by `-c` flag is ignored
 
-## Manually Finishing Run
+### Manually Finishing Run
 
 If you want to finish a run started by `--launch` use `--finish` option. `TESTOMATIO_RUN` environment variable is required:
 
-```sh
-TESTOMATIO={apiKey} TESTOMATIO_RUN={runId} npx @testomatio/reporter@latest --finish
+```bash
+TESTOMATIO={API_KEY} TESTOMATIO_RUN={RUN_ID} npx @testomatio/reporter@latest --finish
 ```
-

package/example/codecept/codecept.conf.js

@@ -1,18 +1,18 @@
 exports.config = {
-  tests: "./*_test.js",
-  output: "./output",
+  tests: './*_test.js',
+  output: './output',
   helpers: {
     Puppeteer: {
-      url: "http://localhost",
+      url: 'http://localhost',
       show: true,
     },
   },
   include: {
-    I: "./steps_file.js",
+    I: './steps_file.js',
   },
   bootstrap: null,
   mocha: {},
-  name: "codecept",
+  name: 'codecept',
   plugins: {
     retryFailedStep: {
       enabled: false,
@@ -22,8 +22,8 @@ exports.config = {
     },
     testomat: {
       enabled: true,
-      require: "../../lib/adapter/codecept",
-      apiKey: "lz8ea4948ud5",
+      require: '../../lib/adapter/codecept',
+      apiKey: 'lz8ea4948ud5',
     },
   },
 };

package/example/codecept/index_test.js

@@ -1,10 +1,10 @@
-Feature("Suite 1 @S25e19ba9");
+Feature('Suite 1 @S25e19ba9');
 
-Scenario("Test issue for suite 1 @Tca70c8c4", (I) => {
-  I.amOnPage("https://github.com/login");
-  I.see("GitHub");
-  I.fillField("login", "randomuser_kmk");
-  I.fillField("password", "randomuser_kmk");
-  I.click("Sign in");
-  I.see("Repositories");
+Scenario('Test issue for suite 1 @Tca70c8c4', I => {
+  I.amOnPage('https://github.com/login');
+  I.see('GitHub');
+  I.fillField('login', 'randomuser_kmk');
+  I.fillField('password', 'randomuser_kmk');
+  I.click('Sign in');
+  I.see('Repositories');
 });

package/example/codecept/sample_test.js

@@ -1,6 +1,6 @@
-Feature("Suite 2 @S2bf55e11");
+Feature('Suite 2 @S2bf55e11');
 
-Scenario("Test for suite 2 @Tc2171bd2", (I) => {
-  I.amOnPage("https://github.com/login");
-  I.see("GitHub");
+Scenario('Test for suite 2 @Tc2171bd2', I => {
+  I.amOnPage('https://github.com/login');
+  I.see('GitHub');
 });

package/example/codecept/steps.d.ts

@@ -1,5 +1,5 @@
 /// <reference types='codeceptjs' />
-type steps_file = typeof import("./steps_file.js");
+type steps_file = typeof import('./steps_file.js');
 
 declare namespace CodeceptJS {
   interface SupportObject {

package/example/codecept/steps_file.js

@@ -1,8 +1,10 @@
 // in this file you can append custom step methods to 'I' object
 
-module.exports = function () {
+module.exports = function() {
   return actor({
+
     // Define custom steps here, use 'this' to access default methods of I.
     // It is recommended to place a general 'login' function here.
+
   });
-};
+}

package/example/core/index.js

@@ -1,14 +1,14 @@
-const { TestomatClient, TRConstants } = require("testomat-reporter");
+const { TestomatClient, TRConstants } = require('testomat-reporter');
 
-const client = new TestomatClient({ apiKey: "l5x5d5cd6pc3" });
+const client = new TestomatClient({ apiKey: 'l5x5d5cd6pc3' });
 
 client
   .createRun()
   .then(async () => {
-    await client.addTestRun("cc883e99", TRConstants.PASSED);
-    await client.addTestRun("7af2c281", TRConstants.PASSED);
-    await client.addTestRun("6603c29e", TRConstants.PASSED);
-    await client.addTestRun("95956b60", TRConstants.FAILED, "Test case failed");
+    await client.addTestRun('cc883e99', TRConstants.PASSED);
+    await client.addTestRun('7af2c281', TRConstants.PASSED);
+    await client.addTestRun('6603c29e', TRConstants.PASSED);
+    await client.addTestRun('95956b60', TRConstants.FAILED, 'Test case failed');
 
     client.updateRunStatus(TRConstants.FAILED);
   })