/** * @fileoverview Tests for CodePath. * @author Toru Nagashima */ "use strict"; //------------------------------------------------------------------------------ // Requirements //------------------------------------------------------------------------------ var assert = require("assert"), eslint = require("../../../lib/eslint"); //------------------------------------------------------------------------------ // Helpers //------------------------------------------------------------------------------ /** * Gets the code path of a given source code. * * @param {string} code - A source code. * @returns {CodePath[]} A list of created code paths. */ function parseCodePaths(code) { var retv = []; eslint.reset(); eslint.defineRule("test", function() { return { onCodePathStart: function(codePath) { retv.push(codePath); } }; }); eslint.verify(code, {rules: {test: 2}}); return retv; } /** * Traverses a given code path then returns the order of traversing. * * @param {CodePath} codePath - A code path to traverse. * @param {object|undefined} options - Omittable. The option object of * `codePath.traverseSegments()` method. * @param {function|undefined} callback - Omittable. The callback function of * `codePath.traverseSegments()` method. * @returns {string[]} The list of segment's ids in the order traversed. */ function getOrderOfTraversing(codePath, options, callback) { var retv = []; codePath.traverseSegments(options, function(segment, controller) { retv.push(segment.id); if (callback) { callback(segment, controller); return; } }); return retv; } //------------------------------------------------------------------------------ // Tests //------------------------------------------------------------------------------ describe("CodePathAnalyzer", function() { describe(".traverseSegments()", function() { describe("should traverse segments from the first to the end:", function() { it("simple", function() { var codePath = parseCodePaths("foo(); bar(); baz();")[0]; var order = getOrderOfTraversing(codePath); assert.deepEqual(order, ["s1_1"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nExpressionStatement\nCallExpression\nIdentifier (foo)\nExpressionStatement\nCallExpression\nIdentifier (bar)\nExpressionStatement\nCallExpression\nIdentifier (baz)"]; initial->s1_1->final; } */ }); it("if", function() { var codePath = parseCodePaths("if (a) foo(); else bar(); baz();")[0]; var order = getOrderOfTraversing(codePath); assert.deepEqual(order, ["s1_1", "s1_2", "s1_3", "s1_4"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nIfStatement\nIdentifier (a)"]; s1_2[label="ExpressionStatement\nCallExpression\nIdentifier (foo)"]; s1_4[label="ExpressionStatement\nCallExpression\nIdentifier (baz)"]; s1_3[label="ExpressionStatement\nCallExpression\nIdentifier (bar)"]; initial->s1_1->s1_2->s1_4; s1_1->s1_3->s1_4->final; } */ }); it("switch", function() { var codePath = parseCodePaths("switch (a) { case 0: foo(); break; case 1: bar(); } baz();")[0]; var order = getOrderOfTraversing(codePath); assert.deepEqual(order, ["s1_1", "s1_2", "s1_4", "s1_5", "s1_6"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nSwitchStatement\nIdentifier (a)\nSwitchCase\nLiteral (0)"]; s1_2[label="ExpressionStatement\nCallExpression\nIdentifier (foo)\nBreakStatement"]; s1_3[style="rounded,dashed,filled",fillcolor="#FF9800",label="<>\nSwitchCase:exit"]; s1_5[label="ExpressionStatement\nCallExpression\nIdentifier (bar)"]; s1_6[label="ExpressionStatement\nCallExpression\nIdentifier (baz)"]; s1_4[label="SwitchCase\nLiteral (1)"]; initial->s1_1->s1_2->s1_3->s1_5->s1_6; s1_1->s1_4->s1_5; s1_2->s1_6; s1_4->s1_6->final; } */ }); it("while", function() { var codePath = parseCodePaths("while (a) foo(); bar();")[0]; var order = getOrderOfTraversing(codePath); assert.deepEqual(order, ["s1_1", "s1_2", "s1_3", "s1_4"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nWhileStatement"]; s1_2[label="Identifier (a)"]; s1_3[label="ExpressionStatement\nCallExpression\nIdentifier (foo)"]; s1_4[label="ExpressionStatement\nCallExpression\nIdentifier (bar)"]; initial->s1_1->s1_2->s1_3->s1_2->s1_4->final; } */ }); it("for", function() { var codePath = parseCodePaths("for (var i = 0; i < 10; ++i) foo(i); bar();")[0]; var order = getOrderOfTraversing(codePath); assert.deepEqual(order, ["s1_1", "s1_2", "s1_3", "s1_4", "s1_5"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nForStatement\nVariableDeclaration\nVariableDeclarator\nIdentifier (i)\nLiteral (0)"]; s1_2[label="BinaryExpression\nIdentifier (i)\nLiteral (10)"]; s1_3[label="ExpressionStatement\nCallExpression\nIdentifier (foo)\nIdentifier (i)"]; s1_4[label="UpdateExpression\nIdentifier (i)"]; s1_5[label="ExpressionStatement\nCallExpression\nIdentifier (bar)"]; initial->s1_1->s1_2->s1_3->s1_4->s1_2->s1_5->final; } */ }); it("for-in", function() { var codePath = parseCodePaths("for (var key in obj) foo(key); bar();")[0]; var order = getOrderOfTraversing(codePath); assert.deepEqual(order, ["s1_1", "s1_3", "s1_2", "s1_4", "s1_5"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nForInStatement"]; s1_3[label="Identifier (obj)"]; s1_2[label="VariableDeclaration\nVariableDeclarator\nIdentifier (key)"]; s1_4[label="ExpressionStatement\nCallExpression\nIdentifier (foo)\nIdentifier (key)"]; s1_5[label="ExpressionStatement\nCallExpression\nIdentifier (bar)"]; initial->s1_1->s1_3->s1_2->s1_4->s1_2; s1_3->s1_5; s1_4->s1_5->final; } */ }); it("try-catch", function() { var codePath = parseCodePaths("try { foo(); } catch (e) { bar(); } baz();")[0]; var order = getOrderOfTraversing(codePath); assert.deepEqual(order, ["s1_1", "s1_2", "s1_3", "s1_4"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nTryStatement\nBlockStatement\nExpressionStatement\nCallExpression\nIdentifier (foo)"]; s1_2[label="CallExpression:exit\nExpressionStatement:exit\nBlockStatement:exit"]; s1_3[label="CatchClause\nIdentifier (e)\nBlockStatement\nExpressionStatement\nCallExpression\nIdentifier (bar)"]; s1_4[label="ExpressionStatement\nCallExpression\nIdentifier (baz)"]; initial->s1_1->s1_2->s1_3->s1_4; s1_1->s1_3; s1_2->s1_4->final; } */ }); }); it("should traverse segments from `options.first` to `options.last`.", function() { var codePath = parseCodePaths("if (a) { if (b) { foo(); } bar(); } else { out1(); } out2();")[0]; var order = getOrderOfTraversing(codePath, { first: codePath.initialSegment.nextSegments[0], last: codePath.initialSegment.nextSegments[0].nextSegments[1] }); assert.deepEqual(order, ["s1_2", "s1_3", "s1_4"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nIfStatement\nIdentifier (a)"]; s1_2[label="BlockStatement\nIfStatement\nIdentifier (b)"]; s1_3[label="BlockStatement\nExpressionStatement\nCallExpression\nIdentifier (foo)"]; s1_4[label="ExpressionStatement\nCallExpression\nIdentifier (bar)"]; s1_6[label="ExpressionStatement\nCallExpression\nIdentifier (out2)"]; s1_5[label="BlockStatement\nExpressionStatement\nCallExpression\nIdentifier (out1)"]; initial->s1_1->s1_2->s1_3->s1_4->s1_6; s1_1->s1_5->s1_6; s1_2->s1_4; s1_6->final; } */ }); it("should stop immediately when 'controller.break()' was called.", function() { var codePath = parseCodePaths("if (a) { if (b) { foo(); } bar(); } else { out1(); } out2();")[0]; var order = getOrderOfTraversing(codePath, null, function(segment, controller) { if (segment.id === "s1_2") { controller.break(); } }); assert.deepEqual(order, ["s1_1", "s1_2"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nIfStatement\nIdentifier (a)"]; s1_2[label="BlockStatement\nIfStatement\nIdentifier (b)"]; s1_3[label="BlockStatement\nExpressionStatement\nCallExpression\nIdentifier (foo)"]; s1_4[label="ExpressionStatement\nCallExpression\nIdentifier (bar)"]; s1_6[label="ExpressionStatement\nCallExpression\nIdentifier (out2)"]; s1_5[label="BlockStatement\nExpressionStatement\nCallExpression\nIdentifier (out1)"]; initial->s1_1->s1_2->s1_3->s1_4->s1_6; s1_1->s1_5->s1_6; s1_2->s1_4; s1_6->final; } */ }); it("should skip the current branch when 'controller.skip()' was called.", function() { var codePath = parseCodePaths("if (a) { if (b) { foo(); } bar(); } else { out1(); } out2();")[0]; var order = getOrderOfTraversing(codePath, null, function(segment, controller) { if (segment.id === "s1_2") { controller.skip(); } }); assert.deepEqual(order, ["s1_1", "s1_2", "s1_5", "s1_6"]); /* digraph { node[shape=box,style="rounded,filled",fillcolor=white]; initial[label="",shape=circle,style=filled,fillcolor=black,width=0.25,height=0.25]; final[label="",shape=doublecircle,style=filled,fillcolor=black,width=0.25,height=0.25]; s1_1[label="Program\nIfStatement\nIdentifier (a)"]; s1_2[label="BlockStatement\nIfStatement\nIdentifier (b)"]; s1_3[label="BlockStatement\nExpressionStatement\nCallExpression\nIdentifier (foo)"]; s1_4[label="ExpressionStatement\nCallExpression\nIdentifier (bar)"]; s1_6[label="ExpressionStatement\nCallExpression\nIdentifier (out2)"]; s1_5[label="BlockStatement\nExpressionStatement\nCallExpression\nIdentifier (out1)"]; initial->s1_1->s1_2->s1_3->s1_4->s1_6; s1_1->s1_5->s1_6; s1_2->s1_4; s1_6->final; } */ }); }); });