solium-plugin-security/test/return-at-end.js

Official Solium Plugin for Security-related lint rules

/**
 * @fileoverview Test for enforce-single-end-return rule
 * @author Mitchell Van Der Hoeff <mitchellvanderhoeff@gmail.com>
 * @author Simon Hajjar <simon.j.hajjar@gmail.com>
 */

"use strict";

let Solium = require("solium");

let userConfig = {
    rules: {
        "security/return-at-end": "error"
    }
};

describe("[RULE] return-at-end: Acceptances", function() {

    it("should not lint abstract functions", done => {
        let code = "contract Foo { function bar(); }",
            errors = Solium.lint(code, userConfig);
        errors.should.be.size(0);

        code = "contract Foo { function bar(uint x, string yy, bytes32 abra) payable returns(string); }";
        errors = Solium.lint(code, userConfig);
        errors.should.be.size(0);

        done();
    });

    it("should accept functions that have a single return statement at the end", function(done) {
        let errors, code = "contract Foo { function foo () {uint256 x = 3; return;} }";

        errors = Solium.lint(code, userConfig);
        errors.should.be.size(0);

        code = "contract Foo { function foo () {return;} }";
        errors = Solium.lint(code, userConfig);
        errors.should.be.size(0);

        code = "contract Foo { function foo () {hello('world'); boo(); if (true) {} return;} }";
        errors = Solium.lint(code, userConfig);
        errors.should.be.size(0);

        code = "contract Foo { function foo () { return callMyFunc(100, 'hello'); } }";
        errors = Solium.lint(code, userConfig);
        errors.should.be.size(0);

        code = `
			contract A {
			    struct Ab {
        			uint a;
        			string b;
    			}
    
    			function foo() returns (Ab) {
        			return Ab({a: 10290, b: "Hello"});
    			}
			}
		`;
        errors = Solium.lint(code, userConfig);
        errors.should.be.size(0);

        Solium.reset();
        done();
    });
});

describe("[RULE] return-at-end: Rejections", function() {

    it("should reject functions that have a return statement not at the end", function(done) {
        let code = "contract Foo { function foo () {return; return;} }";
        let errors;

        errors = Solium.lint(code, userConfig);
        errors.should.be.size(1);

        Solium.reset();
        done();
    });

    it("should reject functions that don't have a return statement", function(done) {
        let code = "contract Foo { function foo () {uint256 x = 3;} }";
        let errors;

        errors = Solium.lint(code, userConfig);
        errors.should.be.size(1);

        Solium.reset();
        done();
    });

    it("should reject return statements whose parent isn't a function, ie, that is not top-level", function(done) {
        let code = "contract Foo { function foo () { do { return 100; } while(true); return; } }";
        let errors;

        errors = Solium.lint(code, userConfig);
        errors.should.be.size(1);

        code = "contract Foo { function foo () { if (true) { return; } else { return; } } }";
        errors = Solium.lint(code, userConfig);
        errors.should.be.size(3);

        Solium.reset();
        done();
    });
});