TestDriver command referenceTestDriver being a command-line tool, provides various command-line options to build, package, and run the Symbian OS tests. Using TestDriver involves setting the appropriate command-line options, which can be changed at any time.
A command in TestDriver is made of two components and a set of switches.
The first component is always the
The options are a list of <switch [parameters]>. A switch is in the
form of a hyphen followed by a letter or double hyphen followed by a word. For
example,
Note: A switch is case sensitive, for example,
Here is a quick reference to all commands and their options: Standard commandsThese standard commands are interpreted in the usual way.
Command referenceThis section is quick reference to all the commands and their options.
|
Option | Description | Value |
---|---|---|
|
Used to specify the target platform. This is mandatory. |
|
|
Used to specify the target variant. This is mandatory. |
|
|
Used to specify the address of the root task to run. See Setting entry point address field, for more details. |
|
|
Allows copying to SYS/BIN with STATLite.
The | |
|
Specifies whether STAT lite is used on the device to communicate with TestDriver. |
|
|
Specifies whether TEF lite is used. |
|
cancel
This command is used to cancel a remote job. The command-line syntax is:
> testdriver cancel
<options>
Option | Description | Value |
---|---|---|
|
Used to specify the job ID. | |
|
Used to specify the remote host/IP address and service name. This is optional. |
cleanremote
This command is used to clean up the server files. The syntax for using this command would be:
> testdriver cleanremote <options>
The following options are available when using the
cleanremote
command:
Option | Description | Value |
---|---|---|
|
Used to specify the job ID. | |
|
Used to specify the host or IP address and the name of remote server |
When the -j
(job ID) is specified, the result files are
deleted on the server and the job is removed from the list of jobs. If
-j
option is not specified, the server cleans up all the files on
the server including EPOCROOT
, REPOSITORYROOT
, the
stat/work directory, the results folders for all jobs and resets the job
number.
config
The command is used to configure the TestDriver, the command-line syntax is:
> testdriver config [<option>]
When used without options, the command prints the current TestDriver
settings which are stored in the TestDriver configuration file. The following
options can be set using the config
command:
Option | Description | Value |
---|---|---|
-b |
Used to specify the build target variant/build: |
|
|
Used if |
|
|
Used to specify if |
|
|
Used to specify the OS build number. | |
|
Used to specify the location to save results and logs (variable:
| |
-- |
Used by signsis tool to sign the TestDriver
| |
|
Used to clear the configuration backup. | |
|
Used to initialise CommsDat with WinTAP for the emulator. Use ON/OVERWRITE/OFF. Note: Currently ON option is not supported. |
|
|
Used to set the location of the EPOC drive (variable:
|
|
|
Used to export the configuration to a preference file. | |
|
Used to import the configuration from a preference file. | |
|
Used to set the SERVER: remote jobs directory. | |
-- |
Used by signsis tool to sign the TestDriver
| |
|
Used to specify the Platsec status. |
|
|
Used to set the SERVER: Port to perform ROM flashing with
| |
|
Used to configure the plug-ins. For example, the device restart and reflash plug-ins. For more details, refer to Configuring the plug-ins. | |
|
Used to enable/disable crash recovery. If ON, crash recovery is enabled. |
ON or OFF |
|
Used to set the location to save the repository for TestDriver
(variable: | |
|
Used to specify the address of the root task to run. See Setting entry point address field, for more details. |
OR
|
|
Used to set the remote server name. | |
|
Used to set the remote service name. | |
|
Used to set the location of the directory containing the source
files (variable: |
|
|
Specifies whether STAT lite is used on the device to communicate with TestDriver. |
|
|
Used to specify the transport protocol that is used to link with the device. |
|
|
Used to transfer the TestExecute Framework (TEF) dependencies. |
|
|
Specifies whether TEF lite is used. |
|
-- |
Used to specify the UID range to use with TestDriver (0xFIRST:0xLAST). Note: The UID values must be valid hexadecimal numbers. |
|
|
Used to set the location where TestDriver1 saved its XML files
(variable: |
|
You can build, set the entry point address, and so on, for the test you
want to run using the 'testdriver config
' command and directly run
the tests using 'testdriver run
' command. See
Setting entry point address field, for more details.
emulatorpackage
This command is used to package the emulator image to be sent to a remote PC. The command-line syntax is:
> testdriver emulatorpackage -tp tp
where, tp
is the absolute path of the test package.
The following option is available when using the
emulatorpackage
command:
Option | Description | Value |
---|---|---|
|
Used to specify the absolute path for the test package. |
|
Note: Currently this command is deprecated.
import
The import
command is used to import the XML files.
The command-line syntax is:
> testdriver import -x <options>
The following option is available when using the import
command:
Option | Description | Value |
---|---|---|
|
Used to set the location of the XML files (variable:
|
|
installpackage
This command is used to install a test package locally. The syntax for installing a test package is:
> testdriver installpackage -tp tpackagePath
Where, tpackagePath
is the absolute path to the test
package you want to install.
The following option is available when using the import
command:
Option | Description | Value |
---|---|---|
|
Used to specify the absolute path to the test package to be installed. |
|
jobstatus
This command is used to request the status of a remote job. The syntax to get the status is:
> testdriver jobstatus <options>
The following options are available when using the
jobstatus
command:
Option | Description | Value |
---|---|---|
|
Used to specify the job ID. | |
|
Used to specify the remote host name/IP address and the name of the remote service. |
masterstatus
This command is used to request the status of the TestDriver Master system when using TestDriver Remote. The command-line syntax is:
> testdriver masterstatus <options>
--srv
option is available while using the
masterstatus
command. Specify the IP address and the server name
of master TestDriver whose status has to be requested.
package
This command is used to build a test package.
> testdriver package [-s s] [-b b] [-tp tp] [-p
p]
The following options are available when using the package
command:
Option | Description | Value |
---|---|---|
|
Used to specify the target platform. This is mandatory. |
|
|
Used to specify the target variant. This is mandatory. |
|
|
Used to specify the address of the task to be built. See Setting entry point address field for more details. |
|
|
Used to specify the absolute path of the test package to be built. |
|
If --tp
is not defined, a package with the name of the
test is generated in the repository.
print
This command is used to print the information related to a test on the screen.
The command-line syntax for printing is:
> testdriver print -s s
where, s
is the address of the root task to run, for
example, root.testdataset.sampletask
. The option -s
displays the contents of the test on the screen.
rbuild
The rbuild
command creates a TestDriver repository from a
pre-built EPOC tree.
The command-line syntax is:
> testdriver rbuild <options>
The following options are available when using the rbuild
command:
Option | Description | Value |
---|---|---|
|
Used to specify the target platform. This is mandatory. |
|
|
Used to specify the target variant. This is mandatory. |
|
|
Used to specify the Platsec status. |
|
|
Used to specify the address of the root task to run. See Setting entry point address field for more details. |
|
|
Allows copying to SYS/BIN with STATLite.
The | |
|
Specifies whether STAT lite is used on the device to communicate with TestDriver. |
|
|
Specifies whether TEF lite is used. |
|
resultpath
This command is returns the last result location.. The syntax for obtaining the result location is:
> testdriver resultpath <options>
results
This command is used to display results from a remote job. The syntax for displaying the results is:
> testdriver results <options>
The following options are available while using the
results
command:
Option | Description | Value |
---|---|---|
|
Used to specify the job ID. | |
|
Used to specify the address and the name of remote server | |
|
Used to specify the path to pick the test results. |
run
Used to run a driver file. The command-line syntax for running is:
> testdriver run <options>
The following options are available when using the run
command:
Option | Description | Value |
---|---|---|
|
Used to specify the target platform. This is mandatory. |
|
|
Used to specify the build type. This is mandatory. |
|
|
Used to specify the location from where results can be picked. | |
|
Used to specify the address of the root task to run. See Setting entry point address field for more details. |
OR
|
|
Used to specify the Platsec status. |
|
|
Used to specify the transport protocol that is used to link with the device. |
|
|
Used to specify the location to save |
|
|
Used to specify the OS build number. | |
|
Used to specify the UCC IP port to which the feedback is sent. | |
|
Used to specify the Kernel EKA1/EKA2. |
EKA1, EKA2 |
|
Used to enable/disable crash recovery. If ON, crash recovery is enabled. |
|
|
Allows copying to SYS/BIN with STATLite.
The | |
|
Specifies whether STAT lite is used on the device to communicate with TestDriver. |
|
|
Specifies whether TEF lite is used. |
|
runremote
This command is used to run a test package remotely. The command-line syntax to run the package is:
> testdriver runremote [-I I] [--sysbin sysbin] [-m m] [-r r]
[-t t] [-l l] [--tp tp] [--testexec testexec] [--platsec platsec] [--srv srv]
[--cl cl]
When you specify the options --testexec
,
--sysbin
and -l
, they are added to the package
manifest. The server reads this manifest and sets its configuration before
running the test specified in the manifest of this package. These options does
not have any effect on the local configuration.
Option | Description | Value |
---|---|---|
|
Used to specify the mode of receiving the results. |
|
|
Used to specify the ROM image. | |
|
Used to specify the unique name for registering the client with
the server in | |
|
Used to specify the working directory, this is mandatory. | |
|
Used to specify the transport protocol that is used to link with the device. | |
|
Used to specify the location where the
|
|
|
Used to transfer the Test Execute Framework (TEF) dependencies to the package. |
|
|
Used to specify the test package. |
|
|
Used to specify the host name or the IP address of the remote PC and the name of the remote service. |
|
|
Used to copy to SYS/BIN with STATLite.
The | |
|
Used to specify if the PlatSec is ON or OFF. |
ON, OFF |
|
Specifies whether STAT lite is used on the device to communicate with TestDriver. |
|
|
Specifies whether TEF lite is used. |
|
Note: All commands save the last used options. For example,
run testdriver build -p armv5
. To use the same options the next
time, just type testdriver build
.