Stop Tests on Hosts When an Error Occurs on One of Them

By default, the master project receives information about errors that occurred in other projects only after the distributed test stops. To change this behavior:

1. Create a network variable and use it as a marker that notifies about an error. The projects that took part in the distributed test share network suite variables. When you change a network suite variable in one of the projects, the others will get notification about this and can handle this situation in the desired manner.

2. In projects that will run on remote computers, create an OnLogError event handler that will change the value of the variable when errors occur.

3. In the master project, create an OnNetVarChange event handler that will stop the distributed tests when the network variable is changed.

Below, you can find detailed descriptions of how to configure the projects.

1. Open the Variables page of the Network Suite and create a network variable. We will use this variable as an error semaphore for all the projects that participate in distributed testing:

   

   This variable will be available for all participating projects when the distributed testing starts, so you do not have to create it in each project.

2. Create an event handler for the OnNetVarChange event. For more information on how to do this, see Creating Event Handlers for TestComplete Events. This event occurs every time when a network variable changes.

3. In the event handler, create test commands that verify what variable was changed and perform the desired actions. To determine the variable that was changed, use the event handler’s VarName parameter (it specifies the name of the changed variable).

   • If you use scripts

     Insert the following code into the event handling routine:

     Show Code

     Show CodeHide Code

     In this example, IsError is the variable that we use to determine that an error occurs during the test on the host.

     JavaScript

     JScript

     Python

     VBScript

     DelphiScript

     C++Script, C#Script

     JavaScript

     function GeneralEvents_OnNetVarChange(Sender, VarName, OldValue, NewValue)
     {
       if (equal(VarName, "IsError"))
       {
         Runner.Stop(true);
       }
     }

     JScript

     function GeneralEvents_OnNetVarChange(Sender, VarName, OldValue, NewValue)
     {
       if (VarName == "IsError")
       {
         Runner.Stop(true);
       }
     }

     Python

     def GeneralEvents_OnNetVarChange(Sender, VarName, OldValue, NewValue):
       if VarName == "IsError":
         Runner.Stop(True)

     VBScript

     Sub GeneralEvents_OnNetVarChange(Sender, VarName, OldValue, NewValue)
       If (VarName = "IsError") Then
         Runner.Stop(True)
       End If
     End Sub

     DelphiScript

     procedure GeneralEvents_OnNetVarChange(Sender; VarName; OldValue; NewValue);
     begin
       if (VarName = 'IsError') then
       begin
         Runner.Stop(true);
       end;
     end;

     C++Script, C#Script

     function GeneralEvents_OnNetVarChange(Sender, VarName, OldValue, NewValue)
     {
       if (VarName == "IsError")
       {
         Runner["Stop"](true);
       }
     }

     Specify true as the parameter for the Stop method, if you want to stop only the current test item. Otherwise, it stops the entire test run.

   • If you use keyword tests

     Show Instructions

     Show InstructionsHide Instructions

     • Add the If... Then operation to the event handling keyword test.

     • Specify the VarName test parameter for Value1:

       

     • Select Equals from the Condition drop-down list.

     • Specify the IsError string constant for Value2.

       Note:

       In this case, IsError is the name of a variable that is used to determine that an error occurs during the test on the host.

       

     • Add the Stop Execution operation as a child of the If... Then operation.

       

     • In the Stop Execution properties, enable the Stop current test only property, to stop only current test item.

       

       To avoid recursive calling, make sure that the Error Message property is empty.

4. Open the Execution Plan editor of your master project and specify the desired jobs as separate test items. In this case, TestComplete will continue test run with the next job if the current fails.

   Note: You can also specify Network Suite as a test item. In this case, TestComplete runs jobs that are specified in the Jobs project collection. However, if an error occurs, it will stop the Network Suite test item. It means that the subsequent jobs will not be run.

5. Set the On error property of the master project’s test items to customize the further behavior of the test engine. To learn more about it, see About Controlling Test Execution Flow.

1. In projects that will run on remote computers, create a handler for the OnLogError event. See Creating Event Handlers for TestComplete Events. The OnLogError event occurs every time TestComplete posts an error message to the test log. Use this handler to catch the moment when an error occurs.

2. Configure the event handler to change the network variable:

   • If you use scripts

     Insert the following code into the event handling routine:

     Show Code

     Show CodeHide Code

     In this example, EventError is the variable that is used to determine that an error occurs during the test on the host.

     JavaScript, JScript

     VBScript

     DelphiScript

     C++Script, C#Script

     JavaScript, JScript

     function GeneralEvents_OnLogError(Sender, LogParams)
     {
       NetworkSuite.Variables.IsError = true;
     }

     VBScript

     Sub GeneralEvents_OnLogError(Sender, LogParams)
       NetworkSuite.Variables.IsError = True
     End Sub

     DelphiScript

     procedure GeneralEvents_OnLogError(Sender; LogParams);
     begin
       NetworkSuite.Variables.IsError := true;
     end;

     C++Script, C#Script

     function GeneralEvents_OnLogError(Sender, LogParams)
     {
       NetworkSuite["Variables"]["IsError"] = true;
     }

   • If you use keyword tests

     Show Instructions

     Show InstructionsHide Instructions

     1. Add the Run Code Snippet operation to the event handler keyword test.

     2. Specify the following code:

        NetworkSuite.Variables.IsError = true
        

     You can use the Set Variable Value operation to change the network variable. However, in this case you need to create the network variable in the project first.