Skip to content

Commit

Permalink
Update test generation docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mpetrunic authored Feb 23, 2021
1 parent e35b850 commit 9f634dc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions tests/generators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Prerequisites:

### Cleaning

This removes the existing virtual environments (`/test_generators/<generator>/venv`) and generated tests (`/yaml_tests/`).
This removes the existing virtual environments (`/tests/generators/<generator>/venv`) and generated tests (`../eth2.0-spec-tests/tests`).

```bash
make clean
Expand All @@ -47,15 +47,15 @@ make clean
This runs all of the generators.

```bash
make -j 4 gen_yaml_tests
make -j 4 generate_tests
```

The `-j N` flag makes the generators run in parallel, with `N` being the amount of cores.


### Running a single generator

The makefile auto-detects generators in the `test_generators` directory and provides a tests-gen target for each generator. See example:
The makefile auto-detects generators in the `tests/generators` directory and provides a tests-gen target for each generator. See example:

```bash
make ./eth2.0-spec-tests/tests/shuffling/
Expand Down Expand Up @@ -210,7 +210,7 @@ Recommendations:

To add a new test generator that builds `New Tests`:

1. Create a new directory `new_tests` within the `test_generators` directory.
1. Create a new directory `new_tests` within the `tests/generators` directory.
Note that `new_tests` is also the name of the directory in which the tests will appear in the tests repository later.
2. Your generator is assumed to have a `requirements.txt` file,
with any dependencies it may need. Leave it empty if your generator has none.
Expand Down

0 comments on commit 9f634dc

Please sign in to comment.