qgsmultirenderchecker.h

Go to the documentation of this file.

/***************************************************************************
    qgsmultirenderchecker.h
     --------------------------------------
    Date                 : 6.11.2014
    Copyright            : (C) 2014 Matthias Kuhn
    Email                : matthias at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSMULTIRENDERCHECKER_H
#define QGSMULTIRENDERCHECKER_H
 
#include "qgis_core.h"
#include "qgsrenderchecker.h"
 
class QgsLayout;

 
class CORE_EXPORT QgsMultiRenderChecker
{
  public:
    QgsMultiRenderChecker();
 
    virtual ~QgsMultiRenderChecker() = default;

    void setControlName( const QString &name );

    void setFileFunctionLine( const QString &file, const QString &function, int line );

    void setControlPathPrefix( const QString &prefix );

    void setRenderedImage( const QString &renderedImagePath ) { mRenderedImage = renderedImagePath; }

    void setExpectFail( bool expectFail ) { mExpectFail = expectFail; }

    void setMapSettings( const QgsMapSettings &mapSettings );

    void setColorTolerance( unsigned int colorTolerance ) { mColorTolerance = colorTolerance; }

    void setSizeTolerance( int xTolerance, int yTolerance )
    {
      mMaxSizeDifferenceX = xTolerance;
      mMaxSizeDifferenceY = yTolerance;
    }

    bool runTest( const QString &testName, unsigned int mismatchCount = 0 );

    QString report() const;

    QString markdownReport() const;

    QString controlImagePath() const;

    static void drawBackground( QImage *image ) { QgsRenderChecker::drawBackground( image ); }
 
  private:
    QString mSourceFile;
    QString mSourceFunction;
    int mSourceLine = -1;
 
    bool mResult = false;
 
    QString mReportHeader;
    QString mReport;
 
    QString mMarkdownReportHeader;
    QString mMarkdownReport;
 
    QString mRenderedImage;
    QString mControlName;
    QString mControlPathPrefix;
    unsigned int mColorTolerance = 0;
    int mMaxSizeDifferenceX = 0;
    int mMaxSizeDifferenceY = 0;
    QgsMapSettings mMapSettings;
    bool mExpectFail = false;
 
    bool mIsCiRun = false;
};


class CORE_EXPORT QgsLayoutChecker : public QgsMultiRenderChecker
{
  public:
    QgsLayoutChecker( const QString &testName, QgsLayout *layout );

    void setSize( QSize size ) { mSize = size; }

    bool testLayout( QString &report SIP_OUT, int page = 0, int pixelDiff = 0, bool createReferenceImage = false );
 
  private:
    QgsLayoutChecker() = delete;
 
    QString mTestName;
    QgsLayout *mLayout = nullptr;
    QSize mSize;
    int mDotsPerMeter;
};
 
 
#endif // QGSMULTIRENDERCHECKER_H