Add C++ test to obs-studio-server by sandboxcoder · Pull Request #1706 · streamlabs/obs-studio-node

sandboxcoder · 2026-05-22T17:18:02Z

Description

This pull request depends on another pull request. After that PR is merged, we can merge this one.
Add support for Catch2 testing framework C++ obs-studio-server tests
Turn obs-studio-server into static lib
Add null check on g_server in obs-studio-server/source/nodeobs_api.cpp since we do not need ipc server running during these tests

Motivation and Context

There are some tests that we can run much more easily from C++. We can get better code coverage from these tests in certain cases.

How Has This Been Tested?

Types of changes

New feature (non-breaking change which adds functionality)

Checklist:

The code has been tested.
All commit messages are properly formatted and commits squashed where appropriate.
I have included updates to all appropriate documentation.

Copilot

Pull request overview

Adds a Catch2-based C++ unit-test executable for obs-studio-server and restructures the server build so the core code can be linked into tests (and the main server executable) via a new static library.

Changes:

Introduces new Catch2 test(s) for osn::Source concurrency behavior plus OBS init/teardown helpers.
Refactors obs-studio-server CMake to build a obs-studio-server-lib static library and link both the server executable and unit tests against it.
Updates CI unit-test runner to execute both client and server Catch2 test suites.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
obs-studio-server/tests/test-osn-source.cpp	Adds a Catch2 test exercising concurrent `GetProperties` / `Release` on browser sources.
obs-studio-server/tests/test-helper.hpp	Declares a small helper for initializing/finalizing OBS for tests.
obs-studio-server/tests/test-helper.cpp	Implements OBS initialization/teardown and runtime parsing of test working directory.
obs-studio-server/source/nodeobs_api.cpp	Guards crash-manager server callback registration behind a `g_server` null check.
obs-studio-server/CMakeLists.txt	Builds server core as a static lib and adds a Catch2 unit-test executable with test discovery.
ci/run-unit-tests.js	Runs both `obs-studio-client` and `obs-studio-server` CTest-discovered Catch2 suites in CI.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

aleksandr-voitenko · 2026-05-22T18:21:55Z

+target_include_directories(obs-studio-server-lib PUBLIC ${PROJECT_INCLUDE_PATHS})
+
+if(WIN32)
+    target_link_libraries(obs-studio-server-lib PUBLIC ${PROJECT_LIBRARIES} optimized crashpad strmiids)


Now that most server sources are compiled into obs-studio-server-lib, the Windows compile definitions below (WIN32_LEAN_AND_MEAN, NOMINMAX, UNICODE, _UNICODE) no longer apply to those sources because they are still scoped only to ${PROJECT_NAME}. ${PROJECT_NAME} now compiles just main.cpp, so the actual server implementation may build with different Windows/Unicode macro state than before. Please move or duplicate the Windows target_compile_definitions onto obs-studio-server-lib.

This has been addressed thanks

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

* Add support for Catch2 C++ test * Turn obs-server into a static lib * Add osn-source test

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

aleksandr-voitenko · 2026-05-29T16:50:40Z

+	std::vector<ipc::value> args = {};
+	std::vector<ipc::value> response;
+	OBS_API::OBS_API_destroyOBS_API(nullptr, 0, args, response);
+	REQUIRE(response.size() >= 1);


https://catch2-temp.readthedocs.io/en/latest/configuration.html#disabling-exceptions

By default, Catch2 uses exceptions to signal errors and to abort tests when an assertion from the REQUIRE family of assertions fails.

aleksandr-voitenko · 2026-05-29T16:51:54Z

+	{
+		auto sourceCount = osn::Source::Manager::GetInstance().size();
+		const int iterations = 20;
+		std::vector<std::thread> workers;


If a later REQUIRE aborts after earlier iterations started threads, workers will be destroyed while still joinable and terminate the process. Please add an RAII join guard or create all inputs before starting worker threads.

aleksandr-voitenko · 2026-05-29T16:55:34Z

+            "$<TARGET_FILE_DIR:Catch2::Catch2>"
+            "$<TARGET_FILE_DIR:Catch2::Catch2WithMain>"
+            "$<TARGET_FILE_DIR:libcurl>"
+if(APPLE)


CMake does not parse if() blocks recursively inside another command’s parentheses.

In CMake, this is a command invocation:

catch_discover_tests( obs_studio_server_unit_tests DL_PATHS ... if(APPLE) ... endif() )

Everything between catch_discover_tests( and its matching ) is parsed as that command’s argument list. The if(APPLE) there is not treated as the start of a conditional block; it is just an unquoted argument/token inside the catch_discover_tests call.

sandboxcoder requested a review from Copilot May 22, 2026 17:53

Copilot started reviewing on behalf of sandboxcoder May 22, 2026 17:53 View session

Copilot AI reviewed May 22, 2026

View reviewed changes

aleksandr-voitenko reviewed May 22, 2026

View reviewed changes

This was referenced May 22, 2026

add strong ref to resolve race condition #1707

Merged

addref to obs_source_t* before getProperties #1701

Merged

sandboxcoder requested a review from Copilot May 22, 2026 20:08

Copilot started reviewing on behalf of sandboxcoder May 22, 2026 20:09 View session

Copilot AI reviewed May 22, 2026

View reviewed changes

Comment thread obs-studio-server/tests/obs-setup.cpp

Comment thread obs-studio-server/tests/obs-setup.cpp

Comment thread obs-studio-server/tests/obs-setup.cpp Outdated

Comment thread obs-studio-server/tests/test-osn-source.cpp

Add C++ test to obs-studio-server

99d1c4d

* Add support for Catch2 C++ test * Turn obs-server into a static lib * Add osn-source test

sandboxcoder force-pushed the rno/obs-source-getproperties-test branch from f24f68f to 99d1c4d Compare May 26, 2026 17:00

sandboxcoder added 7 commits May 26, 2026 20:08

working dir via cmake & set testHelper use RAII

c22425c

fix MacOS build

dd5a1c8

add libcurl to MacOS test

c0a2371

use CMAKE_INSTALL_PREFIX for working directory

be78a66

fix missing framework issue on MacOS

72bea85

rename TestHelper -> ObsSetup

323733b

use REQUIRE to guard before indexing

290fc88

sandboxcoder requested a review from Copilot May 28, 2026 15:31

Copilot started reviewing on behalf of sandboxcoder May 28, 2026 15:31 View session

Copilot AI reviewed May 28, 2026

View reviewed changes

sandboxcoder added 7 commits May 28, 2026 10:46

catch_discover_tests cleanup

51ddb28

update test to trigger crash

72e7d20

enable test to pass on CI env until staging is merged

c600680

run clang-format

83be350

wrap check for object destruction

73c542a

run clang-format

64f5339

remove extra empty returns

39d3004

sandboxcoder marked this pull request as ready for review May 29, 2026 16:00

aleksandr-voitenko reviewed May 29, 2026

View reviewed changes

mark TODO comments

b1ba437

Conversation

sandboxcoder commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aleksandr-voitenko May 22, 2026

Choose a reason for hiding this comment

Uh oh!

sandboxcoder May 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

aleksandr-voitenko May 29, 2026

Choose a reason for hiding this comment

Uh oh!

aleksandr-voitenko May 29, 2026

Choose a reason for hiding this comment

Uh oh!

aleksandr-voitenko May 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sandboxcoder commented May 22, 2026 •

edited

Loading