Test run considerations for API Suites

Before you configure an API Suite run, you must read the considerations you must take into account.

You can find the following information about API Suites:

Important information about API Suites

When you want to run an API Suite from a project on HCL OneTest™ Server and the test suite in HCL OneTest™ API meets any of the following conditions:
  • The test suite refers to local stubs that use a transport other than HTTP or MQ.
  • The test suite refers to local stubs that use the HTTP transport.
  • The transport used in the tests in the test suite is configured with the host name set to localhost for the HTTP/TCP proxy.
  • The test suite has tests that use a transport and the transport requires third-party application Jar files for a successful run.
You must then refer to the following table for the next steps:
If... Then...

The tests in an API Suite refer to local stubs that use a transport other than HTTP or MQ.
You must perform any of the following actions before you commit the test asset to the remote repository:
  • Remove the reference to the local stub from the test suite.
  • Publish the stubs to HCL® Quality Server.

    To publish and edit stubs, see Publishing stubs.

The tests in an API Suite refer to local stubs that use the HTTP transport. You must perform the following actions before you commit the test asset to the remote repository:
  1. Create a test suite that contains the stub and tests that run on the stub.
  2. Configure the physical HTTP transport with the following parameters in the Client tab in the Physical View:
    • Set the Host name or IP address of the HTTP Proxy server in the Proxy Host field.
    • Set 3128 as the proxy server port in the Proxy Port field.
  3. Set the reference to the stub for the tests in the test suite scenario from the Scenario Editor dialog box from the Test Factory view by selecting the Live system option in the Satisfied by column to run the stubs on the HTTP proxy registered with HCL OneTest™ Server.
  4. Save the project.

The transport used in the tests in an API Suite is configured with the host name set to localhost for the HTTP/TCP proxy.

You must replace the host name with fully-qualified-domain-name or IPAddress of the proxy host in the tests before you commit the test asset to the remote repository.
You plan to run the API Suite on the computer where HCL OneTest™ Server is installed and the API Suite contains tests that use a transport from any of the following third-party applications:
  • Camel
  • CentraSite
  • CICS
  • Coherence
  • Database
  • IMS
  • Integra
  • JMS
  • SAP RFC
  • Software AG Universal Messaging
  • TIBCO EMS
  • TIBCO Rendezvous
  • TIBCO SmartSockets
  • WebSphere Application Server Service Integration Bus (SiBus)
  • WebLogic
  • Software AG webMethods
  • WebSphere MQ
You must complete the following tasks:
  1. Identify the location of the third-party application JAR files. You can use Library Manager to know the location where the third-party application JAR files are saved.
  2. Copy the third-party application JAR files to the computer where HCL OneTest™ Server is installed.
See Copying third-party application Jars to Kubernetes.
You plan to run the API Suite on a remote Docker host and the API Suite contains tests that use a transport from any of the following third-party applications:
  • Camel
  • CentraSite
  • CICS
  • Coherence
  • Database
  • IMS
  • Integra
  • JMS
  • SAP RFC
  • Software AG Universal Messaging
  • TIBCO EMS
  • TIBCO Rendezvous
  • TIBCO SmartSockets
  • WebSphere Application Server Service Integration Bus (SiBus)
  • WebLogic
  • Software AG webMethods
  • WebSphere MQ
You must complete the following tasks:
  1. Identify the location of the third-party application JAR files. You can use Library Manager to know the location where the third-party application JAR files are saved.
  2. Copy the third-party application JAR files to the computer where the remote Docker host is installed.
See Copying third-party application Jars to a remote Docker host.

Important information about report configuration in API Suites

You must configure test suites in HCL OneTest™ API to use a results database so that the details of the test results can be captured and displayed in the HCL OneTest™ Server API results reports. See Configuring the project results database.

If your server projects use either a Microsoft SQL Server, MYSQL, or both as a project results database, you must copy the Microsoft SQL Server and MySQL database JAR files to the JDBC folder in the path /data/JDBC on HCL OneTest™ Server. See Copying third-party application Jars to Kubernetes.

The database JAR files that you need are based on the version of Microsoft SQL Server or MQSQL that you use with HCL OneTest™ API. See Adding Microsoft SQL Server and MySQL drivers.

To run an API Suite, see Configuring an API Suite run.