The source compatibility suite prevents regressions and helps understand what impact changes in the language and implementation have on real-world Cadence projects.
The suite contains a set of repository descriptions. When the suite is run, the repositories get cloned and checked. The runner can optionally run benchmarks and compare against another commit / branch, producing output in the terminal (pretty), as JSON, or Markdown.
In the future we can integrate this as part of CI, maybe as a periodic job.
-
Install the dependencies:
pip3 install -r requirements.txt
-
Run the suite. For example, to clone the repositories, benchmark, and compare to branch
master:python3 main.py --format=pretty --bench --compare-ref master