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

By default, the master project receives information about errors that occurred in slave projects only after the distributed test stops. To change this behavior, 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. To detect the changes of network suite variables, use the OnNetVarChange event. The entire procedure includes the following steps:

• Create a network variable that will be shared between all distributed tests.

• In the slave project, create an OnLogError event handler that will change the value of the variable when errors occur.

• 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 master and slave projects.

To prepare the master project, follow these steps:

1. Open the project properties and select Playback on the list on the left of the page. Disable the Stop on error and Error dialog options. Otherwise, TestComplete stops the entire test run right after the first error or exception occurs.

   

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

   

   Note:

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

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

4. 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, do the following:

     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.

5. Open the Test Items page of the Project Editor 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:

   Also, you can specify NetworkSuite as a test item. In this case, TestComplete runs jobs that are specified in the Jobs Editor. However, if an error occurs, it will stop the NetworkSuite test item. It means that the subsequent jobs will not be run.

6. Change the Stop on Error properties of the project suite’s and project’s test items to customize the further behavior of the test engine. To learn more about it, see Stopping Tests on Errors and Exceptions - Overview.

Follow these steps:

1. Create an event 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. This handler allows you to catch the moment when an error occurs.

2. In the event handler, create the test commands that will 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

     Python

     VBScript

     DelphiScript

     C++Script, C#Script

     JavaScript, JScript

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

     Python

     def GeneralEvents_OnNetVarChange(Sender, VarName, OldValue, NewValue):
       if VarName == "IsError":
         Runner.Stop(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, do the following:

     Show Instructions

     Show InstructionsHide Instructions

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

     • Specify the following code:

       NetworkSuite.Variables.IsError = true
       

     Note:

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