The SOAtest Smart API Test Generator enables you to capture traffic and create API tests from Parasoft Recorder can record API calls and user actions during interactions with a web application. You can convert the API traffic into API tests that you can extend and execute in CTP or the SOAtest desktop. You can download the recorded user actions and convert them into Selenium tests with Parasoft Selenic. In this section:
| Table of Contents | ||
|---|---|---|
|
Overview
The SOAtest Smart API Test Generator Parasoft Recorder includes the following components:
- SOAtest Traffic Parasoft Recorder Chrome extension: The traffic recorder is an extension for the Chrome browser . It extension is installed on the local machine and provides an interface for starting/stopping recording, as well as configuring your connection to SOAtest, as well as starting/stopping recordingSOAtest so that the SOAtest Web Proxy can convert API traffic into tests.
- Parasoft SOAtest Web Proxy: The proxy is installed on the local machine, processes traffic, and creates a .tst file in SOAtest.
- Parasoft Root Certificate Authority: The CA enables HTTPS traffic to be recorded.
The Smart API Test Generator connects to a SOAtest desktop or server, which enables you to configure and run the test.
...
System Requirements
This section describes the requirements for Parasoft Recorder components and associated functionality.
Browser Extension
- Latest version of Google Chrome
- The SOAtest Web Proxy must also be running to record API traffic.
SOAtest Web Proxy
- Port 40090 must be available to run the web proxy.
Generating API Tests
- SOAtest desktop or server 9.10.5 or later
Creating and Managing Selenium Tests
- Refer to the System Requirements.Latest version of Google Chrome
Licensing
You can freely download and install the Smart API Test GeneratorParasoft Recorder, but a valid license is required to use the API test generation features in SOAtest or the Selenium test creation and management features in Parasoft Selenic. Contact your Parasoft representative for complete licensing information.
API Testing License
Advanced for the Advanced Test Generation license feature in SOAtest is required to record traffic and generate tests. The following license options are available:
- Advanced Test Generation Desktop: Enables you to create assets from the web proxy on the same machine where SOAtest is installed. Connections from remote machines are not allowed.
- Advanced Test Generation 5 Users: Up to five users can create assets from any machine that can connect to the SOAtest server.
- Advanced Test Generation 25 Users: Up to 25 users can create assets from any machine that can connect to the SOAtest server.
- Advanced Test Generation 100 Users: Up to 100 users can create assets from any machine that can connect to the SOAtest server.
Selenium Test License
Refer to the Parasoft Selenic documentation for details about licensing.Contact your Parasoft representative for additional licensing information.
Installation
Run the parasoft_soatest_smart_api_test_generatorrecorder_<version>_win32.exe file for installation on Windows or the parasoft_soatest_smart_api_test_generatorrecorder_<version>_macos.dmg for installation on Mac OS. If Mac OS can not run the .dmg for security reasons, right-click the file and choose Open With> Installer.
...
During Windows installation, you will be prompted to install the Parasoft SOAtest Web Proxy as a Windows service. This enables you to start and stop the proxy using the services console under the Windows Control Panel, as well as use the SOAtest Web Proxy console in the Windows Start menu (see Starting the Web Proxy). You can also manually start the proxy by running the executable JAR file (see Manually Starting the Web Proxy).
The Windows and Mac installer will also prompt you to install the SOAtest Traffic Parasoft Recorder from the Google Chrome store (Windows shown). See Manual Installation if access to the Google Chrome store is prohibited or if you experience issues using the installer.
The installer will prompt you to install the Parasoft Root Certificate Authority if it is not detected. The CA is required to record traffic over HTTPS. The CA is normally installed along with the SOAtest/Virtualize desktop application. You can also add the CA manually (see Installing the Parasoft Root Certificate Authority).
During installation on Mac OS, you can enable the web proxy to automatically start whenever you log into the machine.
You can enable or disable automatic start up for the web proxy after installation by in the System Preferences> Users & Groups> Login Items settings.
...
| Info | ||
|---|---|---|
| ||
You can click the padlock icon to view the Apple developer ID certificate authority (CA). The certificate identifies Parasoft as a trusted source of software for Apple devices.
|
After the installer finishes, you will be prompted to enable the extension when you launch Chrome.
...
Use the regular Windows program uninstaller in the control panel to fully uninstall the tool. The Mac OS installer ships with an Uninstall SOAtest Smart API Test Parasoft Recorder Generator utility that you can run if you wish to completely uninstall the tool. The Mac OS utility will be located in your Applications/Parasoft folder.
...
The following instructions describe how to manually install the SOAtest Smart API Test Generator Parasoft Recorder components if you are unable to use the Windows installer.
- Download the TrafficRecordingExtension.zip folder (contact your Parasoft representative).
- Extract the contents of the compressed folder anywhere on your machine. No additional installation is necessary to run the Parasoft SOAtest Web Proxy.
- Open a Chrome browser window and open the Extensions page (chrome://extensions).
- Enable the Developer mode option and click Load unpacked extension.
- Navigate to and choose the [TrafficRecordingExtension_INSTALL]/chrome-extension directory to install the extension. The tool will be available in the browser bar.
The Parasoft SOAtest Web Proxy and SOAtest server must be running before you can use the extension record API traffic (see Starting the Web Proxy). If the SOAtest server is running and the default configuration is used to start the proxy, you will be able to start using the extension to record traffic. See SOAtest Smart API Test Generator Usage if these components are running. You will also need to configure connections to the Parasoft SOAtest Web Proxy and SOAtest server once the browser extension is installed.
...
The Parasoft Root Certificate Authority is normally installed automatically by both the SOAtest Windows installer and the SOAtest Smart API Test Generator Parasoft Recorder installer. You can also run the run soatestcli with with the -installcertificate option to manually install it if necessary. For example:
...
The web proxy API will be started on port 40090 by default. The proxy port used for recording API traffic will be assigned by scanning for open ports starting with port 40443. You can configure port numbers and other options when starting the proxy in the web proxy console. See Advanced SOAtest Smart API Test Generator Configuration for additional information.
...
On Mac OS, the web proxy will be located in your Applications/Parasoft folder.
Manually Starting the Web Proxy
...
%INSTALLDIR%/jre/bin/java -jar com.parasoft.traffic.proxy.jar
| Info | ||
|---|---|---|
| ||
The Smart API Test Generator Parasoft Recorder ships with its own instance of Java, but you can use any Java 8 or later that is already installed on your system. |
...
The version number can be helpful if you need to troubleshoot issues with the SOAtest Smart API Test GeneratorParasoft Recorder.
Executing the JAR with this argument only enables the proxy to report the version and does not start the proxy.
...