5.
Relationship between TET_SUITE_ROOT and TET_TSROOT
The TETware
tcc
provides support for the
TET_SUITE_ROOT
environment variable and the
TET_TSROOT
distributed configuration variable.
The
TET_SUITE_ROOT
functionality is derived from ETET, whereas the
TET_TSROOT
functionality is derived from dTET2.
Both these variables are used by
tcc
to locate the
test suite root
directory, but the meanings of the variables are not the same.
In summary,
TET_TSROOT
refers to the test suite root directory itself, whereas
TET_SUITE_ROOT
refers to some path prefix of the test suite root directory (usually the
parent directory).
Soon after
tcc
starts up it determines the location of the test suite root directory.
Normally,
tcc
locates the test suite root directory below the
tet root
directory.
However, you can use the
TET_SUITE_ROOT
environment variable to instruct
tcc
to look for the test suite root directory below a different location.
TET_SUITE_ROOT
is also one of the communication variables.
tcc
puts this variable in the environment when it executes a test case or
tool.
If you don't specify a
TET_SUITE_ROOT
environment variable,
tcc
supplies one with a default value which is the same as the value of the
TET_ROOT
environment variable.
In Distributed TETware,
TET_SUITE_ROOT
is only used on the local system.
The location of the test suite root directory on each remote system is
specified explicitly by a
TET_REM_ nnn_TET_TSROOT
distributed configuration variable in the
tetdist.cfg
file.
Since the
TET_SUITE_ROOT
feature is derived from ETET, remote and distributed test cases don't
normally access this environment variable.
So, by default,
tcc
puts an empty
TET_SUITE_ROOT
variable in the environment when it executes a test case or tool on a
remote system.
However, in order to enable ETET test cases that expect to read
TET_SUITE_ROOT
from the environment to be processed on remote systems, it is possible
to specify a value for
TET_REM_ nnn_TET_SUITE_ROOT
in the distributed configuration file.
When this is done,
tcc
assigns the specified value to the
TET_SUITE_ROOT
environment variable
before processing the test case or tool on the remote system.
Note that the
TET_REM_ nnn_TET_SUITE_ROOT
distributed configuration variable is only supported in order to provide
backwards compatibility for ETET test cases on remote systems.
It is not used by
tcc
itself since the location of the test suite root directory on a remote
system must always be specified by the
TET_REM_ nnn_TET_TSROOT
distributed configuration variable.
See also
-
"Directory structure'', "Communication variables''
and "Distributed configuration variables used by Distributed TETware''
in the TETware Programmers Guide.
-
"Environment variables'' in the TETware User Guide.
-
The
tcc
manual page in the TETware User Guide.
|