From OpenTTCN DocZone
Home | Developer's corner | Knowledge base | Working documents | Documentation | Tutorials | Training | How do I | Frequently asked questions | Technical support |
Command-line tools quick reference (2.56.0)
Contents |
ot
Usage: ot COMMAND
COMMAND:
start starts OpenTTCN server in the background
stop stops OpenTTCN server
status [@all] prints status information
version prints version information
activate [file] activates installed license key
help prints this message
help activate prints help about activation
help more prints detailed help and more commands
OPENTTCN COMMAND LINE TOOLS SUMMARY:
importer3 processes TTCN-3 and optionally ASN.1 source modules
importer2 processes TTCN-2 source modules
session manages testing sessions and prints session status
tester runs selected test cases and test campaigns
ADVANCED COMMAND SYNTAX:
add daemon DAEMON adds daemon to the allowed list
remove daemon DAEMON removes daemon from the allowed list
add resource RES_ID RES_DESC adds resource descriptor
remove resource RES_ID removes resource descriptor
list resources lists existing resources
DAEMON:
assigned daemon identifier
RES_ID:
assigned resource identifier
RES_DESC:
resource descriptor that may define adapter startup instructions
Syntax (adapter startup): adapter:BINARY@DAEMON [PARAMETERS]
Example (adapter startup): adapter:SA_P1_impl.exe@MyDaemon1 L3 @session
importer3
Usage: importer3 COMMAND [OPTIONS] [PARAMETERS]
COMMAND AND PARAMETERS:
load SESSION FILES translates and puts modules to the session
analyze FILES performs syntax and semantic analysis
parameterize SESSION FILES parameterizes session with parameters
version prints version information
help prints this message
help more prints detailed help message
FILES:
FILE [FILE [...]]
File names may contain wildcards.
LOAD OPTIONS:
--generate-timestamp-files, -t generate timestamp files
--timestamps-output-dir, -s DIR put timestamp files to a directory
EXAMPLE:
importer3 load -t MySession MyFile1.ttcn MyFile2.ttcn
PARAMETERIZE OPTIONS:
--append, -a append module parameters defined in the parameter file
to the parameter repository overwriting existing
values if needed instead of reconstructing the parameter
repository from scratch
ADVANCED COMMAND SYNTAX:
delete SESSION DEFS-OR-MODULES deletes individual defs or modules
DEFS-OR-MODULES: DEF-OR-MODULE [DEF-OR-MODULE [...]]
DEF-OR-MODULE: MODULE_ID.DEF_ID | MODULE_ID
DETAILS:
The '--generate-timestamp-files' option can be used to create makefiles. If
this option is set, a timestamp file with default .tsf extension is created
for each source file that was successfully loaded into the repository. If the
file with such name already exists, it is overwritten. Base for the timestamp
filename is taken from the base part of the filename of the successfully
loaded source file. Unless otherwise specified, timestamp files are created
in the current directory even if file path for one or several source files
refers to some other directory.
The '--timestamps-output-dir' option has effect only if the '-t' option was
specified. It is ignored otherwise. It specifies timestamp files output
directory relative to the current one. The output directory shall not end
with a terminating slash or backslash character.
The 'delete' command deletes the list of individual definitions or modules
specified on the command-line from the R2 repository. If a particular
definition or module is not found in R2, request to delete it is silently
ignored. SESSION defines session in which erased definitions are located.
Example: importer3 delete MySession MyModule1 MyModule2.MyConst1
importer2
Usage: importer2 COMMAND
COMMAND:
load SESSION FILE translates and puts suite to the session
analyze FILE performs syntax analysis
parameterize SESSION FILE parameterizes session with parameters
version prints version information
help prints this message
session
Usage: session COMMAND
COMMAND:
create SESSION creates a new session
delete SESSION deletes an existing session
status SESSION prints session status
list shows the list of existing sessions
version prints version information
help prints this message
help more prints detailed help and more commands
ADVANCED COMMAND SYNTAX:
register SESSION ADAPTER IOR registers adapter
unregister SESSION ADAPTER unregisters adapter
stop SESSION ADAPTER stops and unregisters running adapter
add binding SESSION PORT RES_ID associates TSI port with a resource
remove binding SESSION PORT removes resource binding for a TSI port
set_iut_version SESSION [VERSION] sets IUT version (used for logging)
set property SESSION NAME[=VALUE] sets or resets session property
REMARKS:
In 'set_iut_version' command, VERSION represents a string used to identify
IUT version. Omitting VERSION parameter or supplying an empty string in its
place will remove IUT version association if it existed for the specified
session. If IUT version is set for a particular session, it will appear in
the header of the standard execution log produced by a test run.
In 'set property' command, omitting the VALUE part of the name-value pair
means that the property binding is removed from the session altogether.
tester
Usage: tester COMMAND
COMMAND:
run [OPTIONS] SESSION CASES runs test campaign
terminate SESSION terminates running campaign
release SESSION deallocates campaign resources
initialize SESSION initializes campaign resources
evaluate SESSION CASES evaluates selection expression
prepare SESSION CASES performs run-time preparation
doc SESSION generates documentation
version prints version information
help prints this message
help more prints detailed help message
CASES:
@all | @runnable | @control | (TEST_CASE_NAME)+
OPTIONS:
--quiet, -q disable logging to a minimum
--indent, -i print indented messages
--suppress-value, -d suppress message value printout
--xml-log, -x FILE generate XML log file
--xml-log-stdout, -s print XML log to standard output
--log-encoded-as-text, -t log encoded messages in text format
--log-encoded-as-hex, -h log encoded messages in hex format
--log-enqueued-events, -e log events that arrived to the port queue
--log-mismatch-events, -m log mismatching communication statements
--smart-mismatch, -M log mismatch that preceded non-pass verdict
--log-redirect, -r redirect test component log to files
--log-redirect-path, -R DIR redirect log and put log files in DIR
--log-src-line-numbers, -l enable logging of source file line numbers
--log-src-file-name, -f enable logging of source file name
--no-init, -n suppress implicit initialization before run
--print-parameters, -p log values of module parameters before run
--maxtime, -a SECS limit test case execution maximum duration
--print-stack-trace, -b log stack trace for non-pass verdict
If '-q' ('--quiet') option is on, test components are instructed to emit an
absolute minimum of log events, what can be used to increase test system
performance. Only start and end of a test case, setverdict(inconc),
setverdict(fail), error situations and final verdicts are logged when this
option is enabled. User might want to rerun a failing test case with full
logging enabled to pinpoint precise location of an error.
The '-i' or '--indent' option instructs the log subsystem to output TTCN-3
messages in pretty-printed, i.e. indented format. By default, messages that
participate in communication instructions are printed in plain unindented
form. This option is ignored if the '-d' option is specified.
The '-d' or '--suppress-value' option disables printout of message value
in TTCN-3 abstract value notation form. This option does not affect '-t'
and '-h' options. By default, all messages are printed in abstract value
notation form.
The '-x' or '--xml-log' option instructs the log subsystem to output a test
campaign log in XML format to the specified FILE.
The '-s' or '--xml-log-stdout' option instructs the log subsystem to output
a test campaign log in XML format to the standard output. This option
automatically suppresses printout of the text-based log in the classic
format to the standard output.
The '-t' or '--log-encoded-as-text' option prints encoded TTCN-3 message
that participates in 'send' or 'receive' operation in textual form. The
encoded form of the message will be logged only if the encoder or decoder
has provided relevant encoding information to the test execution.
The '-h' or '--log-encoded-as-hex' option is similar to the '-t' option,
except that the encoded message is logged in hexadecimal form. This switch
can be combined with the '-t' option, in which case the encoded message
will be logged in both textual and hexadecimal form.
The '-e' or '--log-enqueued-events' option enables logging of communication
events that have arrived to the port queue but were not yet matched by the
relevant receiving operation. Event is logged at the time of its arrival to
the port queue of a test component. Trace log for such events looks almost
the same as for normal receiving operations like receive, getreply and so on
except that the /* ENQUEUED */ prefix will appear in front of the log line.
Note that the appearance of such entry in the log does not indicate that an
event was actually matched by some receiving operation. (TTCN-3 only)
The '-m' or '--log-mismatch-events' option enables logging of receiving
communication statements that have been evaluated for example as a part of
an alt statement but that did not match. Trace log for such events looks
almost the same as for normal receiving operations like receive, getreply
and so on except that the /* MISMATCH ... */ prefix will appear in front
of the log line. (TTCN-3 only)
If non-pass verdict is assigned, the '-M' or '--smart-mismatch' option
enables reporting of mismatch events that supposedly caused non-pass
verdict assignment. Reporting is performed for mismatch events that
were produced during most recent evaluation of the list of alternatives
of the alt construct that immediately contains the setverdict statement
in question, if any such alt construct exists. If verdict assignment
was performed in an altstep or default attached to alt construct, then
mismatch events produced during evaluation of alternatives in the calling
alt construct are also reported. Remember that standalone receiving
operations are subject to conceptual expansion into an alt construct
with the only one alternative and an empty statement block attached.
Note that mismatch events in question are buffered and reported only
after assignment of non-pass verdict was reported.
This option takes precedence over the -q option, i.e. mismatch events are
reported even if the latter option is enabled.
Combined with -q, this option gives you a concise means to report potential
reason of non-pass verdict without receiving too much trace log information.
This option is available in TTCN-3 only.
The '-r' or '--log-redirect' option redirects test component log output to
files. Files are named componentName.TC_testcase.log and placed in the
current working directory of tester. When using this option, the output
produced by tester is similar to the quiet (-q) option. If the test
component is running on a different computer, the log files will be saved
there. This option provides a means to increase performance if testing is
limited by log transmission speed but the log information is still
necessary. It can also be used to provide a concise output whilst saving all
the log information on disk for future reference.
The '-R' or '--log-redirect-path' option does the same as -r but allows
the path where the logfiles are to be saved to be specified as a parameter.
The path is relative to the test component working directory and computer, so
a absolute pathname should always be specified.
The '-l' or '--log-src-line-numbers' option enables logging of line numbers
of relevant statements as they appear in the source file. (TTCN-3 only)
The '-f' or '--log-src-file-name' option enables logging of source file name
that contains relevant logged statements. (TTCN-3 only)
The '-n' or '--no-init' option suppresses implicit initialization of campaign
resources before running a campaign. This may be useful to speedup the
preparation phase before the commencement of test case execution. This option
gives it's user more fine-grain control over the execution process, however
it also delegates more responsibility to the user. In particular, it becomes
the user's responsibility to issue 'tester initialize' command beforehand if
this option is used, and to make sure that the aforementioned command is
issued subsequently after a test suite, module parameter set etc. has changed.
The '-p' or '--print-parameters' option leads to a printout of a snapshot
of module parameter values effective before the commencement of a test
campaign run. Effective values of parameters are derived either from their
default specification in the relevant test suite, or from their
specification by the user. A particular module parameter may also be left
unspecified.
The SECS parameter of the '--maxtime' ('-a') option is a floating-point
value specifying maximum test case execution time in seconds. If execute()
statement of a TTCN-3 control part defines its own limit for a test case,
then this limit is overriden by the user setting defined using this option.
openttcnd
Usage: openttcnd COMMAND [OPTIONS]
COMMAND:
start starts OpenTTCN server in the foreground
version prints version information
help prints this message
OPTIONS:
--ior, -i IOR specify IOR for status notification callbacks
If '-i' or '--ior' option is specified, OpenTTCN server will treat the
specified IOR as a reference to the CORBA servant that is willing to
receive callback notifications about status changes during the OpenTTCN
server startup. This will allow the listening servant to have precise
and timely information about OpenTTCN server startup completion. Normally
'ot' or TCI-TM entity acts as this kind of CORBA servant transparently.
HINTS:
To start OpenTTCN server in the background, use 'ot start' instead.
odb
List of commands:
attach SESSION attach to session
a SESSION alias for attach
break FILE:LINE set breakpoint at line number in file
b FILE:LINE alias for break
delete [n] delete all breakpoints [or breakpoint n]
continue continue execution
c alias for continue
next next line, stepping over function calls
n alias for next
step next line, stepping into function calls
s alias for step
stepo step out of the current function call
so alias for stepo
backtrace [n] print trace of all stack frames; or of at most n
frames, innermost if n > 0, outermost if n < 0
bt [n] alias for backtrace
print [/i] expr show value of expr; indented if /i switch is on
p [/i] expr alias for print
frame n select frame number n
info threads print list of available test components
ts alias for info threads
thread n select test component number n
t n alias for thread
detach detach from the current session
quit exit odb
q alias for quit
help print list of commands
help more print more help
Notes:
Syntax of the 'expr' argument of the 'print' command is simplified. Only
identifiers of local or component variables or identifiers of formal
parameters are allowed. Only value variables are supported, meaning no
timer or port variables, component or default references. Arrays are
also supported.
Invocation of an altstep, either explicit or implicit e.g. through default
attachment and activation, is regarded as a function call.
Views
Personal tools
- Copyright © 2007-2008 OpenTTCN Ltd. All Rights Reserved