config.script

Software Testing Automation Framework (STAF)的开发代码

OPTION J2=-d64
OPTION JVMName=MyJVM1
OPTION JVM=/opt/sunjdk1.4.0/jre/bin/java
OPTION MAXLOGS=2
OPTION MAXLOGSIZE=2048
:exmp.
:p.
If you wanted to run the STAX Java service in a JVM, called MyJVM1, with a maximum heap
size of 128M, and wanted the Event and EventManager Java services to run in a
different JVM, called MyJVM2, with a maximum heap size of 64M, you could specify
the following service registration lines in the STAF.cfg file (or dynamically
register the services in this order using the specified options).
:xmp.
SERVICE STAX  LIBRARY JSTAF  EXECUTE C:/STAF/service/STAX.jar \
              OPTION JVMName=MyJVM1 OPTION J2=-Xmx128m
SERVICE Event LIBRARY JSTAF  EXECUTE C:/STAF/service/STAFEvent.jar \
              OPTION JVMName=MyJVM2 OPTION J2=-Xmx64m
SERVICE EventManager LIBRARY JSTAF  EXECUTE C:/STAF/services/EventManager.jar \
              OPTION JVMName=MyJVM2
:exmp.
.*
.*---------------------------------------------------------------------
.*
:i1.ServiceLoader registration
:ih1.configuration
:i2.ServiceLoader registration
:ih1.registration
:i2.ServiceLoader registration
:h2 id=serviceloadercfcg.Service Loader Registration
:h3.Description
:p.Service loaders are registered with the SERVICELOADER configuration statement.
:h4.Syntax
:xmp.
SERVICELOADER LIBRARY <Implementation library> &lbrk.EXECUTE <Executable>&rbrk.
              &lbrk.OPTION <Name[=Value]>&rbrk.... &lbrk.PARMS <Parameters>&rbrk.
:exmp.

:p.:xph.LIBRARY:exph. is the name of the shared library / DLL
which implements the service loader or acts as a proxy for the service loader.  See the
information for each service loader to determine the appropriate value
for this option.
:p.:xph.EXECUTE:exph. is used by service proxy libraries / DLLs to specify what
the proxy library should execute.  For example, this might be the name of
the Java jar file which actually implements the service loader.  This
option has no significance for non-proxy service libraries.  See the Service Registration
section for information regarding the JSTAF service proxy library.
:p.:xph.OPTION:exph. specifes a configuration option that will be passed on
to the service loader library / DLL.  This is typically used by service proxy
libraries to further control the interface to the actual service loader
implementation.  You may specify multiple :xph.OPTION:exph.s for a given
service loader.  See the Service Registration section
for acceptable options for the JSTAF
service proxy library.  Otherwise, see the documentation provided with the
service (proxy) library.
:p.:xph.PARMS:exph. specifies optional parameters that will be passed to the
service loader during initialization.
:h4.Examples
:xmp.
SERVICELOADER LIBRARY STAFDSLS
SERVICELOADER LIBRARY JSTAF EXECUTE C:/STAF/services/CustomServiceLoader.jar
:exmp.
.*
.*---------------------------------------------------------------------
.*
:i1.Authenticator registration
:ih1.configuration
:i2.Authenticator registration
:ih1.registration
:i2.Authenticator registration
:h2.Authenticator Registration
:h3.Description
:p.Authenticator services are registered with the AUTHENTICATOR configuration statement.
The first Authenticator registered is the default, unless overridden by using the
:xph.DEFAULTAUTHENTICATOR:exph. operational parameter.
:h4.Syntax
:xmp.
AUTHENTICATOR <Name> LIBRARY <Implementation library> &lbrk.EXECUTE <Executable>&rbrk.
                     &lbrk.OPTION <Name[=Value]>&rbrk.... &lbrk.PARMS <Parameters>&rbrk.
:exmp.

:p.:xph.<Name>:exph. is the name by which this authenticator service will be
known on this machine.  The name cannot be "none" as this is reserved for use by STAF.
If you want to authenticate across systems, you must register the authenticator on
each system using the same name (case-insensitive).
:p.:xph.LIBRARY:exph. is the name of the shared library / DLL which implements
the authenticator service or acts as a proxy for the authenticator service.
See the information for each authenticator to determine the appropriate value
for this option.
:p.:xph.EXECUTE:exph. is used by service proxy libraries to specify what
the proxy library should execute.  For example, this might be the name of the
Java jar file which actually implements the authenticator service.
This option has no significance for non-proxy service libraries.  See the
Service Registration section for information regarding the JSTAF
service proxy library.
:p.:xph.OPTION:exph. specifes a configuration option that will be passed on
to the shared library / DLL.  This is typically used by service proxy
libraries to further control the interface to the actual service
implementation.  You may specify multiple :xph.OPTION:exph.s for a given
authenticator service.  See the Service Registration section for acceptable options
for the JSTAF service proxy library.  Otherwise, see the documentation
provided with the service (proxy) library.
:p.:xph.PARMS:exph. specifies optional parameters that will be passed to the
authenticator service during initialization.

:h4.Examples
:xmp.
AUTHENTICATOR MyAuth LIBRARY JSTAF EXECUTE C:/STAF/services/MyAuth.jar

AUTHENTICATOR AuthSample LIBRARY JSTAF \
              EXECUTE {STAF/Config/STAFRoot}\services\AuthSampleV300.jar \
              OPTION JVMName=Auth \
              PARMS "UserPropertiesFile {STAF/Config/STAFRoot}/services/authsample.properties"
:exmp.
.*---------------------------------------------------------------------
:ih1.registration
:i2.Authenticator registration
:h3 id=sampleAuth.Sample Authenticator
:p.A sample authenticator service is provided by STAF and is available
via the
.*b2h html <A HREF="http://staf.sourceforge.net/getcurrent.php">Download STAF</A> website.
It is called AuthSample and is available as a jar file called
AuthSampleV300.jar.

:h4.Registration Syntax
:p.To try out user trust, you can register the sample authenticator as
follows (assuming you downloaded it to a services directory created in the
STAF root directory).
:xmp.
AUTHENTICATOR AuthSample LIBRARY JSTAF \
              EXECUTE {STAF/Config/STAFRoot}\services\AuthSampleV300.jar \
              PARMS "USERPROPERTIESFILE {STAF/Config/STAFRoot}/services/authsample.properties"
:exmp.

:p.:xph.LIBRARY:exph. must be JSTAF for this sample authenticator
as it is implemented in Java.
:p.:xph.EXECUTE:exph. must be the fully-qualified name of the AuthSampleV300.jar
file.
:p.This sample authenticator has the following required parameter:
:ul.
:li.:xph.UserPropertiesFile:exph. specifies the fully-qualified name of
a file that contains the user identifers and passwords that this
authenticator supports.  The format of a user properties file must be
that of a Java Properties file.  A property file contains a set of strings.
Properties in a file are declared with the syntax name=value.  The
name specifies the user identifier and the value specifies its password.
:eul.
:p.To perform user authentication across systems, the authenticator
must be registered as the same name (case-insensitive) on all machines
where you want to use user trust authentication and with the same
user properties file (e.g. one that supports the same user identifiers
and passwords).

:h4.User Properties File
:p.An example of a user properties file is:
:xmp.
# User Properties File for the Sample Authenticator

User1=Password1
User2=Password2
User3=Password3
User4=Password4
User5=Password5
:exmp.
:p.You can specify any user identifiers and passwords that you want
in a user properties file.
However, do not specify any confidential information (e.g. any real
passwords that you want to protect) as this information is not
protected when sent over the network in STAF V3.0.0.
In STAF V3.1, a secure TCP interface will be provided.
.*
.*---------------------------------------------------------------------
.*
:i1.Operational parameters
:ih1.configuration
:i2.Operational parameters
:h2 id=opparms.Operational parameters
:h3.Description
:p.STAFProc allows you to set various parameters which affect the general
operation of STAF.  The SET configuration statement lets you set
these general operational parameters.
:h4.Syntax
:xmp.
SET &lbrk.CONNECTATTEMPTS <Number>&rbrk. &lbrk.CONNECTRETRYDELAY <Number>&rbrk.
.*  &lbrk.MAXFILES <Number>&rbrk.
    &lbrk.MAXQUEUESIZE <Number>&rbrk.
    &lbrk.INITIALTHREADS <Number>&rbrk. &lbrk.THREADGROWTHDELTA <Number>&rbrk.
    &lbrk.DATADIR <Directory Name>&rbrk.
    &lbrk.INTERFACECYCLING <Enabled | Disabled>&rbrk.
    &lbrk.DEFAULTINTERFACE <Name>&rbrk.
    &lbrk.DEFAULTAUTHENTICATOR <Name>&rbrk.
    &lbrk.ENABLEDIAGS&rbrk.
    &lbrk.STRICTFSCOPYTRUST&rbrk.
    &lbrk.RESULTCOMPATIBILITYMODE <Mode>&rbrk.
    &lbrk.DEFAULTSTOPUSING <Method>&rbrk.
    &lbrk.DEFAULTNEWCONSOLE | DEFAULTSAMECONSOLE&rbrk.
    &lbrk.DEFAULTFOCUS <Background | Foreground | Minimized>&rbrk.
    &lbrk.PROCESSAUTHMODE <Authentication Mode>&rbrk.
    &lbrk.DEFAULTAUTHUSERNAME&rbrk. &lbrk.DEFAULTAUTHPASSWORD&rbrk.
    &lbrk.DEFAULTAUTHDISABLEDACTION <Disabled Action>&rbrk.
    &lbrk.DEFAULTSHELL <Shell>&rbrk.
    &lbrk.DEFAULTNEWCONSOLESHELL <Shell>&rbrk. &lbrk.DEFAULTSAMECONSOLESHELL <Shell>&rbrk.
:exmp.
:p.:xph.CONNECTATTEMPTS:exph. specifies the maximum number of times to attempt
to connect to a remote system.  The default is 2.
Note that a trace warning message is generated for each failed attempt if the
Warning trace point is enabled.
You may also change this setting dynamically using the MISC service's SET command.
:p.:xph.CONNECTRETRYDELAY:exph. specifies the maximum time in milliseconds to
wait after a failed connection attempt to a remote system before trying to connect
again (if the maximum number of times to attempt to connect to a remote system has
not been reached yet).  The default is 1000 (i.e., 1 second).
You may also change this setting dynamically using the MISC service's SET command.
.*:p.:xph.MAXFILES:exph. specifies the maximum number of files STAFProc may have
.*open.  The default is 500.  
.*Note that this option only has effect on OS/2 systems.
.*Since STAF V3 is not supported on OS/2, this option has been deprecated.
:p.:xph.MAXQUEUESIZE:exph. specifies the maximum size of the queue associated
with each process' handle.  The default is 100.
You may also change this setting dynamically using the MISC service's SET command.
:p.:xph.INITIALTHREADS:exph. specifies the number of threads initially created
to handle service requests.  The default is 5.
:p.:xph.THREADGROWTHDELTA:exph. specifies the number of additional threads which
should be created when all existing threads are busy.  The default is 1.
:p.:xph.DATADIR:exph. specifies the directory that STAF and its services will
use to write data.  The default is :xph.{STAF/Config/STAFRoot}/data/{STAF/Config/InstanceName}:exph..
Note that this directory name must be unique per instance of
STAFProc running on a single machine.  Also, make sure to include the
"SET DATADIR" line in the STAF configuration file at the beginning of the
file, before any services are registered, since the data directory can be
used during service registration.
See :hdref refid=datadircfg. for more information about the 
STAF data directory and its contents.
:p.:xph.INTERFACECYCLING:exph. specifies whether to enable or disable automatic
interface cycling.  The default is to enable automatic interface cycling.
You may also change this setting dynamically using the MISC service's SET command.
Recognized values are the following:
:ul compact.
:li.:xph.ENABLED:exph. - Enables automatic interface cycling which means that
if you do not specify an interface in the endpoint when submitting a STAF
request, STAF will attempt to connect to the endpoint using all of the
interfaces (aka connection providers) that are configured (instead of just the
default interface).  STAF will first try to connect via the cached interface
(if one exists for this endpoint).  If this endpoint is not cached, STAF will
first attempt to connect via the default interface.  If the connect attempt
fails, STAF will start attempting to connect using other configured interfaces
until one works or there are no more interfaces left to try.  If a connect
attempt succeeds, STAF will cache the interface that worked for this endpoint
so that the next STAF request that specifies this endpoint will try to connect
first using the cached interface.
:p.Note that automatic interface cycling only has an effect if there are
multiple interfaces configured in the STAF configuration file on the
machine that is submitting a STAF request.
Also, note that the MISC service provides a LIST ENDPOINTCACHE request to
show the cached endpoints and a PURGE ENDPOINTCACHE request to purge one
or more cached endpoints.
:p.
:li.:xph.DISABLED:exph. - Disables automatic interface cycling which means that
if you do not specify an interface in the endpoint when submitting a STAF request,
STAF will only try to connect to the endpoint using the default interface.
:eul.
:p.:xph.DEFAULTINTERFACE:exph. specifies the name of the network interface
(aka connection provider) to use, by default.  If not specified, the first
interface registered is the default.
You may also change this setting dynamically using the MISC service's SET command.
:p.:xph.DEFAULTAUTHENTICATOR:exph. specifies the name of the Authenticator to 
use, by default.  If not specified, the first Authenticator registered is the
default.  If no authenticators are registered, the default authenticator is
:xph.none:exph..
You may also change this setting dynamically using the MISC service's SET command.
:p.:xph.ENABLEDIAGS:exph. specifies to enable diagnostics.  The default is
to disable diagnostics.
You may also enable (or disable) recording diagnostics dynamically
using the DIAG service.
:p.:xph.STRICTFSCOPYTRUST:exph. specifies to enable strict trust checking
when copying a file or directory using the FS service.  The default is
to disable strict trust checking (e.g. do lenient trust checking) on a FS
COPY request when the machine submitting the request is the same as the
machine where which the file/directory is being copied.
That is, :xph.STRICTFSCOPYTRUST:exph. specifies that a trust check should be done to
verify that MachineA trusts MachineB when MachineA submits a COPY request to the
FS service on MachineB to copy a file or directory back to MachineA.
The default is to do lenient trust checking so that MachineA does not have
to trust MachineB since why would MachineA ask MachineB to copy the file/directory
if he didn't want the copy to work.
You may also change this setting dynamically using the FS service's SET command.
:p.:xph.RESULTCOMPATIBILITYMODE:exph. specifies the compatibility mode used
when sending the result from a STAF service request back to a pre-STAF V3 system.
Recognized values are the following:
:ul compact.
:li.:xph.VERBOSE:exph. - 
When structured data (see :hdref refid=marshall.) is returned in
the result buffer string, this option indicates to automatically unmarshall
the data and provide it in a "verbose format" which is easy to read.
This "verbose format" is equivalent to the output provided when using the
STAF executable's -verbose option (see :hdref refid=stafexecmd.).
This is the default mode.
:li.:xph.NONE:exph. - This indicates that no changes to the result buffer string will
be made.  Note that marshalled data is not as easy to read.
:eul.
You may also change this setting dynamically using the MISC service's SET command.
:p.:xph.DEFAULTSTOPUSING:exph. allows you to specify the default method used
to STOP processes.  See :hdref refid=psstop. for more information on available
methods.
You may also change this setting dynamically using the PROCESS service's SET command.
:p.:xph.DEFAULTNEWCONSOLE:exph. specifies that processes should be STARTed in a
new console window.  This is the default for Windows systems.
.*and OS/2.
This option has no effect on Unix systems.
You may also change this setting dynamically using the PROCESS service's SET command.
:p.:xph.DEFAULTSAMECONSOLE:exph. specifies that processes should be STARTed in
the same console as STAFProc.  This is the default on Unix systems.
.*This option has no effect on OS/2.
You may also change this setting dynamically using the PROCESS service's SET command.
:p.:xph.DEFAULTFOCUS:exph. specifies the focus that is to be given to new windows
opened when starting a process on a Windows system. The default focus mode is Background.
This option only has effect on Windows systems.  &varres.
See :hdref refid=procstr. for more information on the :xph.FOCUS:exph. option.
You may also change this setting dynamically using the PROCESS service's SET command.
:p.:xph.PROCESSAUTHMODE:exph. specifies the mode by which usernames/passwords
are authenticated when starting processes.  The value of this option is platform
specific.  Recognized values are the following:
:ul compact.
:li.:xph.DISABLED:exph. - This indicates that the user may not specify a username/password
with which to authenticate when starting a process.  This mode is available on