feat(rules): add 'no-execute-script' rule

Author: alecxe

README.md

@@ -53,11 +53,15 @@ Rule                         | Default       | Options
 [no-absolute-url][]          | 1             |
 [no-expect-in-po][]          | 1             | requires plugin "settings"
 [no-promise-in-if][]         | 1             | 
+[no-execute-script][]        | 1             | requires plugin "settings"
 [by-css-shortcut][]          | 0             |
 
 For example, the `missing-perform` rule is enabled by default and will cause
 ESLint to throw an error (with an exit code of `1`) when triggered.
 
+The `requires plugin "settings"` note indicates that a rule needs the plugin to have configured settings in your eslint config.
+For example, `no-execute-script` rule expects configured paths to either spec, or page object files, or both. 
+
 You may customise each rule by adding a value in your `.eslintrc` `rules`
 property:
 
@@ -88,6 +92,7 @@ See [configuring rules][] for more information.
 [by-css-shortcut]: docs/rules/by-css-shortcut.md
 [no-expect-in-po]: docs/rules/no-expect-in-po.md
 [no-promise-in-if]: docs/rules/no-promise-in-if.md
+[no-execute-script]: docs/rules/no-execute-script.md
 [configuring rules]: http://eslint.org/docs/user-guide/configuring#configuring-rules
 
 ## Recommended configuration

docs/rules/no-execute-script.md

@@ -0,0 +1,25 @@
+# Recommend against executing scripts in specs and page objects
+
+This rule disallows using `browser.executeScript()` or `browser.executeAsyncScript()` or `browser.driver.executeScript()` or `browser.driver.executeAsyncScript()` inside spec files and page objects.
+Executing scripts should rather be a part of "helpers" or "libs".
+
+**Important:** This rule requires plugin `settings` to have the configured "glob"-style paths (see [`minimatch`](https://github.com/isaacs/minimatch) to learn more about the supported "glob" syntax) to distinguish Page Object and Spec files from others. 
+
+Edit your ESLint config and add (this is example configuration):
+
+    settings: {
+      "eslint-plugin-protractor":
+        paths: {
+          po: ["**/test/e2e/po/*.po.js"],
+          specs: ["**/test/e2e/specs/*.spec.js"]
+        }
+      }
+    }
+
+If neither `po`, nor `specs` is specified, the rule would be disabled.
+
+*Note: Because ESLint uses absolute paths and it is difficult to correctly locate base path of your project from within a plugin, so it is highly suggested to use complete paths to files you want to match to leverage the risk of targeting wrong directories and files.*
+
+## Rule details
+
+This rule would warn if it sees `browser.executeScript()` or `browser.executeAsyncScript()` or `browser.driver.executeScript()` or `browser.driver.executeAsyncScript()` function calls inside a file that matches at least one of the patterns configured in paths/po and paths/specs arrays.

index.js

@@ -18,6 +18,7 @@ var arrayCallbackReturn = require('./lib/rules/array-callback-return')
 var noAbsoluteURL = require('./lib/rules/no-absolute-url')
 var noExpectInPO = require('./lib/rules/no-expect-in-po')
 var noPromiseInIf = require('./lib/rules/no-promise-in-if')
+var noExecuteScript = require('./lib/rules/no-execute-script')
 
 module.exports = {
   rules: {
@@ -38,7 +39,8 @@ module.exports = {
     'array-callback-return': arrayCallbackReturn,
     'no-absolute-url': noAbsoluteURL,
     'no-expect-in-po': noExpectInPO,
-    'no-promise-in-if': noPromiseInIf
+    'no-promise-in-if': noPromiseInIf,
+    'no-execute-script': noExecuteScript
   },
   configs: {
     recommended: {
@@ -60,6 +62,7 @@ module.exports = {
         'protractor/no-absolute-url': 1,
         'protractor/no-expect-in-po': 1,
         'protractor/no-promise-in-if': 1,
+        'protractor/no-execute-script': 1,
         'protractor/by-css-shortcut': 0
       },
       globals: {

lib/is-browser-execute-script.js

@@ -0,0 +1,28 @@
+'use strict'
+
+/**
+ * @fileoverview Utility function to determine if a node is a browser.executeScript() or browser.driver.executeScript() or browser.executeAsyncScript() or browser.driver.executeAsyncScript() call
+ * @author Alexander Afanasyev
+ */
+module.exports = function (node) {
+  var object = node.callee.object
+  var property = node.callee.property
+
+  if (object && property) {
+    var isExecuteScript = property.name === 'executeScript'
+    var isExecuteAsyncScript = property.name === 'executeAsyncScript'
+
+    if (isExecuteScript || isExecuteAsyncScript) {
+      var isBrowser = object.name === 'browser'
+      var isBrowserDriver = object.object && object.object.name === 'browser' &&
+                                             object.property && object.property.name === 'driver'
+      if (isBrowser || isBrowserDriver) {
+        var objectName = isBrowser ? 'browser' : 'browser.driver'
+        var methodName = isExecuteScript ? 'executeScript()' : 'executeAsyncScript()'
+        return objectName + '.' + methodName
+      }
+    }
+  }
+
+  return false
+}

lib/rules/no-execute-script.js

@@ -0,0 +1,49 @@
+'use strict'
+
+/**
+ * @fileoverview Recommend against executing scripts in specs and page objects
+ * @author Alexander Afanasyev
+ */
+
+var isBrowserExecuteScript = require('../is-browser-execute-script')
+
+var PLUGIN_NAME = 'eslint-plugin-protractor'
+var multimatch = require('multimatch')
+
+module.exports = {
+  meta: {
+    schema: []
+  },
+
+  create: function (context) {
+    // do nothing if appropriate settings are not present
+    var settings = context.settings
+    if (!settings || !settings[PLUGIN_NAME] || !settings[PLUGIN_NAME].paths || !(settings[PLUGIN_NAME].paths.po || settings[PLUGIN_NAME].paths.specs)) {
+      return {}
+    }
+
+    // get glob matches
+    var filename = context.getFilename()
+    var patternsPO = settings[PLUGIN_NAME].paths.po || []
+    var patternsSpecs = settings[PLUGIN_NAME].paths.specs || []
+    var matches = multimatch(filename, patternsPO.concat(patternsSpecs))
+
+    // do nothing if a filename does not match pre-configured patterns
+    if (matches.length === 0) {
+      return {}
+    }
+
+    return {
+      'CallExpression': function (node) {
+        var result = isBrowserExecuteScript(node)
+
+        if (result) {
+          context.report({
+            node: node,
+            message: 'Unexpected "' + result + '"'
+          })
+        }
+      }
+    }
+  }
+}

test/rules/no-execute-script.js

@@ -0,0 +1,157 @@
+'use strict'
+
+var rule = require('../../lib/rules/no-execute-script')
+var RuleTester = require('eslint').RuleTester
+var eslintTester = new RuleTester()
+
+eslintTester.run('no-execute-script', rule, {
+  valid: [
+    {
+      code: 'var test = "bar"'
+    },
+
+    {
+      code: 'browser.executeScript("return 1;");'
+    },
+
+    {
+      code: 'browser.executeScript("return 2;");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            po: ['*.txt']
+          }
+        }
+      },
+      filename: '/usr/app/test/e2e/specs/test.spec.js'
+    },
+
+    {
+      code: 'browser.executeScript("return 3;");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            specs: ['*.somethingelse.js']
+          }
+        }
+      },
+      filename: 'test.spec.js'
+    },
+
+    {
+      code: 'browser.executeScript("return 4;");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            po: [],
+            specs: []
+          }
+        }
+      },
+      filename: 'test.po.js'
+    },
+
+    {
+      code: 'browser.executeScript("return 5;");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            specs: ['*.somethingelse1.js', '*.somethingelse2.js']
+          }
+        }
+      },
+      filename: 'test.spec.js'
+    },
+
+    {
+      code: 'browser.get("url");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            specs: ['**/*.spec.js', '*.spec.js']
+          }
+        }
+      },
+      filename: 'test.spec.js'
+    }
+  ],
+
+  invalid: [
+    {
+      code: 'browser.executeScript("return -1;");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            po: ['**/po/*.po.js']
+          }
+        }
+      },
+      filename: '/var/app/test/e2e/po/test.po.js',
+      errors: [{
+        message: 'Unexpected "browser.executeScript()"'
+      }]
+    },
+
+    {
+      code: 'browser.executeAsyncScript("return -2;");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            specs: ['**/*.spec.js']
+          }
+        }
+      },
+      filename: '/var/app/test/e2e/specs/test.spec.js',
+      errors: [{
+        message: 'Unexpected "browser.executeAsyncScript()"'
+      }]
+    },
+
+    {
+      code: 'browser.driver.executeScript("return -3;");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            po: ['**/*.somethingelse1.js', '**/*.po.js', '**/*.somethingelse2.js']
+          }
+        }
+      },
+      filename: '/var/app/test/e2e/po/test.po.js',
+      errors: [{
+        message: 'Unexpected "browser.driver.executeScript()"'
+      }]
+    },
+
+    {
+      code: 'browser.driver.executeAsyncScript("return -4;");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            po: [],
+            specs: ['**/*.somethingelse1.js', '**/*.spec.js', '**/*.somethingelse2.js']
+          }
+        }
+      },
+      filename: '/var/app/test/e2e/specs/test.spec.js',
+      errors: [{
+        message: 'Unexpected "browser.driver.executeAsyncScript()"'
+      }]
+    },
+
+    {
+      code: 'browser.executeAsyncScript("return -5;");',
+      settings: {
+        'eslint-plugin-protractor': {
+          paths: {
+            po: ['**/*.po.js'],
+            specs: ['**/*.somethingelse1.js', '**/*.somethingelse2.js']
+          }
+        }
+      },
+      filename: '/var/app/test/e2e/po/test.po.js',
+      errors: [{
+        message: 'Unexpected "browser.executeAsyncScript()"'
+      }]
+    }
+  ]
+})