Skip to content

[bugfix] Restore environment correctly in case of module load failures #1501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 28, 2020
Merged

[bugfix] Restore environment correctly in case of module load failures #1501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions reframe/core/runtime.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,12 @@ def loadenv(*environs):


def emit_loadenv_commands(*environs):
env_snapshot, commands = loadenv(*environs)
env_snapshot.restore()
env_snapshot = snapshot()
try:
_, commands = loadenv(*environs)
finally:
env_snapshot.restore()

return commands


Expand Down
21 changes: 17 additions & 4 deletions unittests/test_environments.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#
# SPDX-License-Identifier: BSD-3-Clause

import contextlib
import os
import pytest

Expand Down Expand Up @@ -225,8 +226,8 @@ def test_env_immutability(base_environ, env0):
prgenv.ldflags = ['-lm']


def test_env_emit_load_commands(base_environ, user_runtime,
modules_system, env0):
def test_emit_loadenv_commands(base_environ, user_runtime,
modules_system, env0):
ms = rt.runtime().modules_system
expected_commands = [
ms.emit_load_commands('testmod_foo')[0],
Expand All @@ -237,8 +238,8 @@ def test_env_emit_load_commands(base_environ, user_runtime,
assert expected_commands == rt.emit_loadenv_commands(env0)


def test_env_emit_load_commands_with_confict(base_environ, user_runtime,
modules_system, env0):
def test_emit_loadenv_commands_with_confict(base_environ, user_runtime,
modules_system, env0):
# Load a conflicting module
modules_system.load_module('testmod_bar')
ms = rt.runtime().modules_system
Expand All @@ -250,3 +251,15 @@ def test_env_emit_load_commands_with_confict(base_environ, user_runtime,
'export _var3=${_var1}',
]
assert expected_commands == rt.emit_loadenv_commands(env0)


def test_emit_loadenv_failure(user_runtime):
snap = rt.snapshot()
environ = env.Environment('test', modules=['testmod_foo', 'testmod_xxx'])

# Suppress the module load error and verify that the original environment
# is preserved
with contextlib.suppress(EnvironError):
rt.emit_loadenv_commands(environ)

assert rt.snapshot() == snap