TestComplete Command Line

In general, the TestComplete command line is as follows:

Here the parenthesis mean the group of command-line arguments. The “|” means OR, for example, “/r | /run” means you can use either /r OR /run. Square brackets mean the argument or group of arguments is optional.

Note that TestComplete has two executables for 32-bit and 64-bit:

• The TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

• The TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

file_name

Launches TestComplete and loads the specified project (.mds file) or project suite (.pjs) into it.

/run (or /r)

/ExportLog:file_name (or /el:file_name)

/ExportLogToXMLAlso

/ExportSummary:file_name (or /es:file_name)

/ErrorLog:file_name

/exit (or /e)

/SilentMode

If this argument is specified, TestComplete works in Silent mode, that is, it neither displays dialogs, nor informs you about errors or warnings. The dialogs and messages to be displayed are handled as if you pressed the default button in them. Information about these dialogs and messages is posted to Silent.log file to the <System_Drive>:\Documents and Settings\<UserName>\Application Data\SmartBear\TestComplete\14.0 folder on Windows XP and Windows Server 2003 and to the <System_Drive>:\Users\<UserName>\AppData\Roaming\SmartBear\TestComplete\14.0 folder on Windows Vista, Windows 7, Windows Server 2008 and later operating systems (the file must not be read-only or locked by another application). The errors that occur during the test execution are posted to the test log.

If TestComplete is running in Silent mode, it does not press the default button in the window asking if the user wants to convert the project created in earlier TestComplete versions to the new format. This was done to prevent users from accidental project conversion. To force TestComplete to convert such a project automatically, use the /ForceConversion command-line argument. If TestComplete running in Silent mode is integrated into a source control system, it tries to enable the batch mode for the source control system. This mode allows working with the source control system without displaying dialogs and messages invoked by the source control system provider. If the source control system does not support the batch mode, TestComplete disables source control integration support. For more information, see Working With Source Control Systems in Silent Mode.

/ForceConversion

/Timeout:time_in_seconds

/ns

Opens TestComplete without displaying the splash screen.

/agpatcheroff

Disables Silverlight auto-patching.

/UsageStatistics:File_name (or /US:File_name)

Commands TestComplete to collect statistics on usage of Name Mapping items during test runs. TestComplete will save the gathered data to the specified file. You can then use this data in the Name Mapping editor and remove unused mapping items. See Find and Remove Unused Mapping Items for details.

If the file name includes spaces, enclose it in quotes:

/install:extension_name (or /ip:extension_name)

/uninstall:extension_name (or /up:extension_name)

/EnableModule:module_set

/RestServerPort:port

The port used by the TestComplete RESTful service that is provided by the REST API plugin. The default port is 2377. Make sure this port is allowed through your firewall or antivirus.

/DisableExternalReporting

Disables how to send test results to external test management systems (for instance, Zephyr for Jira).

• Running TestComplete from the command line is, probably, the easiest way to launch it from third-party tools. This approach is used rather frequently for running TestComplete from continuous integration (CI) systems and custom test frameworks. Note that TestComplete requires an interactive user session for simulating user actions. So, if your CI system or test framework runs TestComplete on a remote machine (typically called an agent or node), this CI system or framework should create an interactive user session for the TestComplete run on that agent (node). For information on how to do this, see the CI system documentation.

• You can determine what parameters were passed to TestComplete in its command line by using the ParamStr function. It allows you to get a TestComplete command-line argument specified by its index. To get the total number of arguments in the command line, use the ParamCount function.

  The following code demonstrates how you can determine command-line arguments:

  JavaScript, JScript

  Python

  VBScript

  DelphiScript

  C++Script, C#Script

  JavaScript, JScript

  function CommandLineArgs()
  {
    var i;
    var nArgs = BuiltIn.ParamCount();
    Log.Message("Total number of command-line arguments: " + nArgs);
    Log.Message("The fully-qualified name of the TestComplete executable: " + BuiltIn.ParamStr(0));
  
    for (i = 1; i <= nArgs ; i++)
      Log.Message("Arg " + i + ": " + BuiltIn.ParamStr(i));
  }

  Python

  def CommandLineArgs():
    nArgs = BuiltIn.ParamCount()
    Log.Message("Total number of command-line arguments: " + str(nArgs))
    Log.Message("The fully-qualified name of the TestComplete executable: " + BuiltIn.ParamStr(0))
  
    for i in range (1, nArgs+1):
      Log.Message("Arg " + str(i) + ": " + BuiltIn.ParamStr(i))

  VBScript

  Sub CommandLineArgs
    Dim nArgs, i
  
    nArgs = BuiltIn.ParamCount
    Log.Message "Total number of command-line arguments: " & nArgs
    Log.Message "The fully-qualified name of the TestComplete executable: " & BuiltIn.ParamStr(0)
  
    For i = 1 To nArgs
      Log.Message "Arg " & i & ": " & BuiltIn.ParamStr(i)
    Next
  End Sub

  DelphiScript

  procedure CommandLineArgs;
  var nArgs, i;
  begin
    nArgs := BuiltIn.ParamCount;
    Log.Message('Total number of command-line arguments: ' + VarToStr(nArgs));
    Log.Message('The fully-qualified name of the TestComplete executable: ' + BuiltIn.ParamStr(0));
  
    for i := 1 to nArgs do
      Log.Message('Arg ' + VarToStr(i) + ': ' + BuiltIn.ParamStr(i));
  end;

  C++Script, C#Script

  function CommandLineArgs()
  {
    var nArgs = BuiltIn["ParamCount"]();
    Log["Message"]("Total number of command-line arguments: " + nArgs);
    Log["Message"]("The fully-qualified name of the TestComplete executable: " + BuiltIn["ParamStr"](0));
  
    for (var i = 1; i <= nArgs ; i++)
      Log["Message"]("Arg " + i + ": " + BuiltIn["ParamStr"](i));
  }

• It is not recommended to launch TestComplete using the runas command, since this significantly slows down the test execution.

Below are several examples of running TestComplete via the command line.

• The following command runs TestComplete, loads the specified project suite (MySuite.pjs), and commands TestComplete to execute test items of the MyProj project:

  TestComplete.exe "C:\My Projects\MySuite.pjs" /r /p:MyProj

• The following command runs TestComplete, loads the specified project suite (MySuite.pjs), and commands TestComplete to execute all projects that are enabled. TestComplete waits until the run is over, and then gets closed.

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /e

• The following command runs TestComplete, loads the specified project suite (MySuite.pjs), and commands TestComplete to run the ProjectTestItem3 test item of the MyProj project:

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /p:MyProj /t:"ProjectTestItem1|ProjectTestItem2|ProjectTestItem3"

• The following command runs TestComplete, loads the specified project suite (MySuite.pjs), and commands TestComplete to run the tests associated with the NetworkSuite project item of the MyTest project:

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /p:MyTest /pi:NetworkSuite

• The following command runs TestComplete, loads the specified project suite (MySuite.pjs), and commands TestComplete to execute the Test1 keyword test of the MyProj project:

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /p:MyProj /t:"KeywordTests|Test1"

• The following command runs TestComplete, loads the specified project suite (MySuite.pjs), and commands TestComplete to run the Main script routine located in the Unit1 unit of the MyProj project:

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /p:MyProj /u:Unit1 /rt:Main

  -- or --

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /p:MyProj /t:"Script|Unit1|Main"

• The following command runs TestComplete, loads the MySuite.pjs project suite, and commands TestComplete to run the Task1 task of the network suite’s Job1 job in the MyProj project:

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /p:MyProj /t:"NetworkSuite|Jobs|Job1|Task1"

• The following command runs TestComplete, loads the MySuite.pjs project suite, and commands TestComplete to run the Job1 job in the MyProj project’s network suite:

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /p:MyProj /t:"NetworkSuite|Jobs|Job1|Job1"

  The name of the Jobs collection is the same as the job’s name (Job1).

• The following command runs TestComplete, loads the MySuite.pjs project suite, and commands TestComplete to run all the enabled tests assigned to all the enabled CrossBrowserTesting environments in the project suite:

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /cbt

• The following command runs TestComplete, loads the MySuite.pjs project suite, commands TestComplete to execute the test items of the MyProj project and to send their test results to the Regression test cycle of the 2.1 version of the Jira project bound to the MyProj project:

  TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /r /p:MyProj /ZephyrVersion:2.1 /ZephyrCycle:Regression

Note:

TestComplete waits until the specified project suite, project, test, and so on is executed in all the examples above. However, the command line is ready to receive new commands right after TestComplete has been launched.

If you want the command line to wait until the test (project and so on) execution is over, you can use the START command as shown in the example below:

start "My Title" /wait TestComplete.exe "C:\Work\My Projects\MySuite.pjs" /run /exit /SilentMode

Pay attention to the string after the START command in the example above. It is the title of the command-line window and it is needed for the command to work correctly.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.

TestComplete 32-bit executable is located in the <TestComplete>\Bin folder.

TestComplete 64-bit executable is located in the <TestComplete>\x64\Bin folder.