Add a new instruction - "abort"

Author: prantlf

Gruntfile.js

@@ -401,7 +401,16 @@ module.exports = function (grunt) {
           force: true
         },
         commands: [
-          { wait: true}
+          {wait: true}
+        ]
+      },
+      'abort': {
+        options: {
+          force: true
+        },
+        commands: [
+          {abort: 'Stop.'},
+          {file: 'aborted'}
         ]
       }
     },

INSTRUCTIONS.md

@@ -32,6 +32,7 @@ One of the instructions has to be present in every command. These properties are
 - [isNotSelected](#isnotselected)
 - [isNotVisible](#isnotvisible)
 - [isNotVisibleWithinViewport](#isnotvisiblewithinviewport)
+- [abort](#abort)
 - [file](#file)
 
 #### setViewport
@@ -610,6 +611,11 @@ The input string should contain selector of the element to check.
 }
 ```
 
+## abort
+Type: `String`
+
+Stops executing firther commands and fails current Grunt task with the specified message. It can be used to stop the tests at a specific point and investigate the situation in the web browser.
+
 ## file
 Type: `String`
 

README.md

@@ -270,6 +270,7 @@ One of the [instructions] has to be present in every command. These properties a
 * [isNotSelected](INSTRUCTIONS.md#isnotselected)
 * [isNotVisible](INSTRUCTIONS.md#isnotvisible)
 * [isNotVisibleWithinViewport](INSTRUCTIONS.md#isnotvisiblewithinviewport)
+* [abort](INSTRUCTIONS.md#abort)
 * [file](INSTRUCTIONS.md#file)
 
 #### options
@@ -496,6 +497,7 @@ your code using Grunt.
 
 ## Release History
 
+ * 2018-03-11  [v0.8.0]  Add a new instruction - "abort"
  * 2018-03-01  [v0.7.0]  Add optional automatic file numbering
  * 2018-02-28  [v0.6.0]  Add the allRequired option to the hasClass instruction
  * 2018-02-26  [v0.5.0]  Allow checking and setting various properties

package.json

@@ -26,8 +26,8 @@
     "node": ">= 4"
   },
   "scripts": {
-    "security": "test `node --version | cut -c 2` -ne 4 && nsp check || echo 'No vulnerabilities check possible on Node.js 4'",
-    "test": "npm run security && grunt",
+    "prepare": "test `node --version | cut -c 2` -ne 4 && nsp check || echo 'No vulnerabilities check possible on Node.js 4'",
+    "test": "grunt",
     "coverage": "grunt instrument && GRUNT_HTML_DOM_SNAPSHOT_COVERAGE=1 grunt",
     "coveralls": "test `node --version | cut -c 2` -eq 8 && npm run coverage && grunt coveralls",
     "semantic-release": "semantic-release",
@@ -36,21 +36,21 @@
   "dependencies": {
     "mkdirp": "^0.5.1",
     "pad-left": "^2.1.0",
-    "webdriverio": "^4.11.0"
+    "webdriverio": "^4.12.0"
   },
   "devDependencies": {
-    "grunt": "^1.0.1",
+    "grunt": "^1.0.2",
     "grunt-contrib-clean": "^1.1.0",
     "grunt-contrib-connect": "^1.0.2",
     "grunt-contrib-nodeunit": "^1.0.0",
     "grunt-coveralls": "^1.0.1",
     "grunt-eslint": "^20.1.0",
     "grunt-istanbul": "^0.8.0",
     "grunt-selenium-standalone": "^1.0.1",
-    "nsp": "^3.1.0",
+    "nsp": "^3.2.1",
     "phantomjs-prebuilt": "^2.1.16",
-    "semantic-release": "^12.4.1",
-    "travis-deploy-once": "^4.3.4"
+    "semantic-release": "^15.0.2",
+    "travis-deploy-once": "^4.4.0"
   },
   "peerDependencies": {
     "grunt": ">=0.4.5"

tasks/html-dom-snapshot.js

@@ -21,7 +21,7 @@ const fs = require('fs'),
         'isEnabled', 'isExisting', 'isFocused', 'isSelected', 'isVisible',
         'isVisibleWithinViewport', 'isNotEnabled', 'isNotExisting',
         'isNotFocused', 'isNotSelected', 'isNotVisible',
-        'isNotVisibleWithinViewport'
+        'isNotVisibleWithinViewport', 'abort'
       ].map(function (instruction) {
         return require('./instructions/' + instruction);
       });

tasks/instructions/abort.js

@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = {
+  detect: function (command) {
+    return !!command.abort;
+  },
+
+  perform: function (grunt, target, client, command) {
+    throw new Error('Aborted: "' + command.abort +
+                    '" in the target "' + target + '".\n' +
+                    JSON.stringify(command));
+  }
+};

test/test.js

@@ -91,5 +91,11 @@ exports['html-dom-snapshot'] = {
     const pages = readPages('scenario1.html');
     test.equal(pages.expected, pages.actual, 'scenario1.html');
     test.done();
+  },
+
+  'abort': function (test) {
+    const snapshot = fs.existsSync('test/snapshots/abort.html');
+    test.ok(!snapshot, 'abort.html');
+    test.done();
   }
 };