added set common plugin hook

Author: DavertMik

CHANGELOG.md

@@ -1,3 +1,7 @@
+0.8.0
+
+* Added `setCommonPlugins` hook
+
 0.7.0
 
 * Added `setTestHost` hook
@@ -7,4 +11,4 @@
 
 * Added `setBrowser` hook
 * Added try/catch block when taking cookie for `setSharedCookie`
-* CodeceptJS 3 compatibility
+* CodeceptJS 3 compatibility

README.md

@@ -61,6 +61,26 @@ const { setHeadlessWhen } = require('@codeceptjs/configure');
 // export DEV=true && npx codeceptjs run
 setHeadedWhen(process.env.DEV); 
 ```
+### setCommonPlugins
+
+Enables CodeceptJS plugins which are recommened for common usage.
+The list of plugins can be updated from version to version so this hook ensures that all of them are loaded and you won't need to update them in a config:
+
+```js
+// in codecept.conf.js
+const { setHeadlessWhen } = require('@codeceptjs/configure');
+
+setCommonPlugins();
+```
+
+These plugins will be loaded:
+
+* tryTo
+* retryFailedStep
+* retryTo
+* eachElement
+* pauseOnFail
+* screenshotOnFail
 
 ### setSharedCookies
 

hooks/setCommonPlugins.js

@@ -0,0 +1,14 @@
+const { config } = require('../codeceptjs');
+
+module.exports = function() {
+
+  config.addHook(cfg => {
+    if (!cfg.plugins) cfg.plugins = {};
+    cfg.plugins.tryTo = cfg.plugins.tryTo || { enabled: true };
+    cfg.plugins.retryFailedStep = cfg.plugins.retryFailedStep || { enabled: false };
+    cfg.plugins.retryTo = cfg.plugins.retryTo || { enabled: true };
+    cfg.plugins.eachElement = cfg.plugins.eachElement || { enabled: true };
+    cfg.plugins.pauseOnFail = cfg.plugins.pauseOnFail || {};
+    cfg.plugins.screenshotOnFail = cfg.plugins.screenshotOnFail || {};
+  });
+}

index.js

@@ -5,4 +5,5 @@ module.exports = {
   setWindowSize: require('./hooks/setWindowSize'),
   setBrowser: require('./hooks/setBrowser'),
   setTestHost: require('./hooks/setTestHost'),
+  setCommonPlugins: require('./hooks/setCommonPlugins'),
 }

package.json

@@ -27,7 +27,7 @@
   },
   "devDependencies": {
     "chai": "^4.2.0",
-    "codeceptjs": "^3.0.0",
+    "codeceptjs": "^3.3.0",
     "mocha": "^8.2.1",
     "puppeteer": "^2.1",
     "webdriverio": "^6.4.2"

test/index_test.js

@@ -7,6 +7,7 @@ const {
   setWindowSize,
   setBrowser,
   setTestHost,
+  setCommonPlugins,
 } = require('../index');
 
 describe('Hooks tests', () => {
@@ -308,4 +309,40 @@ describe('Hooks tests', () => {
       });
     });
   });  
+
+  describe('#setCommonPlugins', () => {
+    it('create standard plugins', () => {
+      Config.reset();
+      const config = {
+        helpers: {},
+      }
+      setCommonPlugins();
+      Config.create(config);
+      expect(Config.get()).to.have.nested.property(`plugins.screenshotOnFail`);
+      expect(Config.get()).to.have.nested.property(`plugins.tryTo`);
+      expect(Config.get()).to.have.nested.property(`plugins.retryTo`);
+      expect(Config.get()).to.have.nested.property(`plugins.eachElement`);
+    });
+
+    it('should not override plugins', () => {
+      Config.reset();
+      const config = {
+        helpers: {},
+        plugins: {
+          screenshotOnFail: { enabled: false },
+          otherPlugin: {}
+        }
+      }
+      setCommonPlugins();
+      Config.create(config);
+      expect(Config.get()).to.have.nested.property(`plugins.screenshotOnFail`);
+      expect(Config.get()).to.have.nested.property(`plugins.screenshotOnFail.enabled`);
+      expect(Config.get().plugins.screenshotOnFail.enabled).to.be.false;
+      expect(Config.get()).to.have.nested.property(`plugins.tryTo`);
+      expect(Config.get()).to.have.nested.property(`plugins.retryTo`);
+      expect(Config.get()).to.have.nested.property(`plugins.eachElement`);
+      expect(Config.get()).to.have.nested.property(`plugins.otherPlugin`);
+    });
+  });
+
 });