|
| 1 | +'use strict' |
| 2 | + |
| 3 | +/** |
| 4 | + * @fileoverview Ensure correct locator argument type for `element()`, `element.all()`, `$()` and `$$()` |
| 5 | + * @author Alexander Afanasyev |
| 6 | + */ |
| 7 | + |
| 8 | +var isElementFinder = require('../is-element-finder') |
| 9 | +var isElementArrayFinder = require('../is-element-array-finder') |
| 10 | + |
| 11 | +// The first four "is" functions below are simple helper functions that help to distinguish between `$` vs `element`, and `$$` vs `element.all` |
| 12 | + |
| 13 | +/** |
| 14 | + * Checks if a given node is an ElementFinder represented by element() callee - both nested and not |
| 15 | + * |
| 16 | + * @param {ASTNode} node - A node to check. |
| 17 | + * @returns {boolean} |
| 18 | + */ |
| 19 | +function isElement (node) { |
| 20 | + return node.callee.name === 'element' || (node.callee.property && node.callee.property.name === 'element') |
| 21 | +} |
| 22 | + |
| 23 | +/** |
| 24 | + * Checks if a given node is an ElementArrayFinder represented by all() callee - both nested and not |
| 25 | + * |
| 26 | + * @param {ASTNode} node - A node to check. |
| 27 | + * @returns {boolean} |
| 28 | + */ |
| 29 | +function isElementAll (node) { |
| 30 | + return node.callee.property && node.callee.property.name === 'all' |
| 31 | +} |
| 32 | + |
| 33 | +/** |
| 34 | + * Checks if a given node is an ElementFinder represented by $() callee - both nested and not |
| 35 | + * |
| 36 | + * @param {ASTNode} node - A node to check. |
| 37 | + * @returns {boolean} |
| 38 | + */ |
| 39 | +function is$ (node) { |
| 40 | + return node.callee.name === '$' || (node.callee.property && node.callee.property.name === '$') |
| 41 | +} |
| 42 | + |
| 43 | +/** |
| 44 | + * Checks if a given node is an ElementArrayFinder represented by $$() callee - both nested and not |
| 45 | + * |
| 46 | + * @param {ASTNode} node - A node to check. |
| 47 | + * @returns {boolean} |
| 48 | + */ |
| 49 | +function is$$ (node) { |
| 50 | + return node.callee.name === '$$' || (node.callee.property && node.callee.property.name === '$$') |
| 51 | +} |
| 52 | + |
| 53 | +/** |
| 54 | + * Checks if a given CallExpression node has the first literal argument |
| 55 | + * |
| 56 | + * @param {ASTNode} node - A node to check. |
| 57 | + * @returns {boolean} |
| 58 | + */ |
| 59 | +function isArgumentLiteral (node) { |
| 60 | + return node.arguments && node.arguments[0].type === 'Literal' |
| 61 | +} |
| 62 | + |
| 63 | +/** |
| 64 | + * Checks if a given CallExpression node has the argument the "by" expression |
| 65 | + * |
| 66 | + * @param {ASTNode} node - A node to check. |
| 67 | + * @returns {boolean} |
| 68 | + */ |
| 69 | +function isArgumentByLocator (node) { |
| 70 | + if (node.arguments && node.arguments[0].type === 'CallExpression') { |
| 71 | + var argument = node.arguments[0] |
| 72 | + if (argument.callee && argument.callee.object && argument.callee.object.name === 'by') { |
| 73 | + return true |
| 74 | + } |
| 75 | + } |
| 76 | + return false |
| 77 | +} |
| 78 | + |
| 79 | +module.exports = { |
| 80 | + meta: { |
| 81 | + schema: [] |
| 82 | + }, |
| 83 | + |
| 84 | + // TODO: need to make isElementFinder and isElementArrayFinder universal - handling both Member and Call expressions |
| 85 | + create: function (context) { |
| 86 | + return { |
| 87 | + CallExpression: function (node) { |
| 88 | + // element finders |
| 89 | + if (isElementFinder(node)) { |
| 90 | + // handle element |
| 91 | + if (isElement(node) && isArgumentLiteral(node)) { |
| 92 | + context.report({ |
| 93 | + node: node.arguments[0], |
| 94 | + message: 'Invalid locator type.' |
| 95 | + }) |
| 96 | + } |
| 97 | + |
| 98 | + // handle $ |
| 99 | + if (is$(node) && isArgumentByLocator(node)) { |
| 100 | + context.report({ |
| 101 | + node: node.arguments[0], |
| 102 | + message: 'Invalid locator type.' |
| 103 | + }) |
| 104 | + } |
| 105 | + } |
| 106 | + |
| 107 | + // element array finders |
| 108 | + if (isElementArrayFinder(node)) { |
| 109 | + // handle element.all |
| 110 | + if (isElementAll(node) && isArgumentLiteral(node)) { |
| 111 | + context.report({ |
| 112 | + node: node.arguments[0], |
| 113 | + message: 'Invalid locator type.' |
| 114 | + }) |
| 115 | + } |
| 116 | + |
| 117 | + // handle $$ |
| 118 | + if (is$$(node) && isArgumentByLocator(node)) { |
| 119 | + context.report({ |
| 120 | + node: node.arguments[0], |
| 121 | + message: 'Invalid locator type.' |
| 122 | + }) |
| 123 | + } |
| 124 | + } |
| 125 | + } |
| 126 | + } |
| 127 | + } |
| 128 | +} |
0 commit comments