# Getting Started

This is the official OpenTAP documentation for users and developers.

# What is OpenTAP

OpenTAP is an Open Source project for fast and easy development and execution of automated tests.

OpenTAP is built with simplicity, scalability and speed in mind, and is based on an extendable architecture that leverages .NET Core. OpenTAP offers a range of sequencing functionality and infrastructure that makes it possible for you to quickly develop plugins tailored for your automation needs – plugins that can be shared with the OpenTAP community through the OpenTAP package repository.

Learn more about OpenTAP here.

# Install OpenTAP

# Windows

  1. Download OpenTAP from our homepage here.
  2. Start the installer.

We recommend that you download the Software Development Kit, or simply the Developer’s System Community Edition provided by Keysight Technologies. The Developer System is a bundle that contains the SDK as well as a graphical user interface and result viewing capabilities. It can be installed by typing the following:

tap package install "Developer's System CE" -y

# Linux

# 1. Install dependencies

On Linux, OpenTAP has a few dependencies that must be manually installed, namely libc6, libunwind, unzip, git, and curl. On Debian derivatives, these can be installed by running the following command:

apt-get install libc6-dev libunwind8 unzip git curl

Note that the packages may have different names on other distributions. OpenTAP should still work if you install the equivalent packages for your distribution.

In addition to these packages, OpenTAP depends on dotnet core runtime version 2.1. Version 3.0 and greater are not supported. The installation procedure depends on your distribution. Please see the official documentation from Microsoft for further instructions.

# 2. Install OpenTAP

Download the OpenTAP distribution (.tar) from our homepage here.

Install the downloaded distribution:

  • .tar do the following:
    1. Untar the package in you home directory tar -xf OpenTAP*.tar
    2. Change the permission of the INSTALL.sh file to be executable: chmod u+x INSTALL.sh
    3. Run the INSTALL.sh script: ./INSTALL.sh.

# Docker

We also provide docker images for running OpenTAP. You can find them at hub.docker.com/r/opentapio/opentap.

We maintain two images:

  1. a development image which includes all necessary tools to build OpenTAP projects (~2.5GB)
  2. a production image which includes only dependencies required to run OpenTAP (~330MB)

The development image is widely used for building and packaging plugins in highly reproducible environments, and we use it internally for continuous deployment. Have a look at the Demonstration plugin's gitlab CI file where we build, test, version, and publish the plugin directly in a continuous integration pipeline.

# Where to go next

Are you already an OpenTAP user, or want to try it out? Have a look at the User Guide.

Are you a developer and want to create plugins for OpenTAP? Have a look at the Developer Guide.