MODULES Uize.Test.Class

SEARCH EXAMPLES SOURCE DEPS TEST

Contents

1. Introduction

The Uize.Test.Class module provides convenience methods for writing test cases against Uize.Class subclass modules.

DEVELOPERS: Ben Ilegbodu

1.1. Examples

There are no dedicated showcase example pages for the Uize.Test.Class module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Test.Class module...

1.2. Implementation Info

The Uize.Test.Class module defines the Uize.Test.Class class, which is a subclass of Uize.Test.

INHERITANCE CHAIN

Uize.Class −> Uize.Class.Test −> Uize.Test −> Uize.Test.Class

1.2.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

INSTANCE METHODS

setInstance

STATE PROPERTIES

instance | moduleToTest

STATIC METHODS

1.2.2. Features Overridden in This Module

The features listed in this section have been overridden in this module.

The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

valueOf

STATIC METHODS

Uize.Test.Class.requiredModulesTest

STATIC PROPERTIES

Uize.Test.Class.moduleName | Uize.Test.Class.nonInheritableStatics

1.2.3. Features Inherited From Other Modules

The features listed in this section have been inherited from other modules.

The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

STATE PROPERTIES

STATIC METHODS

STATIC PROPERTIES

Uize.Test.Class.pathToResources

1.2.4. Modules Directly Under This Namespace

Uize.Test.Class.mChildObjectBindings | Uize.Test.Class.mDeclarativeChildObjects | Uize.Test.Class.mModels | Uize.Test.Class.mSpy

1.2.5. Unit Tests

There is no dedicated unit tests module for the Uize.Test.Class module.

2. Static Methods

2.1. Uize.Test.Class.addTest

Inherited from Uize.Class.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class.Test`, first introduced in `Uize.Class.Test`)
	this static feature is inherited by subclasses

2.2. Uize.Test.Class.alphastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.3. Uize.Test.Class.declare

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.4. Uize.Test.Class.derivedPropertiesTest

SYNTAX

testCLASS = Uize.Test.Class.derivedPropertiesTest (
  derivedPropertiesTestsARRAYorOBJ
);

2.4.1. derivedPropertiesTestARRAYorOBJ

See Uize.Test.Class.derivedPropertyTest static method for the structure for each set of derived property tests.

EXAMPLE

Uize.Test.Class.derivedPropertiesTest (
  [
    {
      propertyName:'isEmpty',
      cases:[
      ]
    },
    {
      propertyName:'oneSelected',
      cases:[
      ]
    },
    {
      propertyName:'someSelected',
      cases:[
      ]
    }
  ]
);

NOTES

see the related Uize.Test.Class.derivedPropertyTest static method

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.5. Uize.Test.Class.derivedPropertyTest

SYNTAX

testCLASS = Uize.Test.Class.derivedPropertyTest (
  testParamsOBJ
);

2.5.1. testParamsOBJ

2.5.1.1. propertyName

2.5.1.2. cases

2.5.1.2.1. title

The title of the test case

2.5.1.2.2. instanceProperties

Properties to set on instance to cause derivation

2.5.1.2.3. expected

The expected derived value for the test case

2.5.1.2.4. expectFunc

A function (in lieu of the expected property) that takes the derived property value and a reference to the instance as parameters. It will return true if the derived property value is what is expected, false otherwise.

2.5.1.2.5. createParams

Optional parameters to pass to the create function (that override createParams for the testParamsObBJ).

2.5.1.3. instanceProperties

2.5.1.4. create

An alternative function for creating a model instance that would be different than just calling the constructor.

2.5.1.5. createParams

Optional parameters to pass to the create function.

2.5.1.6. testProperties

2.5.1.7. caseTestProperties

EXAMPLE

Uize.Test.Class.derivedPropertyTest (
  {
    propertyName:'isEmpty',
    cases:[
      {
        title:'No total items',
        instanceProperties:{totalItems:0},
        expected:true
      },
      {
        title:'1 total items',
        instanceProperties:{totalItems:1},
        expected:false
      },
      {
        title:'Many total items',
        instanceProperties:{totalItems:2},
        expectFunc:function(derivedPropertyValue, instance) {
          return this.expect(false, derivedPropertyValue);
        }
      }
    ]
  }
);

NOTES

see the related Uize.Test.Class.derivedPropertiesTest static method

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.6. Uize.Test.Class.doMy

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.7. Uize.Test.Class.dualContextMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.8. Uize.Test.Class.dualContextProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.9. Uize.Test.Class.fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.10. Uize.Test.Class.get

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.11. Uize.Test.Class.getInstance

Gets an instantiation of class defined by the moduleToTest state property.

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.12. Uize.Test.Class.getModule

Gets a reference to the class defined by the moduleToTest state property.

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.13. Uize.Test.Class.instanceMethodTest

SYNTAX

testCLASS = Uize.Test.Class.instanceMethodTest (
  paramsOBJ
);

2.13.1. paramsOBJ

2.13.1.1. methodName

2.13.1.2. cases

2.13.1.2.1. title

2.13.1.2.2. params

2.13.1.2.3. instanceProperties

2.13.1.2.4. expected

2.13.1.2.5. expectFunc

2.13.1.2.6. initialize

2.13.1.2.7. createParams

Optional parameters to pass to the create function (that override createParams for the testParamsObBJ).

2.13.1.3. instanceProperties

2.13.1.4. initialize

2.13.1.5. title

optional

2.13.1.6. create

An alternative function for creating a instance that would be different than just calling the constructor.

2.13.1.7. createParams

Optional parameters to pass to the create function.

2.13.1.8. testProperties

EXAMPLE

Uize.Test.Class.instanceMethodTest (
  {
    methodName:'getCurve',
    cases:[
      {
        params:['position'],
        expected:true
      }
    ]
  }
);

NOTES

see the related Uize.Test.Class.instanceMethodsTest static method

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.14. Uize.Test.Class.instanceMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.15. Uize.Test.Class.instanceMethodsTest

SYNTAX

testCLASS = Uize.Test.Class.instanceMethodsTest (
  instanceMethodsTestsARRAYorOBJ
);

2.15.1. instanceMethodsTestsARRAYorOBJ

See Uize.Test.Class.instanceMethodTest static method for the structure for each set of instance method tests.

EXAMPLE

Uize.Test.Class.instanceMethodsTest (
  [
    {
      methodName:'getCurve',
      cases:[
      ]
    },
    {
      methodName:'getDialogProperties',
      cases:[
      ]
    }
  ]
);

NOTES

see the related Uize.Test.Class.instanceMethodTest static method

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.16. Uize.Test.Class.instanceProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.17. Uize.Test.Class.isAsync

Inherited from Uize.Class.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class.Test`, first introduced in `Uize.Class.Test`)
	this static feature is inherited by subclasses

2.18. Uize.Test.Class.makeDeclarativeCasesPropertyTest

SYNTAX

testCLASS = Uize.Test.Class.makeDeclarativeCasesPropertyTest (
  testTitleSTR,
  testParamsOBJ
);

NOTES

see the related Uize.Test.Class.makeDeclarativeCasesTest and Uize.Test.Class.makeMultipleDeclarativeCasesTest static methods

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.19. Uize.Test.Class.makeDeclarativeCasesTest

SYNTAX

testCLASS = Uize.Test.Class.makeDeclarativeCasesTest (
  testTitleSTR,
  casesARRAY,
  testFUNC,
  testPropertiesOBJ,
  caseTestPropertiesOBJ
);

NOTES

see the related Uize.Test.Class.makeMultipleDeclarativeCasesTest static method

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.20. Uize.Test.Class.makeMultipleDeclarativeCasesTest

SYNTAX

testCLASS = Uize.Test.Class.makeMultipleDeclarativeCasesTest (
  testTitleSTR,
  makeTestFUNC,
  casesARRAY
);

NOTES

see the related and Uize.Test.Class.makeDeclarativeCasesPropertyTest Uize.Test.Class.makeDeclarativeCasesTest static methods

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.21. Uize.Test.Class.migratedStaticMethodsTest

Inherited from Uize.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Test`, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.22. Uize.Test.Class.migratedStaticPropertiesTest

Inherited from Uize.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Test`, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.23. Uize.Test.Class.mixins

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.24. Uize.Test.Class.moduleAliasTest

Inherited from Uize.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Test`, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.25. Uize.Test.Class.moduleToTest

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.26. Uize.Test.Class.omegastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.27. Uize.Test.Class.propertyConformerTest

SYNTAX

testCLASS = Uize.Test.Class.propertyConformerTest (
  testParamsOBJ
);

2.27.1. testParamsOBJ

2.27.1.1. propertyName

2.27.1.2. cases

2.27.1.2.1. title

The title of the test case

2.27.1.2.2. instanceProperties

Properties to set on instance to cause derivation

2.27.1.2.3. expected

The expected derived value for the test case

2.27.1.3. instanceProperties

2.27.1.4. testProperties

2.27.1.5. caseTestProperties

EXAMPLE

Uize.Test.Class.propertyConformerTest (
  {
    propertyName:'listName',
    cases:[
      {
        title:'Caps are lowercase',
        instanceProperties:{listName:'FOO'},
        expected:'foo'
      },
      {
        title:'Mixed case is lowercase',
        instanceProperties:{listName:'FoO'},
        expected:'foo'
      },
      {
        title:'Lower case is still lowercase',
        instanceProperties:{listName:'foo'},
        expected:'foo'
      ]
    ]
  }
);

NOTES

see the related Uize.Test.Class.propertyConformersTest static method

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.28. Uize.Test.Class.propertyConformersTest

SYNTAX

testCLASS = Uize.Test.Class.propertyConformersTest (
  propertyConformersTestARRAYorOBJ
);

2.28.1. propertyConformersTestARRAYorOBJ

See Uize.Test.Class.propertyConformerTest static method for the structure for each set of property conformer tests.

EXAMPLE

Uize.Test.Class.propertyConformersTest (
  [
    {
      propertyName:'listName',
      cases:[
      ]
    }
    ..
  ]
);

NOTES

see the related Uize.Test.Class.propertyConformerTest static method

IMPLEMENTATION INFO

	this feature was introduced in this module
	this static feature is inherited by subclasses

2.29. Uize.Test.Class.requiredModulesTest

IMPLEMENTATION INFO

	this is an override of an inherited feature (implementation is in this module, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.30. Uize.Test.Class.resolve

Inherited from Uize.Class.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class.Test`, first introduced in `Uize.Class.Test`)
	this static feature is inherited by subclasses

2.31. Uize.Test.Class.set

Inherited from Uize.Class.Test, but introduced in Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class.Test`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.32. Uize.Test.Class.singleton

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.33. Uize.Test.Class.splitHostAndProperty

Inherited from Uize.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Test`, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.34. Uize.Test.Class.stateProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.35. Uize.Test.Class.staticMethodTest

Inherited from Uize.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Test`, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.36. Uize.Test.Class.staticMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.37. Uize.Test.Class.staticMethodsTest

Inherited from Uize.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Test`, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.38. Uize.Test.Class.staticProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.39. Uize.Test.Class.staticPropertyTest

Inherited from Uize.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Test`, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.40. Uize.Test.Class.subclass

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.41. Uize.Test.Class.testModuleTest

Inherited from Uize.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Test`, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.42. Uize.Test.Class.testSuite

Inherited from Uize.Test.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Test`, first introduced in `Uize.Test`)
	this static feature is inherited by subclasses

2.43. Uize.Test.Class.toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.44. Uize.Test.Class.unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

2.45. Uize.Test.Class.wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

3. Instance Methods