Merge branch 'add-unittest--swapscreens'

Author: dannyedel

.appveyor.yml

@@ -26,6 +26,7 @@ before_build:
         -DDownloadTestPDF=ON
         -DBoostStaticLink=ON
         -DWindowsStaticLink=OFF
+        -DRunDualScreenTests=OFF
         -DBOOST_ROOT=\libraries\boost
         -DBOOST_LIBRARYDIR=\libraries\boost\lib32-msvc-12.0
 

.travis.yml

@@ -12,6 +12,7 @@ qt4_deps: &q4dep
     - texlive-latex-recommended
     - texlive-pictures
     - latex-beamer
+    - xserver-xorg-video-dummy
 qt5_deps: &q5dep
     - libboost-program-options-dev
     - libboost-test-dev
@@ -25,6 +26,7 @@ qt5_deps: &q5dep
     - texlive-latex-recommended
     - texlive-pictures
     - latex-beamer
+    - xserver-xorg-video-dummy
 addons:
     apt:
         packages: *q4dep

CMakeLists.txt

@@ -35,6 +35,7 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 option(UseQtFive "Build with Qt5 and libpoppler-qt5" ON)
 option(UpdateTranslations "Do you want to update the .ts files (WARNING: running make clean will delete them!)" OFF)
 option(BuildTests "Build unit tests (this requires pdflatex or internet access and DownloadTestPDFs=ON)" ON)
+option(RunDualScreenTests "Also run tests that require two screens to be connected" ON)
 option(BoostStaticLink "Link statically against the boost libraries" OFF)
 option(WindowsStaticLink "Windows/MSVC only: Link statically against the dependencies and set /MT instead of /MD" ON)
 option(DownloadTestPDF "Download test PDFs from http://danny-edel.de, rather then building them using latex-beamer" OFF)

_travis/configure

@@ -9,10 +9,17 @@ cd build
 
 CMAKE_PARAMETERS="-DCMAKE_VERBOSE_MAKEFILE=ON"
 
-# on OSX: Download Test PDF,
-# rather than install pdflatex
+CMAKE_PARAMETERS+=" -DCMAKE_BUILD_TYPE=Debug"
+
+# OSX specific stuff
 if [ "$TRAVIS_OS_NAME" = "osx" ] ; then
+	# Download Test PDF,
+	# rather than install pdflatex
 	CMAKE_PARAMETERS+=" -DDownloadTestPDF=ON"
+
+	# Skip dual screen tests since we don't have
+	# xvfb-run
+	CMAKE_PARAMETERS+=" -DRunDualScreenTests=OFF"
 fi
 
 # Activate code coverage analysis

_travis/test

@@ -2,12 +2,13 @@
 set -ex
 cd build
 
-XVFB=
 # Call CTest test runner within XvFB
 if [ "$TRAVIS_OS_NAME" = "linux" ] ; then
-	XVFB="xvfb-run -a"
+	xvfb-run -a -s '-screen 0 1920x1080x24 -screen 1 1920x1200x24' \
+		ctest --output-on-failure --timeout 60
+else
+	ctest --output-on-failure --timeout 60
 fi
-$XVFB ctest --output-on-failure --timeout 60
 
 # print coverage report, ignore errors
 ctest -T coverage || true

dspdfviewer.cpp

@@ -376,3 +376,11 @@ void DSPDFViewer::toggleSecondaryScreenDuplication()
   }
   emit renderPage();
 }
+
+const QRect DSPDFViewer::audienceGeometry() const {
+	return audienceWindow.geometry();
+}
+
+const QRect DSPDFViewer::secondGeometry() const {
+	return secondaryWindow.geometry();
+}

dspdfviewer.h

@@ -93,6 +93,11 @@ private slots:
 
     bool isAudienceScreenBlank() const;
 
+	/** Allow const access to the windows' positions.
+	 * Needed for tests to inspect things. */
+	const QRect audienceGeometry() const;
+	const QRect secondGeometry() const;
+
 signals:
   void wallClockUpdate(const QTime& wallClock) const;
   void slideClockUpdate(const QTime& slideClock) const;

renderthread.cpp

@@ -33,12 +33,11 @@ RenderThread::RenderThread(const PDFDocumentReference& theDocument, const Render
 
 void RenderThread::run()
 {
-  DEBUGOUT << "RenderThread for " << renderMe.pageNumber() << renderMe.requestedPageSize() << " started";
+  DEBUGOUT << "RenderThread for" << renderMe << "started";
   QImage renderImage = RenderUtils::renderPagePart(m_page.page, renderMe.requestedPageSize(), renderMe.pagePart());
   if ( renderImage.isNull() )
   {
-    WARNINGOUT << "RenderThread for " << renderMe.pageNumber() <<
-		renderMe.requestedPageSize().width() << renderMe.requestedPageSize().height() << " failed";
+    WARNINGOUT << "RenderThread for" << renderMe << "failed";
     QSharedPointer<RenderingIdentifier> ri( new RenderingIdentifier(renderMe) );
     emit renderingFailed(ri);
     return;
@@ -57,6 +56,6 @@ void RenderThread::run()
     }
   }
   QSharedPointer<RenderedPage> renderResult(new RenderedPage( renderImage, links, renderMe ));
-  DEBUGOUT << "RenderThread for " << renderMe.pageNumber() << renderMe.requestedPageSize() << " successful, image has size " << renderResult->getImage().size();
+  DEBUGOUT << "RenderThread for" << renderMe << "successful, image has size" << renderResult->getImage().size();
   emit renderingFinished(renderResult);
 }

sconnect.h

@@ -5,9 +5,9 @@
  * Quick and dirty hack to check QObject::connect()'s return value
  */
 template<typename Sender, typename Signal, typename Receiver, typename Slot>
-void sconnect(Sender sender, Signal signal, Receiver receiver, Slot slot) {
+void sconnect(Sender sender, Signal signal, Receiver receiver, Slot slot, Qt::ConnectionType type=Qt::AutoConnection) {
 	bool okay = QObject::connect(
-		sender, signal, receiver, slot);
+		sender, signal, receiver, slot, type);
 	if ( ! okay ) {
 		throw std::runtime_error(
 		std::string("QObject::connect failed. sender: ")+signal+" receiver: "+slot);

testing/CMakeLists.txt

@@ -118,6 +118,31 @@ set_tests_properties(
 		PASS_REGULAR_EXPRESSION ${DSPDFVIEWER_VERSION}
 )
 
+# Only build and run the swap screen test on Qt5
+if(UseQtFive)
+	add_executable(testswapscreen
+		testswapscreen.cc
+		testswapscreen-main.cc
+	)
+	target_link_libraries(testswapscreen
+		testhelp
+	)
+
+	if(RunDualScreenTests)
+		add_test(NAME testswapscreen
+			COMMAND testswapscreen
+				--prerender-prev=0
+				--prerender-next=0
+				images.pdf
+		)
+		set_tests_properties(testswapscreen
+			PROPERTIES
+				TIMEOUT 60
+				SKIP_RETURN_CODE 77
+		)
+	endif()
+endif()
+
 
 # On windows you cannot change the locale on a case-by-case basis.
 #

testing/testhelpers.hh

@@ -51,6 +51,16 @@ namespace TestHelpers {
 		QColor grabPixelColor( uint x, uint y);
 	};
 
+	template<typename T1, typename T2>
+		inline
+		void check(const T1& lhs, const T2& rhs, int failcode=2) {
+			if ( ! (lhs == rhs) ) {
+				WARNINGOUT << "Failure:" << lhs << "!=" << rhs;
+				QApplication::exit(failcode);
+			} else {
+				DEBUGOUT << "All right." << lhs << "==" << rhs;
+			}
+		}
 }
 
 /** Print a QSize to a standard output stream */

testing/testswapscreen-main.cc

@@ -0,0 +1,19 @@
+#include "testswapscreen.h"
+#include "testhelpers.hh"
+
+int main(int argc, char** argv) {
+
+	QApplication qapp(argc,argv);
+
+	qRegisterMetaType< QSharedPointer<RenderedPage> >("QSharedPointer<RenderedPage>");
+
+	RuntimeConfiguration rc{argc, argv};
+
+	DSPDFViewer dsp{rc};
+	SwapScreensAndCheckAlign testdriver{dsp};
+
+	sconnect(&testdriver, SIGNAL(screenSwapRequested()), &dsp, SLOT(swapScreens()));
+	sconnect(&testdriver, SIGNAL(quitRequested()), &dsp, SLOT(exit()));
+
+	return qapp.exec();
+}

testing/testswapscreen.cc

@@ -1,11 +1,75 @@
+#include "testswapscreen.h"
 #include "testhelpers.hh"
 
-int main() {
-	// Spawn Xvfb
-	// Launch dspdfviewer on the rectangles PDF file
-	// Check left and right screen center colors
-	// Send S Keystroke
-	// Check colors again, make sure they are swapped
+#include <QDesktopWidget>
+#include <QRect>
 
-	throw std::runtime_error("Not supported yet.");
+using namespace std;
+using namespace TestHelpers;
+
+SwapScreensAndCheckAlign::SwapScreensAndCheckAlign(DSPDFViewer& d):
+	dspdfviewer(d),
+	screenPrimary( QApplication::desktop()->screenGeometry( 0 ) ),
+	screenSecondary( QApplication::desktop()->screenGeometry( 1 ) ),
+	verify(true)
+{
+	DEBUGOUT << "Number of screens:" << QApplication::desktop()->numScreens() ;
+
+	DEBUGOUT << "screen 0 [pri]:" << screenPrimary;
+	DEBUGOUT << "screen 1 [sec]:" << screenSecondary;
+
+
+	if ( QApplication::desktop()->numScreens() != 2 ) {
+		WARNINGOUT << "Not running in a dual-screen environment";
+		verify = false;
+	} else if ( screenPrimary == screenSecondary ) {
+		WARNINGOUT << "Cannot tell the screens apart";
+		verify = false;
+	} else if ( screenPrimary.width() == 0 || screenPrimary.height() == 0 ) {
+		WARNINGOUT << "Cannot query primary screen size";
+		verify = false;
+	} else if ( screenSecondary.width() == 0 || screenSecondary.height() == 0 ) {
+		WARNINGOUT << "Cannot query secondary screen size";
+		verify = false;
+	}
+	if ( ! verify ) {
+		WARNINGOUT << "Disabling verification.";
+	}
+	// 1 Second time to boot
+	QTimer::singleShot(1000, this, SLOT(checkStartPositions()));
+}
+
+void SwapScreensAndCheckAlign::checkStartPositions() {
+	DEBUGOUT << "Start positions";
+	if ( verify ) {
+		check(dspdfviewer.audienceGeometry(), screenSecondary); // Audience starts on external
+		check(dspdfviewer.secondGeometry(), screenPrimary); // Presenter starts on internal
+	}
+	DEBUGOUT << "Firing screen swap event";
+	emit screenSwapRequested();
+	// 0.5 sec to swap
+	QTimer::singleShot(500, this, SLOT(checkAfterFirstSwap()));
+}
+
+void SwapScreensAndCheckAlign::checkAfterFirstSwap() {
+	DEBUGOUT << "Check after first swap";
+	if ( verify ) {
+		check(dspdfviewer.audienceGeometry(), screenPrimary); // Audience window on laptop
+		check(dspdfviewer.secondGeometry(), screenSecondary); // Presenter window on beamer
+	}
+	emit screenSwapRequested();
+	// 0.5 sec time to swap
+	QTimer::singleShot(500, this, SLOT(checkAfterSwapBack()));
+}
+
+void SwapScreensAndCheckAlign::checkAfterSwapBack() {
+	DEBUGOUT << "Check after swapping back";
+	if ( verify ) {
+		check(dspdfviewer.audienceGeometry(), screenSecondary);
+		check(dspdfviewer.secondGeometry(), screenPrimary);
+		emit quitRequested();
+	}
+	else {
+		QCoreApplication::exit(77);
+	}
 }

testing/testswapscreen.h

@@ -0,0 +1,31 @@
+#pragma once
+
+#include "dspdfviewer.h"
+
+/** Test driver
+ *
+ * If it detects two screens, it will verify that the windows switch to the
+ * specified positions.
+ * If running on single-screen, the commands will be executed without verification,
+ * just to make sure the code doesn't segfault or similar.
+ *
+ * Rinse and repeat 3 times.
+ *
+ */
+class SwapScreensAndCheckAlign: public QObject {
+	Q_OBJECT
+
+	DSPDFViewer& dspdfviewer;
+	QRect screenPrimary;
+	QRect screenSecondary;
+	bool verify;
+public:
+	SwapScreensAndCheckAlign(DSPDFViewer& app);
+signals:
+	void screenSwapRequested();
+	void quitRequested();
+public slots:
+	void checkStartPositions();
+	void checkAfterFirstSwap();
+	void checkAfterSwapBack();
+};

windowrole.cpp

@@ -2,11 +2,9 @@
 #include <stdexcept>
 
 QString to_QString( const WindowRole& wr) {
-	switch( wr ) {
-		case WindowRole::AudienceWindow:
-			return QString::fromUtf8("Audience_Window");
-		case WindowRole::PresenterWindow:
-			return QString::fromUtf8("Secondary_Window");
+	if( wr == WindowRole::AudienceWindow ) {
+		return QString::fromUtf8("Audience_Window");
+	} else {
+		return QString::fromUtf8("Secondary_Window");
 	}
-	throw std::runtime_error("Control should never get here.");
 }