16#ifndef QGSRENDERCHECKER_H
17#define QGSRENDERCHECKER_H
28#include <QRegularExpression>
33#define DUMP_BASE64_IMAGES 0
57 static QDir testReportDir();
65 static bool shouldGenerateReport();
74 QString controlImagePath()
const;
82 void setControlImagePath(
const QString &path );
92 QString report(
bool ignoreSuccess =
true )
const;
103 QString markdownReport(
bool ignoreSuccess =
true )
const;
110 return static_cast<float>( mMismatchCount ) /
111 static_cast<float>( mMatchTarget ) * 100;
139 void setControlName(
const QString &name );
153 void setControlPathSuffix(
const QString &name );
156 QString imageToHash(
const QString &imageFile );
161 void setRenderedImage(
const QString &imageFileName ) { mRenderedImageFile = imageFileName; }
192 void setSizeTolerance(
int xTolerance,
int yTolerance ) { mMaxSizeDifferenceX = xTolerance; mMaxSizeDifferenceY = yTolerance; }
201 AvoidExportingRenderedImage = 1 << 0,
247 bool compareImages( const QString &testName, const QString &referenceImageFile, const QString &renderedImageFile,
unsigned int mismatchCount = 0,
QgsRenderChecker::
Flags flags =
QgsRenderChecker::
Flags() );
259 Q_DECL_DEPRECATED
bool isKnownAnomaly( const QString &diffImageFile )
SIP_DEPRECATED;
265 static
void drawBackground( QImage *image );
272 QString expectedImageFile()
const {
return mExpectedImageFile; }
296 static QString sourcePath();
303 unsigned int mMatchTarget = 0;
304 int mElapsedTime = 0;
313#if DUMP_BASE64_IMAGES
314 void dumpRenderedImageAsBase64();
317 void performPostTestActions(
Flags flags );
319 bool mResult =
false;
320 bool mExpectFail =
false;
324 QString mControlName;
325 unsigned int mMismatchCount = 0;
326 unsigned int mColorTolerance = 0;
327 int mMaxSizeDifferenceX = 0;
328 int mMaxSizeDifferenceY = 0;
329 int mElapsedTimeTarget = 0;
331 QString mControlExtension = QStringLiteral(
"png" );
332 QString mControlPathPrefix;
333 QString mControlPathSuffix;
334 bool mIsCiRun =
false;
335 QVector<QgsDartMeasurement> mDashMessages;
336 bool mBufferDashMessages =
false;
337 QString mDiffImageFile;
352inline
bool compareWkt( const QString &a, const QString &b,
double tolerance = 0.000001 )
354 QgsDebugMsgLevel( QStringLiteral(
"a:%1 b:%2 tol:%3" ).arg( a, b ).arg( tolerance ), 2 );
355 const thread_local QRegularExpression re(
"-?\\d+(?:\\.\\d+)?(?:[eE]\\d+)?" );
357 QString a0( a ), b0( b );
358 a0.replace( re, QStringLiteral(
"#" ) );
359 b0.replace( re, QStringLiteral(
"#" ) );
366 QList<double> al, bl;
369 QRegularExpressionMatch match = re.match( a );
370 while ( match.hasMatch() )
372 al << match.captured( 0 ).toDouble();
373 pos = match.capturedStart( 0 ) + match.capturedLength( 0 );
374 match = re.match( a, pos );
376 match = re.match( b );
377 while ( match.hasMatch() )
379 bl << match.captured( 0 ).toDouble();
380 pos = match.capturedStart( 0 ) + match.capturedLength( 0 );
381 match = re.match( b, pos );
384 if ( al.size() != bl.size() )
387 for (
int i = 0; i < al.size(); i++ )
Emits dart measurements for display in CDash reports.
The QgsMapSettings class contains configuration for rendering of the map.
This class allows checking rendered images against comparison images.
This is a helper class for unit tests that need to write an image and compare it to an expected resul...
void setControlExtension(const QString &extension)
Sets file extension for the control image.
float matchPercent() const
Returns the percent of pixels which matched the control image.
unsigned int matchTarget() const
Returns the total number of pixels in the control image.
QString mReport
HTML format report.
QFlags< Flag > Flags
Render checker flags.
Flag
Render checker flags.
int elapsedTime() const
Returns the total elapsed time for the rendering test.
QString mRenderedImageFile
QString mMarkdownReport
Markdown report.
QString renderedImage() const
Returns the path of the rendered image generated by the test.
void setElapsedTimeTarget(int target)
QVector< QgsDartMeasurement > dartMeasurements() const
Gets access to buffered dash messages.
void setControlPathPrefix(const QString &name)
Sets the path prefix where the control images are kept.
void setRenderedImage(const QString &imageFileName)
Sets the file name of the rendered image generated by the test.
QString mExpectedImageFile
void setSizeTolerance(int xTolerance, int yTolerance)
Sets the largest allowable difference in size between the rendered and the expected image.
void enableDashBuffering(bool enable)
Call this to enable internal buffering of dash messages.
unsigned int mismatchCount() const
Returns the number of pixels which did not match the control image.
void setExpectFail(bool expectFail)
Sets whether the comparison is expected to fail.
void setColorTolerance(unsigned int colorTolerance)
Set tolerance for color components used by runTest() and compareImages().
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
#define SIP_ENUM_BASETYPE(type)
#define QgsDebugMsgLevel(str, level)
bool compareWkt(const QString &a, const QString &b, double tolerance=0.000001)
Compare two WKT strings with some tolerance.
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)