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

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

First, install dependencies and set up the virtualenv:

make install-deps-fedora

Then run tests:

make test

You can also run individual targets:

make lint
make test_no_lint
make codespell
make fast_lint

Running the tests inside a container

Prerequisites

You will need podman installed on your system.

Running the containerized tests

The Makefile includes targets for running the tests inside a container:

make test_container

By default, tests run in an el9 container. To use a different container:

TEST_CONTAINER=el8 make test_container
TEST_CONTAINER=el10 make test_container

You can also run only lint or only tests in a container:

make lint_container
TEST_CONTAINER=el8 make test_container_no_lint
TEST_CONTAINER=el10 make lint_container