godot/tests/SCsub

#!/usr/bin/env python
from misc.utility.scons_hints import *

Import("env")

env.tests_sources = []

env_tests = env.Clone()

# We must disable the THREAD_LOCAL entirely in doctest to prevent crashes on debugging
# Since we link with /MT thread_local is always expired when the header is used
# So the debugger crashes the engine and it causes weird errors
# Explained in https://github.com/onqtam/doctest/issues/401
if env_tests["platform"] == "windows":
    env_tests.Append(CPPDEFINES=[("DOCTEST_THREAD_LOCAL", "")])

if env["disable_exceptions"]:
    env_tests.Append(CPPDEFINES=["DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS"])

env_tests.add_source_files(env.tests_sources, "*.cpp")

lib = env_tests.add_library("tests", env.tests_sources)
env.Prepend(LIBS=[lib])
SCons: Add unobtrusive type hints in SCons files 2024-06-11 20:19:07 +00:00			`#!/usr/bin/env python`
			`from misc.utility.scons_hints import *`
SCsub: Add python shebang as a hint for syntax highlighting Also switch existing shebangs to "better" /usr/bin/env python. 2016-10-17 06:50:25 +00:00
SCons: Format buildsystem files with psf/black Configured for a max line length of 120 characters. psf/black is very opinionated and purposely doesn't leave much room for configuration. The output is mostly OK so that should be fine for us, but some things worth noting: - Manually wrapped strings will be reflowed, so by using a line length of 120 for the sake of preserving readability for our long command calls, it also means that some manually wrapped strings are back on the same line and should be manually merged again. - Code generators using string concatenation extensively look awful, since black puts each operand on a single line. We need to refactor these generators to use more pythonic string formatting, for which many options are available (`%`, `format` or f-strings). - CI checks and a pre-commit hook will be added to ensure that future buildsystem changes are well-formatted. 2020-03-30 06:28:32 +00:00			`Import("env")`
GODOT IS OPEN SOURCE 2014-02-10 01:10:30 +00:00
style: Fix PEP8 whitespace issues in Python files Done with `autopep8 --select=E2,W2`, fixes: - E201 - Remove extraneous whitespace. - E202 - Remove extraneous whitespace. - E203 - Remove extraneous whitespace. - E211 - Remove extraneous whitespace. - E221 - Fix extraneous whitespace around keywords. - E222 - Fix extraneous whitespace around keywords. - E223 - Fix extraneous whitespace around keywords. - E224 - Remove extraneous whitespace around operator. - E225 - Fix missing whitespace around operator. - E226 - Fix missing whitespace around operator. - E227 - Fix missing whitespace around operator. - E228 - Fix missing whitespace around operator. - E231 - Add missing whitespace. - E231 - Fix various deprecated code (via lib2to3). - E241 - Fix extraneous whitespace around keywords. - E242 - Remove extraneous whitespace around operator. - E251 - Remove whitespace around parameter '=' sign. - E261 - Fix spacing after comment hash. - E262 - Fix spacing after comment hash. - E265 - Format block comments. - E271 - Fix extraneous whitespace around keywords. - E272 - Fix extraneous whitespace around keywords. - E273 - Fix extraneous whitespace around keywords. - E274 - Fix extraneous whitespace around keywords. - W291 - Remove trailing whitespace. - W293 - Remove trailing whitespace. 2016-10-30 17:57:40 +00:00			`env.tests_sources = []`
GODOT IS OPEN SOURCE 2014-02-10 01:10:30 +00:00
SCons: Build tests/ and main/ in cloned environments Allows switching `tests=yes`/`no` and rebuilding only tests and main, instead of the whole engine. Co-authored-by: Andrii Doroshenko (Xrayez) <xrayez@gmail.com> 2020-07-26 13:53:01 +00:00			`env_tests = env.Clone()`

Crash when debugging tests by disabling thread_local in /MT context 2020-07-26 16:18:25 +00:00			`# We must disable the THREAD_LOCAL entirely in doctest to prevent crashes on debugging`
			`# Since we link with /MT thread_local is always expired when the header is used`
			`# So the debugger crashes the engine and it causes weird errors`
			`# Explained in https://github.com/onqtam/doctest/issues/401`
			`if env_tests["platform"] == "windows":`
			`env_tests.Append(CPPDEFINES=[("DOCTEST_THREAD_LOCAL", "")])`

SCons: Disable C++ exception handling Upon investigating the extremely slow MSVC build times in #80513, I noticed that while Godot policy is to never use exceptions, we weren't enforcing it with compiler flags, and thus still included exception handling code and stack unwinding. This is wasteful on multiple aspects: - Binary size: Around 20% binary size reduction with exceptions disabled for both MSVC and GCC binaries. - Compile time: * More than 50% build time reduction with MSVC. * 10% to 25% build time reduction with GCC + LTO. - Performance: Possibly, needs to be benchmarked. Since users may want to re-enable exceptions in their own thirdparty code or the libraries they compile with Godot, this behavior can be toggled with the `disable_exceptions` SCons option, which defaults to true. 2023-08-14 11:02:40 +00:00			`if env["disable_exceptions"]:`
			`env_tests.Append(CPPDEFINES=["DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS"])`
Increase number of sections in object files for tests with MSVC 2020-12-30 13:48:23 +00:00
SCons: Build tests/ and main/ in cloned environments Allows switching `tests=yes`/`no` and rebuilding only tests and main, instead of the whole engine. Co-authored-by: Andrii Doroshenko (Xrayez) <xrayez@gmail.com> 2020-07-26 13:53:01 +00:00			`env_tests.add_source_files(env.tests_sources, "*.cpp")`

			`lib = env_tests.add_library("tests", env.tests_sources)`
GODOT IS OPEN SOURCE 2014-02-10 01:10:30 +00:00			`env.Prepend(LIBS=[lib])`