Remove prepare/install fields leaking into prepare step data (#2986)

* Remove prepare/install fields leaking into prepare step data
teemtee · Jun 28, 2024 · 1bc2cb9 · 1bc2cb9
1 parent 9717fc4
commit 1bc2cb9
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 15 deletions.
diff --git a/tmt/steps/__init__.py b/tmt/steps/__init__.py
@@ -222,6 +222,9 @@ class _RawStepData(TypedDict, total=False):
     how: Optional[str]
     name: Optional[str]
 
+    summary: Optional[str]
+    order: Optional[int]
+
 
 RawStepDataArgument = Union[_RawStepData, list[_RawStepData]]
 
@@ -302,6 +305,10 @@ def from_spec(  # type: ignore[override]
         return data
 
 
+class RawWhereableStepData(TypedDict, total=False):
+    where: Union[str, list[str]]
+
+
 @dataclasses.dataclass
 class WhereableStepData:
     """

diff --git a/tmt/steps/execute/upgrade.py b/tmt/steps/execute/upgrade.py
@@ -15,7 +15,8 @@
 from tmt.steps.discover.fmf import DiscoverFmf, DiscoverFmfStepData, normalize_ref
 from tmt.steps.execute import ExecutePlugin
 from tmt.steps.execute.internal import ExecuteInternal, ExecuteInternalData
-from tmt.steps.prepare import PreparePlugin, _RawPrepareStepData
+from tmt.steps.prepare import PreparePlugin
+from tmt.steps.prepare.install import _RawPrepareInstallStepData
 from tmt.utils import Environment, EnvVarValue, Path, field
 
 STATUS_VARIABLE = 'IN_PLACE_UPGRADE'
@@ -266,7 +267,7 @@ def _install_dependencies(
             recommends: bool = False) -> None:
         """ Install packages required/recommended for upgrade """
         phase_name = 'recommended' if recommends else 'required'
-        data: _RawPrepareStepData = {
+        data: _RawPrepareInstallStepData = {
             'how': 'install',
             'name': f'{phase_name}-packages-upgrade',
             'summary': f'Install packages {phase_name} by the upgrade',

diff --git a/tmt/steps/prepare/__init__.py b/tmt/steps/prepare/__init__.py
@@ -1,4 +1,3 @@
-import collections
 import copy
 import dataclasses
 from typing import (
@@ -48,14 +47,8 @@ class PrepareStepData(tmt.steps.WhereableStepData, tmt.steps.StepData):
 PrepareStepDataT = TypeVar('PrepareStepDataT', bound=PrepareStepData)
 
 
-class _RawPrepareStepData(tmt.steps._RawStepData, total=False):
-    where: Optional[list[str]]
-    package: list[str]
-    missing: str
-    roles: collections.defaultdict[str, list[str]]
-    hosts: dict[str, str]
-    order: int
-    summary: str
+class _RawPrepareStepData(tmt.steps._RawStepData, tmt.steps.RawWhereableStepData, total=False):
+    pass
 
 
 class PreparePlugin(tmt.steps.Plugin[PrepareStepDataT]):
@@ -277,6 +270,8 @@ def as_key(self) -> frozenset['tmt.base.DependencySimple']:
         #
         # 1. make the list of requirements unique,
         # 2. group guests with same requirements.
+        from tmt.steps.prepare.install import _RawPrepareInstallStepData
+
         pruned_requires: dict[frozenset[tmt.base.DependencySimple], DependencyCollection] = {}
         pruned_recommends: dict[frozenset[tmt.base.DependencySimple], DependencyCollection] = {}
 
@@ -302,7 +297,7 @@ def as_key(self) -> frozenset['tmt.base.DependencySimple']:
             if not collection.dependencies:
                 continue
 
-            data: _RawPrepareStepData = {
+            data: _RawPrepareInstallStepData = {
                 'how': 'install',
                 'name': 'requires',
                 'summary': 'Install required packages',

diff --git a/tmt/steps/prepare/distgit.py b/tmt/steps/prepare/distgit.py
@@ -8,7 +8,8 @@
 import tmt.steps.prepare
 import tmt.utils
 from tmt.package_managers import Package
-from tmt.steps.prepare import PreparePlugin, _RawPrepareStepData
+from tmt.steps.prepare import PreparePlugin
+from tmt.steps.prepare.install import _RawPrepareInstallStepData
 from tmt.steps.provision import Guest
 from tmt.utils import Command, Path, ShellScript, field, uniq
 
@@ -53,7 +54,7 @@ def insert_to_prepare_step(
     prepare_step = discover_plugin.step.plan.prepare
     where = cast(tmt.steps.discover.DiscoverStepData, discover_plugin.data).where
     # Future install require
-    data_require: _RawPrepareStepData = {
+    data_require: _RawPrepareInstallStepData = {
         'how': 'install',
         'name': 'requires (dist-git)',
                 'summary': 'Install required packages of tests detected by dist-git',
@@ -66,7 +67,7 @@ def insert_to_prepare_step(
     prepare_step._phases.append(future_requires)
 
     # Future install recommend
-    data_recommend: _RawPrepareStepData = {
+    data_recommend: _RawPrepareInstallStepData = {
         'how': 'install',
         'name': 'recommends (dist-git)',
                 'summary': 'Install recommended packages of tests detected by dist-git',

diff --git a/tmt/steps/prepare/install.py b/tmt/steps/prepare/install.py
@@ -525,6 +525,14 @@ def install_debuginfo(self) -> None:
             'installing debuginfo packages.')
 
 
+class _RawPrepareInstallStepData(tmt.steps.prepare._RawPrepareStepData, total=False):
+    package: Union[str, list[str]]
+    directory: Union[str, list[str]]
+    copr: Union[str, list[str]]
+    exclude: Union[str, list[str]]
+    missing: str
+
+
 @dataclasses.dataclass
 class PrepareInstallData(tmt.steps.prepare.PrepareStepData):
     package: list[tmt.base.DependencySimple] = field(