@applitools/eyes-cypress 3.25.0 → 3.25.3

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 ## Unreleased
 
 
+
+## 3.25.3 - 2022/3/29
+
+### Features
+### Bug fixes
+- consider batchId from config file and environments variable when closing batch
+- Fix config file parameters (e.g. `browser`) not being passed
+
+## 3.25.2 - 2022/3/23
+
+### Features
+### Bug fixes
+- fix Cypress Documentation inaccuracies
+- Support batchId, batchName and batchSequenceName from the config file, eyesOpen and environment variables
+
+## 3.25.1 - 2022/3/15
+
+- fix test script
+
 ## 3.25.0 - 2022/3/15
 
 - convert cypress to work on top of universal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-cypress",
-  "version": "3.25.0",
+  "version": "3.25.3",
   "main": "index.js",
   "license": "SEE LICENSE IN LICENSE",
   "bin": {
@@ -19,12 +19,12 @@
     "cypress:run": "cypress run --config-file test/fixtures/cypress-play.json --spec=test/fixtures/testApp/cypress/integration-play/play.js",
     "cypress:run:new": "node_modules/cypress-new/bin/cypress run --config-file test/fixtures/cypress-play.json --spec=test/fixtures/testApp/cypress/integration-play/play.js",
     "cypress:play": "cd test/fixtures/testApp && cypress run --config integrationFolder=cypress/integration-play,pluginsFile=cypress/plugins/index-play.js,supportFile=cypress/support/index-run.js --spec=cypress/integration-play/play.js",
-    "preversion": "yarn build && bongo preversion --skip-deps",
-    "version": "bongo version",
+    "preversion": "yarn build && bongo preversion --skip-deps --verifyPendingChanges",
+    "version": "bongo version --withPendingChanges",
     "postversion": "bongo postversion --skip-release-notification",
     "deps": "bongo deps",
     "generate:tests": "coverage-tests generate",
-    "test:coverage": "yarn generate:tests && cd test/coverage/generic &&  unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) cypress run ; cd -",
+    "test:coverage": "yarn generate:tests && cd test/coverage/generic &&  unset APPLITOOLS_API_KEY && APPLITOOLS_BATCH_NAME='JS Coverage Tests: eyes-selenium' APPLITOOLS_BATCH_ID=$(uuidgen) cypress run",
     "prepublish:setup": "sudo apt-get install xvfb"
   },
   "files": [
@@ -62,7 +62,7 @@
   "devDependencies": {
     "@applitools/scripts": "1.1.0",
     "@applitools/sdk-coverage-tests": "^2.3.18",
-    "@applitools/sdk-release-kit": "0.13.11",
+    "@applitools/sdk-release-kit": "1.2.1",
     "@applitools/snaptdout": "1.0.1",
     "@applitools/test-server": "1.0.8",
     "@applitools/test-utils": "1.1.5",

package/src/browser/eyesOpenMapping.js

@@ -1,6 +1,31 @@
 function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks}) {
   let browsersInfo = args.browser || appliConfFile.browser;
   let accessibilitySettings = args.accessibilityValidation || appliConfFile.accessibilityValidation;
+  const batch = {
+    id:
+      args.batchId ||
+      (args.batch ? args.batch.id : undefined) ||
+      appliConfFile.batchId ||
+      (appliConfFile.batch ? appliConfFile.batch.id : undefined),
+    name:
+      args.batchName ||
+      (args.batch ? args.batch.name : undefined) ||
+      appliConfFile.batchName ||
+      (appliConfFile.batch ? appliConfFile.batch.name : undefined),
+    sequenceName:
+      args.batchSequenceName ||
+      (args.batch ? args.batch.sequenceName : undefined) ||
+      appliConfFile.batchSequenceName ||
+      (appliConfFile.batch ? appliConfFile.batch.sequenceName : undefined),
+  };
+
+  if (!batch.name) {
+    delete batch['name'];
+  }
+  if (!batch.sequenceName) {
+    delete batch['sequenceName'];
+  }
+
   const mappedValues = [
     'accessibilityValidation',
     'browser',
@@ -9,6 +34,9 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
     'enablePatterns',
     'ignoreDisplacements',
     'ignoreCaret',
+    'batchName',
+    'batchId',
+    'batchSequenceName',
   ];
 
   if (browsersInfo) {
@@ -29,12 +57,13 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
     ignoreDisplacements: args.ignoreDisplacements || appliConfFile.ignoreDisplacements,
   };
 
+  const appliConfFileCopy = {...appliConfFile};
   for (const val of mappedValues) {
     if (args.hasOwnProperty(val)) {
       delete args[val];
     }
-    if (appliConfFile.hasOwnProperty(val)) {
-      delete appliConfFile[val];
+    if (appliConfFileCopy.hasOwnProperty(val)) {
+      delete appliConfFileCopy[val];
     }
   }
 
@@ -42,11 +71,12 @@ function eyesOpenMapValues({args, appliConfFile, testName, shouldUseBrowserHooks
     ...args,
     browsersInfo,
     defaultMatchSettings,
+    batch,
   };
 
   return Object.assign(
     {testName, dontCloseBatches: !shouldUseBrowserHooks},
-    appliConfFile,
+    appliConfFileCopy,
     mappedArgs,
   );
 }

package/src/plugin/config.js

@@ -15,9 +15,12 @@ function makeConfig() {
     ],
   });
 
-  if (!config.batch || !config.batch.id) {
-    config.batch = {id: uuid.v4(), ...config.batch};
+  if ((!config.batch || !config.batch.id) && !config.batchId) {
+    config.batch = {
+      id: uuid.v4(),
+    };
   }
+
   if (config.failCypressOnDiff === '0') {
     config.failCypressOnDiff = false;
   }

package/src/plugin/hooks.js

@@ -26,7 +26,7 @@ function makeGlobalRunHooks({closeManager, closeBatches, closeUniversalServer})
         }
         if (!config.appliConfFile.dontCloseBatches) {
           await closeBatches({
-            batchIds: [config.appliConfFile.batch.id],
+            batchIds: [config.appliConfFile.batchId || config.appliConfFile.batch.id],
             serverUrl: config.appliConfFile.serverUrl,
             proxy: config.appliConfFile.proxy,
             apiKey: config.appliConfFile.apiKey,