a unified VTK regression testing framework More...

#include <vtkTesting.h>

Inheritance diagram for vtkTesting:

Collaboration diagram for vtkTesting:

Public Types
enum	ReturnValue { FAILED = 0, PASSED = 1, NOT_RUN = 2, DO_INTERACTOR = 3 }
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkTesting *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	CompareAverageOfL2Norm (vtkDataSet pdA, vtkDataSet pdB, double tol)
int	CompareAverageOfL2Norm (vtkDataArray daA, vtkDataArray daB, double tol)
void	CleanArguments ()
int	IsValidImageSpecified ()
int	IsInteractiveModeSpecified ()
int	IsFlagSpecified (const char *flag)

virtual void	SetFrontBuffer (int)
virtual void	FrontBufferOn ()
virtual void	FrontBufferOff ()
virtual int	GetFrontBuffer ()

virtual int	RegressionTest (double thresh)
virtual int	RegressionTest (double thresh, ostream &os)

virtual int	RegressionTest (const std::string &pngFileName, double thresh)
virtual int	RegressionTest (const std::string &pngFileName, double thresh, ostream &os)

virtual int	RegressionTest (vtkAlgorithm *imageSource, double thresh)
virtual int	RegressionTest (vtkAlgorithm *imageSource, double thresh, ostream &os)

virtual void	SetRenderWindow (vtkRenderWindow *rw)
virtual vtkRenderWindow *	GetRenderWindow ()

virtual void	SetValidImageFileName (const char *)
const char *	GetValidImageFileName ()

virtual double	GetImageDifference ()

void	AddArgument (const char *argv)
void	AddArguments (int argc, const char **argv)

char *	GetArgument (const char *arg)

const char *	GetDataRoot ()
virtual void	SetDataRoot (const char *)

const char *	GetTempDirectory ()
virtual void	SetTempDirectory (const char *)

virtual void	SetBorderOffset (int)
virtual int	GetBorderOffset ()

virtual void	SetVerbose (int)
virtual int	GetVerbose ()
Static Public Member Functions
static vtkTesting *	New ()
static int	IsTypeOf (const char *type)
static vtkTesting *	SafeDownCast (vtkObjectBase *o)
static int	Test (int argc, char argv[], vtkRenderWindow rw, double thresh)

static int	InteractorEventLoop (int argc, char argv[], vtkRenderWindowInteractor iren, const char *stream=NULL)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkTesting ()
	~vtkTesting ()
Static Protected Member Functions
static char *	IncrementFileName (const char *fname, int count)
static int	LookForFile (const char *newFileName)
Protected Attributes
int	FrontBuffer
vtkRenderWindow *	RenderWindow
char *	ValidImageFileName
double	ImageDifference
char *	TempDirectory
int	BorderOffset
int	Verbose
std::vector< std::string >	Args
char *	DataRoot
double	StartWallTime
double	StartCPUTime

Detailed Description

a unified VTK regression testing framework

This is a VTK regression testing framework. Looks like this:

vtkTesting* t = vtkTesting::New();

Two options for setting arguments

Option 1: for ( cc = 1; cc < argc; cc ++ ) { t->AddArgument(argv[cc]); }

Option 2: t->AddArgument("-D"); t->AddArgument(my_data_dir); t->AddArgument("-V"); t->AddArgument(my_valid_image);

...

Two options of doing testing:

Option 1: t->SetRenderWindow(renWin); int res = t->RegressionTest(threshold);

Option 2: int res = t->RegressionTest(test_image, threshold);

...

if ( res == vtkTesting::PASSED ) { Test passed } else { Test failed }

Tests:: vtkTesting (Tests)

Definition at line 79 of file vtkTesting.h.

Member Typedef Documentation

typedef vtkObject vtkTesting::Superclass

Reimplemented from vtkObject.

Definition at line 83 of file vtkTesting.h.

Member Enumeration Documentation

enum vtkTesting::ReturnValue

Enumerator:

FAILED
PASSED
NOT_RUN
DO_INTERACTOR

Definition at line 87 of file vtkTesting.h.

Constructor & Destructor Documentation

vtkTesting::vtkTesting ( ) [protected]

vtkTesting::~vtkTesting ( ) [protected]

Member Function Documentation

static vtkTesting* vtkTesting::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkTesting::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

virtual int vtkTesting::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkTesting* vtkTesting::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkTesting::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkTesting* vtkTesting::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkTesting::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

static int vtkTesting::Test	(	int	argc,
		char *	argv[],
		vtkRenderWindow *	rw,
		double	thresh
	)		`[static]`

static int vtkTesting::InteractorEventLoop	(	int	argc,
		char *	argv[],
		vtkRenderWindowInteractor *	iren,
		const char *	stream = `NULL`
	)		`[static]`

This method is intended to be a comprehensive, one line replacement for vtkRegressionTest and for the replay based testing using vtkInteractorEventRecorder greatly simplifying API and code bloat. It scans the command line specified for the following : - If a "--DisableReplay" is specified, it disables the testing replay. This is particularly useful in enabling the user to exercise the widgets. Typically the widgets are defined by the testing replay, so the user misses out on playing around with the widget definition behaviour. - If a "--Record" is specified in the command line, it records the interactions into a "vtkInteractorEventRecorder.log" file. This is useful when creating the playback stream that is plugged into tests. Typical usage in a test for a VTK widget that needs playback testing / recording is : const char TestFooWidgetTestLog[] = { .... }; int TestFooWidget( int argc, char *argv[] ) { ... return vtkTesting::InteractorEventLoop( argc, argv, iren, TestFooWidgetTestLog ); } In tests where no playback is exercised, the API is simply int TestFoo( int argc, char *argv[] ) { ... return vtkTesting::InteractorEventLoop( argc, argv, iren ); }

virtual void vtkTesting::SetFrontBuffer ( int ) [virtual]

Use front buffer for tests. By default use back buffer.

virtual void vtkTesting::FrontBufferOn ( ) [virtual]

Use front buffer for tests. By default use back buffer.

virtual void vtkTesting::FrontBufferOff ( ) [virtual]

Use front buffer for tests. By default use back buffer.

virtual int vtkTesting::GetFrontBuffer ( ) [virtual]

Use front buffer for tests. By default use back buffer.

virtual int vtkTesting::RegressionTest ( double thresh ) [virtual]

Perform the test and return result. At the same time the output will be written cout

virtual int vtkTesting::RegressionTest	(	double	thresh,
		ostream &	os
	)		`[virtual]`

Perform the test and return result. At the same time the output will be written cout

virtual int vtkTesting::RegressionTest	(	const std::string &	pngFileName,
		double	thresh
	)		`[virtual]`

Perform the test and return result. The test image will be read from the png file at pngFileName.

virtual int vtkTesting::RegressionTest	(	const std::string &	pngFileName,
		double	thresh,
		ostream &	os
	)		`[virtual]`

Perform the test and return result. The test image will be read from the png file at pngFileName.

virtual int vtkTesting::RegressionTest	(	vtkAlgorithm *	imageSource,
		double	thresh
	)		`[virtual]`

Compare the image with the valid image.

virtual int vtkTesting::RegressionTest	(	vtkAlgorithm *	imageSource,
		double	thresh,
		ostream &	os
	)		`[virtual]`

Compare the image with the valid image.

int vtkTesting::CompareAverageOfL2Norm	(	vtkDataSet *	pdA,
		vtkDataSet *	pdB,
		double	tol
	)

Compute the average L2 norm between all point data data arrays of types float and double present in the data sets "dsA" and "dsB" (this includes instances of vtkPoints) Compare the result of each L2 comutation to "tol".

int vtkTesting::CompareAverageOfL2Norm	(	vtkDataArray *	daA,
		vtkDataArray *	daB,
		double	tol
	)

Compute the average L2 norm between two data arrays "daA" and "daB" and compare against "tol".

virtual void vtkTesting::SetRenderWindow ( vtkRenderWindow * rw ) [virtual]

Set and get the render window that will be used for regression testing.

virtual vtkRenderWindow* vtkTesting::GetRenderWindow ( ) [virtual]

Set and get the render window that will be used for regression testing.

virtual void vtkTesting::SetValidImageFileName ( const char * ) [virtual]

Set/Get the name of the valid image file

const char* vtkTesting::GetValidImageFileName ( )

Set/Get the name of the valid image file

virtual double vtkTesting::GetImageDifference ( ) [virtual]

Get the image difference.

void vtkTesting::AddArgument ( const char * argv )

Pass the command line arguments into this class to be processed. Many of the Get methods such as GetValidImage and GetBaselineRoot rely on the arguments to be passed in prior to retrieving these values. Just call AddArgument for each argument that was passed into the command line

void vtkTesting::AddArguments	(	int	argc,
		const char **	argv
	)

Pass the command line arguments into this class to be processed. Many of the Get methods such as GetValidImage and GetBaselineRoot rely on the arguments to be passed in prior to retrieving these values. Just call AddArgument for each argument that was passed into the command line

char* vtkTesting::GetArgument ( const char * arg )

Search for a specific argument by name and return its value (assumed to be the next on the command tail). Up to caller to delete the returned string.

void vtkTesting::CleanArguments ( )

This method delete all arguments in vtkTesting, this way you can reuse it in a loop where you would have multiple testing.

const char* vtkTesting::GetDataRoot ( )

Get some parameters from the command line arguments, env, or defaults

virtual void vtkTesting::SetDataRoot ( const char * ) [virtual]

Get some parameters from the command line arguments, env, or defaults

const char* vtkTesting::GetTempDirectory ( )

Get some parameters from the command line arguments, env, or defaults

virtual void vtkTesting::SetTempDirectory ( const char * ) [virtual]

Get some parameters from the command line arguments, env, or defaults