580620 - Implement a general assert function (to replace assertJS in nearly all cases)

Status: VERIFIED FIXED

(Testing Graveyard :: Mozmill, defect)

Description

[Henrik Skupin [:whimboo][⌚️UTC+1] (away from Feb 12th - Feb 22nd)]

Similar to bug 579943 it would helpful to also have a general assert function available which also gives us the chance to specify a closure function for the evaluation and to remove the eval expression.

Patch is upcoming in a minute...

Comment 1

[Henrik Skupin [:whimboo][⌚️UTC+1] (away from Feb 12th - Feb 22nd)]

Attachment: Patch to introduce assert

Comment 2

[Jeff Hammel]

Comment on attachment 459005 [details] [diff] [review]
Patch to introduce assert

>diff --git a/mozmill/mozmill/extension/resource/modules/controller.js b/mozmill/mozmill/extension/resource/modules/controller.js
>index e0b1e56..02cdacd 100644
>--- a/mozmill/mozmill/extension/resource/modules/controller.js
>+++ b/mozmill/mozmill/extension/resource/modules/controller.js
>@@ -55,6 +55,7 @@ var aConsoleService = Components.classes["@mozilla.org/consoleservice;1"].
> 
> // Declare most used utils functions in the controller namespace
> var sleep = utils.sleep;
>+var assert = utils.assert;
> var waitFor = utils.waitFor;
> var waitForEval = utils.waitForEval;
> 
>@@ -685,18 +686,24 @@ MozMillController.prototype.assertValue = function (el, value) {
>   return false;
> };
> 
>+/**
>+ * Check if the callback function evaluates to true
>+ */
>+MozMillController.prototype.assert = function(callback)
>+{

<snip/>

> //Assert that a provided value is selected in a select element
>diff --git a/mozmill/mozmill/extension/resource/modules/utils.js b/mozmill/mozmill/extension/resource/modules/utils.js
>index f3f3ce8..9cc9a71 100644
>--- a/mozmill/mozmill/extension/resource/modules/utils.js
>+++ b/mozmill/mozmill/extension/resource/modules/utils.js
>@@ -403,6 +403,19 @@ function sleep(milliseconds) {
> }
> 
> /**
>+ * Check if the callback function evaluates to true
>+ */
>+MozMillController.prototype.assert = function(callback) {

Why is this also MozMillController.prototype.assert?  Should it just be `function assert()`

>+  var result = callback();
>+
>+  if (!result) {
>+    throw new Error(arguments.callee.name + ": Failed for '" + callback + "'");

I'd prefer if this was a new error type, AssertionError, but its not that important

Comment 3

[Jeff Hammel]

Comment on attachment 459005 [details] [diff] [review]
Patch to introduce assert

need clarification as to why you define MozMillController.prototype.assert twice (once in utils and once in controller)

Comment 4

[Heather Arthur [:harth]]

We should look into implementing (stealing code from node/narwhal) the commonJS assert module for mozmill 2.0 http://wiki.commonjs.org/wiki/Unit_Testing/1.0#Assert.

Comment 5

[Henrik Skupin [:whimboo][⌚️UTC+1] (away from Feb 12th - Feb 22nd)]

Attachment: Patch v2

Comment 6

[Jeff Hammel]

Comment on attachment 460862 [details] [diff] [review]
Patch v2

looks good

Comment 7

[Henrik Skupin [:whimboo][⌚️UTC+1] (away from Feb 12th - Feb 22nd)]

Merged with master and 1.4.2:
http://github.com/mozautomation/mozmill/commit/31ef72a6aba6324f4df052b125bd1e83dcb99fd2
http://github.com/mozautomation/mozmill/commit/cb6a77d77eb4540c1827f25b43c0e6755b94f3fe

Comment 8

[Henrik Skupin [:whimboo][⌚️UTC+1] (away from Feb 12th - Feb 22nd)]

We missed to declare this function inside exported symbols. I have landed a breakage fix:

http://github.com/mozautomation/mozmill/commit/304714b64270f1a7584f59d54475df7b459bee10
http://github.com/mozautomation/mozmill/commit/85379f77b48e08fd4ff0a763dbcebca2fcad6ece

Comment 9

[Geo Mealer [:geo] -- This account is inactive after 2015-07-07]

Verified via running sample code for pass and fail

Comment 10

[Henrik Skupin [:whimboo][⌚️UTC+1] (away from Feb 12th - Feb 22nd)]

Documentation added:
https://developer.mozilla.org/en/Mozmill/Mozmill_Controller_Object#assert()