Skip to content

Commit

Permalink
Clear the test environment before each function run
Browse files Browse the repository at this point in the history
  • Loading branch information
jasongrout committed Jan 7, 2023
1 parent 6b4df54 commit 0f5dac3
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 22 deletions.
15 changes: 12 additions & 3 deletions jupyter_core/tests/test_command.py
Expand Up @@ -21,11 +21,20 @@
resetenv = patch.dict(os.environ)


def setup_module():
def setup_function():
resetenv.start()
for var in [
"JUPYTER_CONFIG_DIR",
"JUPYTER_CONFIG_PATH",
"JUPYTER_DATA_DIR",
"JUPYTER_NO_CONFIG",
"JUPYTER_PATH",
"JUPYTER_PLATFORM_DIRS",
"JUPYTER_RUNTIME_DIR",
]:
os.environ.pop(var, None)


def teardown_module():
def teardown_function():
resetenv.stop()


Expand Down
37 changes: 18 additions & 19 deletions jupyter_core/tests/test_paths.py
Expand Up @@ -50,16 +50,7 @@
{},
)

no_config_env = patch.dict(
"os.environ",
{
"JUPYTER_PLATFORM_DIRS": "",
"JUPYTER_CONFIG_DIR": "",
"JUPYTER_DATA_DIR": "",
"JUPYTER_RUNTIME_DIR": "",
"JUPYTER_PATH": "",
},
)
environment = patch.dict("os.environ")

use_platformdirs = patch.dict("os.environ", {"JUPYTER_PLATFORM_DIRS": "1"})

Expand All @@ -68,18 +59,26 @@
prefer_env = patch.dict("os.environ", {"JUPYTER_PREFER_ENV_PATH": "True"})
prefer_user = patch.dict("os.environ", {"JUPYTER_PREFER_ENV_PATH": "False"})

resetenv = patch.dict(os.environ)


def setup_module():
resetenv.start()
def setup_function():
environment.start()
for var in [
"JUPYTER_CONFIG_DIR",
"JUPYTER_CONFIG_PATH",
"JUPYTER_DATA_DIR",
"JUPYTER_NO_CONFIG",
"JUPYTER_PATH",
"JUPYTER_PLATFORM_DIRS",
"JUPYTER_RUNTIME_DIR",
]:
os.environ.pop(var, None)
# For these tests, default to preferring the user-level over environment-level paths
# Tests can override this preference using the prefer_env decorator/context manager
os.environ["JUPYTER_PREFER_ENV_PATH"] = "no"


def teardown_module():
resetenv.stop()
def teardown_function():
environment.stop()


def realpath(path):
Expand Down Expand Up @@ -272,14 +271,14 @@ def test_runtime_dir_linux():

def test_jupyter_path():
system_path = ["system", "path"]
with no_config_env, patch.object(paths, "SYSTEM_JUPYTER_PATH", system_path):
with patch.object(paths, "SYSTEM_JUPYTER_PATH", system_path):
path = jupyter_path()
assert path[0] == jupyter_data_dir()
assert path[-2:] == system_path


def test_jupyter_path_user_site():
with no_config_env, patch.object(site, "ENABLE_USER_SITE", True):
with patch.object(site, "ENABLE_USER_SITE", True):
path = jupyter_path()

# deduplicated expected values
Expand All @@ -297,7 +296,7 @@ def test_jupyter_path_user_site():


def test_jupyter_path_no_user_site():
with no_config_env, patch.object(site, "ENABLE_USER_SITE", False):
with patch.object(site, "ENABLE_USER_SITE", False):
path = jupyter_path()
assert path[0] == jupyter_data_dir()
assert path[1] == paths.ENV_JUPYTER_PATH[0]
Expand Down

0 comments on commit 0f5dac3

Please sign in to comment.