Merge pull request #62 from mobify/release

Marlow Payne · web-flow · commit 3f7b7c6d89ea · 2016-08-01T15:59:51.000-07:00
Release 1.7.0
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,6 @@
 Status: **Ready for Review** or **Open for Visibility**
 Owner: 
-Reviewers: @ellenmobify @marlowpayne @mobify-derrick
+Reviewers: @ellenmobify @marlowpayne @mikenikles
 
 ## Changes
 - (change1)
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,7 @@
+1.7.0
+    - Introduces 'waitForContextsReady' command.
+1.6.3
+    - Fixes a bug in `waitForAjaxCompleted` in cases where `$` is not bound to jQuery.
 1.6.2
     - Update `preview` command to accept `site.js` files under `/system/site.js`
 1.6.1
diff --git a/README.md b/README.md
@@ -328,6 +328,26 @@ this.demoTest = function (browser) {
 };
 ```
 
+#### waitForContextsReady(expectedContextsCount, milliseconds, timeout, messages, callback)
+
+The `waitForContextsReady` command receives a number of expected contexts to check for, waits for a maximum time before timing out, and polls at a specified time interval. Used with Appium when testing hybrid mobile web apps. See http://nightwatchjs.org/api/contexts.html
+
+Parameter Name          | Parameter Type | Description
+-------------           | -------------- | -----------
+expectedContextsCount   | Number         | The condition to check against.
+milliSeconds            | Number         | _optional_ The number of milliseconds to poll before timeout.
+timeout                 | Number         | _optional_ The number of milliseconds between each poll.
+message                 | String         | _optional_ The message to output.
+callback                | Function       | _optional_ A function to call after the current command finishes execution.   
+
+```
+this.demoTest = function (browser) {
+    browser.waitForContextsReady(3, 8000);
+    // At this point, it is safe to switch the context to either the NATIVE
+    // context or any of the WEBVIEW_* contexts.
+};
+```
+
 #### waitForUrl(url, milliseconds, timeout, messages, callback)
 
 The `waitForUrl` command waits until the page URL is equal to the specified `url`.
diff --git a/commands/waitForAjaxCompleted.js b/commands/waitForAjaxCompleted.js
@@ -3,7 +3,7 @@ exports.command = function(callback) {
 
     // Uses waitForCondition to run code within the client browser
     //
-    return client.waitForCondition('return $.active;', 8000, function(result) {
+    return client.waitForCondition('return jQuery.active;', 8000, function(result) {
         if (typeof callback === 'function') {
             callback.call(client, result);
         }
diff --git a/commands/waitForContextsReady.js b/commands/waitForContextsReady.js
@@ -0,0 +1,71 @@
+var util = require('util'),
+    events = require('events');
+
+var CommandAction = function() {
+    events.EventEmitter.call(this);
+    this.startTimer = null;
+    this.cb = null;
+    this.ms = null;
+    this.selector = null;
+    this.protocol = require('nightwatch/lib/api/protocol.js')(this.client);
+};
+
+util.inherits(CommandAction, events.EventEmitter);
+
+CommandAction.prototype.command = function(expectedContextsCount, milliseconds, timeout, messages, callback) {
+
+    if (milliseconds && typeof milliseconds !== 'number') {
+        throw new Error('waitForContextsReady expects second parameter to be number; ' + typeof (milliseconds) + ' given');
+    }
+
+    var lastArgument = Array.prototype.slice.call(arguments, 0).pop();
+    if (typeof (lastArgument) === 'function') {
+        callback = lastArgument;
+    }
+
+    if (!messages || typeof messages !== 'object') {
+        messages = {
+            success: 'All contexts found after ',
+            timeout: 'Timed out while waiting for contexts after '
+        };
+    }
+
+    timeout = timeout && typeof (timeout) !== 'function' && typeof (timeout) !== 'object' ? timeout : 0;
+
+    this.startTimer = new Date().getTime();
+    this.cb = callback || function() {};
+    this.ms = milliseconds || 1000;
+    this.timeout = timeout;
+    this.messages = messages;
+    this.check(expectedContextsCount);
+    return this;
+};
+
+CommandAction.prototype.check = function(expectedContextsCount) {
+    var self = this;
+
+    this.protocol.contexts(function(result) {
+        var now = new Date().getTime();
+        var contextsCount = result.value ? result.value.length : -1;
+
+        if (expectedContextsCount === contextsCount) {
+            setTimeout(function() {
+                var msg = self.messages.success + (now - self.startTimer) + ' milliseconds.';
+                self.cb.call(self.client.api, result.value);
+                self.client.assertion(true, !!result.value, false, msg, true);
+                return self.emit('complete');
+            }, self.timeout);
+        } else if (now - self.startTimer < self.ms) {
+            setTimeout(function() {
+                self.check(expectedContextsCount);
+            }, 500);
+        } else {
+            var msg = self.messages.timeout + self.ms + ' milliseconds.';
+            self.cb.call(self.client.api, false);
+            self.client.assertion(false, false, false, msg, true);
+            return self.emit('complete');
+        }
+    });
+};
+
+module.exports = CommandAction;
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nightwatch-commands",
-  "version": "1.6.2",
+  "version": "1.7.0",
   "description": "A set of Mobify specific custom commands for Nightwatch.js",
   "repository": {
     "type": "git",
@@ -11,15 +11,16 @@
     "url": "https://github.com/mobify/nightwatch-commands/issues"
   },
   "devDependencies": {
-    "nightwatch": "0.8.6",
+    "nightwatch": "0.9.1",
     "nodeunit": "~0.8.4",
     "grunt": "0.4.5",
+    "grunt-cli": "~0.1.13",
     "grunt-eslint": "^17.0.0",
     "mobify-code-style": "^2.3.6"
   },
   "scripts": {
     "install": "node selenium/installation/install.js",
-    "test": "grunt lint"
+    "test": "./node_modules/.bin/grunt lint; ./node_modules/.bin/grunt test"
   },
   "homepage": "https://github.com/mobify/nightwatch-commands",
   "dependencies": {
diff --git a/tests/mocks.json b/tests/mocks.json
@@ -1,76 +1,89 @@
 {
-  "port" : 10195,
-  "mocks" : [
-    {
-      "url" : "/wd/hub/session",
-      "postdata" : "{\"desiredCapabilities\":{\"browserName\":\"firefox\",\"javascriptEnabled\":true,\"acceptSslCerts\":true,\"platform\":\"ANY\"},\"sessionId\":null}",
-      "response" : "{\"status\": 0, \"sessionId\": \"1352110219202\", \"value\": { \"javascriptEnabled\": true, \"browserName\": \"firefox\"}, \"state\": null}",
-      "responseHeaders" : {
-      },
-      "statusCode" : 200,
-      "method": "POST"
-    },
-    {
+    "port": 10195,
+    "mocks": [{
+        "url": "/wd/hub/session",
+        "postdata": "",
+        "response": "{\"status\": 0, \"sessionId\": \"1352110219202\", \"value\": { \"javascriptEnabled\": true, \"browserName\": \"firefox\", \"version\": \"TEST\", \"platform\": \"TEST\"}, \"state\": null}",
+        "responseHeaders": {},
+        "statusCode": 201,
+        "method": "POST"
+    }, {
       "url" : "/wd/hub/session/1352110219202",
-      "method": "DELETE"
-    },
-    {
+      "postdata" : "",
+      "response" : "{\"status\":0,\"value\":true}"
+    }, {
+      "url" : "/wd/hub/session/1352110219202",
+      "postdata" : "",
+      "response" : "{\"status\":0,\"value\":false}"
+    }, {
+      "url" : "/wd/hub/session/1352110219202",
+      "method": "DELETE",
+      "postdata" : "",
+      "response" : "{\"status\":0,\"value\":false}"
+    }, {
+      "url" : "/wd/hub/session/1352110219202/url",
+      "method": "GET",
+      "postdata" : ""
+    }, {
       "url" : "/wd/hub/session/1352110219202/url",
+      "method": "POST",
       "postdata" : "{\"url\":\"http://localhost\"}"
-    },
-    {
-      "url" : "/wd/hub/test",
-      "response" : "{\"status\":0}"
-    },
-    {
-      "url" : "/wd/hub/test_error",
-      "response" : "{\"status\":7,\"value\":{\"screen\":\"screenshot_data\"}}",
-      "statusCode" : 500
-    },
-    {
-      "url" : "/wd/hub/session/1352110219202/element",
-      "postdata" : "{\"using\":\"css selector\",\"value\":\"body\"}",
-      "response" : "{\"sessionId\":\"1352110219202\",\"status\":0,\"value\":{\"ELEMENT\":\"0\"},\"class\":\"org.openqa.selenium.remote.Response\",\"hCode\":604376696}"
-    },
-    {
-      "url" : "/wd/hub/session/1352110219202/element",
-      "postdata" : "{\"using\":\"css selector\",\"value\":\"#weblogin\"}",
-      "response" : "{\"sessionId\":\"1352110219202\",\"status\":0,\"value\":{\"ELEMENT\":\"0\"},\"class\":\"org.openqa.selenium.remote.Response\",\"hCode\":604376696}"
-    },
-    {
-      "url" : "/wd/hub/session/1352110219202/buttondown",
-      "postdata" : "{\"button\":0}",
-      "response" : "{\"sessionId\":\"1352110219202\",\"status\":0,\"class\":\"org.openqa.selenium.remote.Response\",\"hCode\":604376696}"
-    },
-    {
+    }, {
+      "url" : "/wd/hub/session/1352110219202/url",
+      "method": "GET",
+      "postdata" : "",
+      "response" : "{\"value\":\"http://localhost/\",\"status\":0}"
+    }, {
+      "url" : "/wd/hub/session/null/url",
+      "method": "GET",
+      "postdata" : ""
+    }, {
       "url" : "/wd/hub/session/1352110219202/execute",
       "postdata" : "{\"script\":\"return true;\",\"args\":[]}",
       "response" : "{\"status\":0,\"value\":true}"
-    },
-    {
+    }, {
+      "url" : "/wd/hub/session/1352110219202/execute",
+      "postdata" : "{\"script\":\"return false\",\"args\":[]}",
+      "response" : "{\"status\":0,\"value\":false}"
+    }, {
       "url" : "/wd/hub/session/1352110219202/execute",
       "postdata" : "{\"script\":\"return Mobify.evaluatedData;\",\"args\":[]}",
       "response" : "{\"status\":0,\"value\":true}"
-    },
-    {
-      "url" : "/wd/hub/session/1352110219202/execute",
-      "postdata" : "{\"script\":\"var passedArgs = Array.prototype.slice.call(arguments,0); return function (sel, t) {        var event = new MouseEvent(t || 'click', {            'view': window,            'bubbles': true,            'cancelable': true        });        var el = document.querySelector(sel);        el.dispatchEvent(event);        return true;    }.apply(window, passedArgs);\",\"args\":[\".clickMe\",null]}",
+    }, {
+      "url" : "/wd/hub/session/null/execute",
+      "method": "POST",
+      "postdata": "{\"script\":\"var passedArgs = Array.prototype.slice.call(arguments,0); return function () {\\n        var framework = Mobify || Adaptive;\\n        return !!framework;\\n    }.apply(window, passedArgs);\",\"args\":[]}",
       "response" : "{\"status\":0,\"value\":true}"
-    },
-    {
+    }, {
       "url" : "/wd/hub/session/1352110219202/execute",
-      "postdata" : "{\"script\":\"var passedArgs = Array.prototype.slice.call(arguments,0); return function (sel, t) {        var event = new MouseEvent(t || 'click', {            'view': window,            'bubbles': true,            'cancelable': true        });        var el = document.querySelector(sel);        el.dispatchEvent(event);        return true;    }.apply(window, passedArgs);\",\"args\":[\".clickMe\",\"click\"]}",
+      "method": "POST",
+      "postdata": "{\"script\":\"var passedArgs = Array.prototype.slice.call(arguments,0); return function () {\\n        var framework = Mobify || Adaptive;\\n        return !!framework;\\n    }.apply(window, passedArgs);\",\"args\":[]}",
       "response" : "{\"status\":0,\"value\":true}"
-    },
-    {
+    }, {
       "url" : "/wd/hub/session/1352110219202/execute",
+      "method": "POST",
       "postdata": "{\"script\":\"var passedArgs = Array.prototype.slice.call(arguments,0); return function (){        var framework = Mobify || Adaptive;        return !!framework;    }.apply(window, passedArgs);\",\"args\":[]}",
       "response" : "{\"status\":0,\"value\":true}"
-    },
-    {
+    }, {
+      "url" : "/wd/hub/session/1352110219202/execute",
+      "postdata": "{\"script\":\"var passedArgs = Array.prototype.slice.call(arguments,0); return function () {\\n        var framework = Mobify || Adaptive;\\n        return framework ? framework.evaluatedData : null;\\n    }.apply(window, passedArgs);\",\"args\":[]}",
+      "response" : "{\"status\":0,\"value\":true}"
+    }, {
+      "url" : "/wd/hub/session/1352110219202/execute",
+      "postdata" : "{\"script\":\"var passedArgs = Array.prototype.slice.call(arguments,0); return function (sel, t) {\\n        var event = new MouseEvent(t || 'click', {\\n            'view': window,\\n            'bubbles': true,\\n            'cancelable': true\\n        });\\n        var el = document.querySelector(sel);\\n        el.dispatchEvent(event);\\n        return true;\\n    }.apply(window, passedArgs);\",\"args\":[\".clickMe\",\"click\"]}",
+      "response" : "{\"status\":0,\"value\":true}"
+    }, {
+      "url" : "/wd/hub/session/1352110219202/execute",
+      "postdata" : "{\"script\":\"var passedArgs = Array.prototype.slice.call(arguments,0); return function (sel, t) {\\n        var event = new MouseEvent(t || 'click', {\\n            'view': window,\\n            'bubbles': true,\\n            'cancelable': true\\n        });\\n        var el = document.querySelector(sel);\\n        el.dispatchEvent(event);\\n        return true;\\n    }.apply(window, passedArgs);\",\"args\":[\".clickMe\",null]}",
+      "response" : "{\"status\":0,\"value\":true}"
+    }, {
       "url" : "/wd/hub/session/1352110219202/execute",
       "postdata" : "{\"script\":\"return $.active;\",\"args\":[]}",
       "response" : "{\"status\":0,\"value\":0}"
-    }
-  ]
+    }, {
+      "url" : "/wd/hub/session/1352110219202/contexts",
+      "method": "GET",
+      "postdata" : "",
+      "response" : "{\"status\":0,\"value\":[\"NATIVE\", \"WEBVIEW_1\", \"WEBVIEW_2\"]}"
+    }]
 }
diff --git a/tests/nightwatch.js b/tests/nightwatch.js
@@ -1,23 +1,40 @@
 var nightwatch = require('../node_modules/nightwatch');
 
 module.exports = {
-    init : function(callback) {
-        return nightwatch.client({
-            // desiredCapabilities: {
-            //   browserName: 'chrome'
-            // },
+    init: function(options, callback) {
+        var opts = {
+            seleniumPort: 10195,
+            silent: true,
+            output: false,
+            globals: {
+                myGlobal: 'test'
+            },
+            desiredCapabilities: {
+                browserName: 'chrome'
+            },
             /* eslint-disable camelcase */
             custom_commands_path: '../commands',
-            custom_assertions_path: '../assertions',
-            selenium_port : 10195,
+            custom_assertions_path: '../assertions'
             /* eslint-enable camelcase */
-            silent : true,
-            output : false
-        }).start().once('error', function() {
+        };
+
+        if (options) {
+            for (var prop in options) {
+                if (options.hasOwnProperty(prop)) {
+                    opts[prop] = options[prop];
+                }
+            }
+        }
+
+        return nightwatch.client(opts).on('selenium:session_create', function() {
+            if (callback) {
+                callback();
+            }
+        }).once('error', function() {
             if (callback) {
                 callback();
             }
             process.exit();
-        });
+        }).start();
     }
 };
diff --git a/tests/node_modules/mockserver.js b/tests/node_modules/mockserver.js
diff --git a/tests/run_tests.js b/tests/run_tests.js
diff --git a/tests/src/testWaitForContextsReady.js b/tests/src/testWaitForContextsReady.js

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ exports.command = function(callback) {`
`3`	`3`
`4`	`4`	`// Uses waitForCondition to run code within the client browser`
`5`	`5`	`//`
`6`		`- return client.waitForCondition('return $.active;', 8000, function(result) {`
	`6`	`+ return client.waitForCondition('return jQuery.active;', 8000, function(result) {`
`7`	`7`	`if (typeof callback === 'function') {`
`8`	`8`	`callback.call(client, result);`
`9`	`9`	`}`