Move mocks to their own interface (#4645)

Chatterino · May 20, 2023 · e1a6c24 · e1a6c24
1 parent 5d0bdc1
commit e1a6c24
Show file tree

Hide file tree

Showing 12 changed files with 564 additions and 501 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -174,6 +174,10 @@ include(cmake/resources/generate_resources.cmake)
 
 add_subdirectory(src)
 
+if (BUILD_TESTS OR BUILD_BENCHMARKS)
+    add_subdirectory(mocks)
+endif ()
+
 if (BUILD_TESTS)
     enable_testing()
     add_subdirectory(tests)

diff --git a/benchmarks/CMakeLists.txt b/benchmarks/CMakeLists.txt
@@ -15,6 +15,7 @@ add_executable(${PROJECT_NAME} ${benchmark_SOURCES})
 add_sanitizers(${PROJECT_NAME})
 
 target_link_libraries(${PROJECT_NAME} PRIVATE chatterino-lib)
+target_link_libraries(${PROJECT_NAME} PRIVATE chatterino-mocks)
 
 target_link_libraries(${PROJECT_NAME} PRIVATE benchmark::benchmark)
 

diff --git a/benchmarks/src/Highlights.cpp b/benchmarks/src/Highlights.cpp
@@ -1,11 +1,12 @@
 #include "Application.hpp"
-#include "singletons/Settings.hpp"
 #include "common/Channel.hpp"
 #include "controllers/accounts/AccountController.hpp"
 #include "controllers/highlights/HighlightController.hpp"
 #include "controllers/highlights/HighlightPhrase.hpp"
 #include "messages/Message.hpp"
 #include "messages/SharedMessageBuilder.hpp"
+#include "mocks/EmptyApplication.hpp"
+#include "singletons/Settings.hpp"
 #include "util/Helpers.hpp"
 
 #include <benchmark/benchmark.h>
@@ -45,65 +46,17 @@ class BenchmarkMessageBuilder : public SharedMessageBuilder
     }
 };
 
-class MockApplication : IApplication
+class MockApplication : mock::EmptyApplication
 {
 public:
-    Theme *getThemes() override
-    {
-        return nullptr;
-    }
-    Fonts *getFonts() override
-    {
-        return nullptr;
-    }
-    IEmotes *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;
-    }
     HighlightController *getHighlights() override
     {
         return &this->highlights;
     }
-    TwitchIrcServer *getTwitch() override
-    {
-        return nullptr;
-    }
-    ChatterinoBadges *getChatterinoBadges() override
-    {
-        return nullptr;
-    }
-    FfzBadges *getFfzBadges() override
-    {
-        return nullptr;
-    }
-    IUserDataController *getUserData() override
-    {
-        return nullptr;
-    }
 
     AccountController accounts;
     HighlightController highlights;

diff --git a/benchmarks/src/main.cpp b/benchmarks/src/main.cpp
@@ -1,13 +1,20 @@
+#include "singletons/Settings.hpp"
+
 #include <benchmark/benchmark.h>
 #include <QApplication>
 #include <QtConcurrent>
 
+using namespace chatterino;
+
 int main(int argc, char **argv)
 {
     QApplication app(argc, argv);
 
     ::benchmark::Initialize(&argc, argv);
 
+    // Ensure settings are initialized before any tests are run
+    chatterino::Settings settings("/tmp/c2-empty-test");
+
     QtConcurrent::run([&app] {
         ::benchmark::RunSpecifiedBenchmarks();
 

diff --git a/mocks/.clang-format b/mocks/.clang-format
@@ -0,0 +1,55 @@
+Language: Cpp
+
+AccessModifierOffset: -4
+AlignEscapedNewlinesLeft: true
+AllowShortFunctionsOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLambdasOnASingleLine: Empty
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: false
+AlwaysBreakBeforeMultilineStrings: false
+BasedOnStyle: Google
+BraceWrapping:
+  AfterClass: "true"
+  AfterControlStatement: "true"
+  AfterFunction: "true"
+  AfterNamespace: "false"
+  BeforeCatch: "true"
+  BeforeElse: "true"
+BreakBeforeBraces: Custom
+BreakConstructorInitializersBeforeComma: true
+ColumnLimit: 80
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+DerivePointerBinding: false
+FixNamespaceComments: true
+IndentCaseLabels: true
+IndentWidth: 4
+IndentWrappedFunctionNames: true
+IndentPPDirectives: AfterHash
+SortIncludes: CaseInsensitive
+IncludeBlocks: Regroup
+IncludeCategories:
+  # Project includes
+  - Regex: '^"[a-zA-Z\._-]+(/[a-zA-Z0-9\._-]+)*"$'
+    Priority: 1
+  # Third party library includes
+  - Regex: '<[[:alnum:].]+/[a-zA-Z0-9\._\/-]+>'
+    Priority: 3
+  # Qt includes
+  - Regex: '^<Q[a-zA-Z0-9\._\/-]+>$'
+    Priority: 3
+    CaseSensitive: true
+  # LibCommuni includes
+  - Regex: "^<Irc[a-zA-Z]+>$"
+    Priority: 3
+  # Misc libraries
+  - Regex: '^<[a-zA-Z_0-9]+\.h(pp)?>$'
+    Priority: 3
+  # Standard library includes
+  - Regex: "^<[a-zA-Z_]+>$"
+    Priority: 4
+NamespaceIndentation: Inner
+PointerBindsToType: false
+SpacesBeforeTrailingComments: 2
+Standard: Auto
+ReflowComments: false
diff --git a/mocks/CMakeLists.txt b/mocks/CMakeLists.txt
@@ -0,0 +1,7 @@
+project(chatterino-mocks)
+
+add_library(chatterino-mocks INTERFACE)
+
+target_include_directories(chatterino-mocks INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/include)
+
+target_link_libraries(${PROJECT_NAME} INTERFACE gmock)
diff --git a/mocks/include/mocks/EmptyApplication.hpp b/mocks/include/mocks/EmptyApplication.hpp
@@ -0,0 +1,81 @@
+#pragma once
+
+#include "Application.hpp"
+
+namespace chatterino::mock {
+
+class EmptyApplication : public IApplication
+{
+public:
+    Theme *getThemes() override
+    {
+        return nullptr;
+    }
+
+    Fonts *getFonts() override
+    {
+        return nullptr;
+    }
+
+    IEmotes *getEmotes() override
+    {
+        return nullptr;
+    }
+
+    AccountController *getAccounts() override
+    {
+        return nullptr;
+    }
+
+    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;
+    }
+
+    HighlightController *getHighlights() override
+    {
+        return nullptr;
+    }
+
+    TwitchIrcServer *getTwitch() override
+    {
+        return nullptr;
+    }
+
+    ChatterinoBadges *getChatterinoBadges() override
+    {
+        return nullptr;
+    }
+
+    FfzBadges *getFfzBadges() override
+    {
+        return nullptr;
+    }
+
+    IUserDataController *getUserData() override
+    {
+        return nullptr;
+    }
+};
+
+}  // namespace chatterino::mock