Begin Method

Description

You can mark arbitrary parts of script code as test cases. Such “test cases” will be included in the Summary report as a separate entry. You can also send the results of such “test cases” to an external test management system (for instance, Zephyr for Jira).

The aqTestCase.Begin method sets the starting point for the code fragment you want to mark as a test case.

To set the ending point, use the aqTestCase.End method.

Declaration

Applies To

The method is applied to the following object:

Parameters

The method has the following parameters:

Result Value

None.

Remarks

• The aqTestCase.Begin and aqTestCase.End methods do not allow creating nested test cases. The End method call must alway follow the Begin method call.

• If you call the aqTestCase.Begin method without calling an accompanying aqTestCase.End method, TestComplete will treat all the executed code (from the aqTestCase.Begin method call to the end of the run) as a single test case.

  However, in this case, TestComplete will not send test results to an external test management system (if it is specified by the aqTestCase.Begin method’s ExternalTestCase parameter).

• The aqTestCase.Begin and aqTestCase.End methods do not necessarily need to belong to the same routine. They can belong to different routines as long as the proper call order is kept: the routine that calls the aqTestCase.Begin method must run before the routine that calls the aqTestCase.End method.

• To make sure that the ending point is always set properly in your test cases, we recommend that you use the Begin and End methods along with handling exception statements.

  Example

  ExampleExample

  JavaScript, JScript

  Python

  VBScript

  DelphiScript

  C#Script

  JavaScript, JScript

  function Main()
  {
    …
    aqTestCase.Begin("My test case");
  
    try{
      …
    }
    catch (e)
    {
      …
    }
    finally{
      aqTestCase.End();
    …
    }
  
  }

  Python

  def Main():
    …
  
    aqTestCase.Begin("My test case")
    try
      …
    except Exception as e:
      …
    else
      …
    finally:
      aqTestCase.End()
    …
  

  VBScript

  Sub Main
  
    …
    aqTestCase.Begin "My test case"
  
    On Error Resume Next
      …
    If Err.Number <> 0 Then
      …
    End If
    aqTestCase.End
  
    …
  
  End Sub

  DelphiScript

  procedure Main();
  begin
    …
    aqTestCase.Begin('My test case');
    try
      begin
        …
      end;
    finally
      begin
        aqTestCase.End;
      end;
    end;
    …
  end;

  C#Script

  function Main()
  {
    …
    aqTestCase["Begin"]("My test case");
  
    try{
      …
    }
    catch (e)
    {
      …
    }
    finally{
      aqTestCase["End"]();
    }
  
    …
  }

• You can use the methods in data-driven tests to isolate individual iterations through a data source.

Example

The following sample code marks a part of the Main routine as the Create an order test:

def main():
  page = Aliases.browser.page 

  panel = page.Aspnetform.panel
  panel.Username.SetText("Tester")
  panel.Password.SetText("test")
  panel.submitbutton.Click()
  page.Wait()
  
  # Sets the beginning of the "Create an order" test
  aqTestCase.Begin("Create an order");
  try:
    page.Aspnetform.table.cell1.linkOrder.Click()
    page.Wait()

    cell = page.Aspnetform.table.cell.panelContent.tableorder.cell
    cell.selectProduct.ClickItem("ScreenSaver")
    #...
    cell.panel.linkProcess.Click()
  
    page.Wait()
    page.Aspnetform.table.cell1.linkViewAllOrders.Click()
    page.Wait()
  except Exception as e:
    #...
  finally:
    # Sets the end of the "Create order" test
    aqTestCase.End()
  
  table = page.Aspnetform.table.cell.panelContent.panel.table
  table.Cell(1, table.ColumnCount[1] - 1).ImageButton(0).Click()
  page.Wait()
  
  #...
  Aliases.browser.Close()

See Also

aqTestCase Object
End Method
Summary Report
Integration With Zephyr for Jira