class %UnitTest.TestCase
extends %RegisteredObject
Extend this class to create new test case classes. In the test case class, for each test that you want to run, create a method whose name begins with Test. You'll use %UnitTest.Manager.RunTest to run all tests in a specified directory.
TestCase provides $$$Assert* macros that can be used to test conditions (located in the file %outUnitTest.INC). The $$$Assert* macros call their associated methods automatically. A test fails if one or more of the macros fails, otherwise the test passes.
Click a method to go to the description of its macro:
AssertTrueViaMacro
AssertNotTrueViaMacro
AssertEqualsViaMacro
AssertNotEqualsViaMacro
AssertStatusOKViaMacro
AssertStatusNotOKViaMacro
AssertFilesSameViaMacro
AssertSkippedViaMacro
Use the OnBefore* methods to perform tasks before all test cases or before each test case.
Use the OnAfter* methods to perform tasks after all test cases or after each test case.
You might use OnBefore* and OnAfter* to, for example, set environment
variables before tests and unset them after tests or load files before tests and delete
files after tests.
Click a method to go to the description:
OnBeforeAllTests
OnBeforeOneTest
OnAfterAllTests
OnAfterOneTest
Note: In your test class, do not use property names that begin with Test, as the auto-generated Get and Set methods corresponding to the properties would also begin with Test, and, thus, be treated as test methods.
• property Debug
as %Boolean [ InitialExpression = 0 ];
Use the /debug flag with %UnitTest.Manager.RunTest to break into debug mode on the first failure.
• property SkipTest
as %Boolean [ InitialExpression = 0 ];
The SkipTest property gets set when a test is being skipped. It will be handled by the %UnitTest.Manager to handle
skipping tests from OnBeforeOneTest. NOTE: OnBeforeAllTests does not currently support skipping tests.
• method %OnNew(initvalue)
as %Status
Run by the %New method to provide notification that a new instance of an object
is being created. Passes initialization information to a new instance of the object.
If this method returns an error then the object is not created.
It is passed the arguments provided in the %New call. There may be up to
ten of these arguments, p1...p10.
• method AssertEqualsViaMacro(autoquoted, value1, value2, description)
as %Boolean
Returns true if two values are equal. Invoke with the $$$AssertEquals macro, in the form
$$$AssertEquals(value1,value2,"description")
where:
- value1,value2
- Values to be compared.
- description
- Optional comment shown on the results page. If you don't include a description, the expression is used by default.
Example:
do $$$AssertEquals(x,y,"x equals y")
• method AssertFilesSameViaMacro(autoquoted, file1, file2, description)
as %Boolean
Returns true if two files are identical. Invoke with the $$$AssertFilesSame macro in the form.
$$$AssertFilesSame(file1,file2,"description")
where:
- file1,file2
- Files to compare. If no directory path is specified, the current UnitTest directory is used.
- description
- Optional comment shown on the results page. If you don't include a description, the expression is used by default.
Example:
do $$$AssertFilesSame(output.log,reference.log,"Comparing output.log to reference.log")
• method AssertNotEqualsViaMacro(autoquoted, value1, value2, description)
as %Boolean
Returns true if expressions are not equal. Invoke with the $$$AssertNotEquals macro in the form.
$$$AssertNotEquals(value1,value2,"description")
where:
- value1,value2
- Values to be compared.
- description
- Optional comment shown on the results page. If you don't include a description, the expression is used by default.
Example:
do $$$AssertNotEquals(x,y,"x is not equal to y")
• method AssertNotTrueViaMacro(autoquoted, value, description)
as %Boolean
Returns true if the expression is not true. Invoke with the $$$AssertNotTrue macro in the form.
$$$AssertNotTrue(value, "description")
where:
- value
- Expression to be evaluated.
- description
- Optional comment shown on the results page. If you don't include a description, the expression is used by default.
Example:
do $$$AssertNotTrue(x=y,"Expression x=y is not true")
• method AssertSkippedViaMacro(message)
as %Boolean
An assertion to state that the test has been skipped for the reason described in the assertion's message
This would typically be used if the preconditions for the test have not been met.
After calling this assertion, you would typically would want to quit from the test method.
• method AssertStatusEqualsViaMacro(autoquoted, value1, value2, description)
as %Boolean
Returns true if two statuses are equal. Invoke with the $$$AssertStatusEquals macro in the form.
$$$AssertStatusEquals(value1,value2,"description")
where:
- value1,value2
- Expressions that return status codes.
- description
- Optional comment shown on the results page. If you don't include a description, the expression is used by default.
Example: This is extremely useful to verify an expected failure.
s x=##class(Sample.Person).%New()
s sc=x.%Save()
s sc2=$system.Status.Error(5659,"Name")
d $$$AssertStatusEquals(sc,sc2,"Verify Name property requirement at %Save")
• method AssertStatusNotOKViaMacro(autoquoted, status, description)
as %Boolean
Returns true if the status code is not a successful status code. Invoke with the $$$AssertStatusNotOK macro in the form.
$$$AssertStatusNotOK(value, "description")
where:
- value
- Expression that returns a status code.
- description
- Optional comment shown on the results page. If you don't include a description, the expression is used by default.
Example:
set sc=##class(%Integer).IsValid("$")
do $$$AssertStatusNotOK(sc,"Status is NotOK")
• method AssertStatusOKViaMacro(autoquoted, status, description)
as %Boolean
Returns true if the status code is $$$OK. Invoke with the $$$AssertStatusOK macro in the form.
$$$AssertStatusOK(value, "description")
where:
- value
- Expression that returns a status code.
- description
- Optional comment shown on the results page. If you don't include a description, the expression is used by default.
Example:
set sc=##class(%Integer).IsValid("5")
do $$$AssertStatusOK(sc,"Status is OK")
• method AssertTrueViaMacro(autoquoted, value, description)
as %Boolean
Returns true if expression is true. Invoke with the $$$AssertTrue macro in the form.
$$$AssertTrue(value, "description")
where:
- value
- Expression to be evaluated.
- description
- Optional comment shown on the results page. If you don't include a description, the expression is used by default.
Example:
do $$$AssertTrue(x=y,"Expression x=y is true")
• method LogMessage(message)
Enter a message in quotes, such as "Start of test". Message is entered in the log (^UnitTest.Result) when a test is run.
• method OnAfterAllTests()
as %Status
Run by RunTest once after all test methods in the test class are run. Can be used to tear down a test environment that was set up by OnBeforeAllTests See example in OnBeforeAllTests.
• method OnAfterOneTest(testname As %String)
as %Status
Run by RunTest immediately after each test method in the test class is run.
- testname
- Name of the test to be run. Required.
• method OnBeforeAllTests()
as %Status
Run by RunTest once before any test methods in the test class are run. Can be used to set up a
test environment that will be later cleaned up by OnAfterAllTests.
Example: Setup and Cleanup of an environment:
Method OnBeforeAllTests() As %Status
{
//do setup stuff here
set ^inputMessage = "input message"
quit $$$OK
}
Method OnAfterAllTests() As %Status
{
//do clean up stuff here
kill ^inputMessage
quit $$$OK
}
• method OnBeforeOneTest(testname As %String)
as %Status
Run by RunTest immediately before each test method in the test class is run.
- testname
- Name of the test to be run. Required.
