https://github.com/meherett/pytest-solidity

PyTest plugin for testing smart contracts for Ethereum blockchain.
https://github.com/meherett/pytest-solidity

cobra ethereum ethereum-blockchain pytest pytest-cobra pytest-plugin python smart-contracts solidity

Last synced: 3 months ago
JSON representation

PyTest plugin for testing smart contracts for Ethereum blockchain.

• Host: GitHub
• URL: https://github.com/meherett/pytest-solidity
• Owner: meherett
• License: mit
• Created: 2018-09-12T01:25:45.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T06:39:34.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T14:57:32.718Z (7 months ago)
• Topics: cobra, ethereum, ethereum-blockchain, pytest, pytest-cobra, pytest-plugin, python, smart-contracts, solidity
• Language: Python
• Homepage: https://pypi.org/project/pytest-cobra
• Size: 184 KB
• Stars: 26
• Watchers: 3
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• DeFi-Developer-Road-Map - Plugin for testing smart contracts

README

        
	

  		



# PyTest-Cobra ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytest-cobra.svg?style=for-the-badge)

*PyTest plugin for testing Smart Contracts for Ethereum blockchain.*

[![Build Status](https://travis-ci.com/cobraframework/pytest-cobra.svg?branch=master)](https://travis-ci.com/cobraframework/pytest-cobra)

![PyPI Version](https://img.shields.io/pypi/v/pytest-cobra.svg?color=blue)

![GitHub License](https://img.shields.io/github/license/cobraframework/pytest-cobra.svg)

![Github Date](https://img.shields.io/github/release-date/cobraframework/pytest-cobra.svg?color=black)

![PyPI Wheel](https://img.shields.io/pypi/wheel/pytest-cobra.svg?color=%2308490e)

[![Donate with Ethereum](https://en.cryptobadges.io/badge/micro/0xD32AAEDF28A848e21040B6F643861A9077F83106)](https://en.cryptobadges.io/donate/0xD32AAEDF28A848e21040B6F643861A9077F83106)

## Dependency

This library requires the `solc` executable to be present.

Only versions `>=0.4.2` are supported and tested though this library may work

with other versions.

[solc installation instructions](http://solidity.readthedocs.io/en/latest/installing-solidity.html)

Install Solidity compiler (solc) using Node Package  Manager(npm)

```

npm install -g solc

```

or for Ubuntu(Linux)

```

sudo add-apt-repository ppa:ethereum/ethereum

sudo apt-get update

sudo apt-get install solc

```

## Quickstart

Installation

```

pip install pytest-cobra

```

## Development

Clone the repository and then run

```

pip install -e . -r requirements.txt

```

## Usage

#### Execute your test suite

 Example MetaCoin

 [picture](https://github.com/cobraframework/pytest-cobra/blob/master/example/example.png)

```python

# MetaCoin Testing

# cobra is pytest fixture

def test_metacoin(cobra):

    # Getting Contract Factory by name

    metacoin = cobra.contract('MetaCoin')

    

    # Getting Contract Instance of MetaCoin

    metacoin = metacoin.deploy()

    assert metacoin.getBalance(cobra.accounts[0]) == 10000

```

### Running test from Solidity file (.sol)

```

pytest --cobra MetaCoin.sol

```

#### Optional commands

##### Import path remappings

`solc` provides path aliasing allow you to have more reusable project configurations.

```

pytest --cobra MetaCoin.sol --import_remappings ["zeppeling=/my-zeppelin-checkout-folder"]

```

##### Allow paths

```

pytest --cobra MetaCoin.sol --allow_paths "/home/meheret,/user,/"

```

### Running test from compiled Contracts Json file (.json)

Compile your contracts into a package (soon to be ethPM-compliant)

```

solc --combined-json abi,bin,bin-runtime contracts/ > MetaCoin.json

```

Testing Contracts.json

```

pytest --cobra MetaCoin.json

```

### Running test from Yaml file (.yaml) 

```yaml

test:

  artifact_path: "./build/contracts/"

  test_paths: ["./tests"]

  contracts: [

    contract: {

        artifact: "Contract.json",

        links: ["Contract.json"]

    }

  ]

```

## Further help

##### PyTest

Go check out the [PyTest](http://pytest.org).

## Author ✒️

* **Meheret Tesfaye** - *Initial work* - [Cobra](https://github.com/cobraframework)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details