Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/firedancer-io/solana-conformance
Conformance test suite for the Solana protocol
https://github.com/firedancer-io/solana-conformance
firedancer solana
Last synced: about 2 months ago
JSON representation
Conformance test suite for the Solana protocol
- Host: GitHub
- URL: https://github.com/firedancer-io/solana-conformance
- Owner: firedancer-io
- Created: 2024-03-12T17:35:04.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-13T20:55:05.000Z (about 2 months ago)
- Last Synced: 2024-11-13T21:22:53.045Z (about 2 months ago)
- Topics: firedancer, solana
- Language: Python
- Homepage:
- Size: 382 KB
- Stars: 9
- Watchers: 7
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Solana Test Suite
This tool allows for validation of targets (e.g. Firedancer) against Solana Agave by running it against a series of predefined tests. It takes either binary or human-readable Protobuf messages as inputs and runs them through the specified targets. It also includes functionality to validate targets for other issues, such as memory corruption.
## Requirements
This tool works on RHEL8 or Ubuntu.
## Installation
Clone this repository and, for RHEL8, run:
```sh
source install.sh
```
For Ubuntu, run:
```sh
source install_ubuntu.sh
```
### Install auto-completion
```sh
solana-test-suite --install-completion
```
You will need to reload your shell + the `test_suite_env` venv to see the changes.
## Currently Supported Harness Types
`list-harness-types` will provide the most updated list.
```
$ solana-test-suite list-harness-types
Available harness types:
- ElfLoaderHarness
- InstrHarness
- SyscallHarness
- CpiHarness
- VmInterpHarness
- VmValidateHarness
- TxnHarness
```
## Protobuf
Each target must contain a function entrypoint that takes in a Context input message and outputs a Effects message (see [`proto/invoke.proto`](https://github.com/firedancer-io/protosol/blob/main/proto/invoke.proto) as an example).
```
Function Entrypoints:
- ElfLoaderHarness: sol_compat_elf_loader_v1
- InstrHarness: sol_compat_instr_execute_v1
- SyscallHarness: sol_compat_vm_syscall_execute_v1
- CpiHarness: sol_compat_vm_cpi_syscall_v1
- VmInterpHarness: sol_compat_vm_interp_v1
- VmValidateHarness: sol_compat_vm_validate_v1
- TxnHarness: sol_compat_txn_execute_v1
```
### Updating definitions
All message definitions are defined in [protosol](https://github.com/firedancer-io/protosol/). Anytime, protofuf definitions are updated in protosol, you will need to run the following command:
```sh
./fetch_and_generate.sh
```
## Setting up Environment
To setup the `solana-conformance` environment, run the following command and you will be all set:
```
source test_suite_env/bin/activate
```
## Usage
Run the following to view all supported commands or refer to [commands.md](commands.md):
```
solana-test-suite --help
```
### Preferred Debugging
Use the following command instead if you want the ability to debug in GDB:
```
--args python3.11 -m test_suite.test_suite exec-instr --input --target
```
Refer to [`exec-instr`](commands.md#solana-test-suite-exec-instr) command for more information.
Recommended usage is opening two terminals side by side, and running the above command on the same output while changing the target parameter to the two desired targets and stepping through the debugger for each corresponding test case.
### Uninstalling
```sh
source clean.sh
```