Installation

Skyramp has two parts you need to install to start generating tests: the command line interface client on your system, and the language-specific library.

1. CLI installation

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

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

Version check

Verify that Skyramp was installed successfully by checking that the version is at least v0.5.1 or later:

skyramp version

1.1 Using Python libraries

To generate and execute tests in Python, install the required dependencies using pip. These libraries enable Skyramp to integrate with Python testing frameworks such as Pytest or Robot Framework.

1.1.1 Install the Skyramp library

The Skyramp Python library provides the core functionality required for test generation and execution in Python environments. Install it by entering the following command in your terminal:

pip install skyramp

1.1.2 Install Pytest

Pytest is a popular testing framework that provides extensive capabilities for running and structuring test cases. If you plan to use Pytest to run your tests, install it by entering the following command in your terminal:

pip install pytest

1.1.3 Install the Robot framework

The Robot Framework is a keyword-driven testing framework widely used for automation and acceptance testing. For test execution using the Robot Framework, install it by entering the following command in your terminal:

pip install robotframework

Now that you have installed the libraries and test framework, you can generate your first test.

1.2 Using Typescript Libraries

To generate and execute tests in TypeScript, install the necessary dependencies using npm. These dependencies allow Skyramp to integrate with Playwright for browser automation and API testing.

1.2.1 Install the Skyramp library

The Skyramp Typescript library provides the core functionality for test generation and execution in a TypeScript environment. Install it by entering the following command in your terminal:

npm install @skyramp/skyramp

1.2.2 Install Playwright

Playwright is a Typescript-based end-to-end testing framework that enables automation across different browsers. To run test cases using Playwright, install the dependencies by entering the following commands in your terminal:

npm init -y
npm install --save-dev typescript @types/node
npm install playwright @playwright/test

Now that you have installed the libraries and test framework, you can generate your first test.

1.3 Using Java libraries

To generate and execute tests in Java, install the necessary dependencies using wget. These dependencies allow Skyramp to integrate with JUnit, a widely-used testing framework in Java.

1.3.1 Install the Skyramp library

The Skyramp Java library provides the core functionality for test generation and execution in a Java-based environments. Install it by entering the following command in your terminal:

wget -P lib https://repo1.maven.org/maven2/dev/skyramp/skyramp-library/0.5.6/skyramp-library-0.5.6.jar

1.3.2 Install JUnit

JUnit is a widely-used testing framework for Java. Install the necessary JUnit dependencies by entering the following command in your terminal:

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}.jar

Now that you have installed the libraries and test framework, you can generate your first test.

2. Uninstalling the Skyramp Client

To uninstall the Skyramp Client, run the following command in your terminal:

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

This command will uninstall the Skyramp CLI and remove any associated components from your system.

3. Supported Operating Systems

Skyramp is compatible with the following operating systems:

• 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

Ensure that your system meets these requirements before proceeding with the installation.

What’s Next

Now that you have Skyramp installed, go to the Generate & Run a Test section to start using Skyramp. This section will guide you through running your first test and customizing test parameters to fit your requirements.