@applitools/eyes-storybook 3.27.3 → 3.27.4

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## 3.27.4 - 2022/2/9
+
+- updated to @applitools/driver@1.4.9 (from 1.4.7)
+- updated to @applitools/eyes-sdk-core@13.0.0 (from 12.24.9)
+- updated to @applitools/logger@1.0.9 (from 1.0.8)
+- updated to @applitools/visual-grid-client@15.8.62 (from 15.8.55)
+- support adding new test(s) and the value of saveNewTest is false will warn
+- README.md update default value of 'exitcode' to 'true' (from 'false')
+- updated to @applitools/driver@1.4.12 (from 1.4.9)
+- updated to @applitools/eyes-sdk-core@13.0.2 (from 13.0.0)
+- updated to @applitools/logger@1.0.10 (from 1.0.9)
+- updated to @applitools/visual-grid-client@15.8.63 (from 15.8.62)
+- updated to @applitools/utils@1.2.12 (from 1.2.11)
 
 ## 3.27.3 - 2022/1/26
 

package/README.md

@@ -153,7 +153,7 @@ In addition to command-line arguments, it's possible to define the following con
 | `storybookStaticDir`      | undefined                   | Path to Storybook's static files folder (also available as command-line argument). |
 | `showStorybookOutput`     | undefined                   | Whether or not you want to see Storybook output (also available as command-line argument). |
 | `viewportSize`            | { width: 1024, height: 600} | The size of the puppeteer browser's window. This is the browser window which renders the stories originally (and opens at the size provided in the `viewportSize` parameter), and then a DOM snapshot is uploaded to the server, which renders this snapshot on all the browsers and sizes provided in the `browser` parameter.|
-| `exitcode`                | false                       | If tests failed close with non-zero exit code (also available as command-line argument). |
+| `exitcode`                | true                       | If tests failed close with non-zero exit code (also available as command-line argument). |
 | `browser`                 | { width: 800, height: 600, name: 'chrome' } | The size and browser of the generated screenshots. For more info and possible values, see the [browser section below](#configuring-the-browser).|
 | `showLogs`                | false                       | Whether or not you want to see logs of the Eyes-Storybook plugin. |
 | `batch`                     | undefined                   | An object which describes different aspects of the batch. The following lines in this table depict the various ways to configure the batch. |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-storybook",
-  "version": "3.27.3",
+  "version": "3.27.4",
   "description": "",
   "engines": {
     "node": ">=8.6.0"
@@ -59,14 +59,15 @@
     "directory": "packages/eyes-storybook"
   },
   "dependencies": {
-    "@applitools/driver": "1.4.9",
-    "@applitools/eyes-sdk-core": "13.0.0",
+    "@applitools/driver": "1.4.12",
+    "@applitools/eyes-sdk-core": "13.0.2",
     "@applitools/functional-commons": "1.6.0",
-    "@applitools/logger": "1.0.9",
+    "@applitools/logger": "1.0.10",
     "@applitools/monitoring-commons": "1.0.19",
     "@applitools/spec-driver-puppeteer": "1.1.0",
     "@applitools/test-server": "1.0.8",
-    "@applitools/visual-grid-client": "15.8.62",
+    "@applitools/utils": "1.2.12",
+    "@applitools/visual-grid-client": "15.8.63",
     "boxen": "4.2.0",
     "chalk": "3.0.0",
     "detect-port": "1.3.0",
@@ -82,7 +83,6 @@
     "@applitools/sdk-release-kit": "0.13.11",
     "@applitools/sdk-shared": "0.9.11",
     "@applitools/snaptdout": "^1.0.1",
-    "@applitools/utils": "1.2.11",
     "@storybook/react": "^6.4.0",
     "@testing-library/dom": "^5.6.1",
     "babel-core": "^6.26.3",

package/src/cli.js

@@ -47,6 +47,7 @@ const {performance, timeItAsync} = makeTiming();
         results,
         totalTime,
         testConcurrency: config.testConcurrency,
+        saveNewTests: config.saveNewTests,
       });
       console.log(outputStr);
       if (config.jsonFilePath) {

package/src/processResults.js

@@ -2,17 +2,21 @@
 const flatten = require('lodash.flatten');
 const chalk = require('./chalkify');
 const {TestResultsError, TestResultsFormatter} = require('@applitools/eyes-sdk-core');
+const utils = require('@applitools/utils');
 const uniq = require('./uniq');
 const concurrencyMsg = require('./concurrencyMsg');
 
-function processResults({results = [], totalTime, testConcurrency}) {
+function processResults({results = [], totalTime, testConcurrency, saveNewTests = true}) {
   let outputStr = '\n';
   const formatter = new TestResultsFormatter();
-
+  const pluralize = utils.general.pluralize;
   let testResults = results.map(r => r.resultsOrErr);
   testResults = flatten(testResults).filter(r => r.constructor.name !== 'Error');
   const unresolved = testResults.filter(r => r.getIsDifferent());
   const passedOrNew = testResults.filter(r => !r.getIsDifferent());
+  const newTests = testResults.filter(r => r.getIsNew());
+  const newTestsSize = newTests.length;
+  const warnForUnsavedNewTests = !!(!saveNewTests && newTestsSize);
 
   let errors = results.map(({title, resultsOrErr}) =>
     Array.isArray(resultsOrErr)
@@ -31,10 +35,10 @@ function processResults({results = [], totalTime, testConcurrency}) {
 
   outputStr += '[EYES: TEST RESULTS]:\n\n';
   if (passedOrNew.length > 0) {
-    outputStr += testResultsOutput(passedOrNew);
+    outputStr += testResultsOutput(passedOrNew, warnForUnsavedNewTests);
   }
   if (unresolved.length > 0) {
-    outputStr += testResultsOutput(unresolved);
+    outputStr += testResultsOutput(unresolved, warnForUnsavedNewTests);
   }
   if (errors.length) {
     const sortedErrors = errors.sort((a, b) => a.title.localeCompare(b.title));
@@ -52,23 +56,38 @@ function processResults({results = [], totalTime, testConcurrency}) {
 
   if (errors.length && !unresolved.length) {
     outputStr += chalk.red(
-      `\nA total of ${errors.length} stor${
-        errors.length > 1 ? 'ies' : 'y'
-      } failed for unexpected error${errors.length > 1 ? 's' : ''}.`,
+      `\nA total of ${errors.length} stor${pluralize(errors, [
+        'ies',
+        'y',
+      ])} failed for unexpected error${pluralize(errors)}.`,
     );
   } else if (unresolved.length && !errors.length) {
     outputStr += chalk.keyword('orange')(
-      `\nA total of ${unresolved.length} difference${
-        unresolved.length > 1 ? 's were' : ' was'
-      } found.`,
+      `\nA total of ${unresolved.length} difference${pluralize(unresolved, [
+        's were',
+        ' was',
+      ])} found.`,
     );
   } else if (unresolved.length || errors.length) {
     outputStr += chalk.red(
-      `\nA total of ${unresolved.length} difference${
-        unresolved.length > 1 ? 's were' : ' was'
-      } found and ${errors.length} stor${errors.length > 1 ? 'ies' : 'y'} failed for ${
-        errors.length > 1 ? '' : 'an '
-      }unexpected error${errors.length > 1 ? 's' : ''}.`,
+      `\nA total of ${unresolved.length} difference${pluralize(unresolved, [
+        's were',
+        ' was',
+      ])} found and ${errors.length} stor${pluralize(errors, [
+        'ies',
+        'y',
+      ])} failed for ${pluralize(errors, ['', 'an '])}unexpected error${pluralize(errors)}.`,
+    );
+  } else if (warnForUnsavedNewTests) {
+    const countText =
+      newTestsSize > 1
+        ? `are ${newTestsSize} new tests`
+        : `is a new test: '${newTests[0].getName()}'`;
+    outputStr += chalk.red(
+      `\n'saveNewTests' was set to false and there ${countText}. Please approve ${pluralize(
+        newTestsSize,
+        ['their', 'its'],
+      )} baseline${pluralize(newTestsSize)} in Eyes dashboard.\n`,
     );
   } else if (passedOrNew.length) {
     outputStr += chalk.green(`\nNo differences were found!`);
@@ -93,7 +112,9 @@ function processResults({results = [], totalTime, testConcurrency}) {
       }),
     );
   });
-  const exitCode = passedOrNew.length && !errors.length && !unresolved.length ? 0 : 1;
+  const exitCode =
+    !warnForUnsavedNewTests && passedOrNew.length && !errors.length && !unresolved.length ? 0 : 1;
+
   return {
     outputStr,
     formatter,
@@ -101,7 +122,7 @@ function processResults({results = [], totalTime, testConcurrency}) {
   };
 }
 
-function testResultsOutput(results) {
+function testResultsOutput(results, warnForUnsavedNewTests) {
   let outputStr = '';
   const sortedTestResults = results.sort((a, b) => a.getName().localeCompare(b.getName()));
   sortedTestResults.forEach(result => {
@@ -110,7 +131,8 @@ function testResultsOutput(results) {
       .toString()}] - `;
 
     if (result.getIsNew()) {
-      outputStr += `${storyTitle}${chalk.blue('New')}\n`;
+      const newResColor = warnForUnsavedNewTests ? 'orange' : 'blue';
+      outputStr += `${storyTitle}${chalk.keyword(newResColor)('New')}\n`;
     } else if (result.isPassed()) {
       outputStr += `${storyTitle}${chalk.green('Passed')}\n`;
     } else {