diff options
author | Alex Browne <stephenalexbrowne@gmail.com> | 2018-06-13 06:27:08 +0800 |
---|---|---|
committer | Alex Browne <stephenalexbrowne@gmail.com> | 2018-06-13 06:40:18 +0800 |
commit | d0c348e5957d2adcd5b6f7b0727a5afd326e3b33 (patch) | |
tree | 4ed1fb51ca2fdee1b980df01012f2b903178d57a /packages/sol-cov/src/trace_collector.ts | |
parent | f50d3088dcc7fc7fb88ebfce397684b32aa037aa (diff) | |
download | dexon-sol-tools-d0c348e5957d2adcd5b6f7b0727a5afd326e3b33.tar dexon-sol-tools-d0c348e5957d2adcd5b6f7b0727a5afd326e3b33.tar.gz dexon-sol-tools-d0c348e5957d2adcd5b6f7b0727a5afd326e3b33.tar.bz2 dexon-sol-tools-d0c348e5957d2adcd5b6f7b0727a5afd326e3b33.tar.lz dexon-sol-tools-d0c348e5957d2adcd5b6f7b0727a5afd326e3b33.tar.xz dexon-sol-tools-d0c348e5957d2adcd5b6f7b0727a5afd326e3b33.tar.zst dexon-sol-tools-d0c348e5957d2adcd5b6f7b0727a5afd326e3b33.zip |
Refactor sol-cov to de-duplicate code for coverage and profiling
Diffstat (limited to 'packages/sol-cov/src/trace_collector.ts')
-rw-r--r-- | packages/sol-cov/src/trace_collector.ts | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/packages/sol-cov/src/trace_collector.ts b/packages/sol-cov/src/trace_collector.ts new file mode 100644 index 000000000..1b458edec --- /dev/null +++ b/packages/sol-cov/src/trace_collector.ts @@ -0,0 +1,93 @@ +import { promisify } from '@0xproject/utils'; +import { stripHexPrefix } from 'ethereumjs-util'; +import * as fs from 'fs'; +import { Collector } from 'istanbul'; +import * as _ from 'lodash'; +import { getLogger, levels, Logger } from 'loglevel'; +import * as mkdirp from 'mkdirp'; + +import { AbstractArtifactAdapter } from './artifact_adapters/abstract_artifact_adapter'; +import { constants } from './constants'; +import { parseSourceMap } from './source_maps'; +import { + ContractData, + Coverage, + SourceRange, + Subtrace, + TraceInfo, + TraceInfoExistingContract, + TraceInfoNewContract, +} from './types'; +import { utils } from './utils'; + +const mkdirpAsync = promisify<undefined>(mkdirp); + +export type SingleFileSubtraceHandler = ( + contractData: ContractData, + subtrace: Subtrace, + pcToSourceRange: { [programCounter: number]: SourceRange }, + fileIndex: number, +) => Coverage; + +/** + * TraceCollector is used by CoverageSubprovider to compute code coverage based on collected trace data. + */ +export class TraceCollector { + private _artifactAdapter: AbstractArtifactAdapter; + private _logger: Logger; + private _contractsData!: ContractData[]; + private _collector = new Collector(); + private _singleFileSubtraceHandler: SingleFileSubtraceHandler; + + /** + * Instantiates a TraceCollector instance + * @param artifactAdapter Adapter for used artifacts format (0x, truffle, giveth, etc.) + * @param isVerbose If true, we will log any unknown transactions. Otherwise we will ignore them + * @param singleFileSubtraceHandler A handler function for computing partial coverage for a single file & subtrace + */ + constructor( + artifactAdapter: AbstractArtifactAdapter, + isVerbose: boolean, + singleFileSubtraceHandler: SingleFileSubtraceHandler, + ) { + this._artifactAdapter = artifactAdapter; + this._logger = getLogger('sol-cov'); + this._logger.setLevel(isVerbose ? levels.TRACE : levels.ERROR); + this._singleFileSubtraceHandler = singleFileSubtraceHandler; + } + public async writeOutputAsync(): Promise<void> { + const finalCoverage = this._collector.getFinalCoverage(); + const stringifiedCoverage = JSON.stringify(finalCoverage, null, '\t'); + await mkdirpAsync('coverage'); + fs.writeFileSync('coverage/coverage.json', stringifiedCoverage); + } + public async computeSingleTraceCoverageAsync(traceInfo: TraceInfo): Promise<void> { + if (_.isUndefined(this._contractsData)) { + this._contractsData = await this._artifactAdapter.collectContractsDataAsync(); + } + const isContractCreation = traceInfo.address === constants.NEW_CONTRACT; + const bytecode = isContractCreation + ? (traceInfo as TraceInfoNewContract).bytecode + : (traceInfo as TraceInfoExistingContract).runtimeBytecode; + const contractData = utils.getContractDataIfExists(this._contractsData, bytecode); + if (_.isUndefined(contractData)) { + const errMsg = isContractCreation + ? `Unknown contract creation transaction` + : `Transaction to an unknown address: ${traceInfo.address}`; + this._logger.warn(errMsg); + return; + } + const bytecodeHex = stripHexPrefix(bytecode); + const sourceMap = isContractCreation ? contractData.sourceMap : contractData.sourceMapRuntime; + const pcToSourceRange = parseSourceMap(contractData.sourceCodes, sourceMap, bytecodeHex, contractData.sources); + for (let fileIndex = 0; fileIndex < contractData.sources.length; fileIndex++) { + const singleFileCoverageForTrace = this._singleFileSubtraceHandler( + contractData, + traceInfo.subtrace, + pcToSourceRange, + fileIndex, + ); + this._collector.add(singleFileCoverageForTrace); + } + } +} |