self-hosted/docker-mailserver
1
0
Fork 0
mirror of https://github.com/docker-mailserver/docker-mailserver.git synced 2025-05-31 01:27:48 +02:00
Code Issues Releases Activity

docs: Contributing (tests) - Link to guidance for TEST_TMP_CONFIG (#4451)

Browse Source
This commit is contained in:
Brennan Kinney 2025-04-22 03:29:39 +12:00 committed by GitHub
parent 23bb1c8e50
commit b653d9a586
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/content/contributing/tests.md
View File

@ -35,6 +35,10 @@ There are many functions that aid in writing tests. **We urge you to use them!**
We encourage you to try both of the approaches mentioned above. To make understanding and using the helper functions easy, every function contains detailed documentation comments. Read them carefully!
!!! tip
If your test needs to add or create additional files, our helpers will [manage a disposable config directory per container][technical-guide::test-tmp-config] for you with the path stored in the `TEST_TMP_CONFIG` ENV (outside the container, `/tmp/docker-mailserver` within the container).
### How Are Tests Run?
Tests are split into two categories:
@ -141,3 +145,4 @@ $ make clean tests
[testing-prs]: https://github.com/docker-mailserver/docker-mailserver/blob/master/.github/workflows/test_merge_requests.yml
[get-docker]: https://docs.docker.com/get-docker/
[docs-bats-parallel]: https://bats-core.readthedocs.io/en/v1.8.2/usage.html#parallel-execution
[technical-guide::test-tmp-config]: https://github.com/docker-mailserver/docker-mailserver/pull/4359#issuecomment-2817591085