Implement automated tests (paceholder#177)

* add basic test support

* fix travis.yml

* fix-travis-osx

* fix .appveyor.yml

* Added some dragging tests

* remove failing test

* Improve naming, reuse of code

* fix bug

Author: Quincunx271

.appveyor.yml

@@ -2,15 +2,20 @@ clone_depth: 5
 
 environment:
   matrix:
-    - GENERATOR : "MinGW Makefiles"
-      QTDIR: C:\Qt\5.6\mingw49_32
-      PLATFORM: x86
     - GENERATOR : "Visual Studio 14 2015 Win64"
       QTDIR: C:\Qt\5.6.3\msvc2015_64
       PLATFORM: x64
+      BUILD_TESTING: ON
     - GENERATOR : "Visual Studio 14 2015"
       QTDIR: C:\Qt\5.6.3\msvc2015
       PLATFORM: Win32
+      BUILD_TESTING: ON
+    - GENERATOR : "MinGW Makefiles"
+      QTDIR: C:\Qt\5.6\mingw49_32
+      PLATFORM: x86
+      BUILD_TESTING: OFF
+
+image: Visual Studio 2015
 
 configuration:
   - Release
@@ -21,20 +26,44 @@ image: Visual Studio 2015
   #only:
     #- master
 
-before_build:
-  - mkdir build
-  - cd build
+install:
   - set PATH=%QTDIR%\bin;%PATH%
+  - set Qt5_DIR=%QTDIR%\lib\cmake\Qt5
   - set PATH=C:\MinGW\bin;C:\MinGW\msys\1.0;%PATH%
   - set PATH=%PATH:C:\Program Files\Git\usr\bin=% # trick to remove sh.exe
-  - cmake "-G%GENERATOR%" -DCMAKE_PREFIX_PATH="%QTDIR/lib/cmake/Qt5" ..
+  - mkdir dependencies
+  - cd dependencies
+  - mkdir install
+  - set CMAKE_INSTALL_PREFIX=%cd%\install
+  - set DEPENDENCIES=%cd%\install
+  - git clone https://github.com/catchorg/Catch2.git
+  - cd Catch2
+  - mkdir build
+  - cd build
+  - cmake "-G%GENERATOR%" -DBUILD_TESTING=OFF ..
+  - cmake --build . --target install
+  - set Catch2_DIR=%DEPENDENCIES=%cd%\install\lib\cmake\Catch2
+  - cd ..
+  - cd ..
+  - cd ..
+
+before_build:
+  - mkdir build
+  - cd build
+  - mkdir bin
+  - set OUTPUT_DIR=%cd%\bin
+  - echo %BUILD_TESTING%
+  - cmake "-G%GENERATOR%" -DBUILD_TESTING=%BUILD_TESTING%
+    -DCMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG="%OUTPUT_DIR%"
+    -DCMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE="%OUTPUT_DIR%"
+    ..
 
 
 build_script:
-  - if "%PLATFORM%" == "x86" cmake --build .
-  - if "%PLATFORM%" == "x64" msbuild NodeEditor.sln
-  - if "%PLATFORM%" == "Win32" msbuild NodeEditor.sln
+  - cmake --build .
 
+test_script:
+  - if "%BUILD_TESTING%" == "ON" .\bin\test_nodes.exe
 
 
 after_build:

.travis.yml

@@ -43,11 +43,27 @@ before_install:
    - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install build-essential libgl1-mesa-dev ; fi
    - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get -yy install qtbase5-dev ; fi
 
+install:
+  - DEPS_DIR="${TRAVIS_BUILD_DIR}/deps"
+  - |
+    mkdir -p ${DEPS_DIR}
+    pushd ${DEPS_DIR}
+  - travis_retry git clone https://github.com/catchorg/Catch2.git # Install Catch2
+  - |
+    pushd Catch2
+    git checkout tags/v2.2.2
+    mkdir build && cd build
+  - cmake .. -DBUILD_TESTING=OFF -DCMAKE_INSTALL_PREFIX="${DEPS_DIR}/install"
+  - cmake --build . -- install
+  - export CMAKE_PREFIX_PATH="${DEPS_DIR}/install/:$CMAKE_PREFIX_PATH"
+  - popd; popd
 
 script:
   - mkdir build
   - cd build
   - cmake -DCMAKE_VERBOSE_MAKEFILE=$VERBOSE_BUILD .. && make -j
+  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then xvfb-run --server-args="-screen 0 1024x768x24" ./test/test_nodes; fi
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then ./test/test_nodes; fi
 
 notifications:
   email: false

CMakeLists.txt

@@ -6,6 +6,8 @@ project(NodeEditor CXX)
 set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
 set(CMAKE_DISABLE_SOURCE_CHANGES  ON)
 
+include(CTest)
+
 option(BUILD_EXAMPLES "Build Examples" ON)
 
 # Find the QtWidgets library
@@ -52,6 +54,7 @@ add_library(nodes SHARED
   ${CPP_SOURCE_FILES}
   ${RESOURCES}
 )
+add_library(NodeEditor::nodes ALIAS nodes)
 
 target_include_directories(nodes
   PUBLIC 
@@ -120,6 +123,14 @@ if(BUILD_EXAMPLES)
   add_subdirectory(examples)
 endif()
 
+##################
+# Automated Tests
+##
+
+if(BUILD_TESTING)
+  add_subdirectory(test)
+endif()
+
 ###############
 # Installation
 ##

test/CMakeLists.txt

@@ -0,0 +1,24 @@
+find_package(Catch2 REQUIRED)
+find_package(Qt5 COMPONENTS Test)
+
+add_executable(test_nodes
+  test_main.cpp
+  src/test_dragging.cpp
+  src/TestDataModelRegistry.cpp
+)
+
+target_include_directories(test_nodes
+  PRIVATE
+    ../src
+    ../include/internal
+    include
+)
+
+target_link_libraries(test_nodes
+  PRIVATE
+    NodeEditor::nodes
+    Catch2::Catch
+    Qt5::Test
+)
+
+add_test(test_nodes test_nodes)

test/include/ApplicationSetup.hpp

@@ -0,0 +1,20 @@
+#pragma once
+
+#include <memory>
+
+#include <QApplication>
+
+
+inline std::unique_ptr<QApplication>
+applicationSetup()
+{
+  static int    Argc       = 0;
+  static char   ArgvVal    = '\0';
+  static char*  ArgvValPtr = &ArgvVal;
+  static char** Argv       = &ArgvValPtr;
+
+  auto app = std::make_unique<QApplication>(Argc, Argv);
+  app->setAttribute(Qt::AA_Use96Dpi, true);
+
+  return app;
+}

test/include/Stringify.hpp

@@ -0,0 +1,31 @@
+#pragma once
+
+#include <QtCore/QPoint>
+#include <QtCore/QPointF>
+
+#include <catch.hpp>
+
+#include <QtTest>
+
+namespace Catch
+{
+template <>
+struct StringMaker<QPointF>
+{
+  static std::string
+  convert(QPointF const& p)
+  {
+    return std::string(QTest::toString(p));
+  }
+};
+
+template <>
+struct StringMaker<QPoint>
+{
+  static std::string
+  convert(QPoint const& p)
+  {
+    return std::string(QTest::toString(p));
+  }
+};
+}

test/include/StubNodeDataModel.hpp

@@ -0,0 +1,59 @@
+#pragma once
+
+#include <utility>
+
+#include <nodes/NodeDataModel>
+
+class StubNodeDataModel : public QtNodes::NodeDataModel
+{
+public:
+  QString
+  name() const override
+  {
+    return _name;
+  }
+
+  QString
+  caption() const override
+  {
+    return _caption;
+  }
+
+  unsigned int nPorts(QtNodes::PortType) const override { return 0; }
+
+  QWidget*
+  embeddedWidget() override
+  {
+    return nullptr;
+  }
+
+  QtNodes::NodeDataType dataType(QtNodes::PortType, QtNodes::PortIndex) const override
+  {
+    return QtNodes::NodeDataType();
+  }
+
+  std::shared_ptr<QtNodes::NodeData> outData(QtNodes::PortIndex) override
+  {
+    return nullptr;
+  }
+
+  void setInData(std::shared_ptr<QtNodes::NodeData>, QtNodes::PortIndex) override
+  {
+  }
+
+  void
+  name(QString name)
+  {
+    _name = std::move(name);
+  }
+
+  void
+  caption(QString caption)
+  {
+    _caption = std::move(caption);
+  }
+
+private:
+  QString _name    = "name";
+  QString _caption = "caption";
+};

test/src/TestDataModelRegistry.cpp

@@ -0,0 +1,45 @@
+#include <nodes/DataModelRegistry>
+
+#include <catch.hpp>
+
+#include "StubNodeDataModel.hpp"
+
+using QtNodes::DataModelRegistry;
+using QtNodes::NodeData;
+using QtNodes::NodeDataModel;
+using QtNodes::NodeDataType;
+using QtNodes::PortIndex;
+using QtNodes::PortType;
+
+namespace
+{
+class StubModelStaticName : public StubNodeDataModel
+{
+public:
+  static QString
+  Name()
+  {
+    return "Name";
+  }
+};
+}
+
+TEST_CASE("DataModelRegistry::registerModel", "[interface]")
+{
+  DataModelRegistry registry;
+
+  SECTION("stub model")
+  {
+    registry.registerModel<StubNodeDataModel>();
+    auto model = registry.create("name");
+
+    CHECK(model->name() == "name");
+  }
+  SECTION("stub model with static name")
+  {
+    registry.registerModel<StubModelStaticName>();
+    auto model = registry.create("Name");
+
+    CHECK(model->name() == "name");
+  }
+}

test/src/test_dragging.cpp

@@ -0,0 +1,69 @@
+#include <nodes/Connection>
+#include <nodes/FlowScene>
+#include <nodes/FlowView>
+#include <nodes/Node>
+
+#include <catch.hpp>
+
+#include <QtTest>
+#include <QtWidgets/QApplication>
+
+#include <iostream>
+
+#include "ApplicationSetup.hpp"
+#include "Stringify.hpp"
+#include "StubNodeDataModel.hpp"
+
+using QtNodes::Connection;
+using QtNodes::DataModelRegistry;
+using QtNodes::FlowScene;
+using QtNodes::FlowView;
+using QtNodes::Node;
+using QtNodes::NodeData;
+using QtNodes::NodeDataModel;
+using QtNodes::NodeDataType;
+using QtNodes::PortIndex;
+using QtNodes::PortType;
+
+TEST_CASE("Dragging node changes position", "[gui]")
+{
+  auto app = applicationSetup();
+
+  FlowScene scene;
+  FlowView  view(&scene);
+
+  view.show();
+  REQUIRE(QTest::qWaitForWindowExposed(&view));
+
+  SECTION("just one node")
+  {
+    auto& node = scene.createNode(std::make_unique<StubNodeDataModel>());
+
+    auto& ngo = node.nodeGraphicsObject();
+
+    QPointF scPosBefore = ngo.pos();
+
+    QPointF scClickPos = ngo.boundingRect().center();
+    scClickPos         = QPointF(ngo.sceneTransform().map(scClickPos).toPoint());
+
+    QPoint vwClickPos = view.mapFromScene(scClickPos);
+    QPoint vwDestPos  = vwClickPos + QPoint(10, 20);
+
+    QPointF scExpectedDelta = view.mapToScene(vwDestPos) - scClickPos;
+
+    CAPTURE(scClickPos);
+    CAPTURE(vwClickPos);
+    CAPTURE(vwDestPos);
+    CAPTURE(scExpectedDelta);
+
+    QTest::mouseMove(view.windowHandle(), vwClickPos);
+    QTest::mousePress(view.windowHandle(), Qt::LeftButton, Qt::NoModifier, vwClickPos);
+    QTest::mouseMove(view.windowHandle(), vwDestPos);
+
+    QPointF scDelta            = ngo.pos() - scPosBefore;
+    QPoint  roundDelta         = scDelta.toPoint();
+    QPoint  roundExpectedDelta = scExpectedDelta.toPoint();
+
+    CHECK(roundDelta == roundExpectedDelta);
+  }
+}

test/test_main.cpp

@@ -0,0 +1,2 @@
+#define CATCH_CONFIG_MAIN
+#include <catch.hpp>