fssrv.script

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

:li.:hp2.Goal::ehp2. Show detailed information on all the copy requests
that are currently in progress.
.br
:hp2.Syntax::ehp2.  :xph.LIST COPYREQUESTS LONG:exph.
.br
:hp2.Results::ehp2. If the request is submitted from the
command line, the result, in the verbose format, could look like the following:
:xmp.
[
  {
    Start Date-Time: 20050725-18:31:32
    In/Out         : Out
    Machine        : tcp://client2.company.com
    Directory Name : c:/temp/TestA
    Type           : D
    Transfer State : {
      Name        : c:/temp/TestA/TestA.zip
      Mode        : Binary
      File Size   : 9873006
      Bytes Copied: 1288000
    }
  }
  {
    Start Date-Time: 20050725-18:31:38
    In/Out         : Out
    Machine        : tcp://client1.company.com@6500
    File Name      : c:/tests/Instructions.txt
    Type           : F
    Mode           : Text
    Transfer State : {
      File Size   : 26019
      Bytes Copied: 12000
    }
  }
  {
    Start Date-Time: 20050725-18:31:38
    In/Out         : In
    Machine        : client1.company.com
    File Name      : c:/temp/Instructions.txt
    Type           : F
    Mode           : Text
    Transfer State : {
      File Size   : <None>
      Bytes Copied: 12000
    }
  }
  {
    Start Date-Time: 20050725-18:31:41
    In/Out         : Out
    Machine        : tcp://client3.company.com
    File Name      : c:/temp/TestB/TestB.zip
    Type           : F
    Mode           : Binary
    Transfer State : {
      File Size   : 70483006
      Bytes Copied: 63614000
    }
  }
  {
    Start Date-Time: 20050725-18:32:05
    In/Out         : In
    Machine        : client2.company.com
    Directory Name : c:/temp/TestC
    Type           : D
    Transfer State : {
      Name        : c:/temp/TestC/TestC.txt
      Mode        : Text
      File Size   : <None>
      Bytes Copied: 8000
    }
  }
]
:exmp.
:p.
:li.:hp2.Goal::ehp2. Show the file copy requests that are copying files to
this machine.
.br
:hp2.Syntax::ehp2.&nbsp; :xph.LIST COPYREQUESTS INBOUND FILE:exph.
.br
:hp2.Results::ehp2. If the request is submitted from the
command line, the result, in table format, could look like the following:
:xmp.
Start Date-Time   In/Out Machine             Name                     Type
----------------- ------ ------------------- ------------------------ ----
20050725-18:31:38 In     client1.company.com c:/temp/Instructions.txt F
:exmp.
:p.
:li.:hp2.Goal::ehp2. Show detailed information about the file copy
requests that are copying files from this machine.
.br
:hp2.Syntax::ehp2.&nbsp; :xph.LIST COPYREQUESTS OUTBOUND FILE LONG:exph.
.br
:hp2.Results::ehp2. If the request is submitted from the
command line, the result, in verbose format, could look like the following:
:xmp.
[
  {
    Start Date-Time: 20050725-18:31:38
    In/Out         : Out
    Machine        : tcp://client1.company.com@6500
    File Name      : c:/tests/Instructions.txt
    Type           : F
    Mode           : Text
    Transfer State : {
      File Size   : 26019
      Bytes Copied: 12000
    }
  }
  {
    Start Date-Time: 20050725-18:31:41
    In/Out         : Out
    Machine        : tcp://client3.company.com
    File Name      : c:/temp/TestB/TestB.zip
    Type           : F
    Mode           : Binary
    Transfer State : {
      File Size   : 70483006
      Bytes Copied: 63614000
    }
  }
]
:exmp.
:p.
:li.:hp2.Goal::ehp2. Show detailed information about the file copy
requests that are copying files from this machine in binary mode.
.br
:hp2.Syntax::ehp2.&nbsp; :xph.LIST COPYREQUESTS OUTBOUND BINARY FILE LONG:exph.
.br
:hp2.Results::ehp2. If the request is submitted from the
command line, the result, in table format, could look like the following:
:xmp.
[
  {
    Start Date-Time: 20050725-18:31:41
    In/Out         : Out
    Machine        : tcp://client3.company.com
    File Name      : c:/temp/TestB/TestB.zip
    Type           : F
    Mode           : Binary
    Transfer State : {
      File Size   : 70483006
      Bytes Copied: 63614000
    }
  }
]
:exmp.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.LIST SETTINGS
:i3.file system service
:h3.LIST SETTINGS
:p.LIST SETTINGS shows the operational settings for the FS service.
:h4.Syntax
:xmp.
LIST SETTINGS     
:exmp.
:p.:xph.SETTINGS:exph. specifies that you want to list the current operational
settings for the FS service.
:h4.Security
:p.&seclvl. 2.
:h4.Return Codes
:p.All return codes from LIST SETTINGS are documented in :hdref refid=retcode..
:h4.Results
:p.On successful return, the result buffer will contain a marshalled
:xph.<Map&colon.STAF/Service/FS/Settings>:exph. representing the current
settings for the File System service.
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/FS/Settings
:tnote text='Description'.This map class represents the operational
settings for the File System service.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.strictFSCopyTrust
:c.Strict FS Copy Trust
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:etable.

:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2. List the current operational settings for the
File System service.
.br
:hp2.Syntax::ehp2.&nbsp; :xph.LIST SETTINGS:exph.
.br
:hp2.Results::ehp2. If the request is submitted from the
command line, the result, in default format, could look like the following:
:xmp.
Strict FS Copy Trust: Disabled
:exmp.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.CREATE
:i3.file system service
:h3.CREATE
:p.CREATE creates a directory.
:h4.Syntax
:xmp.
CREATE DIRECTORY <Name> &lbrk.FULLPATH&rbrk. &lbrk.FAILIFEXISTS&rbrk.
:exmp.
:p.:xph.DIRECTORY:exph. specifies the name of the directory to create. &varres.
:p.:xph.FULLPATH:exph. specifies that any intermediate parent directories should
be created if they don't exist.
:p.:xph.FAILIFEXISTS:exph. specifies that the request should generate an error
if the specified directory alread exists.  By default, the request will succeed
if the specified directory already exists.
:h4.Security
:p.&seclvl. 4.
:h4.Return Codes
:p.All return codes from CREATE are documented in :hdref refid=retcode..
:h4.Results
:p.On successful return, the result buffer will be empty.
:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2. Create the directory /tmp/tests
.br
:hp2.Syntax::ehp2.&nbsp; :xph.CREATE DIRECTORY /tmp/tests:exph.
:p.
:li.:hp2.Goal::ehp2. Create the directory {Tests/Root} and ensure that any
intermediate parent directories are created as well.
.br
:hp2.Syntax::ehp2.&nbsp; :xph.CREATE DIRECTORY {Tests/Root} FULLPATH:exph.
:p.
:li.:hp2.Goal::ehp2. Create the directory D&colon.\TestData.  Generate an error if the
directory already exists.
.br
:hp2.Syntax::ehp2.&nbsp; :xph.CREATE DIRECTORY D&colon.\TestData FAILIFEXISTS:exph.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.DELETE
:i3.file system service
:h3.DELETE
:p.DELETE deletes a file system entry.
:h4.Syntax
:xmp.
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
:exmp.
:p.:xph.ENTRY:exph. specifies the name of the file system entry to delete.
&varres.
:p.:xph.CHILDREN:exph. specifies that only children matching :xph.NAME:exph.,
:xph.EXT:exph., and :xph.TYPE:exph. should be deleted.  The entry itself will
not be deleted.
:p.:xph.NAME:exph. specifies a pattern used to match the name of child entries.
Only child entries whose name match this pattern will be deleted.  The default
pattern is "*". &varres.
:p.:xph.EXT:exph. specifies a pattern used to match the extension of child
entries.  Only child entries whose extenision match this pattern will be
deleted.  The default pattern is "*". &varres.
:p.:xph.TYPE:exph. specifies the types of child entries to delete.  These types
are the same types described in section :hdref refid=fsgete..  You may also
specify the string "ALL" to delete all entry types.  By default, all entry types
are deleted.  &varres.
:p.:xph.CASESENSITIVE:exph. specifies that the patterns specified by
:xph.NAME:exph. and :xph.EXT:exph. are to be matched in a case sensitive manner.
:p.:xph.CASEINSENSITIVE:exph. specifies that the patterns specified by
:xph.NAME:exph. and :xph.EXT:exph. are to be matched in a case insensitive
manner.
:note.If neither :xph.CASESENSITIVE:exph. nor :xph.CASEINSENSITIVE:exph. is
specified, the default is determined by the operating system -- unix systems
default to :xph.CASESENSITIVE:exph., all others default to
:xph.CASEINSENSITIVE:exph..
:p.:xph.RECURSE:exph. specifies that the entry's children will be recursively
deleted.
:note.If neither :xph.CHILDREN:exph. nor :xph.RECURSE:exph. is used, only
the entry itself will be deleted.  If :xph.RECURSE:exph. is specified without
:xph.CHILDREN:exph. then the entry and all of its children will be deleted.  If
:xph.RECURSE:exph. and :xph.CHILDREN:exph. are specified, then only the children
matching the specified :xph.NAME:exph., :xph.EXT:exph., and :xph.TYPE:exph. will
be deleted (i.e., the entry itself will not be deleted).
:p.:xph.IGNOREERRORS:exph. specifies that errors encountered (recursively)
deleting children should not be returned.  By default, all errors encountered
while (recursively) deleting children will be returned in the result buffer.
:p.:xph.CONFIRM:exph. indicates that you really want the deletion to occur.
:h4.Security
:p.&seclvl. 4.  If you specify :xph.RECURSE:exph., you must have trust level 5.
:h4.Return Codes
:p.All return codes from DELETE are documented in :hdref refid=retcode..
:h4.Results
:p.
:ul.
:li.On successful return, the result buffer will be empty. 
:p.
:li.If errors were encountered deleting entries and :xph.IGNOREERRORS:exph.
was not specified, the result buffer will contain a
marshalled :xph.<List> of <Map&colon.STAF/Service/FS/ErrorInfo>:exph. representing
a list of error information about the entries that were not successfully deleted.
See table :tref refid=fsErrorInfoTable. for the map class definition of
:xph.<Map&colon.STAF/Service/FS/ErrorInfo>:exph..
:eul.

:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2. Delete the entry /tmp/myfile.txt
.br
:hp2.Syntax::ehp2.&nbsp;
:xph.DELETE ENTRY /tmp/myfile.txt CONFIRM:exph.
:p.
:li.:hp2.Goal::ehp2. Delete the directory /tmp/myfiles and all of its children.
.br
:hp2.Syntax::ehp2.&nbsp; 
:xph.DELETE ENTRY /tmp/myfiles RECURSE CONFIRM:exph.
:p.
:li.:hp2.Goal::ehp2. Recursively delete all the children of C&colon.\TEMP, without
deleting the directory itself.
.br
:hp2.Syntax::ehp2.&nbsp;
:xph.DELETE ENTRY C&colon.\TEMP CHILDREN RECURSE CONFIRM:exph.
:p.
:li.:hp2.Goal::ehp2. Delete all entries with an extension of "tmp" in
C&colon.\MyFiles.  Match the extension in a case insensitive manner.  Do not
recurse down subdirectories.
.br
:hp2.Syntax::ehp2.&nbsp;
:xph.DELETE ENTRY C&colon.\TEMP CHILDREN EXT tmp CASEINSENSITIVE CONFIRM:exph.
:p.
:li.:hp2.Goal::ehp2. Recursively delete all files (and only files) under {MyTempFiles}
with a base name beginning with "test".  Match the name in a case sensitive
manner.  Do not report an errors during the deletion.
.br
:hp2.Syntax::ehp2.&nbsp;
:xph.DELETE ENTRY {MyTempFiles} CHILDREN NAME "test*" RECURSE CASESENSITIVE IGNOREERRORS CONFIRM:exph.
:eul.
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.SET
:i3.file system service
:h3 id=fsset.SET
The SET command allows you to change the operational parameters for the
File System service dynamically (without stopping/restarting STAF) which is
important for STAF machines that must be continuously available.
:p.
Note that to make these settings permanent (e.g. if you want these changes
to apply once STAF is stopped and restarted), you'll need to update the
STAF configuration file with these new settings.

:h4.Syntax
:xmp.
SET  STRICTFSCOPYTRUST <Enabled | Disabled>
:exmp.
:p.See section :hdref refid=opparms. for a description of this option.
Note that setting :xph.STRICTFSCOPYTRUST Enabled:exph. is equivalent
to setting the :xph.STRICTFSCOPYTRUST:exph. operational parameter in the
STAF configuration file.  S