This repository was archived by the owner on Jan 19, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
rules: add the no-modifiers-without-revert rule #7
Open
come-maiz
wants to merge
3
commits into
master
Choose a base branch
from
rule/no-modifier-without-revert
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /** | ||
| * @fileoverview Disallow modifiers without revert | ||
| */ | ||
|
|
||
| "use strict"; | ||
|
|
||
| module.exports = { | ||
| meta: { | ||
| docs: { | ||
| recommended: true, | ||
| type: "warning", | ||
| description: "Warn on modifiers without revert" | ||
| }, | ||
| schema: [] | ||
| }, | ||
|
|
||
| create: function(context) { | ||
| function inspectModifierDeclaration(emitted) { | ||
| if (emitted.exit) { | ||
| return; | ||
| } | ||
| const node = emitted.node; | ||
| if (!hasRevertChild(node)) { | ||
| context.report({ | ||
| node: node, | ||
| message: `Modifier '${node.name}' without revert.` | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| function hasRevertChild(node) { | ||
| // XXX Recursive function. | ||
| // --elopio - 20180105 | ||
| if (Array.isArray(node)) { | ||
| return node.some(element => hasRevertChild(element)); | ||
| } else if (node !== null && typeof node === "object") { | ||
| return isRevertExpression(node) || | ||
| Object.keys(node).some(key => { | ||
| if (key !== "parent") { | ||
| return hasRevertChild(node[key]); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| function isRevertExpression(statement) { | ||
| return statement.type === "ExpressionStatement" && | ||
| statement.expression.type === "CallExpression" && | ||
| (statement.expression.callee.name === "require" || | ||
| statement.expression.callee.name === "revert"); | ||
| } | ||
|
|
||
| return { | ||
| ModifierDeclaration: inspectModifierDeclaration | ||
| }; | ||
| } | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /** | ||
| * @fileoverview Tests for no-unused-imports rule | ||
| */ | ||
|
|
||
| "use strict"; | ||
|
|
||
| let Solium = require("solium"); | ||
| let wrappers = require("./utils/wrappers"); | ||
| let addPragma = wrappers.addPragma; | ||
|
|
||
| let userConfig = { | ||
| rules: { | ||
| "zeppelin/no-modifiers-without-revert": 1 | ||
| } | ||
| }; | ||
|
|
||
| describe("[RULE] no-modifiers-without-revert: Acceptances", function() { | ||
|
|
||
| afterEach(function(done) { | ||
| Solium.reset(); | ||
| done(); | ||
| }); | ||
|
|
||
| it("should accept modifier with require call", function(done) { | ||
| let code = "contract Dummy {\n" + | ||
| "modifier testModifier {\n" + | ||
| " require('dummy' == 'dummy');\n" + | ||
| " _;\n" + | ||
| "}}", | ||
| errors = Solium.lint(addPragma(code), userConfig); | ||
|
|
||
| errors.constructor.name.should.equal("Array"); | ||
| errors.length.should.equal(0); | ||
|
|
||
| done(); | ||
| }); | ||
|
|
||
| it("should accept modifier with revert call", function(done) { | ||
| let code = "contract Dummy {\n" + | ||
| "modifier testModifier {\n" + | ||
| " if ('dummy' == 'dummy') {\n" + | ||
| " revert();\n" + | ||
| " }\n" + | ||
| " _;\n" + | ||
| "}}", | ||
| errors = Solium.lint(addPragma(code), userConfig); | ||
|
|
||
| errors.constructor.name.should.equal("Array"); | ||
| errors.length.should.equal(0); | ||
|
|
||
| done(); | ||
| }); | ||
| }); | ||
|
|
||
| describe("[RULE] no-modifiers-without-revert: Rejections", function() { | ||
| it("should reject modifiers without revert", function(done) { | ||
| let code = "contract Dummy {\n" + | ||
| "modifier testModifier {\n" + | ||
| " _;\n" + | ||
| "}}", | ||
| errors = Solium.lint(addPragma(code), userConfig); | ||
|
|
||
| errors.constructor.name.should.equal("Array"); | ||
| errors.length.should.equal(1); | ||
| errors[0].message.should.equal( | ||
| "Modifier 'testModifier' without revert."); | ||
|
|
||
| Solium.reset(); | ||
|
|
||
| done(); | ||
| }); | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we may want to add test cases for
assertandthrowThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @facuspagnuolo, about
assert, I understood from the slack discussion that we should discuss more about it and not add it yet.About throw, solc warns about it:
Warning: "throw" is deprecated in favour of "revert()", "require()" and "assert()".So I thought there is no need to support deprecated statements that are already triggering a warning.
But both are pretty simple to add, if you disagree I'd be happy to change it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there is a warning for
throwthen there is no need to add it, but why wouldn't we considerassert?