Add C++ test to obs-studio-server #1706
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| #include <catch2/catch_test_macros.hpp> | ||
| #include <fstream> | ||
| #include "nodeobs_api.h" | ||
| #include "osn-error.hpp" | ||
| #include <obs.h> | ||
| #include "shared.hpp" | ||
| #include <string> | ||
| #include "obs-setup.hpp" | ||
| #include <vector> | ||
|
|
||
| namespace osn::tests { | ||
|
|
||
| void setWorkingFolder(const std::string &wd) | ||
| { | ||
| std::vector<ipc::value> args = {ipc::value(wd)}; | ||
| std::vector<ipc::value> response; | ||
| OBS_API::SetWorkingDirectory(nullptr, 0, args, response); | ||
| REQUIRE(response.size() >= 2); | ||
| ErrorCode error = (ErrorCode)response[0].value_union.ui64; | ||
| CHECK(error == ErrorCode::Ok); | ||
|
sandboxcoder marked this conversation as resolved.
|
||
| } | ||
|
sandboxcoder marked this conversation as resolved.
|
||
|
|
||
| void setupApi() | ||
| { | ||
| #if defined(__APPLE__) | ||
| g_util_osx = new UtilInt(); | ||
| g_util_osx->init(); | ||
| // Workaround normal app startup where "browser_source" plugin is initialized | ||
| CHECK(!g_util_osx->hasInitApi()); | ||
| g_util_osx->nextState(); | ||
| CHECK(g_util_osx->hasInitApi()); | ||
| #endif | ||
| const std::string appPath = std::string(OSN_SOURCE_DIR) + "/tests/osn-tests/osnData/slobs-client"; | ||
| std::vector<ipc::value> args = {ipc::value(appPath), ipc::value("en-US"), ipc::value("0.00.00-preview.0"), ipc::value("")}; | ||
| std::vector<ipc::value> response; | ||
| OBS_API::OBS_API_initAPI(nullptr, 0, args, response); | ||
| REQUIRE(response.size() >= 2); | ||
| ErrorCode error = (ErrorCode)response[0].value_union.ui64; | ||
| CHECK(error == ErrorCode::Ok); | ||
|
sandboxcoder marked this conversation as resolved.
|
||
| } | ||
|
|
||
| ObsSetup::ObsSetup() | ||
| { | ||
| setWorkingFolder(OSN_TEST_WD); | ||
| setupApi(); | ||
| } | ||
|
|
||
| ObsSetup::~ObsSetup() | ||
| { | ||
| std::vector<ipc::value> args = {}; | ||
| std::vector<ipc::value> response; | ||
| OBS_API::OBS_API_destroyOBS_API(nullptr, 0, args, response); | ||
| REQUIRE(response.size() >= 1); | ||
|
Collaborator
There was a problem hiding this comment. https://catch2-temp.readthedocs.io/en/latest/configuration.html#disabling-exceptions |
||
| ErrorCode error = (ErrorCode)response[0].value_union.ui64; | ||
| CHECK(error == ErrorCode::Ok); | ||
|
sandboxcoder marked this conversation as resolved.
|
||
| } | ||
|
|
||
| } // namespace osn::tests | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| #pragma once | ||
|
|
||
| namespace osn::tests { | ||
| // This helper object uses RAII pattern to initialize & destroy OBS API | ||
| class ObsSetup { | ||
| public: | ||
| ObsSetup(); | ||
| ~ObsSetup(); | ||
| }; | ||
| } // namespace osn::tests |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| #include <catch2/catch_test_macros.hpp> | ||
| #include <mutex> | ||
| #include "nodeobs_api.h" | ||
| #include "osn-error.hpp" | ||
| #include "osn-input.hpp" | ||
| #include "osn-source.hpp" | ||
| #include <obs.h> | ||
| #include "shared.hpp" | ||
| #include <string> | ||
| #include "obs-setup.hpp" | ||
| #include <thread> | ||
| #include <vector> | ||
|
|
||
| TEST_CASE("Run osn::source tests") | ||
| { | ||
| osn::tests::ObsSetup setupOBS; | ||
|
|
||
|
sandboxcoder marked this conversation as resolved.
|
||
| SECTION("Get properties of browser source while releasing concurrently does not crash") | ||
|
sandboxcoder marked this conversation as resolved.
|
||
| { | ||
| auto sourceCount = osn::Source::Manager::GetInstance().size(); | ||
| const int iterations = 20; | ||
| std::vector<std::thread> workers; | ||
|
Collaborator
There was a problem hiding this comment. If a later |
||
| std::vector<uint8_t> releaseOk(iterations, 0); | ||
| std::vector<ErrorCode> getPropertiesCode(iterations, ErrorCode::Error); | ||
|
sandboxcoder marked this conversation as resolved.
|
||
|
|
||
| for (int i = 0; i < iterations; i++) { | ||
| const std::string sourceName = "test-input-" + std::to_string(i); | ||
| std::vector<ipc::value> args = {ipc::value("browser_source"), ipc::value(sourceName)}; | ||
| std::vector<ipc::value> response; | ||
|
|
||
| osn::Input::Create(nullptr, 0, args, response); | ||
| REQUIRE(response.size() >= 2); | ||
| ErrorCode error = (ErrorCode)response[0].value_union.ui64; | ||
| REQUIRE(error == ErrorCode::Ok); | ||
|
|
||
| uint64_t sourceId = response[1].value_union.ui64; | ||
|
|
||
| workers.push_back(std::thread([sourceId, i, &getPropertiesCode]() { | ||
| std::vector<ipc::value> propArgs = {ipc::value(sourceId)}; | ||
| std::vector<ipc::value> propResponse; | ||
| osn::Source::GetProperties(nullptr, 0, propArgs, propResponse); | ||
| if (propResponse.size() >= 1) { | ||
| getPropertiesCode[i] = (ErrorCode)propResponse[0].value_union.ui64; | ||
| } | ||
| })); | ||
|
|
||
| workers.push_back(std::thread([sourceId, i, &releaseOk]() { | ||
|
|
||
| #if defined(TRIGGER_CRASH) | ||
| // TODO: Enable this code block once staging (commit cc4a0431) is merged. | ||
| // Release the refcount to trigger actual private data destruction | ||
| obs_source_t *src = osn::Source::Manager::GetInstance().find(sourceId); // may be null already | ||
| if (src) { | ||
| obs_source_release(src); | ||
| releaseOk[i] = true; | ||
| } | ||
| #else | ||
| // TODO: delete this block after staging (commit cc4a0431) is merged. | ||
| std::vector<ipc::value> propArgs = {ipc::value(sourceId)}; | ||
| std::vector<ipc::value> propResponse; | ||
| osn::Source::Release(nullptr, 0, propArgs, propResponse); | ||
| // Capture result for checking on the main thread after join. | ||
| if (propResponse.size() >= 1) { | ||
| releaseOk[i] = ((ErrorCode)propResponse[0].value_union.ui64 == ErrorCode::Ok); | ||
| } | ||
| #endif | ||
| })); | ||
| } | ||
|
|
||
| for (std::thread &worker : workers) { | ||
| if (worker.joinable()) | ||
| worker.join(); | ||
| } | ||
|
|
||
| // Check release results on the main thread where Catch2 is safe to use. | ||
| for (int i = 0; i < iterations; i++) { | ||
| CHECK(releaseOk[i]); | ||
| // ErrorCode::InvalidReference is possible if the source was deleted before we could acquire the source | ||
| bool expectedErrorCode = getPropertiesCode[i] == ErrorCode::Ok || getPropertiesCode[i] == ErrorCode::InvalidReference; | ||
| CHECK(expectedErrorCode); | ||
| } | ||
| #if defined(TRIGGER_CRASH) | ||
| // TODO: Enable this code block once staging (commit cc4a0431) is merged. | ||
| CHECK(sourceCount == osn::Source::Manager::GetInstance().size()); // Check to see if all objects released. | ||
| #endif | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.