atiran/sovereignx
3
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed test system documentation (#5266)

Browse source
This commit is contained in:
Eduardo Quezada 2024-08-26 15:59:01 -04:00 committed by GitHub
parent 5de0f3cb4a
commit c075d8e6b1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/how_to_testing_system.md
View file

@ -4,9 +4,9 @@
To run all the tests use:
`make check -j`
To run specific tests, e.g. Spikes ones, use:
`make check TESTS='Spikes'`
`make check TESTS="Spikes"`
To build a ROM (pokemerald-test.elf) that can be opened in mgba to view specific tests, e.g. Spikes ones, use:
`make pokeemerald-test.elf TESTS='Spikes'`
`make pokeemerald-test.elf TESTS="Spikes"`
## How to Write Tests
Manually testing a battle mechanic often follows this pattern:
@ -54,7 +54,7 @@ The `ASSUMPTIONS` block documents that Stun Spore has `EFFECT_PARALYZE`.
If Stun Spore did not have that effect it would cause the tests in the file to be skipped. We write our tests like this so that hackers can change the effects of moves without causing tests to fail.
`SINGLE_BATTLE_TEST` defines the name of the test. Related tests should start with the same prefix, e.g. Stun Spore tests should start with "Stun Spore", this allows just the Stun Spore-related tests to be run with:
`make check TESTS='Stun Spore'`
`make check TESTS="Stun Spore"`
`GIVEN` initializes the parties, `PLAYER` and `OPPONENT` add a Pokémon to their respective parties. They can both accept a block which further customizes the Pokémon's stats, moves, item, ability, etc.

6
include/test/battle.h
View file

@ -3,10 +3,10 @@
* To run all the tests use:
* make check -j
* To run specific tests, e.g. Spikes ones, use:
* make check TESTS='Spikes'
* make check TESTS="Spikes"
* To build a ROM (pokemerald-test.elf) that can be opened in mgba to
* view specific tests, e.g. Spikes ones, use:
* make pokeemerald-test.elf TESTS='Spikes'
* make pokeemerald-test.elf TESTS="Spikes"
*
* Manually testing a battle mechanic often follows this pattern:
* 1. Create a party which can activate the mechanic.
@ -55,7 +55,7 @@
* start with the same prefix, e.g. Stun Spore tests should start with
* "Stun Spore", this allows just the Stun Spore-related tests to be run
* with:
* make check TESTS='Stun Spore'
* make check TESTS="Stun Spore"
*
* GIVEN initializes the parties, PLAYER and OPPONENT add a Pokémon to
* their respective parties. They can both accept a block which further