Docs For Class atkTestCase

Home

Documentation home

Atk index

Docs For Class atkTestCase [ package: atk ]

Class: atkTestCase

Source Location: /test/class.atktestcase.inc

Class atkTestCase

Class Overview

atkTestCase is a specialization of SimpleTest's UnitTestCase. It

contains utility methods that can be used by testcases, such as the ability to swap the default database driver with a mock version

Located in /test/class.atktestcase.inc [line 34]

Wiki documentation

PHPUnit_Framework_TestCase
   |
   --atkTestCase

Author(s):

Ivo Jansch <ivo@achievo.org>

API Tags:

Abstract:

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
test_sql_whereclause_blacklist_checker	atkTestCase is a specialization of SimpleTest's UnitTestCase. It
atkAttributeTestCase	Baseclass for attribute unittests. This class is an extension to the default UnitTestCase. It provides an apiTest method that performs a basic test if the attribute responds to standard api calls correctly
atkCacheTestCase	This file is part of the Achievo ATK distribution.
atkPluginTestCase	atkPluginTestCase is a testcase class for testing Smarty plugins.

[ Top ]

Property Summary

mixed	$m_fixtureData
mixed	$m_path
mixed	$m_restoreDb
mixed	$m_restoreNode
mixed	$m_restoreSecMgr
mixed	$useTestDatabase

[ Top ]

Method Summary

atkTestCase	__construct()	Constructor.
void	addFixture()	Adds the given fixture to the given database.
void	addFixtures()	Adds the given fixtures to the given database.
void	assertAttributeHasFlag()	Asserts if a certain attribute in the given node has the given flag.
void	assertAttributeNotHasFlag()	Asserts if a certain attribute in the given node doesn't have the given flag.
void	assertNoValidationError()	Asserts the given attribute(s) value did not cause the given validation error.
void	assertValidationError()	Asserts the given attribute(s) value caused the given validation error.
array	fixture()	Returns the fixture for the given table name with the given name.
void	restoreDb()
void	restoreNode()
void	restoreSecurityManager()
void	setMockDb()
void	&setMockNode()
void	&setMockSecurityManager()
void	setUp()	Called before each test method to setup some
void	setUpTestDatabase()	Set-up test database data.
void	tearDown()	Called after each test method. By default this
returns	_getPath()	Get path for this test-case.
void	&_getTestDb()	Get test database.
void	_hasValidationError()	Asserts the given attribute(s) value did not cause the given validation error.
boolean	_validateTestDb()	Check if we have a test database for each database.
array	__call()	Override __call to intercept method calls for fixture data.

[ Top ]

Properties

mixed $m_fixtureData = array() [line 44]

[ Top ]

mixed $m_path = null [line 38]

API Tags:

Access:

private

[ Top ]

mixed $m_restoreDb = array() [line 40]

[ Top ]

mixed $m_restoreNode = array() [line 41]

[ Top ]

mixed $m_restoreSecMgr = NULL [line 42]

[ Top ]

mixed $useTestDatabase = false [line 36]

API Tags:

Access:

public

[ Top ]

Methods

Constructor __construct [line 51]

atkTestCase __construct(
[
$label = null] 
)

Constructor.

Parameters:

$label:

API Tags:

Access:

public

[ Top ]

addFixture [line 159]

void addFixture(
string
$name, [string
$database = "default"] 
)

Adds the given fixture to the given database.

Parameters:

string	$name:	fixture name
string	$database:	database name

[ Top ]

addFixtures [line 170]

void addFixtures(
array
$names, [string
$database = "default"] 
)

Adds the given fixtures to the given database.

Parameters:

array	$names:	fixture names
string	$database:	database name

[ Top ]

assertAttributeHasFlag [line 431]

void assertAttributeHasFlag(
atkNodeType
$node, string
$attribName, string
$flagName 
)

Asserts if a certain attribute in the given node has the given flag.

You should pass the flag name to this method!

Parameters:

atkNodeType	$node:
string	$attribName:
string	$flagName:

[ Top ]

assertAttributeNotHasFlag [line 446]

void assertAttributeNotHasFlag(
atkNodeType
$node, string
$attribName, string
$flagName 
)

Asserts if a certain attribute in the given node doesn't have the given flag.

You should pass the flag name to this method!

Parameters:

atkNodeType	$node:
string	$attribName:
string	$flagName:

[ Top ]

assertNoValidationError [line 395]

void assertNoValidationError(
array
$record, mixed
$attribName, string
$error 
)

Asserts the given attribute(s) value did not cause the given validation error.

$attribName can contain the name of a single attributename, or an array with attributenames.

Parameters:

array	$record:
mixed	$attribName:
string	$error:

[ Top ]

assertValidationError [line 414]

void assertValidationError(
array
$record, mixed
$attribName, string
$error 
)

Asserts the given attribute(s) value caused the given validation error.

$attribName can contain the name of a single attributename, or an array with attributenames.

Parameters:

array	$record:
mixed	$attribName:
string	$error:

[ Top ]

fixture [line 213]

array fixture(
string
$table, [string
$name = NULL], [
$database = NULL] 
)

Returns the fixture for the given table name with the given name.

If the fixture doesn't exist NULL is returned. If no database is specified all databases will be searched. If no name is specified all fixtures for the given table will be returned.

Parameters:

string	$table:	table name
string	$name:	fixture name
	$database:

API Tags:

Return:

fixture data

[ Top ]

restoreDb [line 294]

void restoreDb(
[
$conn = NULL] 
)

Parameters:

$conn:

[ Top ]

restoreNode [line 306]

void restoreNode(

$nodename 
)

Parameters:

$nodename:

[ Top ]

restoreSecurityManager [line 316]

void restoreSecurityManager(
)

[ Top ]

setMockDb [line 281]

void setMockDb(
[
$conn = NULL] 
)

Parameters:

$conn:

[ Top ]

setMockNode [line 301]

void &setMockNode(

$nodename, 
&$mocknode 
)

Parameters:

	$nodename:
	&$mocknode:

[ Top ]

setMockSecurityManager [line 311]

void &setMockSecurityManager(

&$mockmanager 
)

Parameters:

&$mockmanager:

[ Top ]

setUp [line 62]

void setUp(
)

Called before each test method to setup some

data etc. By default this means the fixture data will be loaded into the test database. Make sure you call the parent if you override this method!

API Tags:

Access:

public

Redefined in descendants as:

atkAttributeTestCase::setUp() : Setup the testcase.

[ Top ]

setUpTestDatabase [line 101]

void setUpTestDatabase(
)

Set-up test database data.

API Tags:

Access:

public

[ Top ]

tearDown [line 145]

void tearDown(
)

Called after each test method. By default this

means the fixture data and any other data added to the database will be removed from the test database. Make sure you call the parent if you override this method!

Redefined in descendants as:

atkAttributeTestCase::tearDown()

[ Top ]

_getPath [line 262]

returns _getPath(
)

Get path for this test-case.

API Tags:

Return:

the path for this test-case

[ Top ]

_getTestDb [line 276]

void &_getTestDb(

$database 
)

Get test database.

Parameters:

$database:

[ Top ]

_hasValidationError [line 331]

void _hasValidationError(
array
$record, mixed
$attribName, string
$error 
)

Asserts the given attribute(s) value did not cause the given validation error.

$attribName can contain the name of a single attributename, or an array with attributenames.

Parameters:

array	$record:
mixed	$attribName:
string	$error:

[ Top ]

_validateTestDb [line 111]

boolean _validateTestDb(
)

Check if we have a test database for each database.

API Tags:

Access:

protected

[ Top ]

__call [line 246]

array __call(
string
$method, array
$args 
)

Override __call to intercept method calls for fixture data.

This makes it possible to access fixtures if there is a method with the same name as the table the fixture is defined for. Only works properly in PHP5.

Parameters:

string	$method:	method name (table name)
array	$args:	method arguments

API Tags:

Return:

fixture data

[ Top ]