partial support for browser teardown strategy

Author: kbytesys

.gitignore

@@ -1,4 +1,4 @@
 .vscode
 node_modules
 package-lock.json
-. idea/
+.idea/

index.js

@@ -28,6 +28,7 @@ var config = {
     sharedObjects: './shared-objects',
     reports: './reports',
     browser: 'chrome',
+    browserTeardownStrategy: 'always',
     timeout: 15000
 };
 
@@ -44,6 +45,7 @@ program
     .option('-p, --pageObjects <path>', 'path to page objects. defaults to ' + config.pageObjects, config.pageObjects)
     .option('-o, --sharedObjects [paths]', 'path to shared objects (repeatable). defaults to ' + config.sharedObjects, collectPaths, [config.sharedObjects])
     .option('-b, --browser <path>', 'name of browser to use. defaults to ' + config.browser, config.browser)
+    .option('-k, --browser-teardown <optional>', 'browser teardown strategy after every scenario (always, clear, none). defaults to "none"', config.browserTeardownStrategy)
     .option('-r, --reports <path>', 'output path to save reports. defaults to ' + config.reports, config.reports)
     .option('-d, --disableLaunchReport [optional]', 'Disables the auto opening the browser with test report')
     .option('-j, --junit <path>', 'output path to save junit-report.xml defaults to ' + config.reports)
@@ -59,6 +61,7 @@ program.on('--help', function () {
 
 // store browserName globally (used within world.js to build driver)
 global.browserName = program.browser;
+global.browserTeardownStrategy = program.browserTeardown;
 
 // store Eyes Api globally (used within world.js to set Eyes)
 global.eyesKey = config.eye_key;

runtime/world.js

@@ -118,6 +118,9 @@ function createWorld() {
 
     // expose properties to step definition methods via global variables
     Object.keys(runtime).forEach(function (key) {
+        if (key === 'driver' && browserTeardownStrategy !== 'always') {
+            return;
+        }
 
         // make property/method available as a global (no this. prefix required)
         global[key] = runtime[key];
@@ -165,6 +168,23 @@ function importSupportObjects() {
     global.helpers = require('../runtime/helpers.js');
 }
 
+function teardownBrowser(driver) {
+    switch (browserTeardownStrategy) {
+        case 'none':
+            return new Promise(
+                 function(resolve, reject) {});
+        case 'clear':
+            return driver.manage().deleteAllCookies();
+        default:
+            // firefox quits on driver.close on the last window
+            return driver.close().then(function () {
+                if (browserName !== 'firefox'){
+                    return driver.quit();
+                }
+            });
+    }
+}
+
 // export the "World" required by cucumber to allow it to expose methods within step def's
 module.exports = function () {
 
@@ -180,10 +200,11 @@ module.exports = function () {
     // create the driver and applitools eyes before scenario if it's not instantiated
     this.registerHandler('BeforeScenario', function (scenario) {
 
-        if (!global.driver || !global.eyes) {
+        if (!global.driver) {
             global.driver = getDriverInstance();
+        }
 
-            // TOOD: this all feels a bit hacky, needs rethinking...
+        if (!global.eyes) {
             global.eyes = getEyesInstance();
         }
     });
@@ -214,7 +235,19 @@ module.exports = function () {
             fs.writeFileSync(junitOutputPath, xmlReport);
         }
 
-        done();
+        console.log(browserTeardownStrategy);
+
+        if (browserTeardownStrategy !== 'always') {
+            driver.close().then(function () {
+                if (browserName !== 'firefox'){
+                    return driver.quit();
+                }
+                done();
+            });
+        }
+        else {
+            done();
+        }
     });
 
     // executed after each scenario (always closes the browser to ensure fresh tests)
@@ -224,14 +257,8 @@ module.exports = function () {
             return driver.takeScreenshot().then(function (screenShot) {
 
                 scenario.attach(new Buffer(screenShot, 'base64'), 'image/png');
-                // firefox quits on driver.close on the last window
-                return driver.close().then(function () {
-                    if (browserName !== 'firefox'){
-                        return driver.quit();
-                    }
-                })
-                .then(function() {
 
+                teardownBrowser(driver).then(function() {
                     if (eyes) {
                         // If the test was aborted before eyes.close was called ends the test as aborted.
                         return eyes.abortIfNotClosed();
@@ -241,11 +268,6 @@ module.exports = function () {
                 });
             });
         }
-        // firefox quits on driver.close on the last window
-        return driver.close().then(function () {
-            if (browserName !== 'firefox'){
-                return driver.quit();
-            }
-        })
+        return teardownBrowser(driver);
     });
 };