random-mirrors/opensbi
1
0
Fork 0
mirror of https://github.com/riscv-software-src/opensbi synced 2025-10-14 21:06:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: writing_tests: Make docs correspond the latest changes

Browse Source 
We should store test object files list in the `libsbi-objs-y` Makefile
variable, not in `libsbitests-objs-y`. Update the documentation
correspondingly.

Since we don't use the `console_dev` static variable directly in the
`sbi_console_test` unit test anymore, remove the paragraph which says
that we do.

Fixes: 86224ec36aed ("docs/writing_tests: Update tests paths")
Signed-off-by: Ivan Orlov <ivan.orlov0322@gmail.com>
Reviewed-by: Anup Patel <anup@brainfault.org>
This commit is contained in:
Ivan Orlov 2024-03-19 16:02:39 +00:00 committed by Anup Patel
parent f7d0050755
commit 3b2f89e3d6
1 changed files with 1 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/writing_tests.md
View File

@ -53,8 +53,8 @@ SBIUNIT_TEST_SUITE(string_test_suite, string_test_cases);
Then, add the corresponding Makefile entries to `lib/sbi/tests/objects.mk`: Then, add the corresponding Makefile entries to `lib/sbi/tests/objects.mk`:
```lang-makefile ```lang-makefile
... ...
libsbitests-objs-$(CONFIG_SBIUNIT) += sbi_string_test.o
carray-sbi_unit_tests-$(CONFIG_SBIUNIT) += string_test_suite carray-sbi_unit_tests-$(CONFIG_SBIUNIT) += string_test_suite
libsbi-objs-$(CONFIG_SBIUNIT) += tests/sbi_string_test.o
``` ```
If you compiled OpenSBI with CONFIG_SBIUNIT enabled before, you may need to If you compiled OpenSBI with CONFIG_SBIUNIT enabled before, you may need to
@ -113,9 +113,6 @@ carray-sbi_unit_tests-$(CONFIG_SBIUNIT) += string_test_suite
You don't have to compile the `sbi_string_test.o` separately, because the You don't have to compile the `sbi_string_test.o` separately, because the
test code will be included into the `sbi_string` object file. test code will be included into the `sbi_string` object file.
See example in `lib/sbi/tests/sbi_console_test.c`, where statically declared
`console_dev` variable is used to mock the `sbi_console_device` structure.
"Mocking" the structures "Mocking" the structures
------------------------ ------------------------
See the example of structure "mocking" in `lib/sbi/tests/sbi_console_test.c`, See the example of structure "mocking" in `lib/sbi/tests/sbi_console_test.c`,