Move QgsCompositionChecker to core, speeds up compilation with

tests enabled

Author: nyalldawson

CMakeLists.txt

@@ -322,6 +322,7 @@ SET(ENABLE_MODELTEST FALSE CACHE BOOL "Enable QT ModelTest (not for production)"
 
 IF (ENABLE_TESTS)
   SET( QT_USE_QTTEST  TRUE )
+  ADD_DEFINITIONS(-DENABLE_TESTS)
   ENABLE_TESTING()
   # Adds some testing specific build targets e.g. make Experimental
   INCLUDE(Dart)

src/core/qgsmultirenderchecker.cpp

@@ -14,7 +14,7 @@
  ***************************************************************************/
 
 #include "qgsmultirenderchecker.h"
-
+#include "qgscomposition.h"
 #include <QDebug>
 
 QgsMultiRenderChecker::QgsMultiRenderChecker()
@@ -102,3 +102,84 @@ QString QgsMultiRenderChecker::controlImagePath() const
                               QDir::separator() + mControlPathPrefix + QDir::separator() + mControlName + QDir::separator();
   return myControlImageDir;
 }
+
+#ifdef ENABLE_TESTS
+
+//
+// QgsCompositionChecker
+//
+
+///@cond PRIVATE
+
+QgsCompositionChecker::QgsCompositionChecker( const QString& testName, QgsComposition* composition )
+    : QgsMultiRenderChecker()
+    , mTestName( testName )
+    , mComposition( composition )
+    , mSize( 1122, 794 )
+    , mDotsPerMeter( 96 / 25.4 * 1000 )
+{
+  // The composer has some slight render inconsistencies on the whole image sometimes
+  setColorTolerance( 5 );
+}
+
+QgsCompositionChecker::QgsCompositionChecker()
+    : mComposition( nullptr )
+    , mDotsPerMeter( 96 / 25.4 * 1000 )
+{
+}
+
+QgsCompositionChecker::~QgsCompositionChecker()
+{
+}
+
+bool QgsCompositionChecker::testComposition( QString &theReport, int page, int pixelDiff )
+{
+  if ( !mComposition )
+  {
+    return false;
+  }
+
+  setControlName( "expected_" + mTestName );
+
+#if 0
+  //fake mode to generate expected image
+  //assume 96 dpi and size of the control image 1122 * 794
+  QImage newImage( QSize( 1122, 794 ), QImage::Format_RGB32 );
+  mComposition->setPlotStyle( QgsComposition::Print );
+  newImage.setDotsPerMeterX( 96 / 25.4 * 1000 );
+  newImage.setDotsPerMeterY( 96 / 25.4 * 1000 );
+  drawBackground( &newImage );
+  QPainter expectedPainter( &newImage );
+  //QRectF sourceArea( 0, 0, mComposition->paperWidth(), mComposition->paperHeight() );
+  //QRectF targetArea( 0, 0, 3507, 2480 );
+  mComposition->renderPage( &expectedPainter, page );
+  expectedPainter.end();
+  newImage.save( mExpectedImageFile, "PNG" );
+  return true;
+#endif //0
+
+  QImage outputImage( mSize, QImage::Format_RGB32 );
+
+  mComposition->setPlotStyle( QgsComposition::Print );
+  outputImage.setDotsPerMeterX( mDotsPerMeter );
+  outputImage.setDotsPerMeterY( mDotsPerMeter );
+  drawBackground( &outputImage );
+  QPainter p( &outputImage );
+  mComposition->renderPage( &p, page );
+  p.end();
+
+  QString renderedFilePath = QDir::tempPath() + '/' + QFileInfo( mTestName ).baseName() + "_rendered.png";
+  outputImage.save( renderedFilePath, "PNG" );
+
+  setRenderedImage( renderedFilePath );
+
+  bool testResult = runTest( mTestName, pixelDiff );
+
+  theReport += report();
+
+  return testResult;
+}
+
+///@endcond
+
+#endif

src/core/qgsmultirenderchecker.h

@@ -128,4 +128,29 @@ class CORE_EXPORT QgsMultiRenderChecker
     QgsMapSettings mMapSettings;
 };
 
+#ifdef ENABLE_TESTS
+// Renders a composition to an image and compares with an expected output
+///@cond PRIVATE
+class CORE_EXPORT QgsCompositionChecker : public QgsMultiRenderChecker
+{
+  public:
+    QgsCompositionChecker( const QString& testName, QgsComposition* composition );
+    ~QgsCompositionChecker();
+
+    void setSize( QSize size ) { mSize = size; }
+
+    bool testComposition( QString &theReport, int page = 0, int pixelDiff = 0 );
+
+  private:
+    QgsCompositionChecker(); //forbidden
+
+    QString mTestName;
+    QgsComposition* mComposition;
+    QSize mSize;
+    int mDotsPerMeter;
+};
+///@endcond
+#endif
+
+
 #endif // QGSMULTIRENDERCHECKER_H

tests/src/core/CMakeLists.txt

@@ -1,5 +1,5 @@
 # Standard includes and utils to compile into all tests.
-SET (util_SRCS qgscompositionchecker.cpp)
+#SET (util_SRCS qgscompositionchecker.cpp)
 
 
 #####################################################

tests/src/core/qgscompositionchecker.cpp

@@ -17,7 +17,7 @@
 
 #include "qgsapplication.h"
 #include "qgscomposition.h"
-#include "qgscompositionchecker.h"
+#include "qgsmultirenderchecker.h"
 #include "qgscomposermap.h"
 #include "qgscomposermapoverview.h"
 #include "qgsatlascomposition.h"

tests/src/core/qgscompositionchecker.h

@@ -17,7 +17,7 @@
 
 #include "qgsapplication.h"
 #include "qgscomposition.h"
-#include "qgscompositionchecker.h"
+#include "qgsmultirenderchecker.h"
 #include "qgscomposershape.h"
 #include "qgsmaprenderer.h"
 #include <QObject>

tests/src/core/testqgsatlascomposition.cpp

@@ -18,7 +18,7 @@
 #include "qgscomposeritemgroup.h"
 #include "qgscomposerlabel.h"
 #include "qgscomposition.h"
-#include "qgscompositionchecker.h"
+#include "qgsmultirenderchecker.h"
 #include "qgsapplication.h"
 
 #include <QObject>

tests/src/core/testqgscomposereffects.cpp

@@ -19,7 +19,7 @@
 #include "qgscomposerhtml.h"
 #include "qgscomposerframe.h"
 #include "qgscomposition.h"
-#include "qgscompositionchecker.h"
+#include "qgsmultirenderchecker.h"
 #include "qgsfontutils.h"
 #include <QObject>
 #include <QtTest/QtTest>