Press n or j to go to the next uncovered block, b, p or k for the previous block.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | 1x 1x 1x 1x 1x 164x 164x 164x 164x 363x 343x 343x 343x 343x 343x 343x 343x 343x 172x 172x 172x 172x 172x 172x 172x 171x 171x 171x 171x 171x 363x 171x 171x 1688x 171x 1859x 213x 213x 1859x 2046x 171x 171x 171x 171x 1x | const SolidityParser = require('@solidity-parser/parser');
const path = require('path');
const Injector = require('./injector');
const preprocess = require('./preprocessor');
const parse = require('./parse');
/**
* Top level controller for the instrumentation sequence. Also hosts the instrumentation data map
* which the vm step listener writes its output to. This only needs to be instantiated once
* per coverage run.
*/
class Instrumenter {
constructor(config={}){
this.instrumentationData = {};
this.injector = new Injector(config.viaIR);
this.modifierWhitelist = config.modifierWhitelist || [];
this.enabled = {
statements: (config.measureStatementCoverage === false) ? false : true,
functions: (config.measureFunctionCoverage === false) ? false: true,
modifiers: (config.measureModifierCoverage === false) ? false: true,
branches: (config.measureBranchCoverage === false) ? false: true,
lines: (config.measureLineCoverage === false) ? false: true
};
}
_isRootNode(node){
return (node.type === 'ContractDefinition' ||
node.type === 'LibraryDefinition' ||
node.type === 'InterfaceDefinition');
}
_initializeCoverageFields(contract){
contract.runnableLines = [];
contract.fnMap = {};
contract.fnId = 0;
contract.branchMap = {};
contract.branchId = 0;
contract.statementMap = {};
contract.statementId = 0;
contract.injectionPoints = {};
}
/**
* Per `contractSource`:
* - wraps any unbracketed singleton consequents of if, for, while stmts (preprocessor.js)
* - walks the file's AST, creating an instrumentation map (parse.js, registrar.js)
* - injects `instrumentation` solidity statements into the target solidity source (injector.js)
*
* @param {String} contractSource solidity source code
* @param {String} fileName absolute path to source file
* @return {Object} instrumented `contract` object
* {
* contract: instrumented solidity source code,
* contractName: contract name,
* runnableLines: integer
* }
*
*/
instrument(contractSource, fileName) {
const contract = {};
this.injector.resetModifierMapping();
parse.configure(this.enabled, this.modifierWhitelist);
contract.source = contractSource;
contract.instrumented = contractSource;
this._initializeCoverageFields(contract);
// First, we run over the original contract to get the source mapping.
let ast = SolidityParser.parse(contract.source, {loc: true, range: true});
parse[ast.type](contract, ast);
const retValue = JSON.parse(JSON.stringify(contract)); // Possibly apotropaic.
// Now, we reset almost everything and use the preprocessor to increase our effectiveness.
this._initializeCoverageFields(contract);
contract.instrumented = preprocess(contract.source);
// Walk the AST, recording injection points
ast = SolidityParser.parse(contract.instrumented, {loc: true, range: true});
const root = ast.children.filter(node => this._isRootNode(node));
// Handle contracts which only contain import statements
contract.contractName = (root.length) ? root[0].name : null;
parse[ast.type](contract, ast);
// We have to iterate through these points in descending order
const sortedPoints = Object.keys(contract.injectionPoints).sort((a, b) => b - a);
sortedPoints.forEach(injectionPoint => {
// Line instrumentation has to happen first
contract.injectionPoints[injectionPoint].sort((a, b) => {
const injections = [
'injectBranch',
'injectOpenParen',
'injectOrFalse',
'injectAndTrue',
'injectEmptyBranch',
'injectLine'
];
return injections.indexOf(b.type) - injections.indexOf(a.type);
});
contract.injectionPoints[injectionPoint].forEach(injection => {
this.injector[injection.type](
contract,
fileName,
injectionPoint,
injection,
this.instrumentationData
);
});
});
retValue.runnableLines = contract.runnableLines;
retValue.contract = contract.instrumented;
retValue.contractName = contract.contractName;
return retValue;
}
}
module.exports = Instrumenter;
|