Move Environment class to its own module (#5041)

Making `tmt.utils` smaller, but also part of the secrets implementation:
by moving `Environment` and few other bits, it should be possible to
close access to `os.environ`.

A lot of changes, but just moves - some `tmt.utils.Environment` turned
into `from tmt.utils.environment import Environment` + bare
`Environment`; the string would have to change anyway, so at least we
can treat `Environment` as a well-known name in the codebase.

Related to #2609.

Author: happz

tests/unit/test_guest.py

@@ -21,14 +21,14 @@
 from tmt.utils import (
     Command,
     CommandOutput,
-    Environment,
     GeneralError,
     OnProcessEndCallback,
     OnProcessStartCallback,
     Path,
     RunError,
     ShellScript,
 )
+from tmt.utils.environment import Environment
 from tmt.utils.wait import Waiting
 
 from . import TEST_CONTAINERS

tests/unit/test_steps.py

@@ -8,10 +8,10 @@
 import tmt.guest
 import tmt.queue
 import tmt.steps
-import tmt.utils
 from tmt.log import Logger
 from tmt.steps import Phase
 from tmt.utils import GeneralError
+from tmt.utils.environment import Environment
 
 
 class TestPhaseAssertFeelingSafe:
@@ -77,7 +77,7 @@ def go(
             self,
             *,
             guest: tmt.guest.Guest,
-            environment: Optional[tmt.utils.Environment] = None,
+            environment: Optional[Environment] = None,
             logger: Logger,
         ) -> None:
             pass

tests/unit/test_utils.py

@@ -39,6 +39,7 @@
     duration_to_seconds,
     filter_paths,
 )
+from tmt.utils.environment import Environment
 from tmt.utils.git import (
     clonable_git_url,
     git_add,
@@ -1536,7 +1537,7 @@ def test_locate_key_origin_empty_defined(id_tree_empty: fmf.Tree) -> None:
             """,  # noqa: E501
         ),
         # environment
-        (tmt.utils.Environment.from_dict({'FOO': 'BAR'}), None, 'FOO\033[0m: BAR'),
+        (Environment.from_dict({'FOO': 'BAR'}), None, 'FOO\033[0m: BAR'),
         # fmf context
         (
             tmt.utils.FmfContext({'foo': ['bar', 'baz']}),

tmt/base/core.py

@@ -64,14 +64,14 @@
 from tmt.lint import LinterOutcome, LinterReturn
 from tmt.result import ResultInterpret
 from tmt.utils import (
-    Environment,
     FmfContext,
     Path,
     ShellScript,
     normalize_shell_script,
     to_yaml,
     verdict,
 )
+from tmt.utils.environment import Environment
 from tmt.utils.themes import style
 
 if TYPE_CHECKING:
@@ -1198,11 +1198,11 @@ class Test(
         normalize=normalize_require,
         exporter=lambda value: [dependency.to_minimal_spec() for dependency in value],
     )
-    environment: tmt.utils.Environment = field(
-        default_factory=tmt.utils.Environment,
-        normalize=tmt.utils.Environment.normalize,
+    environment: Environment = field(
+        default_factory=Environment,
+        normalize=Environment.normalize,
         serialize=lambda environment: environment.to_fmf_spec(),
-        unserialize=lambda serialized: tmt.utils.Environment.from_fmf_spec(serialized),
+        unserialize=lambda serialized: Environment.from_fmf_spec(serialized),
         exporter=lambda environment: environment.to_fmf_spec(),
     )
 

tmt/base/plan.py

@@ -49,17 +49,15 @@
 from tmt.lint import LinterOutcome, LinterReturn
 from tmt.utils import (
     Command,
-    Environment,
-    EnvVarValue,
     FmfContext,
     GeneralError,
-    HasEnvironment,
     HasPlanWorkdir,
     HasRunWorkdir,
     HasUserAnchorPath,
     style,
     to_yaml,
 )
+from tmt.utils.environment import Environment, EnvVarValue, HasEnvironment
 
 if TYPE_CHECKING:
     import tmt.cli

tmt/base/run.py

@@ -39,15 +39,14 @@
 from tmt.result import Result
 from tmt.utils import (
     Command,
-    Environment,
     GeneralError,
-    HasEnvironment,
     HasRunWorkdir,
     HasUserAnchorPath,
     Path,
     StateFormat,
     WorkdirArgumentType,
 )
+from tmt.utils.environment import Environment, HasEnvironment
 
 if TYPE_CHECKING:
     import tmt.cli
@@ -73,7 +72,7 @@ class RunData(SerializableContainer):
     environment: Environment = field(
         default_factory=Environment,
         serialize=lambda environment: environment.to_fmf_spec(),
-        unserialize=lambda serialized: tmt.utils.Environment.from_fmf_spec(serialized),
+        unserialize=lambda serialized: Environment.from_fmf_spec(serialized),
     )
 
 
@@ -333,7 +332,7 @@ def _environment_from_cli(self) -> Environment:
 
         assert self.tree is not None  # narrow type
 
-        return tmt.utils.Environment.from_cli_options(
+        return Environment.from_cli_options(
             raw_cli_environment_files=self.opt('environment-file') or [],
             raw_cli_environment=self.opt('environment') or [],
             file_root=Path(self.tree.root) if self.tree.root else None,

tmt/checks/__init__.py

@@ -14,6 +14,7 @@
 )
 from tmt.plugins import PluginRegistry
 from tmt.utils import NormalizeKeysMixin
+from tmt.utils.environment import Environment
 
 if TYPE_CHECKING:
     import tmt.base.core
@@ -163,7 +164,7 @@ def go(
         *,
         event: CheckEvent,
         invocation: 'TestInvocation',
-        environment: Optional[tmt.utils.Environment] = None,
+        environment: Optional[Environment] = None,
         logger: tmt.log.Logger,
     ) -> list['CheckResult']:
         """
@@ -268,7 +269,7 @@ def before_test(
         *,
         check: CheckT,
         invocation: 'TestInvocation',
-        environment: Optional[tmt.utils.Environment] = None,
+        environment: Optional[Environment] = None,
         logger: tmt.log.Logger,
     ) -> list['CheckResult']:
         return []
@@ -279,7 +280,7 @@ def after_test(
         *,
         check: CheckT,
         invocation: 'TestInvocation',
-        environment: Optional[tmt.utils.Environment] = None,
+        environment: Optional[Environment] = None,
         logger: tmt.log.Logger,
     ) -> list['CheckResult']:
         return []

tmt/checks/avc.py

@@ -21,6 +21,7 @@
     render_command_report,
     safe_call,
 )
+from tmt.utils.environment import Environment
 from tmt.utils.hints import hints_as_notes
 
 if TYPE_CHECKING:
@@ -493,7 +494,7 @@ def before_test(
         *,
         check: 'AvcCheck',
         invocation: 'TestInvocation',
-        environment: Optional[tmt.utils.Environment] = None,
+        environment: Optional[Environment] = None,
         logger: tmt.log.Logger,
     ) -> list[CheckResult]:
         if invocation.guest.facts.has_selinux:
@@ -507,7 +508,7 @@ def after_test(
         *,
         check: 'AvcCheck',
         invocation: 'TestInvocation',
-        environment: Optional[tmt.utils.Environment] = None,
+        environment: Optional[Environment] = None,
         logger: tmt.log.Logger,
     ) -> list[CheckResult]:
         if not invocation.guest.facts.has_selinux:

tmt/checks/coredump.py

@@ -9,6 +9,7 @@
 from tmt.container import container, field
 from tmt.result import CheckResult, ResultOutcome, save_failures
 from tmt.utils import Command, Path, ShellScript
+from tmt.utils.environment import Environment
 
 if TYPE_CHECKING:
     from tmt.guest import Guest
@@ -530,7 +531,7 @@ def before_test(
         *,
         check: "CoredumpCheck",
         invocation: "TestInvocation",
-        environment: Optional[tmt.utils.Environment] = None,
+        environment: Optional[Environment] = None,
         logger: tmt.log.Logger,
     ) -> list[CheckResult]:
         """Check for crashes before the test starts."""
@@ -568,7 +569,7 @@ def after_test(
         *,
         check: "CoredumpCheck",
         invocation: "TestInvocation",
-        environment: Optional[tmt.utils.Environment] = None,
+        environment: Optional[Environment] = None,
         logger: tmt.log.Logger,
     ) -> list[CheckResult]:
         """Check for crashes after the test finishes."""

tmt/checks/dmesg.py

@@ -11,6 +11,7 @@
 from tmt.guest import GuestCapability
 from tmt.result import CheckResult, ResultOutcome, save_failures
 from tmt.utils import Path, Stopwatch
+from tmt.utils.environment import Environment
 from tmt.utils.hints import hints_as_notes
 
 if TYPE_CHECKING:
@@ -211,7 +212,7 @@ def before_test(
         *,
         check: 'DmesgCheck',
         invocation: 'TestInvocation',
-        environment: Optional[tmt.utils.Environment] = None,
+        environment: Optional[Environment] = None,
         logger: tmt.log.Logger,
     ) -> list[CheckResult]:
         if not invocation.guest.facts.has_capability(GuestCapability.SYSLOG_ACTION_READ_ALL):
@@ -232,7 +233,7 @@ def after_test(
         *,
         check: 'DmesgCheck',
         invocation: 'TestInvocation',
-        environment: Optional[tmt.utils.Environment] = None,
+        environment: Optional[Environment] = None,
         logger: tmt.log.Logger,
     ) -> list[CheckResult]:
         if not invocation.guest.facts.has_capability(GuestCapability.SYSLOG_ACTION_READ_ALL):