Installation

Introduction

Skyramp automates functional and performance test generation across multiple programming languages and testing frameworks. To quickly get started, you'll install the Skyramp Command Line Interface (CLI) and relevant language-specific libraries.

Install or Upgrade Skyramp CLI

To install or upgrade the CLI, run the following command in your terminal:

bash -c "$(curl -fsSL https://skyramp.dev/installer.sh)"

Version check

Ensure Skyramp is successfully installed by verifying its version:

Your version should be v1.2.5 or later.

Skyramp Libraries

Depending on your preferred language and test environment, please follow these installation steps.

Python

Prerequisites

To use Skyramp with Python, please ensure you are using a supported version of the following dependencies:

• Python 3.9.6 or higher

Install the Skyramp Python Library

The Skyramp Python library provides the core functionality required for test generation and execution in Python environments. Use pip to install it:

TypeScript

Prerequisites

To use Skyramp with TypeScript, please ensure you are using supported versions of the following dependencies:

• Node 20 or higher

Install TypeScript with Node typings

Install required TypeScript and Node.js typings:

npm

Install the Skyramp TypeScript Library

The Skyramp Typescript library provides the core functionality for test generation and execution in a TypeScript environment. Use npm to install it:

npm

Java

Prerequisites

To use Skyramp with Java, please ensure you are using supported versions of the following dependencies:

• Java 17 or higher

Install the Skyramp Java Library

The Skyramp Java library provides the core functionality for test generation and execution in Java-based environments. Use wget to download it:

SKYRAMP_VER="1.2.5"
wget -P lib https://repo1.maven.org/maven2/dev/skyramp/skyramp-library/${SKYRAMP_VER}/skyramp-library-${SKYRAMP_VER}

To update the Skyramp Java library, re-run this command with the specific version of choice passed into SKYRAMP_VER.

Test Framework Installation

Skyramp fits seamlessly with your existing testing stack. Based on your preferences, you can use Skyramp with several popular testing frameworks.

Pytest

Pytest is a popular testing framework that provides extensive capabilities for running and structuring test cases. Install Pytest using the following command:

Playwright

NOTE: Playwright installation is a requirement for generating UI and E2E tests.

Playwright is a powerful automation and testing framework capable of handling browser-based and API testing across multiple browser platforms. It provides fast, reliable, and isolated execution environments, enhancing both developer productivity and test execution reliability.

Install Playwright for your language of choice:

Playwright for Python:

Playwright for TypeScript:

npm

JUnit

NOTE: JUnit installation is a requirement for executing Java tests.

JUnit is the most popular Java testing framework widely used for unit, integration, and functional testing. It provides an intuitive API, powerful annotations for flexible test configurations, and extensive community support, making it the standard for enterprise Java projects.

Set versions and download the necessary JAR files:

JUNIT_PLATFORM_VER="1.9.3"
JUNIT_JUPITER_VER="5.11.4"
wget -P lib https://repo1.maven.org/maven2/org/junit/platform/junit-platform-console-standalone/${JUNIT_PLATFORM_VER}/junit-platform-console-standalone-${JUNIT_PLATFORM_VER}.jar
wget -P lib https://repo1.maven.org/maven2/org/junit/jupiter/junit-jupiter-api/${JUNIT_JUPITER_VER}/junit-jupiter-api-${JUNIT_JUPITER_VER}

To update JUnit libraries, re-run this command with the specific versions of choice passed into JUNIT_PLATFORM_VER and JUNIT_JUPITER_VER.

Robot Framework

Robot Framework is a versatile keyword-driven automation framework that supports acceptance test-driven development (ATDD). It's highly extensible, supports a wide range of test scenarios, and is ideal for teams seeking readable and maintainable test suites.

Install Robot Framework using the following command:

Uninstall Skyramp

To uninstall the Skyramp CLI and remove all associated components, run:

/bin/bash -c "$(curl -fsSL https://skyramp.dev/uninstaller.sh)"

System Requirements

Ensure your system meets these requirements:

• Mac OS X: 11.0 or later

• Ubuntu: 18.04 or later

• CentOS: 8.04 or later

• Fedora: 36.0 or later

• Windows Subsystem for Linux (WSL): 1

What’s Next

Now that you have Skyramp installed, go to Generating Your First Test to start using Skyramp. This page will guide you through generating and executing your first test with Skyramp.