Class TestTask

Task class for creating and updating test files.

Object

Shell

BakeTask

TestTask

Package: cake\cake\console\libs\tasks
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: tasks/test.php

Properties summary

$_fixtures public

string

Internal list of fixtures that have been added so far.
$classTypes public

array

class types that methods can be generated for
$path public

string

path to TESTS directory
$tasks public

array

Tasks used.

Inherited Properties

connection, interactive, plugin DbConfig, Dispatch, alias, args, className, command, name, params, shell, taskNames, uses

Method Summary

__interactive() public

Handles interactive baking
_addFixture() public

Add classname to the fixture list. Sets the app. or plugin.plugin_name. prefix.
_processController() public

Process all the models attached to a controller and generate a fixture list.
_processModel() public

Process a model recursively and pull out all the model names converting them to fixture names.
bake() public

Completes final steps for generating data to create test case.
buildTestSubject() public

Construct an instance of the class to be tested. So that fixtures can be detected
execute() public

Execution method always used for tasks
generateConstructor() public

Generate a constructor code snippet for the type and classname
generateFixtureList() public

Generate the list of fixtures that will be required to run this test based on loaded models.
getClassName() public

Get the user chosen Class name for the chosen type
getObjectType() public

Interact with the user and get their chosen type. Can exit the script.
getRealClassName() public

Gets the real class name from the cake short form.
getTestableMethods() public

Get methods declared in the class given. No parent methods will be returned
getUserFixtures() public

Interact with the user to get additional fixtures they want to use.
hasMockClass() public

Is a mock class required for this type of test? Controllers require a mock class.
help() public

Show help file.
isLoadableClass() public

Check if a class with the given type is loaded or can be loaded.
testCaseFileName() public

Make the filename for the test case. resolve the suffixes for controllers and get the plugin path if needed.
typeCanDetectFixtures() public

Checks whether the chosen type can find its own fixtures. Currently only model, and controller are supported

Method Detail

__interactive() public ¶

__interactive( $type = null )

Handles interactive baking

_addFixture() public ¶

_addFixture( string $name )

Add classname to the fixture list. Sets the app. or plugin.plugin_name. prefix.

Parameters

string $name: Name of the Model class that a fixture might be required for.

_processController() public ¶

_processController( Controller $subject )

Process all the models attached to a controller and generate a fixture list.

Parameters

Controller $subject: A controller to pull model names off of.

_processModel() public ¶

_processModel( Model $subject )

Process a model recursively and pull out all the model names converting them to fixture names.

Parameters

Model $subject: A Model class to scan for associations and pull fixtures off of.

bake() public ¶

bake( string $type , string $className )

Completes final steps for generating data to create test case.

Parameters

string $type: Type of object to bake test case for ie. Model, Controller
string $className: the 'cake name' for the class ie. Posts for the PostsController

buildTestSubject() public ¶

buildTestSubject( string $type , string $class )

Construct an instance of the class to be tested. So that fixtures can be detected

Parameters

string $type: The Type of object you are generating tests for eg. controller
string $class: the Classname of the class the test is being generated for.

Returns

object
And instance of the class that is going to be tested.

execute() public ¶

execute( )

Execution method always used for tasks

generateConstructor() public ¶

generateConstructor( string $type , string $fullClassName )

Generate a constructor code snippet for the type and classname

Parameters

string $type: The Type of object you are generating tests for eg. controller
string $fullClassName: $className the Classname of the class the test is being generated for.

Returns

string
Constructor snippet for the thing you are building.

generateFixtureList() public ¶

generateFixtureList( object $subject )

Generate the list of fixtures that will be required to run this test based on loaded models.

Parameters

object $subject: The object you want to generate fixtures for.

Returns

array
Array of fixtures to be included in the test.

getClassName() public ¶

getClassName( string $objectType )

Get the user chosen Class name for the chosen type

Parameters

string $objectType: Type of object to list classes for i.e. Model, Controller.

Returns

string
Class name the user chose.

getObjectType() public ¶

getObjectType( )

Interact with the user and get their chosen type. Can exit the script.

Returns

string
Users chosen type.

getRealClassName() public ¶

getRealClassName( string $type , string $class )

Gets the real class name from the cake short form.

Parameters

string $type: The Type of object you are generating tests for eg. controller
string $class: the Classname of the class the test is being generated for.

Returns

string
Real classname

getTestableMethods() public ¶

getTestableMethods( string $className )

Get methods declared in the class given. No parent methods will be returned

Parameters

string $className: Name of class to look at.

Returns

array
Array of method names.

getUserFixtures() public ¶

getUserFixtures( )

Interact with the user to get additional fixtures they want to use.

Returns

array
Array of fixtures the user wants to add.

hasMockClass() public ¶

hasMockClass( string $type )

Is a mock class required for this type of test? Controllers require a mock class.

Parameters

string $type: The type of object tests are being generated for eg. controller.

Returns

boolean

help() public ¶

help( )

Show help file.

Overrides

Shell::help()

isLoadableClass() public ¶

isLoadableClass( string $type , string $class )

Check if a class with the given type is loaded or can be loaded.

Parameters

string $type: The Type of object you are generating tests for eg. controller
string $class: $className the Classname of the class the test is being generated for.

Returns

boolean

testCaseFileName() public ¶

testCaseFileName( string $type , string $className )

Make the filename for the test case. resolve the suffixes for controllers and get the plugin path if needed.

Parameters

string $type: The Type of object you are generating tests for eg. controller
string $className: the Classname of the class the test is being generated for.

Returns

string
filename the test should be created on.

typeCanDetectFixtures() public ¶

typeCanDetectFixtures( string $type , string $className ,… )

Checks whether the chosen type can find its own fixtures. Currently only model, and controller are supported

Parameters

string $type: The Type of object you are generating tests for eg. controller
string $className ,…: the Classname of the class the test is being generated for.

Returns

boolean

Methods inherited from BakeTask

getPath() public ¶

getPath( )

Gets the path for output. Checks the plugin property and returns the correct path.

Returns

string
Path to output.

startup() public ¶

startup( )

Disable caching for baking. This forces the most current database schema to be used.

Overrides

Shell::startup()

Methods inherited from Shell

__construct() public ¶

__construct( $dispatch )

Constructs this Shell instance.

Overrides

Object::__construct()

_checkArgs() public ¶

_checkArgs( integer $expectedNum , string $command = null )

Will check the number args matches otherwise throw an error

Parameters

integer $expectedNum: Expected number of paramters
string $command optional null: Command

_checkUnitTest() public ¶

_checkUnitTest( )

Action to create a Unit Test

Returns

boolean
Success

_controllerName() public ¶

_controllerName( string $name )

Creates the proper controller plural name for the specified controller class name

Parameters

string $name: Controller class name

Returns

string
Controller plural name

_controllerPath() public ¶

_controllerPath( string $name )

Creates the proper controller path for the specified controller class name

Parameters

string $name: Controller class name

Returns

string
Path to controller

_loadDbConfig() public ¶

_loadDbConfig( )

Loads database file and constructs DATABASE_CONFIG class makes $this->DbConfig available to subclasses

Returns

boolean

_loadModels() public ¶

_loadModels( )

if var $uses = true Loads AppModel file and constructs AppModel class makes $this->AppModel available to subclasses if var $uses is an array of models will load those models

Returns

boolean

_modelKey() public ¶

_modelKey( string $name )

Creates the proper underscored model key for associations

Parameters

string $name: Model class name

Returns

string
Singular model key

_modelName() public ¶

_modelName( string $name )

Creates the proper controller camelized name (singularized) for the specified name

Parameters

string $name: Name

Returns

string
Camelized and singularized controller name

_modelNameFromKey() public ¶

_modelNameFromKey( string $key )

Creates the proper model name from a foreign key

Parameters

string $key: Foreign key

Returns

string
Model name

_pluginPath() public ¶

_pluginPath( string $pluginName )

Find the correct path for a plugin. Scans $pluginPaths for the plugin you want.

Parameters

string $pluginName: Name of the plugin you want ie. DebugKit

Returns

string
$path path to the correct plugin.

_pluralHumanName() public ¶

_pluralHumanName( string $name )

Creates the plural human name used in views

Parameters

string $name: Controller name

Returns

string
Plural human name

_pluralName() public ¶

_pluralName( string $name )

Creates the plural name for views

Parameters

string $name: Name to use

Returns

string
Plural name for views

_singularHumanName() public ¶

_singularHumanName( string $name )

Creates the singular human name used in views

Parameters

string $name: Controller name

Returns

string
Singular human name

_singularName() public ¶

_singularName( string $name )

creates the singular name for use in views.

Parameters

string $name

Returns

string
$name

_welcome() public ¶

_welcome( )

Displays a header for the shell

createFile() public ¶

createFile( string $path , string $contents )

Creates a file at given path

Parameters

string $path: Where to put the file.
string $contents: Content to put in the file.

Returns

boolean
Success

err() public ¶

err( mixed $message = null , integer $newlines = 1 )

Outputs a single or multiple error messages to stderr. If no parameters are passed outputs just a newline.

Parameters

mixed $message optional null: A string or a an array of strings to output
integer $newlines optional 1: Number of newlines to append

error() public ¶

error( string $title , string $message = null )

Displays a formatted error message and exits the application with status code 1

Parameters

string $title: Title of the error
string $message optional null: An optional error message

hr() public ¶

hr( integer $newlines = 0 )

Outputs a series of minus characters to the standard output, acts as a visual separator.

Parameters

integer $newlines optional 0: Number of newlines to pre- and append

in() public ¶

in( string $prompt , mixed $options = null , string $default = null )

Prompts the user for input, and returns it.

Parameters

string $prompt: Prompt text.
mixed $options optional null: Array or string of options.
string $default optional null: Default input value.

Returns

Either
the default value, or the user-provided input.

initialize() public ¶

initialize( )

Initializes the Shell acts as constructor for subclasses allows configuration of tasks prior to shell execution

loadTasks() public ¶

loadTasks( )

Loads tasks defined in var $tasks

Returns

boolean

nl() public ¶

nl( integer $multiplier = 1 )

Returns a single or multiple linefeeds sequences.

Parameters

integer $multiplier optional 1: Number of times the linefeed sequence should be repeated

Returns

string

out() public ¶

out( mixed $message = null , integer $newlines = 1 )

Outputs a single or multiple messages to stdout. If no parameters are passed outputs just a newline.

Parameters

mixed $message optional null: A string or a an array of strings to output
integer $newlines optional 1: Number of newlines to append

Returns

integer
Returns the number of bytes returned from writing to stdout.

shortPath() public ¶

shortPath( string $file )

Makes absolute file path easier to read

Parameters

string $file: Absolute file path

Returns

sting
short path

Methods inherited from Object

Object() public ¶

Object( )

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns

Object

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters

string $name: Name of persisted class
string $type optional null: Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters

string $name: name of the class to persist
string $return: $object the object to persist
$object
$type optional null

Returns

boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters

string $name: name used for object to cache
object $object: the object to persist

Returns

boolean
true on save, throws error if file can not be created

_set() public ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Parameters

$status optional 0: http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters

string $method: Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array(): Message that is to be displayed by the error class

Returns

error
message

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array

Parameters

string $method: Name of the method to call
array $params optional array(): Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.

Parameters

string $msg: Log message
integer $type optional LOG_ERROR: Error type constant. Defined in app/config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Parameters

mixed $url: String or array-based url.
array $extra optional array(): if array includes the key "return" it sets the AutoRender to true.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toString() public ¶

toString( )

Object-to-string conversion. Each class can override this method as necessary.

Returns

string
The name of this class

Properties detail

`$_fixtures` ¶

public string

Internal list of fixtures that have been added so far.

array()

`$classTypes` ¶

public array

class types that methods can be generated for

array('Model', 'Controller', 'Component', 'Behavior', 'Helper')

`$path` ¶

public string

path to TESTS directory

TESTS

`$tasks` ¶

public array

Tasks used.

array('Template')

Classes

Functions

Class TestTask

Properties summary

Inherited Properties

Method Summary

__interactive() public

_addFixture() public

_processController() public

_processModel() public

bake() public

buildTestSubject() public

execute() public

generateConstructor() public

generateFixtureList() public

getClassName() public

getObjectType() public

getRealClassName() public

getTestableMethods() public

getUserFixtures() public

hasMockClass() public

help() public

isLoadableClass() public

testCaseFileName() public

typeCanDetectFixtures() public

Method Detail

__interactive() public ¶

_addFixture() public ¶

Parameters

_processController() public ¶

Parameters

_processModel() public ¶

Parameters

bake() public ¶

Parameters

buildTestSubject() public ¶

Parameters

Returns

execute() public ¶

generateConstructor() public ¶

Parameters

Returns

generateFixtureList() public ¶

Parameters

Returns

getClassName() public ¶

Parameters

Returns

getObjectType() public ¶

Returns

getRealClassName() public ¶

Parameters

Returns

getTestableMethods() public ¶

Parameters

Returns

getUserFixtures() public ¶

Returns

hasMockClass() public ¶

Parameters

Returns

help() public ¶

Overrides

isLoadableClass() public ¶

Parameters

Returns

testCaseFileName() public ¶

Parameters

Returns

typeCanDetectFixtures() public ¶

Parameters

Returns

Methods inherited from BakeTask

getPath() public ¶

Returns

startup() public ¶

Overrides

Methods inherited from Shell

__construct() public ¶

Overrides