1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
from __future__ import annotations
import asyncio
import logging
from unittest import mock
import pytest
from distributed import Nanny
from distributed.core import Status
from distributed.diagnostics.plugin import CondaInstall, InstallPlugin, PipInstall
from distributed.utils_test import captured_logger, gen_cluster
@gen_cluster(client=True, nthreads=[("", 1)])
async def test_pip_install(c, s, a):
with captured_logger(
"distributed.diagnostics.plugin", level=logging.INFO
) as logger:
mocked = mock.Mock()
mocked.configure_mock(
**{"communicate.return_value": (b"", b""), "wait.return_value": 0}
)
with mock.patch(
"distributed.diagnostics.plugin.subprocess.Popen", return_value=mocked
) as Popen:
await c.register_plugin(
PipInstall(packages=["requests"], pip_options=["--upgrade"])
)
assert Popen.call_count > 0
python, *args, file = Popen.call_args[0][0]
assert "python" in python
# Assert that we install using a requirements file to support
# environment variables
assert args == ["-m", "pip", "install", "--upgrade", "-r"]
logs = logger.getvalue()
assert "pip installing" in logs
assert "failed" not in logs
assert "restart" not in logs
@gen_cluster(client=True, nthreads=[("", 1)])
async def test_conda_install(c, s, a):
with captured_logger(
"distributed.diagnostics.plugin", level=logging.INFO
) as logger:
run_command_mock = mock.Mock(name="run_command_mock")
run_command_mock.configure_mock(return_value=(b"", b"", 0))
module_mock = mock.Mock(name="conda_cli_python_api_mock")
module_mock.run_command = run_command_mock
module_mock.Commands.INSTALL = "INSTALL"
with mock.patch.dict("sys.modules", {"conda.cli.python_api": module_mock}):
await c.register_plugin(
CondaInstall(packages=["requests"], conda_options=["--update-deps"])
)
assert run_command_mock.call_count > 0
command = run_command_mock.call_args[0][0]
assert command == "INSTALL"
arguments = run_command_mock.call_args[0][1]
assert arguments == ["--update-deps", "requests"]
logs = logger.getvalue()
assert "conda installing" in logs
assert "failed" not in logs
assert "restart" not in logs
@gen_cluster(client=True, nthreads=[("", 2), ("", 2)])
async def test_pip_install_fails(c, s, a, b):
with captured_logger(
"distributed.diagnostics.plugin", level=logging.ERROR
) as logger:
mocked = mock.Mock()
mocked.configure_mock(
**{
"communicate.return_value": (
b"",
b"Could not find a version that satisfies the requirement not-a-package",
),
"wait.return_value": 1,
}
)
with mock.patch(
"distributed.diagnostics.plugin.subprocess.Popen", return_value=mocked
) as Popen:
with pytest.raises(RuntimeError):
await c.register_plugin(PipInstall(packages=["not-a-package"]))
assert Popen.call_count > 0
logs = logger.getvalue()
assert "install failed" in logs
assert "not-a-package" in logs
@gen_cluster(client=True, nthreads=[("", 2), ("", 2)])
async def test_conda_install_fails_when_conda_not_found(c, s, a, b):
with captured_logger(
"distributed.diagnostics.plugin", level=logging.ERROR
) as logger:
with mock.patch.dict("sys.modules", {"conda": None}):
with pytest.raises(RuntimeError):
await c.register_plugin(CondaInstall(packages=["not-a-package"]))
logs = logger.getvalue()
assert "install failed" in logs
assert "conda could not be found" in logs
@gen_cluster(client=True, nthreads=[("", 2), ("", 2)])
async def test_conda_install_fails_when_conda_raises(c, s, a, b):
with captured_logger(
"distributed.diagnostics.plugin", level=logging.ERROR
) as logger:
run_command_mock = mock.Mock(name="run_command_mock")
run_command_mock.configure_mock(side_effect=RuntimeError)
module_mock = mock.Mock(name="conda_cli_python_api_mock")
module_mock.run_command = run_command_mock
module_mock.Commands.INSTALL = "INSTALL"
with mock.patch.dict("sys.modules", {"conda.cli.python_api": module_mock}):
with pytest.raises(RuntimeError):
await c.register_plugin(CondaInstall(packages=["not-a-package"]))
assert run_command_mock.call_count > 0
logs = logger.getvalue()
assert "install failed" in logs
@gen_cluster(client=True, nthreads=[("", 2), ("", 2)])
async def test_conda_install_fails_on_returncode(c, s, a, b):
with captured_logger(
"distributed.diagnostics.plugin", level=logging.ERROR
) as logger:
run_command_mock = mock.Mock(name="run_command_mock")
run_command_mock.configure_mock(return_value=(b"", b"", 1))
module_mock = mock.Mock(name="conda_cli_python_api_mock")
module_mock.run_command = run_command_mock
module_mock.Commands.INSTALL = "INSTALL"
with mock.patch.dict("sys.modules", {"conda.cli.python_api": module_mock}):
with pytest.raises(RuntimeError):
await c.register_plugin(CondaInstall(packages=["not-a-package"]))
assert run_command_mock.call_count > 0
logs = logger.getvalue()
assert "install failed" in logs
@pytest.mark.slow
@gen_cluster(client=True, nthreads=[("", 1)])
async def test_package_install_on_worker(c, s, a):
(addr,) = s.workers
await c.register_plugin(InstallPlugin(lambda: None, restart_workers=False))
@pytest.mark.slow
@gen_cluster(client=True, nthreads=[("", 1)], Worker=Nanny)
async def test_package_install_on_nanny(c, s, a):
(addr,) = s.workers
await c.register_plugin(InstallPlugin(lambda: None, restart_workers=False))
@pytest.mark.slow
@gen_cluster(client=True, nthreads=[("", 1)], Worker=Nanny)
async def test_package_install_restarts_on_nanny(c, s, a):
(addr,) = s.workers
await c.register_plugin(
InstallPlugin(
lambda: None,
restart_workers=True,
)
)
# Wait until the worker is restarted
while len(s.workers) != 1 or set(s.workers) == {addr}:
await asyncio.sleep(0.01)
@gen_cluster(client=True, nthreads=[("", 1)], Worker=Nanny)
async def test_package_install_failing_does_not_restart_on_nanny(c, s, a):
(addr,) = s.workers
def install_fn():
raise RuntimeError()
with pytest.raises(RuntimeError):
await c.register_plugin(
InstallPlugin(
install_fn,
restart_workers=True,
)
)
# Nanny does not restart
assert a.status is Status.running
assert set(s.workers) == {addr}
|
