cmdref.script

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

.***************************************************************************
.* Software Testing Automation Framework (STAF)
.* (C) Copyright IBM Corp. 2001
.*
.* This software is licensed under the Common Public License (CPL) V1.0. 
.****************************************************************************

.*************************-START-OF-PROLOG-****************************
.*
.*  File Name          : CMDRef SCRIPT
.*  Descriptive Name   : Software Test Automation Framework Command Reference
.*  Detail:
.*
.*     This file describes the STAF Command Reference
.*
.**************************-END-OF-PROLOG-*****************************
:i1.command reference
:i1.service command reference
:h1 id=cmdref.Service Command Reference
:table id     = cmdtab
       headhi = 3
       frame  = box
       split  = yes
       cols   = '* 4*'
       align  = 'l l'.
:tcap.STAF Service Command Reference
.*-----------------------------
:thd.
:c.Command
:c.Syntax
:ethd.
.*-----------------------------
:row.
:c.:hp2.DELAY:ehp2.
:c.Delay (or sleep) a number of milliseconds.
:p.
:xmp.
DELAY <Milliseconds>

HELP
:exmp.
.*-----------------------------
:row.
:c.:hp2.DIAG:ehp2.
:c.Allows diagnostics to be recorded, listed, enabled, disabled, and reset.
:p.
:xmp.
RECORD TRIGGER <Trigger> SOURCE <Source>

LIST   < &lbrk.TRIGGER <Trigger> | SOURCE <Source> | TRIGGERS | SOURCES&rbrk.
         &lbrk.SORTBYCOUNT | SORTBYTRIGGER | SORTBYSOURCE&rbrk. > |
       SETTINGS

RESET  FORCE

ENABLE

DISABLE

HELP
:exmp.
.*-----------------------------
:row.
:c.:hp2.ECHO:ehp2.
:c.Echo a return string from other STAF clients.
:p.
:xmp.
ECHO <Message>

HELP
:exmp.
.*-----------------------------
:row.
:c.:hp2.FS:ehp2.
:c.Allows you to manipulate files and directories.
:p.
:xmp.
COPY   FILE <Name> &lbrk.TOFILE <Name> | TODIRECTORY <Name>&rbrk.  &lbrk.TOMACHINE <Machine>&rbrk.
       &lbrk.TEXT &lbrk.FORMAT <Format>&rbrk.&rbrk.  &lbrk.FAILIFEXISTS | FAILIFNEW&rbrk.

COPY   DIRECTORY <Name> &lbrk.TODIRECTORY <Name>&rbrk.  &lbrk.TOMACHINE <Machine>&rbrk.
       &lbrk.NAME <Pattern>&rbrk.  &lbrk.EXT <Pattern>&rbrk. &lbrk.CASESENSITIVE | CASEINSENSITIVE&rbrk.
       &lbrk.TEXTEXT <Pattern>... &lbrk.FORMAT <Format>&rbrk.&rbrk.
       &lbrk.RECURSE &lbrk.KEEPEMPTYDIRECTORIES | ONLYDIRECTORIES&rbrk.&rbrk.
       &lbrk.IGNOREERRORS&rbrk. &lbrk.FAILIFEXISTS | FAILIFNEW&rbrk.

GET    FILE <Name> &lbrk.&lbrk.TEXT | BINARY&rbrk. &lbrk.FORMAT <Format>&rbrk.&rbrk.

GET    ENTRY <Name> <TYPE | SIZE | MODTIME>

QUERY  ENTRY <Name>

CREATE DIRECTORY <Name> &lbrk.FULLPATH&rbrk. &lbrk.FAILIFEXISTS&rbrk.

LIST   DIRECTORY <Name> &lbrk.NAME <Pattern>&rbrk. &lbrk.EXT <Pattern>&rbrk. &lbrk.TYPE <Types>&rbrk.
       &lbrk.SORTBYNAME | SORTBYSIZE | SORTBYMODTIME&rbrk.
       &lbrk.CASESENSITIVE | CASEINSENSITIVE&rbrk. &lbrk.LONG &lbrk.DETAILS&rbrk.&rbrk. &lbrk.RECURSE&rbrk.

LIST   COPYREQUESTS &lbrk.LONG&rbrk. &lbrk.INBOUND&rbrk. &lbrk.OUTBOUND&rbrk.
       &lbrk.FILE &lbrk.&lbrk.BINARY&rbrk. &lbrk.TEXT&rbrk.&rbrk.&rbrk. &lbrk.DIRECTORY&rbrk.

LIST   SETTINGS

DELETE ENTRY <Name> &lbrk.CHILDREN &lbrk.NAME <Pattern>&rbrk. &lbrk.EXT <Pattern>&rbrk. &lbrk.TYPE <Types>&rbrk.
       &lbrk.CASESENSITIVE | CASEINSENSITIVE&rbrk.&rbrk. &lbrk.RECURSE&rbrk. &lbrk.IGNOREERRORS&rbrk. CONFIRM

SET    STRICTFSCOPYTRUST <Enabled | Disabled>

HELP
:exmp.
.*-----------------------------
:row.
:c.:hp2.HANDLE:ehp2.
:c.Allows you to query information on various process handles and to manage static handles.
:p.
:xmp.
CREATE HANDLE NAME <Handle Name>

DELETE HANDLE <Number>

QUERY HANDLE <Handle>

LIST &lbrk.HANDLES &lbrk.NAME <Handle Name>&rbrk. &lbrk.PENDING&rbrk.  &lbrk.REGISTERED&rbrk.  &lbrk.INPROCESS&rbrk.  &lbrk.STATIC&rbrk.&rbrk.

LIST NOTIFICATIONS &lbrk.HANDLE <Handle> | MACHINE <Machine>&rbrk

AUTHENTICATE USER <User Identifier> CREDENTIALS <Credentials>
             &lbrk.AUTHENTICATOR <Authenticator Name>&rbrk.

UNAUTHENTICATE

HELP
:exmp.
.*-----------------------------
:row.
:c.:hp2.HELP:ehp2.
:c.List and query STAF return codes.  Allows services to register their own
return codes.
:p.
:xmp.
REGISTER   SERVICE <Name> ERROR <Number> INFO <String> DESCRIPTION <String>

UNREGISTER SERVICE <Name> ERROR <Number>

&lbrk.SERVICE <Name>&rbrk. ERROR <Number>

LIST SERVICES | &lbrk.SERVICE <Name>&rbrk. ERRORS

HELP
:exmp.
.*-----------------------------
:row.
:c.:hp2.LOG:ehp2.
:c.Allows for robust data-logging and log file querying and manipulation.
:p.
:xmp.
LOG    <GLOBAL | MACHINE | HANDLE> LOGNAME <Logname> LEVEL <Level>
       MESSAGE <Message> &lbrk.RESOLVEMESSAGE | NORESOLVEMESSAGE&rbrk.

QUERY  <GLOBAL | MACHINE <Machine> &lbrk.HANDLE <Handle>&rbrk. LOGNAME <Logname>
       &lbrk.LEVELMASK <Mask>&rbrk. &lbrk.QMACHINE <Machine>&rbrk.... &lbrk.QHANDLE <Handle>&rbrk....
       &lbrk.NAME <Name>&rbrk.... &lbrk.USER <User>&rbrk.... &lbrk.ENDPOINT <Endpoint>&rbrk....
       &lbrk.CONTAINS <String>&rbrk.... &lbrk.CSCONTAINS <String>&rbrk....
       &lbrk.STARTSWITH <String>&rbrk.... &lbrk.CSSTARTSWITH <String>&rbrk....
       &lbrk.FROM <Timestamp> | AFTER <Timestamp>&rbrk.
       &lbrk.BEFORE <Timestamp> | TO <Timestamp>&rbrk.
       &lbrk.FROMRECORD <Num>&rbrk. &lbrk.TORECORD <Num>&rbrk.
       &lbrk.FIRST <Num> | LAST <Num> | ALL&rbrk. &lbrk.TOTAL | STATS | LONG&rbrk.
       &lbrk.LEVELBITSTRING&rbrk.

LIST   GLOBAL | MACHINES | MACHINE <Machine> &lbrk.HANDLE <Handle> | HANDLES&rbrk. |
       SETTINGS

DELETE <GLOBAL | MACHINE <Machine> &lbrk.HANDLE <Handle>&rbrk.>
        LOGNAME <Logname> CONFIRM

PURGE  <GLOBAL | MACHINE <Machine> &lbrk.HANDLE <Handle>&rbrk.> LOGNAME <Logname> CONFIRM
       &lbrk.LEVELMASK <Mask>&rbrk. &lbrk.QMACHINE <Machine>&rbrk.... &lbrk.QHANDLE <Handle>&rbrk....
       &lbrk.NAME <Name>&rbrk.... &lbrk.USER <User>&rbrk.... &lbrk.ENDPOINT <Endpoint>&rbrk....
       &lbrk.CONTAINS <String>&rbrk.... &lbrk.CSCONTAINS <String>&rbrk....
       &lbrk.STARTSWITH <String>&rbrk.... &lbrk.CSSTARTSWITH <String>&rbrk....
       &lbrk.FROM <Timestamp> | AFTER <Timestamp>&rbrk.
       &lbrk.BEFORE <Timestamp> | TO <Timestamp>&rbrk.
       &lbrk.FROMRECORD <Num>&rbrk. &lbrk.TORECORD <Num>&rbrk.
       &lbrk.FIRST <Num> | LAST <Num>&rbrk.

SET    &lbrk.MAXRECORDSIZE <Size>&rbrk. &lbrk.DEFAULTMAXQUERYRECORDS <Number>&rbrk.
       &lbrk.ENABLERESOLVEMESSAGEVAR | DISABLERESOLVEMESSAGEVAR&rbrk.
       &lbrk.RESOLVEMESSAGE | NORESOLVEMESSAGE&rbrk.

VERSION

HELP
:exmp.
.*-----------------------------
:row.
:c.:hp2.MISC:ehp2.
:c.Provides miscellaneous services such as VERSION, WHOAMI, and WHOAREYOU
information, allows for listing and querying enabled interfaces, allows
you to set operational parameters for STAF and show their settings,
and allows you to list and purge the endpoint cache used by automatic
interface cycling.
:p.
:xmp.
VERSION

WHOAMI

WHOAREYOU

LIST  INTERFACES | SETTINGS | ENDPOINTCACHE

QUERY INTERFACE <Name>

SET   &lbrk.CONNECTATTEMPTS <Number>&rbrk. &lbrk.CONNECTRETRYDELAY <Number>&rbrk.
      &lbrk.MAXQUEUESIZE <Number>&rbrk.    &lbrk.INTERFACECYCLING <Enabled | Disabled>&rbrk.
      &lbrk.DEFAULTINTERFACE <Name>&rbrk.  &lbrk.DEFAULTAUTHENTICATOR <Name>&rbrk.
      &lbrk.RESULTCOMPATIBILITYMODE <Verbose | None>&rbrk.
      
PURGE ENDPOINTCACHE <ENDPOINT <Endpoint>... | CONFIRM>

HELP
:exmp.
.*-----------------------------
:row.
:c.:hp2.MONITOR:ehp2.
:c.Allows test cases the ability to log and query status messages.
:p.
:xmp.
LOG    MESSAGE <Message> [NAME <Name>] &lbrk.RESOLVEMESSAGE | NORESOLVEMESSAGE&rbrk.

QUERY  MACHINE <Machine> < HANDLE <Handle> | NAME <Name> >

LIST   <MACHINES | MACHINE <Machine> [NAMES] | SETTINGS>

DELETE &lbrk.BEFORE <Timestamp>&rbrk. CONFIRM

SET    &lbrk.RESOLVEMESSAGE | NORESOLVEMESSAGE&rbrk.
       &lbrk.OLDRETURNCODES | NEWRETURNCODES&rbrk. &lbrk.MAXRECORDSIZE <Size>&rbrk.
       &lbrk.ENABLERESOLVEMESSAGEVAR | DISABLERESOLVEMESSAGEVAR&rbrk.

VERSION

HELP
:exmp.
.*-----------------------------
:row.
:c.:hp2.PING:ehp2.
:c.Allows you to ping other STAF clients.
:p.
:xmp.
PING &lbrk.MACHINE <Machine>&rbrk.