CONTRIBUTING.md

Contributing new Actors

Table of Contents

• leapp-supplements
  • Table of Contents
  • Actor list
  • Testing your actor
    • Writing tests
    • Running the tests locally
    • Running the tests inside a container
      • Prerequisites
      • Running the containerized tests
      • Entering the containerized environment

Before starting

Familiarize yourself with the Leapp project documentation. The section Creating your first actor is a good place to start. You should also dig around the Leapp Dashboard to make sure the custom actor functionality you are considering doesn't already exist in the mainstream framework.

Testing your actor

Writing tests

Make sure to write tests for your actors as explained in Tests for Actors

Running the tests locally

To run the tests locally, use the simple make targets such as lint, pytest and test:

make test

Running the tests inside a container

Prerequisites

In order to run the containerized environment you will need to install strato-skipper

pip install strato-skipper

Running the containerized tests

The Makefile includes targets for running the tests inside the container. Each simple target has equivalent targets with a suffix of the environment, such as test-rhel8 or lint-rhel7:

make test-rhel8

Alternatively, you can use skipper directly by setting the SKIPPER_CONF environment variable. For example:

SKIPPER_CONF=${PWD}/skipper-rhel8.yaml skipper make test

Entering the containerized environment

The Makefile includes targets for entering specific environment. For example:

make shell-rhel8