Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OpenZeppelin/openzeppelin-test-environment
[Not actively maintained] One-line setup for blazing-fast smart contracts tests
https://github.com/OpenZeppelin/openzeppelin-test-environment
ethereum smart-contracts solidity test testing web3
Last synced: about 1 month ago
JSON representation
[Not actively maintained] One-line setup for blazing-fast smart contracts tests
- Host: GitHub
- URL: https://github.com/OpenZeppelin/openzeppelin-test-environment
- Owner: OpenZeppelin
- License: mit
- Archived: true
- Created: 2019-10-28T18:59:55.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-20T22:13:02.000Z (over 3 years ago)
- Last Synced: 2024-11-01T11:34:54.591Z (about 1 month ago)
- Topics: ethereum, smart-contracts, solidity, test, testing, web3
- Language: Solidity
- Homepage: https://docs.openzeppelin.com/test-environment
- Size: 3.09 MB
- Stars: 90
- Watchers: 23
- Forks: 39
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blockchain-testing - OpenZeppelin Test Environment - JS based framework for smart contract testing ([Ethereum](https://ethereum.org/en/) / Whitepapers)
README
> :warning: **This project is not being actively maintained.** It is advisable to use an alternative ([Hardhat](https://hardhat.org/), [Truffle](https://www.trufflesuite.com/truffle)).
# OpenZeppelin Test Environment
[](https://docs.openzeppelin.com/test-environment)
[](https://www.npmjs.org/package/@openzeppelin/test-environment)
[](https://circleci.com/gh/OpenZeppelin/openzeppelin-test-environment)
**Blazing fast smart contract testing.** One-line setup for an awesome testing experience.
- Near-instant start up: have your code running in under 2s after typing `npm test`.
- Test runner agnostic – from the familiarity of Mocha, to [_parallel tests_](https://docs.openzeppelin.com/test-environment/choosing-a-test-runner#parallel-tests) using Jest or Ava!
- Non-opinionated: use either [`@truffle/contract`](https://www.npmjs.com/package/@truffle/contract) or [`web3-eth-contract`](https://web3js.readthedocs.io/en/v1.2.0/web3-eth-contract.html) as you see fit.
- First class support for the [OpenZeppelin Test Helpers](https://docs.openzeppelin.com/test-helpers).
- Highly configurable: from gas limit and initial balance, to complex custom web3 providers.
- No global variables, no hacks.
_`test-environment` is the result of our learnings while developing the [OpenZeppelin Contracts](https://docs.openzeppelin.com/contracts), combining best practices and the tools we've come to rely on over the years. We think you'll love it!_
## Overview
### Installation
```bash
npm install --save-dev @openzeppelin/test-environment
```
### Usage
By including `require('@openzeppelin/test-environment')` in your test files, a local [ganache-powered blockchain](https://github.com/trufflesuite/ganache-core) with unlocked accounts will be spun up, and all tools configured to work with it.
Here's a quick sample of how using `test-environment` in a [Mocha](https://mochajs.org/) + [Chai](https://www.chaijs.com/) setup looks like.
```javascript
const { accounts, contract } = require('@openzeppelin/test-environment');
const [ owner ] = accounts;
const { expect } = require('chai');
const MyContract = contract.fromArtifact('MyContract'); // Loads a compiled contract
describe('MyContract', function () {
it('deployer is owner', async function () {
const myContract = await MyContract.new({ from: owner });
expect(await myContract.owner()).to.equal(owner);
});
});
```
If you're used to `truffle test`, this probably looks very familiar. Follow our guide on [migrating from Truffle](https://docs.openzeppelin.com/test-environment/migrating-from-truffle) to have your project running with `test-environment` in a breeze!
_Note: if you'd rather not rely on truffle contracts and use web3 contract types directly, worry not: you can [configure `test-environment`](https://docs.openzeppelin.com/test-environment/getting-started#configuration) to use the `web3-eth-contract` abstraction._
## Learn More
* Check out [Getting Started](https://docs.openzeppelin.com/test-environment/getting-started) to use Test Environment in a new project.
* If you are currently using `truffle test`, head instead to [Migrating from Truffle](https://docs.openzeppelin.com/test-environment/migrating-from-truffle).
* The [Choosing a Test Runner](https://docs.openzeppelin.com/test-environment/choosing-a-test-runner) guide will teach you how to use each of the different runners.
* For detailed usage information, take a look at the [API Reference](https://docs.openzeppelin.com/test-environment/api).
## License
Released under the [MIT License](LICENSE).