crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add sol-cov docs to website

Browse Source
This commit is contained in:
Fabio Berger 2018-03-18 16:10:02 +01:00
parent db030016fa
commit c1d17c83f8
15 changed files with 168 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/sol-cov/package.json
View File

@ -22,7 +22,7 @@
"postpublish": {
"assets": [],
"docPublishConfigs": {
"extraFileIncludes": ["../types/src/index.ts"],
"extraFileIncludes": ["../subproviders/src/types.ts"],
"s3BucketPath": "s3://doc-jsons/sol-cov/",
"s3StagingBucketPath": "s3://staging-doc-jsons/sol-cov/"
}

17
packages/website/md/docs/sol_cov/installation.md Normal file
View File

@ -0,0 +1,17 @@
**Install**
```bash
npm install @0xproject/sol-cov --save
```
**Import**
```javascript
import { CoverageSubprovider } from '@0xproject/sol-cov';
```
or
```javascript
var CoverageSubprovider = require('@0xproject/sol-cov').CoverageSubprovider;
```

1
packages/website/md/docs/sol_cov/introduction.md Normal file
View File

@ -0,0 +1 @@
Welcome to the [@0xproject/sol-cov](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-cov) documentation! Sol-cov is a Solidity coverage tool for your smart contract tests.

26
packages/website/md/docs/sol_cov/usage.md Normal file
View File

@ -0,0 +1,26 @@
Sol-cov uses transaction traces in order to figure out which lines of Solidity source code have been covered by your tests. In order for it to gather these traces, you must add the `CoverageSubprovider` to the [ProviderEngine](https://github.com/MetaMask/provider-engine) instance you use when running your Solidity tests. If you're unfamiliar with ProviderEngine, please read the [Web3 Provider explained](https://0xproject.com/wiki#Web3-Provider-Explained) wiki article.
The CoverageSubprovider eavesdrops on the `eth_sendTransaction` and `eth_call` RPC calls and collects traces after each call using `debug_traceTransaction`. `eth_call`'s' don't generate traces - so we take a snapshot, re-submit it as a transaction, get the trace and then revert the snapshot.
```typescript
import { CoverageSubprovider } from '@0xproject/sol-cov';
const provider = new ProviderEngine();
const artifactsPath = 'src/artifacts';
const contractsPath = 'src/contracts';
const networkId = 50;
// Some calls might not have `from` address specified. Nevertheless - transactions need to be submitted from an address with at least some funds. defaultFromAddress is the address that will be used to submit those calls as transactions from.
const defaultFromAddress = '0x5409ed021d9299bf6814279a6a1411a7e866a631';
const coverageSubprovider = new CoverageSubprovider(artifactsPath, contractsPath, networkId, defaultFromAddress);
provider.addProvider(coverageSubprovider);
```
After your test suite is complete (e.g global `after` hook), you'll need to call:
```typescript
await coverageSubprovider.writeCoverageAsync();
```
This will create a `coverage.json` file in the `coverage` directory. This file has an [Istanbul format](https://github.com/gotwarlost/istanbul/blob/master/coverage.json.md) - so you can use any of the existing Instanbul reporters.

1
packages/website/translations/chinese.json
View File

@ -58,6 +58,7 @@
"CONTACT": "联系方式",
"DEPLOYER": "Deployer",
"JSON_SCHEMAS": "JSON Schemas",
"SOL_COV": "Solidty Coverage",
"BLOG": "博客",
"FORUM": "论坛",
"CONNECT": "0x 连接",

1
packages/website/translations/english.json
View File

@ -59,6 +59,7 @@
"CONTACT": "contact",
"DEPLOYER": "Deployer",
"JSON_SCHEMAS": "JSON Schemas",
"SOL_COV": "Solidty Coverage",
"BLOG": "blog",
"FORUM": "forum",
"CONNECT": "0x Connect",

1
packages/website/translations/korean.json
View File

@ -58,6 +58,7 @@
"CONTACT": "문의",
"DEPLOYER": "Deployer",
"JSON_SCHEMAS": "JSON Schemas",
"SOL_COV": "Solidty Coverage",
"BLOG": "블로그",
"FORUM": "포럼",
"CONNECT": "0x Connect",

1
packages/website/translations/russian.json
View File

@ -58,6 +58,7 @@
"CONTACT": "Связаться с нами",
"DEPLOYER": "Deployer",
"JSON_SCHEMAS": "JSON Schemas",
"SOL_COV": "Solidty Coverage",
"BLOG": "Блог",
"FORUM": "Форум",
"CONNECT": "0x Connect",

1
packages/website/translations/spanish.json
View File

@ -59,6 +59,7 @@
"CONTACT": "contacto",
"DEPLOYER": "Deployer",
"JSON_SCHEMAS": "JSON Schemas",
"SOL_COV": "Solidty Coverage",
"BLOG": "blog",
"FORUM": "foro",
"CONNECT": "0x Connect",

1
packages/website/ts/components/sidebar_header.tsx
View File

@ -8,6 +8,7 @@ const titleToIcon: { [title: string]: string } = {
'0x.js': 'zeroExJs.png',
Web3Wrapper: 'zeroExJs.png',
Deployer: 'zeroExJs.png',
'Sol-cov': 'zeroExJs.png',
'JSON Schemas': 'zeroExJs.png',
'0x Connect': 'connect.png',
'0x Smart Contracts': 'contracts.png',

19
packages/website/ts/components/top_bar/top_bar.tsx
View File

@ -157,6 +157,12 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
primaryText={this.props.translate.get(Key.JsonSchemas, Deco.CapWords)}
/>
</Link>,
<Link key="subMenuItem-sol-cov" to={WebsitePaths.SolCov} className="text-decoration-none">
<MenuItem
style={{ fontSize: styles.menuItem.fontSize }}
primaryText={this.props.translate.get(Key.SolCov, Deco.CapWords)}
/>
</Link>,
];
const bottomBorderStyle = this._shouldDisplayBottomBar() ? styles.bottomBar : {};
const fullWidthClasses = isFullWidthPage ? 'pr4' : '';
@ -319,6 +325,14 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
</MenuItem>
</Link>
)}
{!this._isViewingSolCovDocs() && (
<Link to={WebsitePaths.SolCov} className="text-decoration-none">
<MenuItem className="py2">
{this.props.translate.get(Key.SolCov, Deco.Cap)}{' '}
{this.props.translate.get(Key.Docs, Deco.Cap)}
</MenuItem>
</Link>
)}
{!this._isViewingPortal() && (
<Link to={`${WebsitePaths.Portal}`} className="text-decoration-none">
<MenuItem className="py2">
@ -351,6 +365,7 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
!this._isViewingWeb3WrapperDocs() &&
!this._isViewingDeployerDocs() &&
!this._isViewingJsonSchemasDocs() &&
!this._isViewingSolCovDocs() &&
!this._isViewingConnectDocs()) ||
_.isUndefined(this.props.menu)
) {
@ -448,6 +463,9 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
private _isViewingJsonSchemasDocs() {
return _.includes(this.props.location.pathname, WebsitePaths.JSONSchemas);
}
private _isViewingSolCovDocs() {
return _.includes(this.props.location.pathname, WebsitePaths.SolCov);
}
private _isViewingWiki() {
return _.includes(this.props.location.pathname, WebsitePaths.Wiki);
}
@ -460,6 +478,7 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
this._isViewingWeb3WrapperDocs() ||
this._isViewingDeployerDocs() ||
this._isViewingJsonSchemasDocs() ||
this._isViewingSolCovDocs() ||
this._isViewingConnectDocs()
);
}

89
packages/website/ts/containers/sol_cov_documentation.ts Normal file
View File

@ -0,0 +1,89 @@
import { constants as docConstants, DocsInfo, DocsInfoConfig, SupportedDocJson } from '@0xproject/react-docs';
import * as _ from 'lodash';
import * as React from 'react';
import { connect } from 'react-redux';
import { Dispatch } from 'redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { Dispatcher } from 'ts/redux/dispatcher';
import { State } from 'ts/redux/reducer';
import { DocPackages, Environments, WebsitePaths } from 'ts/types';
import { configs } from 'ts/utils/configs';
import { constants } from 'ts/utils/constants';
import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */
const IntroMarkdown = require('md/docs/sol_cov/introduction');
const InstallationMarkdown = require('md/docs/sol_cov/installation');
const UsageMarkdown = require('md/docs/sol_cov/usage');
/* tslint:enable:no-var-requires */
const docSections = {
introduction: 'introduction',
installation: 'installation',
usage: 'usage',
coverageSubprovider: 'coverageSubprovider',
types: docConstants.TYPES_SECTION_NAME,
};
const docsInfoConfig: DocsInfoConfig = {
id: DocPackages.SolCov,
type: SupportedDocJson.TypeDoc,
displayName: 'Sol-cov',
packageUrl: 'https://github.com/0xProject/0x-monorepo',
menu: {
introduction: [docSections.introduction],
install: [docSections.installation],
usage: [docSections.usage],
coverageSubprovider: [docSections.coverageSubprovider],
types: [docSections.types],
},
sectionNameToMarkdown: {
[docSections.introduction]: IntroMarkdown,
[docSections.installation]: InstallationMarkdown,
[docSections.usage]: UsageMarkdown,
},
sectionNameToModulePath: {
[docSections.coverageSubprovider]: ['"sol-cov/src/coverage_subprovider"'],
[docSections.types]: ['"subproviders/src/types"'],
},
menuSubsectionToVersionWhenIntroduced: {},
sections: docSections,
visibleConstructors: [docSections.coverageSubprovider],
typeConfigs: {
// Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is
// currently no way to extract the re-exported types from index.ts via TypeDoc :(
publicTypes: ['NextCallback', 'OnNextCompleted', 'ErrorCallback'],
typeNameToExternalLink: {},
typeNameToPrefix: {
JSONRPCRequestPayload: 'Web3',
},
typeNameToDocSection: {},
},
};
const docsInfo = new DocsInfo(docsInfoConfig);
interface ConnectedState {
docsVersion: string;
availableDocVersions: string[];
docsInfo: DocsInfo;
translate: Translate;
}
interface ConnectedDispatch {
dispatcher: Dispatcher;
}
const mapStateToProps = (state: State, ownProps: DocPageProps): ConnectedState => ({
docsVersion: state.docsVersion,
availableDocVersions: state.availableDocVersions,
translate: state.translate,
docsInfo,
});
const mapDispatchToProps = (dispatch: Dispatch<State>): ConnectedDispatch => ({
dispatcher: new Dispatcher(dispatch),
});
export const Documentation: React.ComponentClass<DocPageProps> = connect(mapStateToProps, mapDispatchToProps)(
DocPageComponent,
);

4
packages/website/ts/index.tsx
View File

@ -54,6 +54,9 @@ const LazyDeployerDocumentation = createLazyComponent('Documentation', async ()
const LazyJSONSchemasDocumentation = createLazyComponent('Documentation', async () =>
System.import<any>(/* webpackChunkName: "connectDocs" */ 'ts/containers/json_schemas_documentation'),
);
const LazySolCovDocumentation = createLazyComponent('Documentation', async () =>
System.import<any>(/* webpackChunkName: "connectDocs" */ 'ts/containers/sol_cov_documentation'),
);
analytics.init();
// tslint:disable-next-line:no-floating-promises
@ -75,6 +78,7 @@ render(
<Route path={`${WebsitePaths.ZeroExJs}/:version?`} component={LazyZeroExJSDocumentation} />
<Route path={`${WebsitePaths.Connect}/:version?`} component={LazyConnectDocumentation} />
<Route path={`${WebsitePaths.Deployer}/:version?`} component={LazyDeployerDocumentation} />
<Route path={`${WebsitePaths.SolCov}/:version?`} component={LazySolCovDocumentation} />
<Route
path={`${WebsitePaths.JSONSchemas}/:version?`}
component={LazyJSONSchemasDocumentation}

2
packages/website/ts/pages/documentation/doc_page.tsx
View File

@ -25,6 +25,7 @@ const docIdToS3FolderName: { [id: string]: string } = {
[DocPackages.Web3Wrapper]: 'web3-wrapper',
[DocPackages.Deployer]: 'deployer',
[DocPackages.JSONSchemas]: 'json-schemas',
[DocPackages.SolCov]: 'sol-cov',
};
const docIdToSubpackageName: { [id: string]: string } = {
@ -34,6 +35,7 @@ const docIdToSubpackageName: { [id: string]: string } = {
[DocPackages.Web3Wrapper]: 'web3-wrapper',
[DocPackages.Deployer]: 'deployer',
[DocPackages.JSONSchemas]: 'json-schemas',
[DocPackages.SolCov]: 'sol-cov',
};
export interface DocPageProps {

3
packages/website/ts/types.ts
View File

@ -358,6 +358,7 @@ export enum WebsitePaths {
Web3Wrapper = '/docs/web3_wrapper',
Deployer = '/docs/deployer',
JSONSchemas = '/docs/json-schemas',
SolCov = '/docs/sol-cov',
}
export enum DocPackages {
@ -367,6 +368,7 @@ export enum DocPackages {
Web3Wrapper = 'WEB3_WRAPPER',
Deployer = 'DEPLOYER',
JSONSchemas = 'JSON_SCHEMAS',
SolCov = 'SOL_COV',
}
export interface TimestampMsRange {
@ -450,6 +452,7 @@ export enum Key {
Contact = 'CONTACT',
Deployer = 'DEPLOYER',
JsonSchemas = 'JSON_SCHEMAS',
SolCov = 'SOL_COV',
Blog = 'BLOG',
Forum = 'FORUM',
Connect = 'CONNECT',