| Matthew Treinish | 817a808 | 2014-07-25 16:07:20 -0400 | [diff] [blame] | 1 | .. _unit_tests_field_guide: |
| Matthew Treinish | a9aef87 | 2014-07-25 16:03:08 -0400 | [diff] [blame] | 2 | |
| Masayuki Igawa | c268dd6 | 2013-09-18 00:51:05 +0900 | [diff] [blame] | 3 | Tempest Field Guide to Unit tests |
| 4 | ================================= |
| Matthew Treinish | 32d3570 | 2013-08-13 11:59:06 -0400 | [diff] [blame] | 5 | |
| 6 | What are these tests? |
| 7 | --------------------- |
| 8 | |
| 9 | Unit tests are the self checks for Tempest. They provide functional |
| Jordan Pittier | 74a56ab | 2017-04-26 16:46:20 +0200 | [diff] [blame] | 10 | verification and regression checking for the internal components of Tempest. |
| 11 | They should be used to just verify that the individual pieces of Tempest are |
| Matthew Treinish | 32d3570 | 2013-08-13 11:59:06 -0400 | [diff] [blame] | 12 | working as expected. They should not require an external service to be running |
| Jordan Pittier | 74a56ab | 2017-04-26 16:46:20 +0200 | [diff] [blame] | 13 | and should be able to run solely from the Tempest tree. |
| Matthew Treinish | 32d3570 | 2013-08-13 11:59:06 -0400 | [diff] [blame] | 14 | |
| Jordan Pittier | 74a56ab | 2017-04-26 16:46:20 +0200 | [diff] [blame] | 15 | Why are these tests in Tempest? |
| Matthew Treinish | 32d3570 | 2013-08-13 11:59:06 -0400 | [diff] [blame] | 16 | ------------------------------- |
| Martin Kopec | d76178e | 2024-01-16 20:43:56 +0100 | [diff] [blame] | 17 | |
| Matthew Treinish | 32d3570 | 2013-08-13 11:59:06 -0400 | [diff] [blame] | 18 | These tests exist to make sure that the mechanisms that we use inside of |
| Jordan Pittier | 74a56ab | 2017-04-26 16:46:20 +0200 | [diff] [blame] | 19 | Tempest are valid and remain functional. They are only here for self |
| 20 | validation of Tempest. |
| Matthew Treinish | 32d3570 | 2013-08-13 11:59:06 -0400 | [diff] [blame] | 21 | |
| 22 | |
| 23 | Scope of these tests |
| 24 | -------------------- |
| Martin Kopec | d76178e | 2024-01-16 20:43:56 +0100 | [diff] [blame] | 25 | |
| Matthew Treinish | 32d3570 | 2013-08-13 11:59:06 -0400 | [diff] [blame] | 26 | Unit tests should not require an external service to be running or any extra |
| 27 | configuration to run. Any state that is required for a test should either be |
| 28 | mocked out or created in a temporary test directory. (see test_wrappers.py for |
| 29 | an example of using a temporary test directory) |