From d0c348e5957d2adcd5b6f7b0727a5afd326e3b33 Mon Sep 17 00:00:00 2001 From: Alex Browne Date: Tue, 12 Jun 2018 15:27:08 -0700 Subject: Refactor sol-cov to de-duplicate code for coverage and profiling --- packages/sol-cov/src/profiler_subprovider.ts | 67 +++++++++++++++++++++++++--- 1 file changed, 61 insertions(+), 6 deletions(-) (limited to 'packages/sol-cov/src/profiler_subprovider.ts') diff --git a/packages/sol-cov/src/profiler_subprovider.ts b/packages/sol-cov/src/profiler_subprovider.ts index 9fd815f07..3489ef62b 100644 --- a/packages/sol-cov/src/profiler_subprovider.ts +++ b/packages/sol-cov/src/profiler_subprovider.ts @@ -1,14 +1,18 @@ +import * as _ from 'lodash'; + import { AbstractArtifactAdapter } from './artifact_adapters/abstract_artifact_adapter'; -import { ProfilerManager } from './profiler_manager'; +import { collectCoverageEntries } from './collect_coverage_entries'; import { TraceCollectionSubprovider } from './trace_collection_subprovider'; -import { TraceInfo } from './types'; +import { SingleFileSubtraceHandler, TraceCollector } from './trace_collector'; +import { ContractData, Coverage, SourceRange, Subtrace, TraceInfo } from './types'; +import { utils } from './utils'; /** * This class implements the [web3-provider-engine](https://github.com/MetaMask/provider-engine) subprovider interface. * ProfilerSubprovider is used to profile Solidity code while running tests. */ export class ProfilerSubprovider extends TraceCollectionSubprovider { - private _profilerManager: ProfilerManager; + private _coverageCollector: TraceCollector; /** * Instantiates a ProfilerSubprovider instance * @param artifactAdapter Adapter for used artifacts format (0x, truffle, giveth, etc.) @@ -22,15 +26,66 @@ export class ProfilerSubprovider extends TraceCollectionSubprovider { shouldCollectCallTraces: false, }; super(defaultFromAddress, traceCollectionSubproviderConfig); - this._profilerManager = new ProfilerManager(artifactAdapter, isVerbose); + this._coverageCollector = new TraceCollector(artifactAdapter, isVerbose, profilerHandler); } public async handleTraceInfoAsync(traceInfo: TraceInfo): Promise { - await this._profilerManager.computeSingleTraceCoverageAsync(traceInfo); + await this._coverageCollector.computeSingleTraceCoverageAsync(traceInfo); } /** * Write the test profiler results to a file in Istanbul format. */ public async writeProfilerOutputAsync(): Promise { - await this._profilerManager.writeProfilerOutputAsync(); + await this._coverageCollector.writeOutputAsync(); } } + +/** + * Computed partial coverage for a single file & subtrace for the purposes of + * gas profiling. + * @param contractData Contract metadata (source, srcMap, bytecode) + * @param subtrace A subset of a transcation/call trace that was executed within that contract + * @param pcToSourceRange A mapping from program counters to source ranges + * @param fileIndex Index of a file to compute coverage for + * @return Partial istanbul coverage for that file & subtrace + */ +export const profilerHandler: SingleFileSubtraceHandler = ( + contractData: ContractData, + subtrace: Subtrace, + pcToSourceRange: { [programCounter: number]: SourceRange }, + fileIndex: number, +): Coverage => { + const absoluteFileName = contractData.sources[fileIndex]; + const profilerEntriesDescription = collectCoverageEntries(contractData.sourceCodes[fileIndex]); + const gasConsumedByStatement: { [statementId: string]: number } = {}; + const statementIds = _.keys(profilerEntriesDescription.statementMap); + for (const statementId of statementIds) { + const statementDescription = profilerEntriesDescription.statementMap[statementId]; + const totalGasCost = _.sum( + _.map(subtrace, structLog => { + const sourceRange = pcToSourceRange[structLog.pc]; + if (_.isUndefined(sourceRange)) { + return 0; + } + if (sourceRange.fileName !== absoluteFileName) { + return 0; + } + if (utils.isRangeInside(sourceRange.location, statementDescription)) { + return structLog.gasCost; + } else { + return 0; + } + }), + ); + gasConsumedByStatement[statementId] = totalGasCost; + } + const partialProfilerOutput = { + [absoluteFileName]: { + ...profilerEntriesDescription, + path: absoluteFileName, + f: {}, // I's meaningless in profiling context + s: gasConsumedByStatement, + b: {}, // I's meaningless in profiling context + }, + }; + return partialProfilerOutput; +}; -- cgit From 82743cca924cd6960909310c8c7941b3c3c30da5 Mon Sep 17 00:00:00 2001 From: Alex Browne Date: Tue, 12 Jun 2018 15:46:41 -0700 Subject: Rename _coverageCollector -> _profilerCollector in TraceCollectionSubprovider --- packages/sol-cov/src/profiler_subprovider.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'packages/sol-cov/src/profiler_subprovider.ts') diff --git a/packages/sol-cov/src/profiler_subprovider.ts b/packages/sol-cov/src/profiler_subprovider.ts index 3489ef62b..62ed1b472 100644 --- a/packages/sol-cov/src/profiler_subprovider.ts +++ b/packages/sol-cov/src/profiler_subprovider.ts @@ -12,7 +12,7 @@ import { utils } from './utils'; * ProfilerSubprovider is used to profile Solidity code while running tests. */ export class ProfilerSubprovider extends TraceCollectionSubprovider { - private _coverageCollector: TraceCollector; + private _profilerCollector: TraceCollector; /** * Instantiates a ProfilerSubprovider instance * @param artifactAdapter Adapter for used artifacts format (0x, truffle, giveth, etc.) @@ -26,16 +26,16 @@ export class ProfilerSubprovider extends TraceCollectionSubprovider { shouldCollectCallTraces: false, }; super(defaultFromAddress, traceCollectionSubproviderConfig); - this._coverageCollector = new TraceCollector(artifactAdapter, isVerbose, profilerHandler); + this._profilerCollector = new TraceCollector(artifactAdapter, isVerbose, profilerHandler); } public async handleTraceInfoAsync(traceInfo: TraceInfo): Promise { - await this._coverageCollector.computeSingleTraceCoverageAsync(traceInfo); + await this._profilerCollector.computeSingleTraceCoverageAsync(traceInfo); } /** * Write the test profiler results to a file in Istanbul format. */ public async writeProfilerOutputAsync(): Promise { - await this._coverageCollector.writeOutputAsync(); + await this._profilerCollector.writeOutputAsync(); } } -- cgit