Overhaul highlight system (#3399)
Checks have been moved into a Controller allowing for easier tests.
This commit is contained in:
pajlada
@@ -0,0 +1,464 @@
|
||||
#include "controllers/highlights/HighlightController.hpp"
|
||||
#include "Application.hpp"
|
||||
#include "BaseSettings.hpp"
|
||||
#include "messages/MessageBuilder.hpp" // for MessageParseArgs
|
||||
#include "providers/twitch/TwitchBadge.hpp" // for Badge
|
||||
#include "providers/twitch/api/Helix.hpp"
|
||||
|
||||
#include <gmock/gmock.h>
|
||||
#include <gtest/gtest.h>
|
||||
#include <QDebug>
|
||||
#include <QDir>
|
||||
#include <QFile>
|
||||
#include <QString>
|
||||
|
||||
using namespace chatterino;
|
||||
using ::testing::Exactly;
|
||||
|
||||
class MockApplication : IApplication
|
||||
{
|
||||
public:
|
||||
Theme *getThemes() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
Fonts *getFonts() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
Emotes *getEmotes() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
AccountController *getAccounts() override
|
||||
{
|
||||
return &this->accounts;
|
||||
}
|
||||
HotkeyController *getHotkeys() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
WindowManager *getWindows() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
Toasts *getToasts() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
CommandController *getCommands() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
NotificationController *getNotifications() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
TwitchIrcServer *getTwitch() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
ChatterinoBadges *getChatterinoBadges() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
FfzBadges *getFfzBadges() override
|
||||
{
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
AccountController accounts;
|
||||
// TODO: Figure this out
|
||||
};
|
||||
|
||||
class MockHelix : public IHelix
|
||||
{
|
||||
public:
|
||||
MOCK_METHOD(void, fetchUsers,
|
||||
(QStringList userIds, QStringList userLogins,
|
||||
ResultCallback<std::vector<HelixUser>> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, getUserByName,
|
||||
(QString userName, ResultCallback<HelixUser> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
MOCK_METHOD(void, getUserById,
|
||||
(QString userId, ResultCallback<HelixUser> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, fetchUsersFollows,
|
||||
(QString fromId, QString toId,
|
||||
ResultCallback<HelixUsersFollowsResponse> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, getUserFollowers,
|
||||
(QString userId,
|
||||
ResultCallback<HelixUsersFollowsResponse> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, fetchStreams,
|
||||
(QStringList userIds, QStringList userLogins,
|
||||
ResultCallback<std::vector<HelixStream>> successCallback,
|
||||
HelixFailureCallback failureCallback,
|
||||
std::function<void()> finallyCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, getStreamById,
|
||||
(QString userId,
|
||||
(ResultCallback<bool, HelixStream> successCallback),
|
||||
HelixFailureCallback failureCallback,
|
||||
std::function<void()> finallyCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, getStreamByName,
|
||||
(QString userName,
|
||||
(ResultCallback<bool, HelixStream> successCallback),
|
||||
HelixFailureCallback failureCallback,
|
||||
std::function<void()> finallyCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, fetchGames,
|
||||
(QStringList gameIds, QStringList gameNames,
|
||||
(ResultCallback<std::vector<HelixGame>> successCallback),
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, searchGames,
|
||||
(QString gameName,
|
||||
ResultCallback<std::vector<HelixGame>> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, getGameById,
|
||||
(QString gameId, ResultCallback<HelixGame> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, createClip,
|
||||
(QString channelId, ResultCallback<HelixClip> successCallback,
|
||||
std::function<void(HelixClipError)> failureCallback,
|
||||
std::function<void()> finallyCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, getChannel,
|
||||
(QString broadcasterId,
|
||||
ResultCallback<HelixChannel> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, createStreamMarker,
|
||||
(QString broadcasterId, QString description,
|
||||
ResultCallback<HelixStreamMarker> successCallback,
|
||||
std::function<void(HelixStreamMarkerError)> failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, loadBlocks,
|
||||
(QString userId,
|
||||
ResultCallback<std::vector<HelixBlock>> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, blockUser,
|
||||
(QString targetUserId, std::function<void()> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, unblockUser,
|
||||
(QString targetUserId, std::function<void()> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, updateChannel,
|
||||
(QString broadcasterId, QString gameId, QString language,
|
||||
QString title,
|
||||
std::function<void(NetworkResult)> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, manageAutoModMessages,
|
||||
(QString userID, QString msgID, QString action,
|
||||
std::function<void()> successCallback,
|
||||
std::function<void(HelixAutoModMessageError)> failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, getCheermotes,
|
||||
(QString broadcasterId,
|
||||
ResultCallback<std::vector<HelixCheermoteSet>> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, getEmoteSetData,
|
||||
(QString emoteSetId,
|
||||
ResultCallback<HelixEmoteSetData> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, getChannelEmotes,
|
||||
(QString broadcasterId,
|
||||
ResultCallback<std::vector<HelixChannelEmote>> successCallback,
|
||||
HelixFailureCallback failureCallback),
|
||||
(override));
|
||||
|
||||
MOCK_METHOD(void, update, (QString clientId, QString oauthToken),
|
||||
(override));
|
||||
};
|
||||
|
||||
static QString DEFAULT_SETTINGS = R"!(
|
||||
{
|
||||
"accounts": {
|
||||
"uid117166826": {
|
||||
"username": "testaccount_420",
|
||||
"userID": "117166826",
|
||||
"clientID": "abc",
|
||||
"oauthToken": "def"
|
||||
},
|
||||
"current": "testaccount_420"
|
||||
},
|
||||
"highlighting": {
|
||||
"selfHighlight": {
|
||||
"enableSound": true
|
||||
},
|
||||
"blacklist": [
|
||||
{
|
||||
"pattern": "zenix",
|
||||
"regex": false
|
||||
}
|
||||
],
|
||||
"users": [
|
||||
{
|
||||
"pattern": "pajlada",
|
||||
"showInMentions": false,
|
||||
"alert": false,
|
||||
"sound": false,
|
||||
"regex": false,
|
||||
"case": false,
|
||||
"soundUrl": "",
|
||||
"color": "#7fffffff"
|
||||
},
|
||||
{
|
||||
"pattern": "gempir",
|
||||
"showInMentions": true,
|
||||
"alert": true,
|
||||
"sound": false,
|
||||
"regex": false,
|
||||
"case": false,
|
||||
"soundUrl": "",
|
||||
"color": "#7ff19900"
|
||||
}
|
||||
],
|
||||
"alwaysPlaySound": true,
|
||||
"highlights": [
|
||||
{
|
||||
"pattern": "!testmanxd",
|
||||
"showInMentions": true,
|
||||
"alert": true,
|
||||
"sound": true,
|
||||
"regex": false,
|
||||
"case": false,
|
||||
"soundUrl": "",
|
||||
"color": "#7f7f3f49"
|
||||
}
|
||||
],
|
||||
"badges": [
|
||||
{
|
||||
"name": "broadcaster",
|
||||
"displayName": "Broadcaster",
|
||||
"alert": false,
|
||||
"sound": false,
|
||||
"soundUrl": "",
|
||||
"color": "#7f427f00"
|
||||
},
|
||||
{
|
||||
"name": "subscriber",
|
||||
"displayName": "Subscriber",
|
||||
"alert": false,
|
||||
"sound": false,
|
||||
"soundUrl": "",
|
||||
"color": "#7f7f3f49"
|
||||
},
|
||||
{
|
||||
"name": "founder",
|
||||
"displayName": "Founder",
|
||||
"alert": true,
|
||||
"sound": false,
|
||||
"soundUrl": "",
|
||||
"color": "#7fe8b7eb"
|
||||
}
|
||||
],
|
||||
"subHighlightColor": "#64ffd641"
|
||||
}
|
||||
})!";
|
||||
|
||||
struct TestCase {
|
||||
// TODO: create one of these from a raw irc message? hmm xD
|
||||
struct {
|
||||
MessageParseArgs args;
|
||||
std::vector<Badge> badges;
|
||||
QString senderName;
|
||||
QString originalMessage;
|
||||
} input;
|
||||
|
||||
struct {
|
||||
bool state;
|
||||
HighlightResult result;
|
||||
} expected;
|
||||
};
|
||||
|
||||
class HighlightControllerTest : public ::testing::Test
|
||||
{
|
||||
protected:
|
||||
void SetUp() override
|
||||
{
|
||||
{
|
||||
// Write default settings to the mock settings json file
|
||||
QDir().mkpath("/tmp/c2-tests");
|
||||
QFile settingsFile("/tmp/c2-tests/settings.json");
|
||||
assert(settingsFile.open(QIODevice::WriteOnly | QIODevice::Text));
|
||||
QTextStream out(&settingsFile);
|
||||
out << DEFAULT_SETTINGS;
|
||||
}
|
||||
|
||||
this->mockHelix = new MockHelix;
|
||||
|
||||
initializeHelix(this->mockHelix);
|
||||
|
||||
EXPECT_CALL(*this->mockHelix, loadBlocks).Times(Exactly(1));
|
||||
EXPECT_CALL(*this->mockHelix, update).Times(Exactly(1));
|
||||
|
||||
this->mockApplication = std::make_unique<MockApplication>();
|
||||
this->settings = std::make_unique<Settings>("/tmp/c2-tests");
|
||||
this->paths = std::make_unique<Paths>();
|
||||
|
||||
this->controller = std::make_unique<HighlightController>();
|
||||
|
||||
this->mockApplication->accounts.initialize(*this->settings,
|
||||
*this->paths);
|
||||
this->controller->initialize(*this->settings, *this->paths);
|
||||
}
|
||||
|
||||
void TearDown() override
|
||||
{
|
||||
QDir().rmdir("/tmp/c2-tests");
|
||||
this->mockApplication.reset();
|
||||
this->settings.reset();
|
||||
this->paths.reset();
|
||||
|
||||
this->controller.reset();
|
||||
|
||||
delete this->mockHelix;
|
||||
}
|
||||
|
||||
std::unique_ptr<MockApplication> mockApplication;
|
||||
std::unique_ptr<Settings> settings;
|
||||
std::unique_ptr<Paths> paths;
|
||||
|
||||
std::unique_ptr<HighlightController> controller;
|
||||
|
||||
MockHelix *mockHelix;
|
||||
};
|
||||
|
||||
TEST_F(HighlightControllerTest, A)
|
||||
{
|
||||
auto currentUser =
|
||||
this->mockApplication->getAccounts()->twitch.getCurrent();
|
||||
std::vector<TestCase> tests{
|
||||
{
|
||||
{
|
||||
// input
|
||||
MessageParseArgs{}, // no special args
|
||||
{}, // no badges
|
||||
"pajlada", // sender name
|
||||
"hello!", // original message
|
||||
},
|
||||
{
|
||||
// expected
|
||||
true, // state
|
||||
{
|
||||
false, // alert
|
||||
false, // playsound
|
||||
boost::none, // custom sound url
|
||||
std::make_shared<QColor>("#7fffffff"), // color
|
||||
false,
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
{
|
||||
// input
|
||||
MessageParseArgs{}, // no special args
|
||||
{}, // no badges
|
||||
"pajlada2", // sender name
|
||||
"hello!", // original message
|
||||
},
|
||||
{
|
||||
// expected
|
||||
false, // state
|
||||
HighlightResult::emptyResult(), // result
|
||||
},
|
||||
},
|
||||
{
|
||||
{
|
||||
// input
|
||||
MessageParseArgs{}, // no special args
|
||||
{
|
||||
{
|
||||
"founder",
|
||||
"0",
|
||||
}, // founder badge
|
||||
},
|
||||
"pajlada22", // sender name
|
||||
"hello!", // original message
|
||||
},
|
||||
{
|
||||
// expected
|
||||
true, // state
|
||||
{
|
||||
true, // alert
|
||||
false, // playsound
|
||||
boost::none, // custom sound url
|
||||
std::make_shared<QColor>("#7fe8b7eb"), // color
|
||||
false, //showInMentions
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
{
|
||||
// input
|
||||
MessageParseArgs{}, // no special args
|
||||
{
|
||||
{
|
||||
"founder",
|
||||
"0",
|
||||
}, // founder badge
|
||||
},
|
||||
"pajlada", // sender name
|
||||
"hello!", // original message
|
||||
},
|
||||
{
|
||||
// expected
|
||||
true, // state
|
||||
{
|
||||
true, // alert
|
||||
false, // playsound
|
||||
boost::none, // custom sound url
|
||||
std::make_shared<QColor>("#7fffffff"), // color
|
||||
false, //showInMentions
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
for (const auto &[input, expected] : tests)
|
||||
{
|
||||
auto [isMatch, matchResult] = this->controller->check(
|
||||
input.args, input.badges, input.senderName, input.originalMessage);
|
||||
|
||||
EXPECT_EQ(isMatch, expected.state);
|
||||
EXPECT_EQ(matchResult, expected.result);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user