noury/mirror-chatterino2
1
0
Fork 0
mirror of https://github.com/Chatterino/chatterino2.git synced 2024-11-13 19:49:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Refactor tests and benchmarks (#4700)

Browse source
This commit is contained in:
nerix 2023-06-24 15:03:27 +02:00 committed by GitHub
parent 5d3e5d9312
commit b9934a4532
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 109 additions and 179 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.github/workflows/test.yml vendored
View file

@ -7,6 +7,7 @@ on:
env:
TWITCH_PUBSUB_SERVER_IMAGE: ghcr.io/chatterino/twitch-pubsub-server-test:v1.0.6
QT_QPA_PLATFORM: minimal
concurrency:
group: test-${{ github.ref }}
@ -74,7 +75,7 @@ jobs:
if: startsWith(matrix.os, 'ubuntu')
run: |
cmake -DBUILD_TESTS=On -DBUILD_APP=OFF ..
cmake --build . --config Release
cmake --build .
working-directory: build-test
shell: bash
@ -85,6 +86,6 @@ jobs:
docker pull ${{ env.TWITCH_PUBSUB_SERVER_IMAGE }}
docker run --network=host --detach ${{ env.TWITCH_PUBSUB_SERVER_IMAGE }}
docker run -p 9051:80 --detach kennethreitz/httpbin
./bin/chatterino-test --platform minimal || ./bin/chatterino-test --platform minimal || ./bin/chatterino-test --platform minimal
./bin/chatterino-test || ./bin/chatterino-test || ./bin/chatterino-test
working-directory: build-test
shell: bash

1
CHANGELOG.md
View file

@ -28,6 +28,7 @@
- Dev: Added support for compiling with `sccache`. (#4678)
- Dev: Added `sccache` in Windows CI. (#4678)
- Dev: Moved preprocessor Git and date definitions to executables only. (#4681)
- Dev: Refactored tests to be able to use `ctest` and run in debug builds. (#4700)
## 2.4.4

1
CMakeLists.txt
View file

@ -138,6 +138,7 @@ find_package(RapidJSON REQUIRED)
find_package(Websocketpp REQUIRED)
if (BUILD_TESTS)
include(GoogleTest)
# For MSVC: Prevent overriding the parent project's compiler/linker settings
# See https://github.com/google/googletest/blob/main/googletest/README.md#visual-studio-dynamic-vs-static-runtimes
set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)

6
benchmarks/src/main.cpp
View file

@ -18,12 +18,12 @@ int main(int argc, char **argv)
settingsDir.setAutoRemove(false); // we'll remove it manually
chatterino::Settings settings(settingsDir.path());
QtConcurrent::run([&app, &settingsDir]() mutable {
QTimer::singleShot(0, [&]() {
::benchmark::RunSpecifiedBenchmarks();
settingsDir.remove();
app.exit(0);
QApplication::exit(0);
});
return app.exec();
return QApplication::exec();
}

4
src/messages/Image.cpp
View file

@ -595,8 +595,8 @@ ImageExpirationPool::ImageExpirationPool()
ImageExpirationPool &ImageExpirationPool::instance()
{
static ImageExpirationPool instance;
return instance;
static auto *instance = new ImageExpirationPool;
return *instance;
}
void ImageExpirationPool::addImagePtr(ImagePtr imgPtr)

8
tests/CMakeLists.txt
View file

@ -60,10 +60,4 @@ if(CHATTERINO_TEST_USE_PUBLIC_HTTPBIN)
target_compile_definitions(${PROJECT_NAME} PRIVATE CHATTERINO_TEST_USE_PUBLIC_HTTPBIN)
endif()
# gtest_add_tests manages to discover the tests because it looks through the source files
# HOWEVER, it fails to run, because we have some bug that causes the QApplication exit to stall when no network requests have been made.
# ctest runs each test individually, so for now we require that testers just run the ./bin/chatterino-test binary without any filters applied
# gtest_add_tests(
# TARGET ${PROJECT_NAME}
# SOURCES ${test_SOURCES}
# )
gtest_discover_tests(${PROJECT_NAME})

235
tests/src/NetworkRequest.cpp
View file

@ -3,17 +3,18 @@
#include "common/NetworkManager.hpp"
#include "common/NetworkResult.hpp"
#include "common/Outcome.hpp"
#include "common/QLogging.hpp"
#include "providers/twitch/api/Helix.hpp"
#include <gtest/gtest.h>
#include <QCoreApplication>
using namespace chatterino;
namespace {
#ifdef CHATTERINO_TEST_USE_PUBLIC_HTTPBIN
const char *const HTTPBIN_BASE_URL = "http://httpbin.org";
// Not using httpbin.org, since it can be really slow and cause timeouts.
// postman-echo has the same API.
const char *const HTTPBIN_BASE_URL = "https://postman-echo.com";
#else
const char *const HTTPBIN_BASE_URL = "http://127.0.0.1:9051";
#endif
@ -28,6 +29,46 @@ QString getDelayURL(int delay)
return QString("%1/delay/%2").arg(HTTPBIN_BASE_URL).arg(delay);
}
class RequestWaiter
{
public:
void requestDone()
{
{
std::unique_lock lck(this->mutex_);
ASSERT_FALSE(this->requestDone_);
this->requestDone_ = true;
}
this->condition_.notify_one();
}
void waitForRequest()
{
using namespace std::chrono_literals;
while (true)
{
{
std::unique_lock lck(this->mutex_);
bool done = this->condition_.wait_for(lck, 10ms, [this] {
return this->requestDone_;
});
if (done)
{
break;
}
}
QCoreApplication::processEvents(QEventLoop::AllEvents);
QCoreApplication::sendPostedEvents(nullptr, QEvent::DeferredDelete);
}
}
private:
std::mutex mutex_;
std::condition_variable condition_;
bool requestDone_ = false;
};
} // namespace
TEST(NetworkRequest, Success)
@ -39,39 +80,23 @@ TEST(NetworkRequest, Success)
for (const auto code : codes)
{
auto url = getStatusURL(code);
std::mutex mut;
bool requestDone = false;
std::condition_variable requestDoneCondition;
RequestWaiter waiter;
NetworkRequest(url)
.onSuccess([code, &mut, &requestDone, &requestDoneCondition,
url](NetworkResult result) -> Outcome {
.onSuccess(
[code, &waiter, url](const NetworkResult &result) -> Outcome {
EXPECT_EQ(result.status(), code);
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
return Success;
})
.onError([&](NetworkResult result) {
.onError([&](const NetworkResult & /*result*/) {
// The codes should *not* throw an error
EXPECT_TRUE(false);
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
})
.execute();
// Wait for the request to finish
std::unique_lock lck(mut);
requestDoneCondition.wait(lck, [&requestDone] {
return requestDone;
});
waiter.waitForRequest();
}
EXPECT_TRUE(NetworkManager::workerThread.isRunning());
@ -86,30 +111,18 @@ TEST(NetworkRequest, FinallyCallbackOnSuccess)
for (const auto code : codes)
{
auto url = getStatusURL(code);
std::mutex mut;
bool requestDone = false;
std::condition_variable requestDoneCondition;
RequestWaiter waiter;
bool finallyCalled = false;
NetworkRequest(url)
.finally(
[&mut, &requestDone, &requestDoneCondition, &finallyCalled] {
.finally([&waiter, &finallyCalled] {
finallyCalled = true;
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
})
.execute();
// Wait for the request to finish
std::unique_lock lck(mut);
requestDoneCondition.wait(lck, [&requestDone] {
return requestDone;
});
waiter.waitForRequest();
EXPECT_TRUE(finallyCalled);
}
@ -127,45 +140,24 @@ TEST(NetworkRequest, Error)
for (const auto code : codes)
{
auto url = getStatusURL(code);
std::mutex mut;
bool requestDone = false;
std::condition_variable requestDoneCondition;
RequestWaiter waiter;
NetworkRequest(url)
.onSuccess([code, &mut, &requestDone, &requestDoneCondition,
url](NetworkResult result) -> Outcome {
.onSuccess(
[&waiter, url](const NetworkResult & /*result*/) -> Outcome {
// The codes should throw an error
EXPECT_TRUE(false);
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
return Success;
})
.onError([code, &mut, &requestDone, &requestDoneCondition,
url](NetworkResult result) {
.onError([code, &waiter, url](const NetworkResult &result) {
EXPECT_EQ(result.status(), code);
if (code == 402)
{
EXPECT_EQ(result.getData(),
QString("Fuck you, pay me!").toUtf8());
}
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
})
.execute();
// Wait for the request to finish
std::unique_lock lck(mut);
requestDoneCondition.wait(lck, [&requestDone] {
return requestDone;
});
waiter.waitForRequest();
}
EXPECT_TRUE(NetworkManager::workerThread.isRunning());
@ -183,30 +175,18 @@ TEST(NetworkRequest, FinallyCallbackOnError)
for (const auto code : codes)
{
auto url = getStatusURL(code);
std::mutex mut;
bool requestDone = false;
std::condition_variable requestDoneCondition;
RequestWaiter waiter;
bool finallyCalled = false;
NetworkRequest(url)
.finally(
[&mut, &requestDone, &requestDoneCondition, &finallyCalled] {
.finally([&waiter, &finallyCalled] {
finallyCalled = true;
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
})
.execute();
// Wait for the request to finish
std::unique_lock lck(mut);
requestDoneCondition.wait(lck, [&requestDone] {
return requestDone;
});
waiter.waitForRequest();
EXPECT_TRUE(finallyCalled);
}
@ -217,44 +197,26 @@ TEST(NetworkRequest, TimeoutTimingOut)
EXPECT_TRUE(NetworkManager::workerThread.isRunning());
auto url = getDelayURL(5);
std::mutex mut;
bool requestDone = false;
std::condition_variable requestDoneCondition;
RequestWaiter waiter;
NetworkRequest(url)
.timeout(1000)
.onSuccess([&mut, &requestDone, &requestDoneCondition,
url](NetworkResult result) -> Outcome {
.onSuccess([&waiter](const NetworkResult & /*result*/) -> Outcome {
// The timeout should throw an error
EXPECT_TRUE(false);
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
return Success;
})
.onError([&mut, &requestDone, &requestDoneCondition,
url](NetworkResult result) {
.onError([&waiter, url](const NetworkResult &result) {
qDebug() << QTime::currentTime().toString()
<< "timeout request finish error";
EXPECT_EQ(result.status(), NetworkResult::timedoutStatus);
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
})
.execute();
// Wait for the request to finish
std::unique_lock lck(mut);
requestDoneCondition.wait(lck, [&requestDone] {
return requestDone;
});
waiter.waitForRequest();
EXPECT_TRUE(NetworkManager::workerThread.isRunning());
}
@ -264,42 +226,24 @@ TEST(NetworkRequest, TimeoutNotTimingOut)
EXPECT_TRUE(NetworkManager::workerThread.isRunning());
auto url = getDelayURL(1);
std::mutex mut;
bool requestDone = false;
std::condition_variable requestDoneCondition;
RequestWaiter waiter;
NetworkRequest(url)
.timeout(2000)
.onSuccess([&mut, &requestDone, &requestDoneCondition,
url](NetworkResult result) -> Outcome {
.timeout(3000)
.onSuccess([&waiter, url](const NetworkResult &result) -> Outcome {
EXPECT_EQ(result.status(), 200);
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
return Success;
})
.onError([&mut, &requestDone, &requestDoneCondition,
url](NetworkResult result) {
.onError([&waiter, url](const NetworkResult & /*result*/) {
// The timeout should *not* throw an error
EXPECT_TRUE(false);
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
})
.execute();
// Wait for the request to finish
std::unique_lock lck(mut);
requestDoneCondition.wait(lck, [&requestDone] {
return requestDone;
});
waiter.waitForRequest();
EXPECT_TRUE(NetworkManager::workerThread.isRunning());
}
@ -310,39 +254,28 @@ TEST(NetworkRequest, FinallyCallbackOnTimeout)
auto url = getDelayURL(5);
std::mutex mut;
bool requestDone = false;
std::condition_variable requestDoneCondition;
RequestWaiter waiter;
bool finallyCalled = false;
bool onSuccessCalled = false;
bool onErrorCalled = false;
NetworkRequest(url)
.timeout(1000)
.onSuccess([&](NetworkResult result) -> Outcome {
.onSuccess([&](const NetworkResult & /*result*/) -> Outcome {
onSuccessCalled = true;
return Success;
})
.onError([&](NetworkResult result) {
.onError([&](const NetworkResult &result) {
onErrorCalled = true;
EXPECT_EQ(result.status(), NetworkResult::timedoutStatus);
})
.finally([&] {
finallyCalled = true;
{
std::unique_lock lck(mut);
requestDone = true;
}
requestDoneCondition.notify_one();
waiter.requestDone();
})
.execute();
// Wait for the request to finish
std::unique_lock lck(mut);
requestDoneCondition.wait(lck, [&requestDone] {
return requestDone;
});
waiter.waitForRequest();
EXPECT_TRUE(finallyCalled);
EXPECT_TRUE(onErrorCalled);

6
tests/src/main.cpp
View file

@ -32,16 +32,16 @@ int main(int argc, char **argv)
qDebug() << "Settings directory:" << settingsDir.path();
chatterino::Settings settings(settingsDir.path());
QtConcurrent::run([&app, &settingsDir]() mutable {
QTimer::singleShot(0, [&]() {
auto res = RUN_ALL_TESTS();
chatterino::NetworkManager::deinit();
settingsDir.remove();
app.exit(res);
QApplication::exit(res);
});
return app.exec();
return QApplication::exec();
#else
return RUN_ALL_TESTS();
#endif