Short Reference CASWebServiceTest

Transcription

1 Short Reference CASWebServiceTest version: 0.2 date: author: project: NH species2000/eurocat Status Person Date Sign draft FS edited version NH final version NH Frank Streitzig (FS: Norbert Hirneisen (NH: science4you.org by science + communication & Verlag für interaktive Medien von-müllenark-str Bonn GERMANY science4you :06 Seite 1 von 6

2 1 Short reference to CASWebServiceTest for Species Introduction How to start Parameters Example: How to read the results How to set up a test run by using the XML-configuration file CASWebServiceTest.xsd sample.xml Short reference to CASWebServiceTest for Species Introduction CASWebServiceTest ist a tool written in JAVA(tm) to generate test requests to the web-service interface of the CASBroker using SOAP. CASWebServiceTest is configurable and supports the test of the request types 1 to 3. The configuration can be done by editing a configuration file in XML-format. The structure of the XMLconfiguration-file is defined by the XML-schema CASWebServiceTest.xsd. The name of the configuration file is variable; you have to pass it to CASWebServiceTest by using the mandatory "-f"- parameter (see below). Therefore you can use several configuration files. On starting of CASWebServiceTest the configuration file will be validated against the XML-scheme. It is possible to start one SOAP-query after the other. The time period each query is taken will be logged, displayed on standard output and logged into a file (optional parameter). A summary is available, too. The delay time between the SOAP-calls is variable starting by zero up to a maximum value defined in the configuration file. This function simulates a real world scenario with variable usage of the SOAPservice. CASWebServiceTes runs in a UNIX/Linux environment and in a Windows environment. 1.2 How to start You have to extract the archive-file to a directory. Then you can edit the example test.xml-file (in the data subdirectory) to meet your purposes. Then you call CASWebServiceTest.sh (Unix/Linux) or CASWebServiceTest.bat (Windows) with the appropriate parameters Parameters mandatory -f xmlfile Configuration XML-file holding the test parameters optional: -l logfile Name of the log file. All output to standard out is stored there as text file row by row with tab-delimited result columns. -u URL URL of the target server. This overwrites the target definition in the configuration file. Using this parameter the same configuration file can be used to target different servers Example: A. Starting a test run by using the configuration file "sample.xml" in the data-directory in a Windows environment: science4you :06 Seite 2 von 6

3 D:\>CASWebServiceTest.bat f data\sample.xml CASWebServiceTest XmlFilename: data\sample.xml LogFilename: data\sample.log Validate XML-File: OK UrlTestServer: MaxWait: 5000 msec. Test run run next test... StartTime: :59: LocalIP: entwicklung Server: spice.sp2000europa.org Test: 1 Methode: satisfytype0request Time msec: 1063 Result: CDMVersion 1.20 wait: 625 msec run next test... StartTime: :59: Test run completed. B. Starting a test run by using the configuration file "sample.xml" in the data-directory and storing the results in the log file "sample.log" in a Windows environment: D:\>CASWebServiceTest.bat f data\sample.xml l data\sample.log How to read the results SOAP-method Remarks Example satisfytype0request CDM Version CDMVersion 1.20 satisfytype1request satisfytype2request Number of found names in the result set of the query Detailed information on a name available or not 100 speciesnames found StandardData found or StandardData NOT found satisfytype3request Number of found and available GSD 31 GSD found gethubidentifiers Number of available hubs 2 hubs found 1.3 How to set up a test run by using the XML-configuration file The structure of the XML-configuration file is shown below. There are two main elements: Within the <setting>-element you find the general settings; within the <testrun>-element you find the information for each test call. The names of the tags correspond to the methods of the web-service interface. The Parameters of these methods are labelled as tags in the configuration file. science4you :06 Seite 3 von 6

4 1.3.1 CASWebServiceTest.xsd <?xml version="1.0" encoding="utf-8"?> <!--W3C Schema generated by XML Spy v4.0.1 U ( <xs:schema xmlns:xs=" elementformdefault="qualified"> <xs:element name="maxwait" type="xs:nonnegativeinteger" /> <xs:element name="url" type="xs:anyuri"/> <xs:element name="gsdidentifier" type="xs:string"/> <xs:element name="hubidentifier" type="xs:string"/> <xs:element name="identifier" type="xs:string"/> <xs:element name="searchlimit" type="xs:integer"/> <xs:element name="searchskip" type="xs:integer"/> <xs:element name="searchstring" type="xs:string"/> <xs:element name="searchtype" type="xs:string"/> <xs:element name="caswebservicetest"> <xs:element ref="setting" minoccurs="1" maxoccurs="1"/> <xs:element ref="testrun" minoccurs="1" maxoccurs="1" /> <xs:element name="setting"> <xs:element ref="url"/> science4you :06 Seite 4 von 6

5 <xs:element ref="maxwait"/> <xs:element name="testrun"> <xs:complextype mixed="true"> <xs:choice minoccurs="0" maxoccurs="unbounded"> <xs:element ref="satisfytype0request"/> <xs:element ref="satisfytype1request"/> <xs:element ref="satisfytype2request"/> <xs:element ref="satisfytype3request"/> <xs:element ref="gethubidentifiers"/> </xs:choice> <xs:element name="gethubidentifiers"> <xs:complextype/> <xs:element name="satisfytype0request"> <xs:complextype/> <xs:element name="satisfytype1request"> <xs:element ref="searchstring"/> <xs:element ref="searchtype"/> <xs:element ref="searchlimit"/> <xs:element ref="searchskip"/> <xs:element ref="gsdidentifier"/> <xs:element ref="hubidentifier"/> <xs:element name="satisfytype2request"> <xs:element ref="gsdidentifier"/> <xs:element ref="identifier"/> <xs:element ref="hubidentifier"/> <xs:element name="satisfytype3request"> <xs:element ref="gsdidentifier"/> <xs:element ref="hubidentifier"/> </xs:schema> sample.xml <?xml version="1.0"?> <CASWebServiceTest xmlns:xsi=" science4you :06 Seite 5 von 6

6 xsi:nonamespaceschemalocation="caswebservicetest.xsd"> <!-- general settings --> <setting> <url> <maxwait>5000</maxwait> </setting> <!-- test run --> <testrun> <satisfytype0request/> <gethubidentifiers/> <satisfytype3request> <GSDIdentifier/> </satisfytype3request> <satisfytype1request> <SearchString>Bacillus</SearchString> <SearchType>scientific</SearchType> <SearchLimit>100</SearchLimit> <SearchSkip>25</SearchSkip> </satisfytype1request> <satisfytype2request> <Identifier>BIO-6756</Identifier> </satisfytype2request> <satisfytype2request> <Identifier>BIO-6802</Identifier> </satisfytype2request> <satisfytype2request> <Identifier>BIO-10257</Identifier> </satisfytype2request> </testrun> </CASWebServiceTest> science4you :06 Seite 6 von 6