steffen/marl-factory-grid
1
0
Fork 0
mirror of https://github.com/illiumst/marl-factory-grid.git synced 2025-07-05 09:01:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

imporvements of testing/new scenario documentation and inclusion in index

Browse Source
This commit is contained in:
Chanumask
2024-01-29 14:35:01 +01:00
parent 1fb35d875e
commit 26a59b5c01
3 changed files with 38 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/testing.rst
View File

@ -1,3 +1,15 @@
Testing
=======
In EDYS, tests are seamlessly integrated through environment hooks, mirroring the organization of rules, as explained in the README.md file.
Running tests
-------------
To include specific tests in your run, simply append them to the "tests" section within the configuration file.
If you want to write new tests, refer to the tests.py file for examples. There are no additional steps required, except for the straightforward inclusion of your custom tests in the configuration.
If the test requires a specific entity in the environment (i.e the clean up test requires a TSPDirtAgent that can observe
and clean dirt in its environment), make sure to include it in the config file.
Writing tests
------------
If you intend to create additional tests, refer to the tests.py file for examples.
Ensure that any new tests implement the corresponding test class and make use of its hooks.
There are no additional steps required, except for the inclusion of your custom tests in the config file.