Welcome
Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
API Tester Guide (Service Virtualization)
This guide describes the tasks that you can perform for using virtual services or stubs to simulate parts of an environment if the real services are not yet available or because they are difficult or expensive to use. This guide is intended for API Testers.
Publishing and running stubs
You can publish stubs that are created in HCL OneTest™ API to HCL Quality Server, Dockerfile and build context, Kubernetes, or Istio, if the stub is based on a supported transport.
Controlling running stubs
You can control stubs that are running in a number of ways.
Query Docker container logs
You can use the docker logs commands to query Docker container logs.

Release Notes
This document contains information about What's new, installation, known issues, known limitations, and contact information of HCL support.
System Requirements
This document includes information about hardware and software requirements for HCL OneTest™ API.
Getting Started
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
Administrator Guide
This guide describes how to install HCL OneTest™ API. After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
- API Tester Reference
  This guide provides the topics to help the API tester use the product by using the user interface, commands or scripts. This guide is intended for API testers.
- API Tester Guide (Service Virtualization)
  This guide describes the tasks that you can perform for using virtual services or stubs to simulate parts of an environment if the real services are not yet available or because they are difficult or expensive to use. This guide is intended for API Testers.
  - HCL OneTest™ Virtualization overview
    HCL OneTest™ Virtualization is software that is used for creating, maintaining, publishing, and running message-based stubs and database stubs.
  - Task flow: Working with the HCL Quality Server Environments dashboard
    You can use the HCL Quality Server Environments dashboard to perform various tasks such as starting, stopping stubs and scenarios, and modifying stub configurations after you have published stubs to HCL Quality Server. You can also lock the environment that contain the published stubs.
  - Virtualizing HTTP
    You can simulate an HTTP connection with a virtual service, also known as a stub.
  - Virtualizing HTTPS
    You can simulate an HTTPS connection with a virtual service, also known as a stub.
  - Virtualizing TCP
    You can simulate a TCP connection with a virtual service, also known as a stub.
  - Virtualizing a REST API without recording or synchronization
    You can virtualize REST APIs by using the Recording Studio, or by synchronizing WADL, Swagger, or RAML documents. When none of these options is available, you can still manually virtualize REST APIs that use path parameters.
  - Creating message-based stubs
    In HCL OneTest™ API, there are several methods that you can use to create a message-based stub.
  - Modifying message-based stubs
    You can use either the Test Editor or the Stub Editor to create, modify, and enhance any legacy or new stubs created by HCL OneTest™ API.
  - Creating and modifying database stubs
    You can create and modify database stubs in HCL OneTest™ API.
  - Configuring stubs to connect to HCL Quality Server and the HTTP proxy
    A stub running on its own may not be sufficient in some cases, because it might have dependencies on services such as HCL Quality Server or the HTTP proxy. If the stub is running on the public cloud and the services are running in the enterprise, you must configure the stub to connect to these services.
  - Publishing and running stubs
    You can publish stubs that are created in HCL OneTest™ API to HCL Quality Server, Dockerfile and build context, Kubernetes, or Istio, if the stub is based on a supported transport.
    - Publishing stubs
      You can publish a stub to HCL Quality Server, Dockerfile and build context, Kubernetes, or Istio with Kubernetes by using the HCL OneTest™ API Publish Stubs wizard.
    - Running stubs
      Several methods are available to start and stop the stubs. You can also modify and control stubs while they are running.
    - Modifying running stubs
      If you are using HCL OneTest™ API to run a stub, you can modify the stub while it is running.
    - Controlling running stubs
      You can control stubs that are running in a number of ways.
      - Locking and unlocking environments
        Locking a HCL Quality Server environment prevents other users from starting or stopping stubs in that environment.
      - Viewing broken stub messages
        On HCL Quality Server Environments Dashboard page, if a stub fails to start (irrespective of from where the stub is started) and displays a Broken state, placing your mouse pointer over the stub displays a message about the possible cause for the Broken state. See the Agent logs for more details of the cause.
      - Viewing stub logs
        HCL Quality Server enables HCL OneTest™ Virtualization users to view the console output of stubs that ran in the selected domain and environment.
      - Query Docker container logs
        You can use the docker logs commands to query Docker container logs.
      - Debugging message-based stubs
        Use the Message Differences window or options available within the stub console display to debug message-based stubs.
    - Behaviors for stubs
      You can create a simple behavior called "echo" that will expose one function and one event for use by a HCL OneTest™ Virtualization stub.
  - Viewing results in HCL Quality Server
    You can use HCL Quality Server to display the results of tests that you run in both HCL OneTest™ API and HCL Quality Server.
  - Viewing usage statistics of virtual services in HCL Quality Server
    HCL Quality Server collects and stores usage metric data. The metric data might include the number and types of actions that are used, the features that are used in the workbench, details about Operating System or languages set while running, and so forth. You cannot view the metric data on the HCL Quality Server user interface, but it is available from the underlying implementation. Storage is either managed by H2 or optionally Apache Cassandra. For more information about the H2 database and its management, see sections A. Server Configuration and D. Deleting Data.
  - Viewing reports in HCL OneTest™ Server
    All the project stakeholders can view test reports for multiple testing products from the Results page on HCL OneTest™ Server. You can access the Results page from a web browser. Therefore, there is no need to install the desktop client.
  - Troubleshooting: HCL OneTest™ Virtualization
    You can use workarounds to common problems that you might encounter when you use HCL OneTest™ Virtualization.
Test Manager Guide
This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
Troubleshooting HCL OneTest™ API
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
HCL OneTest™ API reference
HCL OneTest™ API is a scripting-free environment for developing tests for service-oriented architecture (SOA) messaging and business process integration projects. Tests can be built by recording existing system behaviors or from requirements, by entering the data to send and the data that is expected in return.
Security Considerations
You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
Notices
This document provides information about copyright, trademarks, terms and conditions for product documentation.

Query Docker container logs

You can use the docker logs commands to query Docker container logs.

To query container logs, use the docker logs command. For more information about the docker logs command, see the Docker Documentation.

To see the sysout or syserr logs from a Docker container:

docker logs <container_id>

HCL OneTest™ API logs at warning level by default. Along with modifying the logging.properties in the container to change the log settings, you can also pass an environment variable when running the container to set a logging level for HCL OneTest™ API:

-e RUNTESTS_LOG_LEVEL=ERROR

-e RUNTESTS_LOG_LEVEL=WARN

-e RUNTESTS_LOG_LEVEL=INFO

-e RUNTESTS_LOG_LEVEL=DEBUG

For more information about the environment variable that you can use to set the logging level for HCL OneTest™ API, see Running stubs in a Docker container.