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.
Project structure
When an HCL OneTest™ API project is created for the first time, the project folder structure is created on a disk.

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.
  - Project structure
    When an HCL OneTest™ API project is created for the first time, the project folder structure is created on a disk.
    - Folder structures
      As the number of artifacts grows, a project might start to look disorganized and tests and stubs might become difficult to locate. Adding meaningful logical folder structures means that test artifacts can be organized neatly and found quickly.
    - Architecture school
      Architecture School is the default perspective of HCL OneTest™ API. In this perspective, you build the system to be tested in a simple, graphical fashion, and define the logical and physical system components and their relationships to one another.
    - Implementing tests
      As the number of tests grows, it is important to be able to differentiate tests. If you can deduce information from the test name, you avoid wasting time while searching for a specific test.
- 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.

Project structure

When an HCL OneTest™ API project is created for the first time, the project folder structure is created on a disk.

Project structure

To implement tests and stubs, the following things are needed:

Certain artifacts such as schemas and executable files (psftp.exe for file transfers)
Test data in spreadsheets

On implementation, test suites are generated. All of these artifacts are referenced within your project. If you change their locations while moving the project to another computer, the tests can break. For example, when publishing stubs to HCL® Quality Server, all referenced artifacts, such as test data, also need to be published.

Consider the following points:

Make sure that projects are as self-contained as possible. Moving project locations must not break tests.
Create new folders within the project folder to store artifacts, such as schemas, test data, executables, Apache Ant scripts, and reports.
Where possible, put the schema source data into a project. This helps with portability of your project.
HCL OneTest™ API caches external WSDL, XSD, JSON, and Copybook schema sources, their external dependencies, or both into a /Schemas/ folder inside a JAR file.
Changes to the external schema data source are not reflected in the project's test artifacts until the project is manually synchronized with the schema source. Schema source data that is stored inside the project is loaded upon first use.