Proper unit tests for the application

Author: hluk

CMakeLists.txt

@@ -2,6 +2,7 @@ project(copyq)
 
 OPTION(WITH_WEBKIT "WebKit support" ON)
 OPTION(WITH_QT5 "Qt5 support" OFF)
+OPTION(WITH_TESTS "Run test cases from command line" OFF)
 
 if (WITH_QT5)
     cmake_minimum_required(VERSION 2.8.8)
@@ -34,7 +35,6 @@ else()
     endif(WITH_WEBKIT)
     set(QT_USE_QTWEBKIT ${HAS_WEBKIT})
 
-    include(${QT_USE_FILE})
     set(USE_QXT TRUE)
 endif()
 
@@ -144,6 +144,26 @@ endif(USE_QXT)
 # Be more strict while compiling debugging version
 if(CMAKE_COMPILER_IS_GNUCXX OR "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")
     set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Wextra -Wall -pedantic")
+    set(WITH_TESTS ON)
+endif()
+
+# Compile with tests?
+if (WITH_TESTS)
+    message(STATUS "Building with tests.")
+    add_definitions( -DHAS_TESTS )
+
+    file(GLOB copyq_SOURCES ${copyq_SOURCES}
+        src/tests/*.cpp
+        )
+    file(GLOB copyq_MOCABLE ${copyq_MOCABLE}
+        src/tests/*.h
+        )
+
+    if (WITH_QT5)
+        set(copyq_Qt5_Modules ${copyq_Qt5_Modules} Test)
+    else()
+        set(QT_USE_QTTEST TRUE)
+    endif()
 endif()
 
 set(copyq_LIBRARIES ${copyq_LIBRARIES} ${X11_LIBRARIES} ${X11_Xfixes_LIB})
@@ -187,6 +207,8 @@ add_executable(copyq ${copyq_SOURCES}
 
 if (WITH_QT5)
     qt5_use_modules(copyq ${copyq_Qt5_Modules})
+else()
+    include(${QT_USE_FILE})
 endif()
 
 target_link_libraries(copyq ${QT_LIBRARIES} ${copyq_LIBRARIES})

src/app.cpp

@@ -24,6 +24,9 @@
 #include <QLibraryInfo>
 #include <QLocale>
 #include <QTranslator>
+#ifdef HAS_TESTS
+#   include <QProcessEnvironment>
+#endif
 
 #ifdef Q_OS_UNIX
 #   include <QSocketNotifier>
@@ -54,8 +57,17 @@ App::App(int &argc, char **argv)
     , m_exitCode(0)
     , m_closed(false)
 {
-    QCoreApplication::setOrganizationName("copyq");
-    QCoreApplication::setApplicationName("copyq");
+#ifdef HAS_TESTS
+    QProcessEnvironment env = QProcessEnvironment::systemEnvironment();
+    if ( env.value("COPYQ_TESTING") == "1" ) {
+        QCoreApplication::setOrganizationName("copyq-test");
+        QCoreApplication::setApplicationName("copyq-test");
+    } else
+#endif
+    {
+        QCoreApplication::setOrganizationName("copyq");
+        QCoreApplication::setApplicationName("copyq");
+    }
 
     const QString locale = QLocale::system().name();
     QTranslator *translator = new QTranslator(this);

src/clipboardmonitor.cpp

@@ -21,7 +21,6 @@
 
 #include "client_server.h"
 #include "clipboarditem.h"
-#include "clipboardserver.h"
 
 #include <QMimeData>
 #include <QTimer>
@@ -165,7 +164,10 @@ ClipboardMonitor::ClipboardMonitor(int &argc, char **argv)
              this, SLOT(readyRead()), Qt::DirectConnection );
     connect( m_socket, SIGNAL(disconnected()),
              this, SLOT(quit()) );
-    m_socket->connectToServer( ClipboardServer::monitorServerName() );
+
+    QStringList args = QCoreApplication::instance()->arguments();
+    Q_ASSERT(args.size() == 3);
+    m_socket->connectToServer(args.at(2));
     if ( !m_socket->waitForConnected(2000) ) {
         log( tr("Cannot connect to server!"), LogError );
         exit(1);

src/clipboardserver.cpp

@@ -196,7 +196,7 @@ void ClipboardServer::startMonitoring()
         connect( m_monitor, SIGNAL(readyReadStandardError()),
                  this, SLOT(monitorStandardError()) );
         m_monitor->start( QApplication::arguments().at(0),
-                          QStringList() << "monitor",
+                          QStringList("monitor") << monitorServerName(),
                           QProcess::ReadOnly );
         if ( !m_monitor->waitForStarted(2000) ) {
             log( tr("Cannot start clipboard monitor!"), LogError );

src/main.cpp

@@ -33,6 +33,17 @@
 #include <windows.h>
 #endif
 
+#ifdef HAS_TESTS
+#  include "tests/tests.h"
+#  include <QTest>
+
+namespace tests {
+
+QTEST_MAIN(Tests)
+
+}
+#endif // HAS_TESTS
+
 Q_DECLARE_METATYPE(QByteArray*)
 
 namespace {
@@ -86,6 +97,13 @@ int startClient(int argc, char *argv[])
     return app.exec();
 }
 
+#ifdef HAS_TESTS
+int startTests(int argc, char *argv[])
+{
+    return tests::main(argc, argv);
+}
+#endif
+
 bool needsHelp(const char *arg)
 {
     return strcmp("-h",arg) == 0 ||
@@ -100,11 +118,19 @@ bool needsVersion(const char *arg)
            strcmp("version",arg) == 0;
 }
 
+#ifdef HAS_TESTS
+bool needsTests(const char *arg)
+{
+    return strcmp("--tests", arg) == 0 ||
+           strcmp("tests", arg) == 0;
+}
+#endif
+
 } // namespace
 
 int main(int argc, char *argv[])
 {
-    // print version
+    // print version, help or run tests
     if (argc == 2 || argc == 3) {
         const char *arg = argv[1];
         if ( argc == 2 && needsVersion(arg) ) {
@@ -113,20 +139,25 @@ int main(int argc, char *argv[])
         } else if ( needsHelp(arg) ) {
             evaluate("help", argc == 3 ? argv[2] : NULL);
             return 0;
+#ifdef HAS_TESTS
+        } else if ( needsTests(arg) ) {
+            // Skip the "tests" argument and pass the rest to tests.
+            return startTests(argc - 1, argv + 1);
+#endif
         }
     }
 
     if (argc == 1) {
         // if server hasn't been run yet and no argument were specified
-        // then run this as server
+        // then run this process as server
         return startServer(argc, argv);
-    } else if (argc == 2 && strcmp(argv[1], "monitor") == 0) {
-        // if argument specified and server is running
-        // then run this as client
+    } else if (argc == 3 && strcmp(argv[1], "monitor") == 0) {
+        // if first argument is monitor (second is monitor server name/ID)
+        // then run this process as monitor
         return startMonitor(argc, argv);
     } else {
         // if argument specified and server is running
-        // then run this as client
+        // then run this process as client
         return startClient(argc, argv);
     }
 }

src/scriptable.cpp

@@ -190,7 +190,12 @@ QList<CommandHelp> commandHelp()
                        Scriptable::tr("\nPrint help for COMMAND or all commands."))
            .addArg("[" + Scriptable::tr("COMMAND") + "]")
         << CommandHelp("version, -v, --version",
-                       Scriptable::tr("\nPrint version of program and libraries."));
+                       Scriptable::tr("\nPrint version of program and libraries."))
+#ifdef HAS_TESTS
+        << CommandHelp("tests, --tests",
+                       Scriptable::tr("Run tests."))
+#endif
+           ;
 }
 
 QString helpHead()

src/src.pro

@@ -81,6 +81,13 @@ SOURCES += \
 QT += core gui xml network script
 greaterThan(QT_MAJOR_VERSION, 4): QT += widgets
 
+debug {
+    DEFINES += HAS_TESTS
+    QT += testlib
+    SOURCES += tests/tests.cpp
+    HEADERS += tests/tests.h
+}
+
 WITH_WEBKIT {
     SOURCES += itemweb.cpp
     HEADERS += include/itemweb.h