Testing in Tezos

Testing is important to ensure the quality of the Tezos codebase by detecting bugs and avoiding regressions. Tezos and its components use a variety of tools and frameworks for testing.

This page groups the documentation helping developers to design, write, and execute tests on the Tezos codebase. It covers different kinds of tests (Unit, Integration, etc.) and the associated tools and frameworks. It also includes tutorials for testing more specific parts such as protocol code.

• Overview of Testing in Tezos
  • Testing frameworks
  • Executing tests locally
  • Executing tests through the GitLab CI
  • Conventions

• Ppx_expect
  • How to run tests
  • How to add tests
  • Where to put the tests
  • Integration with Lwt

• Python Execution and Testing Environment
  • Code organization
  • Installation
  • Using poetry to execute pytest
  • A simple sandbox scenario
  • Test suite and pytest
  • Regression testing
  • TODO
  • Known issues
  • Adding new dependencies

• Tezt: OCaml Tezos Test Framework
  • How to Run Tests
  • How to Write New Integration Tests
  • How to Write New Unit Tests
  • Regression Tests
  • Pre-commit hook

• Tezt: Long Tests and Performance Regression Test Framework
  • Adding a Long Test
  • Performance Regression Test framework: Time Series, Alerts and Graphs
  • Example
  • One-Shot Tests
  • Providing Large Data
  • Testing Your Benchmarks Locally

• Making legacy code unit-testable
  • Solutions

• How to Test a Protocol Proposal
  • The master Branch
  • Unit Tests and Sandboxed Mode
  • Testing Migration Code
  • Manual Migration Testing
  • Wrap up the Manual Migration Procedure
  • Automatic Migration Testing With Tezt
  • Wrap up the Automatic Migration Procedure With Tezt
  • Tips and Tricks
  • Anatomy of Migration Code