apple/foundationdb
Add documentation on simulation testing at scale
Aberta
#4.663 aberto em 14 de abr. de 2021
documentationgood first issue
Métricas do repositório
- Stars
- (13.912 estrelas)
- Métricas de merge de PR
- (Mesclagem média 4d) (78 fundiu PRs em 30d)
Description
Now we have open sourced the Joshua testing framework. It's time to add documentation on how to run simulation testings at scale, probably improve both documentation here and at Joshua project. This will make it easier for contributors other than Apple and Snowflake.
To start, we need to describe the steps for setting up the testing infrastructure:
- Have a FoundationDB cluster running.
- Build and run the docker image from this script, make sure the docker image uses the same FDB version as the cluster in the first step. Go inside the docker image and make sure it can talk to the cluster.
- Create a correctness package (i.e., as simple as
ninja package_tests). - Submit correctness package to the cluster.
We also need descriptions on how to check simulation results, e.g., how many failed, how to reproduce, inactive jobs, etc.