From 878d914777a03a04ecb84217152e8b7fd73a5062 Mon Sep 17 00:00:00 2001 From: Sebastian Falbesoner Date: Fri, 8 Dec 2023 17:39:23 +0100 Subject: [PATCH] doc: test: mention OS detection preferences in style guideline --- test/functional/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/test/functional/README.md b/test/functional/README.md index 1bd618a0c34..a4994f2e7c9 100644 --- a/test/functional/README.md +++ b/test/functional/README.md @@ -37,6 +37,10 @@ don't have test cases for. `set_test_params()`, `add_options()` and `setup_xxxx()` methods at the top of the subclass, then locally-defined helper methods, then the `run_test()` method. - Use `f'{x}'` for string formatting in preference to `'{}'.format(x)` or `'%s' % x`. +- Use `platform.system()` for detecting the running operating system and `os.name` to + check whether it's a POSIX system (see also the `skip_if_platform_not_{linux,posix}` + methods in the `BitcoinTestFramework` class, which can be used to skip a whole test + depending on the platform). #### Naming guidelines