Skip to content

Commit

Permalink
Point out locations of where to add stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
p-offtermatt committed Dec 8, 2023
1 parent 84f5cd3 commit 05ab47d
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions tests/e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ The test config governs the config parameters of validators and chains that can
for example we can set the genesis parameters of a chain using `ChainConfig.GenesisChanges`.
* Define a sequence of actions and state checks to perform for our test case.
* Add the new test case to the main file [main.go](main.go).
* ...in the stepChoices slice, where you need to put your step slice and the test config you want to run your steps on.
* ...add your test config to the testConfigs map (which is used to specify configs when calling from the CLI)
* ...if your test case should run by default (if you're not sure, it probably should), also add it to the predefined test cases in
getTestCases (which governs which test cases will be run when no specific test case is specified on the CLI)

For example, a short sequence of actions and state checks could look like this:
```
Expand Down Expand Up @@ -132,6 +136,9 @@ if err != nil {
// potentially check something in the output, or log something, ...
```

Don't forget to wire your action into [main.go](main.go):runStep, where
the action structs and functions to run for each of them are wired together.

**Note:** Actions don't need to check that the state was modified correctly,
since we have the state checks for this.
Still, it's generally a good idea to do a basic check for errors,
Expand Down

0 comments on commit 05ab47d

Please sign in to comment.