Skip to content

Environment

provide.testkit.utils.environment

Environment management utilities for testing.

Provides context managers and utilities for managing test environments, environment variables, and foundation setup/cleanup.

Classes

TestEnvironment 

TestEnvironment(env_vars: dict[str, str] | None = None)

Context manager for test environment setup with proper cleanup.

Initialize test environment manager.

Parameters:

Name Type Description Default
env_vars dict[str, str] | None

Dictionary of environment variables to set during the test

 None
Source code in provide/testkit/utils/environment.py 
21
22
23
24
25
26
27
28
29
def __init__(self, env_vars: dict[str, str] | None = None) -> None:
    """
    Initialize test environment manager.

    Args:
        env_vars: Dictionary of environment variables to set during the test
    """
    self.env_vars = env_vars or {}
    self.original_env: dict[str, str | None] = {}
Functions
__enter__ 
__enter__() -> TestEnvironment

Enter the test environment context.

Source code in provide/testkit/utils/environment.py 
31
32
33
34
35
36
37
38
39
40
def __enter__(self) -> "TestEnvironment":
    """Enter the test environment context."""
    # Save original environment variables
    for key in self.env_vars:
        self.original_env[key] = os.environ.get(key)
        os.environ[key] = self.env_vars[key]

    # Reset foundation setup
    reset_foundation_setup_for_testing()
    return self
__exit__ 
__exit__(exc_type: Any, exc_val: Any, exc_tb: Any) -> None

Exit the test environment context and restore original state.

Source code in provide/testkit/utils/environment.py 
42
43
44
45
46
47
48
49
50
51
52
def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
    """Exit the test environment context and restore original state."""
    # Restore original environment variables
    for key, original_value in self.original_env.items():
        if original_value is None:
            os.environ.pop(key, None)
        else:
            os.environ[key] = original_value

    # Reset foundation setup again for cleanup
    reset_foundation_setup_for_testing()

Functions

add_src_to_path 

add_src_to_path() -> Path

Add src directory to Python path for examples. Returns project root path.

Source code in provide/testkit/utils/environment.py 
66
67
68
69
70
71
72
73
74
75
76
77
def add_src_to_path() -> Path:
    """Add src directory to Python path for examples. Returns project root path."""
    import sys

    example_dir = get_example_dir()
    project_root = example_dir.parent
    src_path = project_root / "src"

    if src_path.exists() and str(src_path) not in sys.path:
        sys.path.insert(0, str(src_path))

    return project_root

get_example_dir 

get_example_dir() -> Path

Get the examples directory path consistently across examples.

Source code in provide/testkit/utils/environment.py 
55
56
57
58
59
60
61
62
63
def get_example_dir() -> Path:
    """Get the examples directory path consistently across examples."""
    # Note: This assumes foundation project structure
    # In testkit context, this should point to foundation's examples
    current_file = Path(__file__).resolve()
    # Go up from testkit/src/provide/testkit/environment.py to find foundation
    testkit_root = current_file.parent.parent.parent.parent
    foundation_root = testkit_root.parent / "provide-foundation"
    return foundation_root / "examples"

reset_test_environment 

reset_test_environment() -> None

Reset the test environment to a clean state.

Source code in provide/testkit/utils/environment.py 
80
81
82
def reset_test_environment() -> None:
    """Reset the test environment to a clean state."""
    reset_foundation_setup_for_testing()