Use SecurityTestRunner to run Ready! API's security tests from the command line.

Transcription

1 SecurityTest Runner SecurityTestRunner runs security tests. Use SecurityTestRunner to run Ready! API's security tests from the command line. You can start the runner from the command line or from the Ready! API user interface. The latter approach is useful, when you need to build the command line and check the settings. See below. Location The runner is located in the <Ready! API>/bin directory. The file name is securitytestrunner.bat (Windows) or securitytestrunner.sh (Linux and OS X). Running The Utility To launch the runner from Ready! API, select the appropriate menu command: In Secure, select Project Launch Security TestRunner from the main menu: In Secure, right-click the desired security test and select Launch Security TestRunner: Ready! API Documentation -

2 In Secure, select the project node in the Navigator panel and then click Run on the Ready! API's toolbar: After you selected a menu command, Ready! API displays a dialog box, where you can configure the parameters of the run (see below). You can then use the generated command string to run the utility from the command line. Parameters The configuration dialog organizes the utility parameters in the following tabs: Basic Overrides Reports Properties Custom Basic

3 Parameter Description Specifies for which TestSuite and TestCase a security test to run. Ready! API's security testing engine is based on the SoapUI engine, where security tests were part of TestCases. Ready! API's security testing subsystem supports SoapUI's approach for specifying the security tests to run. You can find the TestSuite and TestCase names in the Navigator panel right after the name of your security test: TestSuite and TestCase An alternative approach to specify the security test is to use the SecurityTest box. The TestSuite and TestCase parameters are analogues of the -s and -c command-line arguments correspondingly. Ready! API Documentation -

4 Parameter SecurityTest Enable UI SecurityTestRunner Path Save Project Add Settings Project Password user-settings.xml Password Ignore Errors Save After Description Specifies a security test to run. If this parameter is not specified, the runner executes all the security tests in the specified TestCase. This parameter is an analogue of the -n command-line argument. You can specify a security test to run by using this parameter, or by using a combination of the TestSuite and TestCase parameters. Use this option to enable UI-related components. This is required if your test uses the UISupport class. This parameter is an analogue of the -i command-line argument. Specifies the fully-qualified name of the runner file (securitytestrunner.bat or.sh). By default, the file is located in the <Ready! API>\bin directory. This is useful to make sure that all the recent changes to the project are saved before the run. Commands the runner to use workspace settings from the soapuisettings.xml file that is located in your user directory. To specify another XML settings file, use the -t command-line argument. In the Launch SecurityTestRunner dialog, you can specify this argument in the Custom Args tab. Specifies the project password, if your project is encrypted. This parameter is an analogue of the -x command-line argument. Specifies the password for the settings XML file. This parameter is an analogue of the -v command-line argument. Commands the runner to ignore errors that occur during the test run. If you select this check box, the runner will not stop the test if an error occurs. However, in this case the runner will not log information on errors. If you keep this check box clear, the runner will stop when an error occurs and will log information about that error. This parameter is an analogue of the -I command-line argument. Commands the runner to save the project after the test run finishes. This may be useful, if your test stores data to the project. This parameter is an analogue of the -S command-line argument. Overrides

5 Parameter Environment Endpoint Host:Port Username Password Domain Description Specifies the environment configuration for the test run. This value overrides the environment configuration selected for your project in the Ready! API toolbar. To use environments in your tests, you need a SoapUI NG Pro license. If you do not have it, sign up for a free trial to see how it works. This parameter is an analogue of the -E command-line attribute. Specifies the endpoint to be used for requests during the test run. This value overrides endpoints specified in request properties in your project. This parameter is an analogue of the -e command-line argument. Specifies the host and port to use in requests during the test run. Usage format: host:port. You can specify the host by using its IP address or name. This value overrides the hosts and ports specified in request properties in your project. This parameter is an analogue of the -h command-line argument. Specifies a user name for authorization tasks during the test run. This value overrides the user names specified in authorization properties of test requests. This parameter is an analogue of the -u command-line argument. Specifies a password for authorization tasks during the test run. This value overrides the password specified in authorization properties of test requests. This parameter is an analogue of the -p command-line argument. Specifies a domain for authorization tasks during the test run. This value overrides the domains specified in authorization properties of test requests. This parameter is an analogue of the -d command-line argument. Ready! API Documentation -

6 Parameter WSS Password Type Description Specifies the WS-Security password type. You can select Text or Digest that corresponds to the WSS PasswordText and PasswordDigest type respectively. This parameter is an analogue of the -w command-line argument. Reports Print Report Export JUnit Results Export All Commands the runner to include summary data into the generated reports. This parameter is an analogue of the -r command-line argument. Commands the runner to create a JUnit-style report. This parameter is an analogue of the -j command-line argument. If this check box is clear, the report will contain information only about errors. If the check box is selected, the report will include messages of other types too. This parameter is an analogue of the -a command-line argument. The fully-qualified name of the directory that will store exported test reports. If the specified directory does not exist, it will be created. Root directory Important: If the directory exists, reports' files in it will be overwritten. This parameter is an analogue of the -f command-line argument. Commands the runner to generate test coverage reports (in HTML format). Coverage Report To use this functionality, you need a Secure Pro license. If you do not have it, sign up for a free trial to see how it works. This parameter is an analogue of the -g command-line argument.

7 Commands the runner to open the generated reports in your default browser after the test run finishes. Open Report This parameter is an analogue of the -o command-line argument. Note that to use reports in your tests, you need a Secure Pro license. If you do not have it, sign up for a free trial to see how it works. Specifies the type of the generated report. You can use the following values: Select Report Type - Security Issues Report - Creates a security report in.pdf format with information about all security issues that were detected. For more information, see Security Issues Report. - SecurityTest Report - Creates a printable report with information about what scans were performed and their results. See Security Test Report for more information. - Data Export - Generates a report in XML format. See Data Export. If you select this type, the Report Format(s) parameter must specify XML. This parameter is an analogue of the -R command-line argument. Report Format(s) Note that to use reports in your tests, you need a Secure Pro license. If you do not have it, sign up for a free trial to see how it works. Specifies the format of the generated report. Possible values: PDF, XLS, HTML, RTF, CSV, TXT, XML. If you keep this edit box empty, PDF will be used. Do not specify periods in format names. To specify multiple formats, separate them with commas, for example: PDF,XML,CSV. This parameter is an analogue of the -F command-line argument. For more information about reports and customization, see Reporting. Properties Ready! API Documentation -

8 On the Properties tab you can specify variable values that will take effect during the test run. To specify variable values, use strings of the following format: <variable-name>=<value>. Separate multiple name=value pairs with spaces, or put each pair into a new line. If a variable name or value includes spaces, enclose the entire pair in quotes. For example: file=c:\work\file.txt image_to_upload="c:\my Application\image.png" Properties Global Properties Description Specifies global property values for the test run. The values you specify will override properties listed in the Global Properties settings of the Ready! API preferences. System Properties Project Properties This parameter is an analogue of the -G command-line argument. Specifies system property values for the test run. The values you specify will override these properties' values you have in Ready! API's Help > System Properties dialog. This parameter is an analogue of the -D command-line argument. Specifies the project property values for the test run. The values you specify will override project-level properties. This parameter is an analogue of the -P command-line argument. Custom Arguments

9 The Custom Args tab allows you to add any extra arguments to the runner if you need. For example, you can command the runner to use a setting file that is different from the default soapuisettings.xml. To do this, you can enter the following text into the Tool Args edit box: -tc:\work\test-settings.xml Getting The Generated Command Line After you specified the desired launch parameters in the dialog, click Launch to start the runner: You will see the test log: Ready! API Documentation -

10 After the run finishes, you can find the generated command line at the beginning of the test log: Selecttext in the window with the mouse and copy it to the clipboard. See Also SecurityTestRunner Command-Line Arguments Command-Line Runners