tmt.plugins.plan_shapers package

Submodules

tmt.plugins.plan_shapers.max_tests module

class tmt.plugins.plan_shapers.max_tests.MaxTestsPlanShaper(*args: Any, **kwargs: Any)

Bases: PlanShaper

Reshape a plan by limiting the number of tests in a plan.

Initialize name and relation with the parent object

Prepare the workdir for provided id / directory path or generate a new workdir name if workdir=True given. Store command line context and options for future use if context is provided.

classmethod apply(plan: Plan, tests: list[TestOrigin]) → Iterator[Plan]

Apply the shaper to a given plan and a set of tests.

Returns:

a sequence of plans replacing the original plan.

classmethod check(plan: Plan, tests: list[TestOrigin]) → bool

Check whether this shaper should be applied to the given plan.

Returns:

True when the shaper would apply to the given plan.

cli_invocation: 'tmt.cli.CliInvocation' | None = None

classmethod run_options() → list[ClickOptionDecoratorType]

Return additional options for tmt run.

tmt.plugins.plan_shapers.repeat module

class tmt.plugins.plan_shapers.repeat.RepeatPlanShaper(*args: Any, **kwargs: Any)

Bases: PlanShaper

Initialize name and relation with the parent object

Prepare the workdir for provided id / directory path or generate a new workdir name if workdir=True given. Store command line context and options for future use if context is provided.

classmethod apply(plan: Plan, tests: list[TestOrigin]) → Iterator[Plan]

Apply the shaper to a given plan and a set of tests.

Returns:

a sequence of plans replacing the original plan.

classmethod check(plan: Plan, tests: list[TestOrigin]) → bool

Check whether this shaper should be applied to the given plan.

Returns:

True when the shaper would apply to the given plan.

cli_invocation: 'tmt.cli.CliInvocation' | None = None

classmethod run_options() → list[ClickOptionDecoratorType]

Return additional options for tmt run.

Module contents

class tmt.plugins.plan_shapers.PlanShaper(*args: Any, **kwargs: Any)

Bases: Common

A base class for plan shaper plugins.

Initialize name and relation with the parent object

Prepare the workdir for provided id / directory path or generate a new workdir name if workdir=True given. Store command line context and options for future use if context is provided.

abstractmethod classmethod apply(plan: Plan, tests: list[TestOrigin]) → Iterator[Plan]

Apply the shaper to a given plan and a set of tests.

Returns:

a sequence of plans replacing the original plan.

abstractmethod classmethod check(plan: Plan, tests: list[TestOrigin]) → bool

Check whether this shaper should be applied to the given plan.

Returns:

True when the shaper would apply to the given plan.

cli_invocation: 'tmt.cli.CliInvocation' | None = None

abstractmethod classmethod run_options() → list[ClickOptionDecoratorType]

Return additional options for tmt run.