Skip to content
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.

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

Use pytest tmpdir_factory in gen_cluster #6630

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions distributed/tests/test_utils_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@ async def test_gen_cluster_pytest_fixture(c, s, a, b, tmp_path):
assert isinstance(w, Worker)


@gen_cluster(client=True)
async def test_gen_cluster_pytest_fixture_tmpdir_factory(c, s, a, b, tmpdir_factory):
assert isinstance(tmpdir_factory, pytest.TempdirFactory)
assert isinstance(c, Client)
assert isinstance(s, Scheduler)
for w in [a, b]:
assert isinstance(w, Worker)


@pytest.mark.parametrize("foo", [True])
@gen_cluster(client=True)
async def test_gen_cluster_parametrized(c, s, a, b, foo):
Expand Down
44 changes: 28 additions & 16 deletions distributed/utils_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -1064,15 +1064,40 @@ async def test_foo(scheduler, worker1, worker2, pytest_fixture_a, pytest_fixture
def _(func):
if not iscoroutinefunction(func):
raise RuntimeError("gen_cluster only works for coroutine functions.")
# Patch the signature so pytest can inject fixtures
orig_sig = inspect.signature(func)
args = [None] * (1 + len(nthreads)) # scheduler, *workers
if client:
args.insert(0, None)

bound = orig_sig.bind_partial(*args)
new_parameters = [
p for name, p in orig_sig.parameters.items() if name not in bound.arguments
]
requires_tmpdir_factory_fixture = True
if "tmp_path_factory" not in orig_sig.parameters:
requires_tmpdir_factory_fixture = False
new_parameters.append(
inspect.Parameter("tmp_path_factory", inspect.Parameter.KEYWORD_ONLY)
)

@functools.wraps(func)
@clean(**clean_kwargs)
def test_func(*outer_args, **kwargs):
async def async_fn():
result = None
with tempfile.TemporaryDirectory() as tmpdir:
with contextlib.ExitStack() as exitstack:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sure there is much more we could do with an exitstack int his function but I'd rather not touch it for now

tmp_path_factory = kwargs.get("tmp_path_factory")
if tmp_path_factory is None:
# For usage as plain ctxmanager for non-pytest functions
tmpdir = str(exitstack.enter_context(_SafeTemporaryDirectory()))
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is unfortunately the case where tests are using this in an inner function w/out pytest-collection, i.e. we need to handle this case as well

else:
if not requires_tmpdir_factory_fixture:
del kwargs["tmp_path_factory"]
tmpdir = tmp_path_factory.mktemp(func.__name__)
result = None
config2 = merge({"temporary-directory": tmpdir}, config)
with dask.config.set(config2):

workers = []
s = False

Expand Down Expand Up @@ -1217,20 +1242,7 @@ async def async_fn_outer():

return _run_and_close_tornado(async_fn_outer)

# Patch the signature so pytest can inject fixtures
orig_sig = inspect.signature(func)
args = [None] * (1 + len(nthreads)) # scheduler, *workers
if client:
args.insert(0, None)

bound = orig_sig.bind_partial(*args)
test_func.__signature__ = orig_sig.replace(
parameters=[
p
for name, p in orig_sig.parameters.items()
if name not in bound.arguments
]
)
test_func.__signature__ = orig_sig.replace(parameters=new_parameters)

return test_func

Expand Down