Home
Getting Started
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
Testing methodology
By following four basic guidelines, you can incorporate HCL OneTest™ API into your testing methodology. These guidelines drive efficient and expedient integration testing, and they can be applied to your testing process and infrastructure requirements.
Building tests
HCL OneTest™ API separates the task of learning about the system from the tasks of creating test resources, designing (building models), creating and recording test assets, and running tests.
Building system models by using synchronization
When design-time assets are available, building by using synchronization is the preferred technique. Synchronization builds the system under test for you, which simplifies your testing work.

Getting Started
This guide provides an overview and describes the tasks to get you started with HCL OneTest™ API.
- HCL OneTest™ API overview
  You can use HCL OneTest™ API to create, modify, and run service tests.
- Testing methodology
  By following four basic guidelines, you can incorporate HCL OneTest™ API into your testing methodology. These guidelines drive efficient and expedient integration testing, and they can be applied to your testing process and infrastructure requirements.
  - Test approach
    The HCL OneTest™ Studio product suite fits easily into a V-Model approach. The classic V-Model demonstrates each phase in predevelopment and its associated phase in test planning. For example, when the system design is delivered, begin planning for system testing. Testing activities such as design, analysis, planning and execution must happen throughout the entire project life cycle.
  - Test phases
    Apart from being used for driving early test plans, HCL OneTest™ API can be used to shift testing earlier in the software development lifecycle (SDLC) than is traditionally possible with standard test tools that test at the UI level. Soon after you have a local build, you can use HCL OneTest API to do service unit testing.
  - Building tests
    HCL OneTest™ API separates the task of learning about the system from the tasks of creating test resources, designing (building models), creating and recording test assets, and running tests.
    - Options for creating test resources
      HCL OneTest™ API includes a number of options for automated resource creation, including topology discovery, synchronization, and recording.
    - Building system models by using synchronization
      When design-time assets are available, building by using synchronization is the preferred technique. Synchronization builds the system under test for you, which simplifies your testing work.
    - Building a system model manually
      Manual system modeling can be done where synchronization or recording is not possible or there are no service components when synchronized.
    - Test asset creation and recording
      HCL OneTest™ API enables you to record events in the system under test and recorded messages can be used to create tests and stubs more quickly and accurately. This can act as base message and test data for creating ongoing test assets.
    - Test execution
      In HCL OneTest™ API, tests generally consist of one or more inputs into the systems under test (SUT), and then validation of results and side effects. Data from one step of a test can be used to feed the next step. HCL OneTest API is built for testing, so every test step can be validated without scripting.
  - Project structure
    When an HCL OneTest™ API project is created for the first time, the project folder structure is created on a disk.
- Service-oriented architecture (SOA) testing
  A SOA consists of business processes that are implemented by linking individual services. The linking can be done programmatically or with tools based on Business Process Execution Language (BPEL). SOA testing can be challenging because there is no GUI; the focus is on testing interfaces and services.
- Getting started with testing
  You can start using HCL OneTest™ API by completing the preliminary tasks such as creating and running a test, creating and running a stub, recording an HTTP proxy, and running a stub in a Docker container.
- HCL® Quality Server overview
  HCL OneTest™ Virtualization stubs designed in HCL OneTest API are published to HCL® Quality Server, which holds them in a repository.
- HCL OneTest™ API accessibility features
  Users who have a physical disability, such as limited vision, can review the available accessibility features to use HCL OneTest™ API.

Building system models by using synchronization

When design-time assets are available, building by using synchronization is the preferred technique. Synchronization builds the system under test for you, which simplifies your testing work.

The Architectural School perspective is used to build a simple, graphical view of the system under test. The main aim of building this system model is to understand and validate the dependencies, interactions, and constraints between the interfaces. By itself, the system model does not contain enough information to be testable. To enable the creation and execution of tests, the configuration details of the infrastructure components that make up the logical system must be provided. HCL OneTest™ API provides this synchronization capability to simplify this process. Synchronization does the work of building the system under test and automatically adds logical and physical components, dependencies, and interactions.

Consider the following points:

Use the synchronization process for modeling and testing web services.
After the synchronization is complete, verify that the components are synchronized. You can verify the services, operations, schemas, dependencies, and their interactions. This stage is a checkpoint for you to decide on one of the following course of action:
- Move forward to the next phase of activity, such as recording initial messages and creating tests
- Revisit the system model to rectify the invalid or missing components