This class allows checking rendered images against comparison images. More...

#include <qgsmultirenderchecker.h>

Public Member Functions
	QgsMultiRenderChecker ()
	Constructor for QgsMultiRenderChecker.

virtual	~QgsMultiRenderChecker ()=default

QString	controlImagePath () const
	Returns the path to the control images.

QString	markdownReport () const
	Returns a markdown report for this test.

QString	report () const
	Returns a HTML report for this test.

bool	runTest (const QString &testName, unsigned int mismatchCount=0)
	Test using renderer to generate the image to be compared.

void	setColorTolerance (unsigned int colorTolerance)
	Set tolerance for color components used by runTest() Default value is 0.

void	setControlName (const QString &name)
	Base directory name for the control image (with control image path suffixed) the path to the image will be constructed like this: controlImagePath + '/' + mControlName + '/' + mControlName + '.png'.

void	setControlPathPrefix (const QString &prefix)
	Sets the path prefix where the control images are kept.

void	setExpectFail (bool expectFail)
	Sets whether the comparison is expected to fail.

void	setFileFunctionLine (const QString &file, const QString &function, int line)
	Sets the source file, function and line from where the test originates.

void	setMapSettings (const QgsMapSettings &mapSettings)
	Set the map settings to use to render the image.

void	setRenderedImage (const QString &renderedImagePath)
	Set the path to the rendered image.

void	setSizeTolerance (int xTolerance, int yTolerance)
	Sets the largest allowable difference in size between the rendered and the expected image.

Static Public Member Functions
static void	drawBackground (QImage *image)
	Draws a checkboard pattern for image backgrounds, so that opacity is visible without requiring a transparent background for the image.

Detailed Description

This class allows checking rendered images against comparison images.

Its main purpose is for the unit testing framework.

It will either:

take an externally rendered image (setRenderedImage())
render the image based on provided mapSettings (setMapSettings())

This image will then be compared against one or several images in a folder inside the control directory (tests/testdata/control_images/{controlName}).

There are modes for single and for multiple reference images.

If there are no subfolders in the control directory, it will assume an image with the name {controlImage}.png in the control directory itself.
If there are subfolders inside the control directory, it will search for images with the name {controlImage}.png in every subfolder.

For every control image there may be one or several randomly named anomaly images defining allowed anomalies. For every control image, the allowed mismatch and color tolerance values will be calculated individually.

Definition at line 52 of file qgsmultirenderchecker.h.

Constructor & Destructor Documentation

◆ QgsMultiRenderChecker()

QgsMultiRenderChecker::QgsMultiRenderChecker ( )

Constructor for QgsMultiRenderChecker.

Definition at line 22 of file qgsmultirenderchecker.cpp.

◆ ~QgsMultiRenderChecker()

virtual QgsMultiRenderChecker::~QgsMultiRenderChecker ( )

virtualdefault

Member Function Documentation

◆ controlImagePath()

QString QgsMultiRenderChecker::controlImagePath ( ) const

Returns the path to the control images.

Definition at line 258 of file qgsmultirenderchecker.cpp.

◆ drawBackground()

static void QgsMultiRenderChecker::drawBackground ( QImage * image )

inlinestatic

Draws a checkboard pattern for image backgrounds, so that opacity is visible without requiring a transparent background for the image.

Definition at line 163 of file qgsmultirenderchecker.h.

◆ markdownReport()

QString QgsMultiRenderChecker::markdownReport ( ) const

Returns a markdown report for this test.

The report will be empty if the test was successfully run.

See also: report()

Since: QGIS 3.34

Definition at line 232 of file qgsmultirenderchecker.cpp.

◆ report()

QString QgsMultiRenderChecker::report ( ) const

Returns a HTML report for this test.

The report will be empty if the test was successfully run.

See also: markdownReport()

Definition at line 204 of file qgsmultirenderchecker.cpp.

◆ runTest()

bool QgsMultiRenderChecker::runTest	(	const QString &	testName,
		unsigned int	mismatchCount = `0`
	)

Test using renderer to generate the image to be compared.

Parameters

testName	to be used as the basis for writing a file to e.g. /tmp/theTestName.png
mismatchCount	defaults to 0. The number of pixels that are allowed to be different from the control image. In some cases rendering may be non-deterministic. This parameter allows you to account for that by providing a tolerance.

Note: make sure to call setExpectedImage and setMapSettings first

Definition at line 55 of file qgsmultirenderchecker.cpp.

◆ setColorTolerance()

void QgsMultiRenderChecker::setColorTolerance ( unsigned int colorTolerance )

inline

Set tolerance for color components used by runTest() Default value is 0.

Parameters

colorTolerance The maximum difference for each color component including alpha to be considered correct.

Definition at line 111 of file qgsmultirenderchecker.h.

◆ setControlName()

void QgsMultiRenderChecker::setControlName ( const QString & name )

Base directory name for the control image (with control image path suffixed) the path to the image will be constructed like this: controlImagePath + '/' + mControlName + '/' + mControlName + '.png'.

Definition at line 28 of file qgsmultirenderchecker.cpp.

◆ setControlPathPrefix()

void QgsMultiRenderChecker::setControlPathPrefix ( const QString & prefix )

Sets the path prefix where the control images are kept.

Definition at line 45 of file qgsmultirenderchecker.cpp.

◆ setExpectFail()

void QgsMultiRenderChecker::setExpectFail ( bool expectFail )

inline

Sets whether the comparison is expected to fail.

Since: QGIS 3.28

Definition at line 95 of file qgsmultirenderchecker.h.

◆ setFileFunctionLine()

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

Sets the source file, function and line from where the test originates.

Since: QGIS 3.36

Definition at line 33 of file qgsmultirenderchecker.cpp.

◆ setMapSettings()

void QgsMultiRenderChecker::setMapSettings ( const QgsMapSettings & mapSettings )

Set the map settings to use to render the image.

Parameters

mapSettings The map settings

Definition at line 50 of file qgsmultirenderchecker.cpp.

◆ setRenderedImage()

void QgsMultiRenderChecker::setRenderedImage ( const QString & renderedImagePath )

inline

Set the path to the rendered image.

If this is not set or set to null QString, an image will be rendered based on the provided mapsettings

Parameters

renderedImagePath A path to the rendered image with which control images will be compared

Definition at line 88 of file qgsmultirenderchecker.h.

◆ setSizeTolerance()

void QgsMultiRenderChecker::setSizeTolerance	(	int	xTolerance,
		int	yTolerance
	)

inline

Sets the largest allowable difference in size between the rendered and the expected image.

Parameters

xTolerance	x tolerance in pixels
yTolerance	y tolerance in pixels

Definition at line 118 of file qgsmultirenderchecker.h.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/qgsmultirenderchecker.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/qgsmultirenderchecker.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsMultiRenderChecker()

◆ ~QgsMultiRenderChecker()

Member Function Documentation

◆ controlImagePath()

◆ drawBackground()

◆ markdownReport()

◆ report()

◆ runTest()

◆ setColorTolerance()

◆ setControlName()

◆ setControlPathPrefix()

◆ setExpectFail()

◆ setFileFunctionLine()

◆ setMapSettings()

◆ setRenderedImage()

◆ setSizeTolerance()