|
ColdBox Platform v3.8.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.testing.TestBox
public class TestBox
******************************************************************************* Copyright 2005-2009 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Welcome to the next generation of BDD and xUnit testing for CFML applications The TestBox core class allows you to execute all kinds of test bundles, directories and more.
Property Summary | ||||
---|---|---|---|---|
Type | Property & Description | Default | Serializable | Required |
any
|
bundles
Attributes: |
|
true
|
false
|
any
|
codename
Attributes: |
|
true
|
false
|
any
|
labels
Attributes: |
|
true
|
false
|
any
|
options
Attributes: |
|
true
|
false
|
any
|
reporter
Attributes: |
|
true
|
false
|
any
|
utility
Attributes: |
|
true
|
false
|
any
|
version
Attributes: |
|
true
|
false
|
Constructor Summary | |
---|---|
init([any bundles='[runtime expression]'], [any directory='[runtime expression]'], [any reporter='simple'], [any labels='[runtime expression]'], [struct options='[runtime expression]'])
Constructor |
Method Summary | |
---|---|
any |
GETBUNDLES()
|
any |
GETCODENAME()
|
any |
GETLABELS()
|
any |
GETOPTIONS()
|
any |
GETREPORTER()
|
any |
GETUTILITY()
|
any |
GETVERSION()
|
TestBox |
SETBUNDLES(any bundles)
|
TestBox |
SETCODENAME(any codename)
|
TestBox |
SETLABELS(any labels)
|
TestBox |
SETOPTIONS(any options)
|
TestBox |
SETREPORTER(any reporter)
|
TestBox |
SETUTILITY(any utility)
|
TestBox |
SETVERSION(any version)
|
private any |
buildReporter(any reporter)
Build a reporter according to passed in reporter type or class path |
private any |
getBundle(any bundlePath)
Creates and returns a bundle CFC with spec capabilities if not inherited |
private any |
getSpecPaths(any directory)
Get an array of spec paths from a directory |
private any |
inflateBundles(any bundles)
Inflate incoming bundles from a simple string as a standard array |
private any |
inflateLabels(any labels)
Inflate incoming labels from a simple string as a standard array |
private any |
produceReport(any results)
Build a report according to this runner's setup reporter, which can be anything |
any |
run([any bundles], [any directory], [any reporter], [any labels], [struct options], [any testBundles='[runtime expression]'], [any testSuites='[runtime expression]'], [any testSpecs='[runtime expression]'])
Run me some testing goodness, this can use the constructed object variables or the ones you can send right here |
TestResult |
runRaw([any bundles], [any directory], [any labels], [struct options], [any testBundles='[runtime expression]'], [any testSuites='[runtime expression]'], [any testSpecs='[runtime expression]'])
Run me some testing goodness but give you back the raw TestResults object instead of a report |
remote any |
runRemote([string bundles], [string directory], [boolean recurse='true'], [string reporter='simple'], [string reporterOptions='{}'], [string labels=''], [string options], [string testBundles=''], [string testSuites=''], [string testSpecs=''])
Run me some testing goodness, remotely via SOAP, Flex, REST, URL |
private any |
testBundle(any bundlePath, any testResults)
************************************** PRIVATE ************************************************************ // /** This method executes the tests in a bundle CFC according to type |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init([any bundles='[runtime expression]'], [any directory='[runtime expression]'], [any reporter='simple'], [any labels='[runtime expression]'], [struct options='[runtime expression]'])
bundles
- The path, list of paths or array of paths of the spec bundle CFCs to run and testdirectory
- The directory to test which can be a simple mapping path or a struct with the following options: [ mapping = the path to the directory using dot notation (myapp.testing.specs), recurse = boolean, filter = closure that receives the path of the CFC found, it must return true to process or false to continue process ]reporter
- The type of reporter to use for the results, by default is uses our 'simple' report. You can pass in a core reporter string type or an instance of a coldbox.system.testing.reports.IReporterlabels
- The list or array of labels that a suite or spec must have in order to execute.options
- A structure of configuration options that are optionally used to configure a runner.Property Detail |
---|
any bundles
default
- serializable
- truerequired
- falseany codename
default
- serializable
- truerequired
- falseany labels
default
- serializable
- truerequired
- falseany options
default
- serializable
- truerequired
- falseany reporter
default
- serializable
- truerequired
- falseany utility
default
- serializable
- truerequired
- falseany version
default
- serializable
- truerequired
- falseMethod Detail |
---|
public any GETBUNDLES()
public any GETCODENAME()
public any GETLABELS()
public any GETOPTIONS()
public any GETREPORTER()
public any GETUTILITY()
public any GETVERSION()
public TestBox SETBUNDLES(any bundles)
bundles
public TestBox SETCODENAME(any codename)
codename
public TestBox SETLABELS(any labels)
labels
public TestBox SETOPTIONS(any options)
options
public TestBox SETREPORTER(any reporter)
reporter
public TestBox SETUTILITY(any utility)
utility
public TestBox SETVERSION(any version)
version
private any buildReporter(any reporter)
reporter
- The reporter type to build.private any getBundle(any bundlePath)
bundlePath
- The path to the Bundle CFCprivate any getSpecPaths(any directory)
directory
- The directory information struct to test: [ mapping = the path to the directory using dot notation (myapp.testing.specs), recurse = boolean, filter = closure that receives the path of the CFC found, it must return true to process or false to continue process ]private any inflateBundles(any bundles)
bundles
private any inflateLabels(any labels)
labels
private any produceReport(any results)
results
- The results object to use to produce a reportpublic any run([any bundles], [any directory], [any reporter], [any labels], [struct options], [any testBundles='[runtime expression]'], [any testSuites='[runtime expression]'], [any testSpecs='[runtime expression]'])
bundles
- The path, list of paths or array of paths of the spec bundle CFCs to run and testdirectory
- The directory to test which can be a simple mapping path or a struct with the following options: [ mapping = the path to the directory using dot notation (myapp.testing.specs), recurse = boolean, filter = closure that receives the path of the CFC found, it must return true to process or false to continue process ]reporter
- The type of reporter to use for the results, by default is uses our 'simple' report. You can pass in a core reporter string type or an instance of a coldbox.system.testing.reports.IReporter. You can also pass a struct if the reporter requires options: {type="", options={}}labels
- The list or array of labels that a suite or spec must have in order to execute.options
- A structure of configuration options that are optionally used to configure a runner.testBundles
- A list or array of bundle names that are the ones that will be executed ONLY!testSuites
- A list or array of suite names that are the ones that will be executed ONLY!testSpecs
- A list or array of test names that are the ones that will be executed ONLY!public TestResult runRaw([any bundles], [any directory], [any labels], [struct options], [any testBundles='[runtime expression]'], [any testSuites='[runtime expression]'], [any testSpecs='[runtime expression]'])
bundles
- The path, list of paths or array of paths of the spec bundle CFCs to run and testdirectory
- The directory to test which can be a simple mapping path or a struct with the following options: [ mapping = the path to the directory using dot notation (myapp.testing.specs), recurse = boolean, filter = closure that receives the path of the CFC found, it must return true to process or false to continue process ]labels
- The list or array of labels that a suite or spec must have in order to execute.options
- A structure of configuration options that are optionally used to configure a runner.testBundles
- A list or array of bundle names that are the ones that will be executed ONLY!testSuites
- A list or array of suite names that are the ones that will be executed ONLY!testSpecs
- A list or array of test names that are the ones that will be executed ONLY!remote any runRemote([string bundles], [string directory], [boolean recurse='true'], [string reporter='simple'], [string reporterOptions='{}'], [string labels=''], [string options], [string testBundles=''], [string testSuites=''], [string testSpecs=''])
bundles
- The path or list of paths of the spec bundle CFCs to run and testdirectory
- The directory mapping to test: directory = the path to the directory using dot notation (myapp.testing.specs)recurse
- Recurse the directory mapping or not, by default it doesreporter
- The type of reporter to use for the results, by default is uses our 'simple' report. You can pass in a core reporter string type or a class path to the reporter to use.reporterOptions
- A JSON struct literal of options to pass into the reporterlabels
- The list of labels that a suite or spec must have in order to execute.options
- A JSON struct literal of configuration options that are optionally used to configure a runner.testBundles
- A list or array of bundle names that are the ones that will be executed ONLY!testSuites
- A list of suite names that are the ones that will be executed ONLY!testSpecs
- A list of test names that are the ones that will be executed ONLY!private any testBundle(any bundlePath, any testResults)
bundlePath
- The path of the Bundle CFC to test.testResults
- The testing results object to keep track of results
|
ColdBox Platform v3.8.0 | ||||
FRAMES |