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,
245 bool compareImages( const QString &testName, const QString &referenceImageFile, const QString &renderedImageFile,
unsigned int mismatchCount = 0,
QgsRenderChecker::
Flags flags =
QgsRenderChecker::
Flags() );
257 Q_DECL_DEPRECATED
bool isKnownAnomaly( const QString &diffImageFile )
SIP_DEPRECATED;
263 static
void drawBackground( QImage *image );
270 QString expectedImageFile()
const {
return mExpectedImageFile; }
294 static QString sourcePath();
301 unsigned int mMatchTarget = 0;
302 int mElapsedTime = 0;
311#if DUMP_BASE64_IMAGES
312 void dumpRenderedImageAsBase64();
315 void performPostTestActions(
Flags flags );
317 bool mResult =
false;
318 bool mExpectFail =
false;
322 QString mControlName;
323 unsigned int mMismatchCount = 0;
324 unsigned int mColorTolerance = 0;
325 int mMaxSizeDifferenceX = 0;
326 int mMaxSizeDifferenceY = 0;
327 int mElapsedTimeTarget = 0;
329 QString mControlExtension = QStringLiteral(
"png" );
330 QString mControlPathPrefix;
331 QString mControlPathSuffix;
332 bool mIsCiRun =
false;
333 QVector<QgsDartMeasurement> mDashMessages;
334 bool mBufferDashMessages =
false;
335 QString mDiffImageFile;
350inline
bool compareWkt( const QString &a, const QString &b,
double tolerance = 0.000001 )
352 QgsDebugMsgLevel( QStringLiteral(
"a:%1 b:%2 tol:%3" ).arg( a, b ).arg( tolerance ), 2 );
353 const thread_local QRegularExpression re(
"-?\\d+(?:\\.\\d+)?(?:[eE]\\d+)?" );
355 QString a0( a ), b0( b );
356 a0.replace( re, QStringLiteral(
"#" ) );
357 b0.replace( re, QStringLiteral(
"#" ) );
364 QList<double> al, bl;
367 QRegularExpressionMatch match = re.match( a );
368 while ( match.hasMatch() )
370 al << match.captured( 0 ).toDouble();
371 pos = match.capturedStart( 0 ) + match.capturedLength( 0 );
372 match = re.match( a, pos );
374 match = re.match( b );
375 while ( match.hasMatch() )
377 bl << match.captured( 0 ).toDouble();
378 pos = match.capturedStart( 0 ) + match.capturedLength( 0 );
379 match = re.match( b, pos );
382 if ( al.size() != bl.size() )
385 for (
int i = 0; i < al.size(); i++ )
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)