|
TestBox 2.4.0 | ||||
FRAMES |
railo-context.Componenttestbox.system.TestBox
public class TestBox
Copyright Since 2005 TestBox Framework by Luis Majano and Ortus Solutions, Corp 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.
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 | |
---|---|
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 |
string |
getBundles()
|
string |
getCodename()
|
string |
getLabels()
|
string |
getOptions()
|
string |
getReporter()
|
string |
getResult()
|
private any |
getSpecPaths(any directory)
Get an array of spec paths from a directory |
string |
getUtility()
|
string |
getVersion()
|
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]'], [any callbacks='[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]'], [any callbacks='[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 |
sendStatusHeaders(any results)
Send some status headers |
any |
setBundles(any bundles)
|
any |
setCodename(any codename)
|
any |
setLabels(any labels)
|
any |
setOptions(any options)
|
any |
setReporter(any reporter)
|
any |
setResult(any result)
|
any |
setUtility(any utility)
|
any |
setVersion(any version)
|
private any |
testBundle(any bundlePath, any testResults, any callbacks)
PRIVATE ************************************************************ // /** This method executes the tests in a bundle CFC according to type |
Methods inherited from class railo-context.Component |
---|
|
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 testbox.system.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.Method Detail |
---|
private any buildReporter(any reporter)
reporter
- The reporter type to build.private any getBundle(any bundlePath)
bundlePath
- The path to the Bundle CFCpublic string getBundles()
public string getCodename()
public string getLabels()
public string getOptions()
public string getReporter()
public string getResult()
private 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 ]public string getUtility()
public string getVersion()
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]'], [any callbacks='[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 testbox.system.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!callbacks
- A struct of listener callbacks or a CFC with callbacks for listening to progress of the testing: onBundleStart,onBundleEnd,onSuiteStart,onSuiteEnd,onSpecStart,onSpecEndpublic TestResult runRaw([any bundles], [any directory], [any labels], [struct options], [any testBundles='[runtime expression]'], [any testSuites='[runtime expression]'], [any testSpecs='[runtime expression]'], [any callbacks='[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!callbacks
- A struct of listener callbacks or a CFC with callbacks for listening to progress of the testing: onBundleStart,onBundleEnd,onSuiteStart,onSuiteEnd,onSpecStart,onSpecEndremote 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 sendStatusHeaders(any results)
results
public any setBundles(any bundles)
bundles
public any setCodename(any codename)
codename
public any setLabels(any labels)
labels
public any setOptions(any options)
options
public any setReporter(any reporter)
reporter
public any setResult(any result)
result
public any setUtility(any utility)
utility
public any setVersion(any version)
version
private any testBundle(any bundlePath, any testResults, any callbacks)
bundlePath
- The path of the Bundle CFC to test.testResults
- The testing results object to keep track of resultscallbacks
- The callbacks struct or CFC
|
TestBox 2.4.0 | ||||
FRAMES |