merged hooks

Author: DavertMik

docs/basics.md

@@ -110,7 +110,7 @@ AfterSuite((I) => {
 ## Within
 
 To specify the exact area on a page where actions can be performed you can use `within` function.
-Everything executed in its context will be narrowed to context specified by locator: 
+Everything executed in its context will be narrowed to context specified by locator:
 
 Usage: within('section', ()=>{} )
 ```js
@@ -161,34 +161,6 @@ By default a custom console reporter is enabled.
 
 We are currently working on improving reporters support.
 
-## Bootstrap
-
-In case you need to execute arbitrary code before the tests,
-you can place it into your bootstrap file and provide a relative path to it in `codecept.json`
-
-```json
-"bootstrap": "./run_server.js"
-```
-
-To run `bootstrap` async, just export a function in your bootstrap file
-
-```js
-module.exports = function(done) {
-  // async instructions
-  // call done() to continue execution
-  // otherwise call done('error description')
-}
-```
-
-## Teardown
-
-In case you need to execute arbitrary code after the tests have run,
-you can place it into your teardown file and provide a relative path to it in `codecept.json`
-
-```json
-"teardown": "./stop_server.js"
-```
-
 ## Test Options
 
 Features and Scenarios have their options that can be set by passing a hash after their names:

docs/configuration.md

@@ -57,83 +57,6 @@ exports.config = {
 
 (Don't copy-paste this config, it's just demo)
 
-## Hooks
-
-Hooks are implemented as `bootstrap` and `teardown` options in config. You can use them to prepare test environment before execution and cleanup after.
-They can be used to launch stop webserver, selenium server, etc. There are different sync and async ways to define bootstrap and teardown functions.
-
-`bootstrap` and `teardown` options can be:
-
-* JS file, executed as is (synchronously).
-* JS file exporting a function; If function accepts a callback is executed asynchronously. See example:
-
-Config (`codecept.json`):
-
-```js
-  "bootstrap": "./bootstrap.js"
-```
-
-Bootstrap file (`bootstrap.js`):
-
-```js
-// bootstrap.js
-var server = require('./app_server');
-module.exports = function(done) {
-  // on error call done('error description') to stop
-  if (!server.validateConfig()) {
-    done("Can't execute server with invalid config, tests stopped");
-  }
-  // call done() to continue execution
-  server.launch(done);
-}
-```
-
-Pass error description inside a callback (`done('error')`) to prevent test execution on bootstrap.
-
-* JS file exporting an object with `bootstrap` and (or) `teardown` methods for corresponding hooks.
-
-Config (`codecept.json`):
-
-```js
-  "bootstrap": "./bootstrap.js"
-  "teardown": "./bootstrap.js"
-```
-
-Bootstrap file (`bootstrap.js`):
-
-```js
-// bootstrap.js
-var server = require('./app_server');
-module.exports = {
-  bootstrap: function(done) {
-    server.launch(done);
-  },
-  teardown: function(done) {
-    server.stop(done);
-  }
-}
-```
-
-* JS function in case of dynamic config. If function accepts a callback is executed asynchronously. See example:
-
-Config JS (`codecept.conf.js`):
-
-```js
-var server = require('./app_server');
-
-exports.config = {
-  bootstrap: function(done) {
-    server.launch(done);
-  },
-  teardown: function(done) {
-    server.stop(done);
-  }
-  // ...
-  // other config options
-}
-
-```
-
 ## Profile
 
 Using values from `process.profile` you can change the config dynamically.

docs/hooks.md

@@ -204,7 +204,11 @@ module.exports = function() {
 
 ```
 
+<<<<<<< HEAD
 Whenever you execute tests with `--verbose` option you will see registered events and promises executed by recorder.
+=======
+Whenever you execute tests with `--verbose` option you will see registered events and promises executed by a recorder.
+>>>>>>> hook-docs
 
 ### Output
 
@@ -261,4 +265,12 @@ container.append({
 })
 ```
 
-## done()
+<<<<<<< HEAD
+## done()
+=======
+## done()
+
+
+
+
+>>>>>>> hook-docs

lib/command/utils.js

@@ -38,25 +38,15 @@ module.exports.getConfig = function (configFile) {
   process.exit(1);
 };
 
-function isObject(item) {
-  return item && typeof item === 'object' && !Array.isArray(item);
-}
+// alias to deep merge
+module.exports.deepMerge = require('../utils').deepMerge;
 
-function deepMerge(target, source) {
-  if (isObject(target) && isObject(source)) {
-    for (const key in source) {
-      if (isObject(source[key])) {
-        if (!target[key]) Object.assign(target, { [key]: {} });
-        deepMerge(target[key], source[key]);
-      } else {
-        Object.assign(target, { [key]: source[key] });
-      }
-    }
-  }
-  return target;
+function getTestRoot(currentPath) {
+  if (!currentPath) currentPath = '.';
+  if (!path.isAbsolute(currentPath)) currentPath = path.join(process.cwd(), currentPath);
+  return currentPath = !path.extname(currentPath) ? currentPath : path.dirname(currentPath);
 }
-module.exports.deepMerge = deepMerge;
-
+module.exports.getTestRoot = getTestRoot;
 
 function getTestRoot(currentPath) {
   if (!currentPath) currentPath = '.';

lib/container.js

@@ -36,7 +36,8 @@ module.exports = {
   },
 
   append: (newContainer) => {
-    this.container = Object.assign(this.container, newContainer);
+    const deepMerge = require('./utils').deepMerge;
+    container = deepMerge(container, newContainer);
   },
 
   clear: (newHelpers, newSupport) => {

lib/output.js

@@ -92,7 +92,7 @@ module.exports = {
   },
 
   say: (message) => {
-    print(`   ${colors.cyan.bold(message)}`);
+    if (outputLevel >= 1) print(`   ${colors.cyan.bold(message)}`);
   },
 
   result: (passed, failed, skipped, duration) => {

lib/utils.js

@@ -2,6 +2,26 @@ var fs = require('fs');
 var path = require('path');
 var getParameterNames = require('get-parameter-names');
 
+function isObject(item) {
+  return item && typeof item === 'object' && !Array.isArray(item);
+}
+
+function deepMerge(target, source) {
+  if (isObject(target) && isObject(source)) {
+    for (const key in source) {
+      if (isObject(source[key])) {
+        if (!target[key]) Object.assign(target, { [key]: {} });
+        deepMerge(target[key], source[key]);
+      } else {
+        Object.assign(target, { [key]: source[key] });
+      }
+    }
+  }
+  return target;
+}
+
+module.exports.deepMerge = deepMerge;
+
 module.exports.fileExists = function (filePath) {
   try {
     fs.statSync(filePath);
@@ -74,7 +94,6 @@ module.exports.lcfirst = function (str) {
   return str.charAt(0).toLowerCase() + str.substr(1);
 };
 
-
 module.exports.hashCode = function (str) {
   /* Getting 32bit hashCode of string like in Java.
    *  Used in Screenshot name to provide short screenshot names

test/data/sandbox/steps.d.ts

@@ -4,6 +4,7 @@ let should = require('chai').should();
 let assert = require('assert');
 let path = require('path');
 let sinon = require('sinon');
+let FileSystem = require('../../lib/helper/FileSystem');
 
 describe('Container', () => {
 
@@ -78,7 +79,6 @@ describe('Container', () => {
 
   describe('#create', () => {
     it('should create container with helpers', () => {
-      let FileSystem = require('../../lib/helper/FileSystem');
       let config = {
         helpers: {
           MyHelper: {
@@ -114,6 +114,31 @@ describe('Container', () => {
     });
   });
 
+  describe('#append', () => {
+    it('should be able to add new helper', () => {
+      let config = {
+        helpers: {
+          FileSystem: {}
+        }
+      };
+      container.create(config);
+      container.append({helpers: {
+        AnotherHelper: { method: () => 'executed' }
+      }});
+      assert.ok(container.helpers('FileSystem'));
+      container.helpers('FileSystem').should.be.instanceOf(FileSystem);
+
+      assert.ok(container.helpers('AnotherHelper'));
+      container.helpers('AnotherHelper').method().should.eql('executed');
+    });
 
+    it('should be able to add new support object', () => {
+      container.create({});
+      container.append({support: {userPage: { login: '#login' }}})
+      assert.ok(container.support('I'));
+      assert.ok(container.support('userPage'));
+      container.support('userPage').login.should.eql('#login');
+    });
+  });
 
 });