Executed before a test function of a test codeunit is run.

OnBeforeTestRun(CodeunitID : Integer;CodeunitName : Text[30];FunctionName : Text[128]) Ok : Boolean



Type: Integer

The ID of the codeunit to be run.


Type: Text

The name of the test codeunit to be run.


Type: Text

The name of the test function to be run.

This parameter is empty when the OnBeforeTestRun trigger is called for the entire test codeunit.

Return Value


Type: Boolean

true to run the test function; otherwise, false. This value is checked after each function call.

Applies To

Test runner codeunits. Test runner codeunits have the SubType Property (Codeunit) set to TestRunner.

This trigger is optional and not available on a test runner codeunit by default. To implement this trigger, you must manually add it as a function.


A test runner codeunit manages the execution of test codeunits that are run from its OnRun function. When a test codeunit runs, it executes each test function in the codeunit, one at a time. The OnBeforeTestRun trigger is called before the test codeunit, the OnRun function, and each test function.

The OnBeforeTestRun trigger is run in its own database transaction.

You can use the OnBeforeTestRun triggers to perform preprocessing, such as general initialization and logging, or to automate tests by integrating the test runner codeunit with a test management framework.

For more information, see Testing the Application and How to: Create a Test Runner Codeunit.


The following OnBeforeTestRun trigger code initializes a logging variable and returns true to indicate that the test function should execute. This example requires that you create the following global variable.

Name DataType



Copy Code

See Also