testbox.system

Class TestBox

lucee.Component
    extended by testbox.system.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.

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    any bundles


    • access = public
    • returntype = any
    		 true false
    any codename


    • access = public
    • returntype = any
    		 true false
    any labels


    • access = public
    • returntype = any
    		 true false
    any options


    • access = public
    • returntype = any
    		 true false
    any reporter


    • access = public
    • returntype = any
    		 true false
    any result


    • access = public
    • returntype = any
    		 true false
    any utility


    • access = public
    • returntype = any
    		 true false
    any version


    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init([any bundles='[runtime expression]'], [any directory='[runtime expression]'], [any directories='[runtime expression]'], [any reporter='simple'], [any labels='[runtime expression]'], [struct options='[runtime expression]'])
          Constructor.
    Method Summary
    any addBundles(any bundles)
         Constructor.
    any addDirectories(any directories, [boolean recurse='true'])
         Constructor.
    any addDirectory(any directory, [boolean recurse='true'])
         Constructor.
    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.
    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 ************************************************************ //.
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init([any bundles='[runtime expression]'], [any directory='[runtime expression]'], [any directories='[runtime expression]'], [any reporter='simple'], [any labels='[runtime expression]'], [struct options='[runtime expression]'])

    Constructor

    Parameters:
    bundles - The path, list of paths or array of paths of the spec bundle CFCs to run and test
    directory - 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 ]
    directories - Same as @directory, but accepts an array or list
    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
    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.
    Property Detail

    bundles

    property any bundles

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    codename

    property any codename

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    labels

    property any labels

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    options

    property any options

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    reporter

    property any reporter

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    result

    property any result

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    utility

    property any utility

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    version

    property any version

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    addBundles

    public any addBundles(any bundles)

    Constructor

    Parameters:
    bundles

    addDirectories

    public any addDirectories(any directories, [boolean recurse='true'])

    Constructor

    Parameters:
    directories - A set of directories to test which can be a list of simple mapping paths or an array of structs 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 ]
    recurse

    addDirectory

    public any addDirectory(any directory, [boolean recurse='true'])

    Constructor

    Parameters:
    directory - A 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 ]
    recurse

    buildReporter

    private any buildReporter(any reporter)

    Build a reporter according to passed in reporter type or class path

    Parameters:
    reporter - The reporter type to build.

    getBundle

    private any getBundle(any bundlePath)

    Creates and returns a bundle CFC with spec capabilities if not inherited.

    Parameters:
    bundlePath - The path to the Bundle CFC

    getBundles

    public string getBundles()

    getCodename

    public string getCodename()

    getLabels

    public string getLabels()

    getOptions

    public string getOptions()

    getReporter

    public string getReporter()

    getResult

    public string getResult()

    getSpecPaths

    private any getSpecPaths(any directory)

    Get an array of spec paths from a directory

    Parameters:
    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 ]

    getUtility

    public string getUtility()

    getVersion

    public string getVersion()

    inflateBundles

    private any inflateBundles(any bundles)

    Inflate incoming bundles from a simple string as a standard array

    Parameters:
    bundles

    inflateLabels

    private any inflateLabels(any labels)

    Inflate incoming labels from a simple string as a standard array

    Parameters:
    labels

    produceReport

    private any produceReport(any results)

    Build a report according to this runner's setup reporter, which can be anything.

    Parameters:
    results - The results object to use to produce a report

    run

    public 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.

    Parameters:
    bundles - The path, list of paths or array of paths of the spec bundle CFCs to run and test
    directory - 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,onSpecEnd

    runRaw

    public 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

    Parameters:
    bundles - The path, list of paths or array of paths of the spec bundle CFCs to run and test
    directory - 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,onSpecEnd

    runRemote

    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

    Parameters:
    bundles - The path or list of paths of the spec bundle CFCs to run and test
    directory - 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 does
    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 a class path to the reporter to use.
    reporterOptions - A JSON struct literal of options to pass into the reporter
    labels - 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!

    sendStatusHeaders

    private any sendStatusHeaders(any results)

    Send some status headers

    Parameters:
    results

    setBundles

    public any setBundles(any bundles)

    Parameters:
    bundles

    setCodename

    public any setCodename(any codename)

    Parameters:
    codename

    setLabels

    public any setLabels(any labels)

    Parameters:
    labels

    setOptions

    public any setOptions(any options)

    Parameters:
    options

    setReporter

    public any setReporter(any reporter)

    Parameters:
    reporter

    setResult

    public any setResult(any result)

    Parameters:
    result

    setUtility

    public any setUtility(any utility)

    Parameters:
    utility

    setVersion

    public any setVersion(any version)

    Parameters:
    version

    testBundle

    private any testBundle(any bundlePath, any testResults, any callbacks)

    PRIVATE ************************************************************ // /** This method executes the tests in a bundle CFC according to type

    Parameters:
    bundlePath - The path of the Bundle CFC to test.
    testResults - The testing results object to keep track of results
    callbacks - The callbacks struct or CFC