creevey 0.7.37 → 0.8.0-beta.0

package/CHANGELOG.md

@@ -1,18 +1,43 @@
-## [0.7.37](https://github.com/wKich/creevey/compare/v0.7.36...v0.7.37) (2021-08-27)
+# [0.8.0-beta.0](https://github.com/wKich/creevey/compare/v0.7.39...v0.8.0-beta.0) (2022-03-17)
 
 
 ### Bug Fixes
 
-* 🐛 save report data after each tests run ([86c6c2e](https://github.com/wKich/creevey/commit/86c6c2ee1261bdc38fc3b7c6ebb1753348339a0a))
-* 🐛 selenium url path to '/' for webkit browsers ([748d896](https://github.com/wKich/creevey/commit/748d8968c645ee684cec5dcd899d2de749d5e2c6)), closes [#176](https://github.com/wKich/creevey/issues/176)
+* 🐛 revert cross-env scripts, as they not work in unix ([92b04a5](https://github.com/wKich/creevey/commit/92b04a5bed56191b7ee6bd169f5327e30a1c2232))
 
 
 ### Features
 
-* 🎸 failFast doesn't disable maxRetries option ([c81c637](https://github.com/wKich/creevey/commit/c81c63784aecea890596647225ce8278d7383df5)), closes [#175](https://github.com/wKich/creevey/issues/175)
-* 🎸 improve delay option to allow specify browsers ([4bec3b5](https://github.com/wKich/creevey/commit/4bec3b5a4ddca2e2610db4ecf79f0e859202da65)), closes [#174](https://github.com/wKich/creevey/issues/174)
+* 🎸 change format for `skip` parameter ([f244b7c](https://github.com/wKich/creevey/commit/f244b7cd344b276762408a1df841e5afc3853fad))
+* 🎸 Improve skip options ([2fcc624](https://github.com/wKich/creevey/commit/2fcc624a9b2ab1dcdce3927779c8f58bb0a0d02c))
+* new creevey params: "global" and "kind" ([7d7c885](https://github.com/wKich/creevey/commit/7d7c88521a28c91586bfdd663500bea576845292))
+* support storybook 6.4 ([74010e5](https://github.com/wKich/creevey/commit/74010e53d93ff1815427cd7ee818481ce6e21288))
+
+
 
+## [0.7.39](https://github.com/wKich/creevey/compare/v0.7.38...v0.7.39) (2021-11-04)
+
+### Features
+
+- 🎸 add ability to update story arguments from test cases ([18d8ecb](https://github.com/wKich/creevey/commit/18d8ecb909097b585282a04bfb0b0c721ad45e22))
+
+## [0.7.38](https://github.com/wKich/creevey/compare/v0.7.37...v0.7.38) (2021-09-28)
+
+### Features
+
+- 🎸 add storiesProvider config option ([7cf7454](https://github.com/wKich/creevey/commit/7cf74542d527bcfd5b41b17026464a4f9298e1f5))
+
+## [0.7.37](https://github.com/wKich/creevey/compare/v0.7.36...v0.7.37) (2021-08-27)
+
+### Bug Fixes
+
+- 🐛 save report data after each tests run ([86c6c2e](https://github.com/wKich/creevey/commit/86c6c2ee1261bdc38fc3b7c6ebb1753348339a0a))
+- 🐛 selenium url path to '/' for webkit browsers ([748d896](https://github.com/wKich/creevey/commit/748d8968c645ee684cec5dcd899d2de749d5e2c6)), closes [#176](https://github.com/wKich/creevey/issues/176)
+
+### Features
 
+- 🎸 failFast doesn't disable maxRetries option ([c81c637](https://github.com/wKich/creevey/commit/c81c63784aecea890596647225ce8278d7383df5)), closes [#175](https://github.com/wKich/creevey/issues/175)
+- 🎸 improve delay option to allow specify browsers ([4bec3b5](https://github.com/wKich/creevey/commit/4bec3b5a4ddca2e2610db4ecf79f0e859202da65)), closes [#174](https://github.com/wKich/creevey/issues/174)
 
 ## [0.7.36](https://github.com/wKich/creevey/compare/v0.7.35...v0.7.36) (2021-07-30)
 

package/README.md

@@ -29,7 +29,7 @@ It named after [Colin Creevey](https://harrypotter.fandom.com/wiki/Colin_Creevey
 - [Examples](https://github.com/wKich/creevey-examples)
 - Advanced usage
   - [Write tests](docs/tests.md)
-  - [Use your Selenium Grid (BrowserStack/SauceLabs/etc)](docs/grid.md)
+  - [Use your Selenium Grid (LambdaTest/BrowserStack/SauceLabs/etc)](docs/grid.md)
 - [Future plans](#future-plans)
 - [Known issues](#known-issues)
 - [Used by](#used-by)

package/docs/config.md

@@ -112,7 +112,19 @@ module.exports = {
 
 ### Storybook parameters
 
-Also you could define parameters on `kind` or `story` levels. All these parameters are deeply merged by storybook for each story.
+Also you could define parameters on `global`, `kind` or `story` levels. All these parameters are deeply merged by Storybook for each story. But bear in mind when you define skip option as an array Storybook treats it as primitive value and doesn't merge with other skip options.
+
+```tsx
+// .storybook/preview.tsx
+export const parameters = {
+  creevey: {
+    // Skip all *hover tests in IE11 on the global level
+    skip: {
+      ie11: { in: 'ie11', tests: /.*hover$/ },
+    },
+  },
+};
+```
 
 ```tsx
 import React from 'react';
@@ -126,12 +138,12 @@ export default {
     creevey: {
       // You could skip some browsers/stories or even specific tests
       skip: [
-        { in: 'ie11', reason: '`MyComponent` do not support IE11' },
-        { in: 'firefox', stories: 'Loading' },
+        { in: 'ie11', reason: "`MyComponent` doesn't support ie11" },
+        { in: 'firefox', stories: 'Loading', reason: "Loading stories are flaky in firefox" },
         {
           in: ['firefox', 'chrome'],
           tests: /.*hover$/,
-          reason: 'For some reason `MyComponent` hovering do not work correctly',
+          reason: "For some reason `MyComponent` hovering doesn't work correctly",
         },
       ],
     },
@@ -155,6 +167,18 @@ Basic.parameters = {
 
 ### `skip` option examples:
 
+```ts
+interface SkipOption {
+  reason?: string;
+  in?: string | string[] | RegExp;
+  kinds?: string | string[] | RegExp;
+  stories?: string | string[] | RegExp;
+  tests?: string | string[] | RegExp;
+}
+
+type SkipOptions = SkipOption | SkipOption[] | Record<string, SkipOption | SkipOption[]>;
+```
+
 - Skip all stories for all browsers:
   - `skip: true`
   - `skip: 'Skip reason message'`
@@ -175,6 +199,14 @@ Basic.parameters = {
   - `skip: { tests: 'click' }`
   - `skip: { tests: ['hover', 'click'] }`
   - `skip: { tests: /^press.*$/ }`
-- Multiple skip options: `skip: [{ /* ... */ }]`
+- Multiple skip options:
+  - as an array `skip: [{ /* ... */ }]`
+  - as an object
+    ```
+    skip: {
+      foo: { /* ... */ },
+      bar: { /* ... */ },
+    }
+    ```
 
 NOTE: If you try to skip stories by story name, the storybook name format will be used (For more info see [storybook-export-vs-name-handling](https://storybook.js.org/docs/formats/component-story-format/#storybook-export-vs-name-handling))

package/docs/grid.md

@@ -1,7 +1,8 @@
 ## Use your Selenium Grid (BrowserStack/SauceLabs/etc)
 
-Sometimes you already have Selenium Grid on one of many different e2e testing services, like BrowserStack or SauceLabs , or use self-hosted one. You could use these services. If your Selenium Grid located in same network where you going to start Creevey, you will need to define `gridUrl` parameter in Creevey config. Overwise you need to start tunneling tool depends of what Grid you use:
+Sometimes you already have Selenium Grid on one of many different e2e testing services, like LambdaTest, BrowserStack, or SauceLabs , or use a self-hosted one. You could use these services. If your Selenium Grid is located in the same network where you going to start Creevey, you will need to define `gridUrl` parameter in Creevey config. Overwise you need to start tunneling tool depending on what Grid you use:
 
+- [LambdaTest] (https://www.npmjs.com/package/@lambdatest/node-tunnel)
 - [browserstack-local](https://www.npmjs.com/package/browserstack-local)
 - [sauce-connect-launcher](https://www.npmjs.com/package/sauce-connect-launcher)
 - [open-ssh-tunnel](https://www.npmjs.com/package/open-ssh-tunnel)

package/lib/cjs/client/addon/Manager.js

@@ -7,6 +7,8 @@ exports.CreeveyManager = void 0;
 
 var _coreEvents = require("@storybook/core-events");
 
+var _shared = require("../../shared");
+
 var _types = require("../../types");
 
 var _creeveyClientApi = require("../shared/creeveyClientApi");
@@ -243,7 +245,7 @@ var CreeveyManager = /*#__PURE__*/function () {
 
     _defineProperty(this, "onSetStories", function (data) {
       // TODO: Send PR to storybook to fix this
-      var stories = data.v ? (0, _utils.denormalizeStoryParameters)(data) : data;
+      var stories = data.v ? (0, _shared.denormalizeStoryParameters)(data) : data.stories;
       _this.stories = stories;
     });
 

package/lib/cjs/client/addon/utils.js

@@ -4,15 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getEmojiByTestStatus = getEmojiByTestStatus;
-exports.denormalizeStoryParameters = exports.combineParameters = void 0;
-
-var _lodash = require("lodash");
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
 function getEmojiByTestStatus(status) {
   var skip = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
@@ -44,35 +35,4 @@ function getEmojiByTestStatus(status) {
         return '';
       }
   }
-} // NOTE: Copy-paste from storybook/api
-
-
-var combineParameters = function combineParameters() {
-  for (var _len = arguments.length, parameterSets = new Array(_len), _key = 0; _key < _len; _key++) {
-    parameterSets[_key] = arguments[_key];
-  }
-
-  return (// eslint-disable-next-line @typescript-eslint/no-unsafe-return
-    _lodash.mergeWith.apply(void 0, [{}].concat(parameterSets, [function (_, srcValue) {
-      // Treat arrays as scalars:
-      if (Array.isArray(srcValue)) return srcValue;
-      return undefined;
-    }]))
-  );
-}; // NOTE: Copy-paste from storybook/api
-
-
-exports.combineParameters = combineParameters;
-
-var denormalizeStoryParameters = function denormalizeStoryParameters(_ref) {
-  var globalParameters = _ref.globalParameters,
-      kindParameters = _ref.kindParameters,
-      stories = _ref.stories;
-  return (0, _lodash.mapValues)(stories, function (storyData) {
-    return _objectSpread(_objectSpread({}, storyData), {}, {
-      parameters: combineParameters(globalParameters, kindParameters[storyData.kind], storyData.parameters)
-    });
-  });
-};
-
-exports.denormalizeStoryParameters = denormalizeStoryParameters;
+}

package/lib/cjs/client/addon/withCreevey.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.withCreevey = withCreevey;
 
-var _coreEvents = _interopRequireDefault(require("@storybook/core-events"));
+var Events = _interopRequireWildcard(require("@storybook/core-events"));
 
 var polyfill = _interopRequireWildcard(require("event-source-polyfill"));
 
@@ -17,8 +17,6 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
@@ -49,14 +47,14 @@ function _resetCurrentStory() {
         switch (_context3.prev = _context3.next) {
           case 0:
             setTimeout(function () {
-              return channel.emit(_coreEvents.default.SET_CURRENT_STORY, {
+              return channel.emit(Events.SET_CURRENT_STORY, {
                 storyId: true,
                 name: '',
                 kind: ''
               });
             }, 0);
             return _context3.abrupt("return", new Promise(function (resolve) {
-              return channel.once(_coreEvents.default.STORY_MISSING, resolve);
+              return channel.once(Events.STORY_MISSING, resolve);
             }));
 
           case 2:
@@ -89,12 +87,12 @@ function catchRenderError(channel) {
   }
 
   function removeHandlers() {
-    channel.off(_coreEvents.default.STORY_ERRORED, errorHandler);
-    channel.off(_coreEvents.default.STORY_THREW_EXCEPTION, errorHandler);
+    channel.off(Events.STORY_ERRORED, errorHandler);
+    channel.off(Events.STORY_THREW_EXCEPTION, errorHandler);
   }
 
-  channel.once(_coreEvents.default.STORY_ERRORED, errorHandler);
-  channel.once(_coreEvents.default.STORY_THREW_EXCEPTION, exceptionHandler);
+  channel.once(Events.STORY_ERRORED, errorHandler);
+  channel.once(Events.STORY_THREW_EXCEPTION, exceptionHandler);
   return Object.assign(promise, {
     cancel: removeHandlers
   });
@@ -111,10 +109,10 @@ function waitForStoryRendered(channel) {
   }
 
   function removeHandlers() {
-    channel.off(_coreEvents.default.STORY_RENDERED, renderHandler);
+    channel.off(Events.STORY_RENDERED, renderHandler);
   }
 
-  channel.once(_coreEvents.default.STORY_RENDERED, renderHandler);
+  channel.once(Events.STORY_RENDERED, renderHandler);
   return Object.assign(promise, {
     cancel: removeHandlers
   });
@@ -188,7 +186,7 @@ function withCreevey() {
               renderPromise = waitForStoryRendered(channel);
               errorPromise = catchRenderError(channel);
               setTimeout(function () {
-                return channel.emit(_coreEvents.default.SET_CURRENT_STORY, {
+                return channel.emit(Events.SET_CURRENT_STORY, {
                   storyId: storyId,
                   name: name,
                   kind: kind
@@ -250,7 +248,7 @@ function withCreevey() {
   }
 
   function updateGlobals(globals) {
-    _addons.addons.getChannel().emit(_coreEvents.default.UPDATE_GLOBALS, {
+    _addons.addons.getChannel().emit(Events.UPDATE_GLOBALS, {
       globals: globals
     });
   }