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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277 | def deactivate_ssh(
*,
task_group_activity_id: int,
task_group_id: int,
ssh_config: SSHConfig,
tasks_base_dir: str,
) -> None:
"""
Deactivate a task group venv.
This function is run as a background task, therefore exceptions must be
handled.
Arguments:
task_group_id:
task_group_activity_id:
ssh_config:
tasks_base_dir:
Only used as a `safe_root` in `remove_dir`, and typically set to
`user_settings.ssh_tasks_dir`.
"""
LOGGER_NAME = f"{__name__}.ID{task_group_activity_id}"
with TemporaryDirectory() as tmpdir:
log_file_path = get_log_path(Path(tmpdir))
logger = set_logger(
logger_name=LOGGER_NAME,
log_file_path=log_file_path,
)
logger.debug("START")
with next(get_sync_db()) as db:
db_objects_ok, task_group, activity = get_activity_and_task_group(
task_group_activity_id=task_group_activity_id,
task_group_id=task_group_id,
db=db,
logger_name=LOGGER_NAME,
)
if not db_objects_ok:
return
with SingleUseFractalSSH(
ssh_config=ssh_config,
logger_name=LOGGER_NAME,
) as fractal_ssh:
try:
# Check SSH connection
ssh_ok = check_ssh_or_fail_and_cleanup(
fractal_ssh=fractal_ssh,
task_group=task_group,
task_group_activity=activity,
logger_name=LOGGER_NAME,
log_file_path=log_file_path,
db=db,
)
if not ssh_ok:
return
# Check that the (local) task_group venv_path does exist
if not fractal_ssh.remote_exists(task_group.venv_path):
error_msg = f"{task_group.venv_path} does not exist."
logger.error(error_msg)
fail_and_cleanup(
task_group=task_group,
task_group_activity=activity,
logger_name=LOGGER_NAME,
log_file_path=log_file_path,
exception=FileNotFoundError(error_msg),
db=db,
)
return
activity.status = TaskGroupActivityStatusV2.ONGOING
activity = add_commit_refresh(obj=activity, db=db)
if task_group.env_info is None:
logger.warning(
"Recreate pip-freeze information, since "
f"{task_group.env_info=}. NOTE: this should "
"only happen for task groups created before 2.9.0."
)
# Prepare replacements for templates
replacements = get_collection_replacements(
task_group=task_group,
python_bin="/not/applicable",
)
# Define script_dir_remote and create it if missing
script_dir_remote = (
Path(task_group.path) / SCRIPTS_SUBFOLDER
).as_posix()
fractal_ssh.mkdir(
folder=script_dir_remote, parents=True
)
# Prepare arguments for `_customize_and_run_template`
common_args = dict(
replacements=replacements,
script_dir_local=(
Path(tmpdir) / SCRIPTS_SUBFOLDER
).as_posix(),
script_dir_remote=script_dir_remote,
prefix=(
f"{int(time.time())}_"
f"{TaskGroupActivityActionV2.DEACTIVATE}"
),
fractal_ssh=fractal_ssh,
logger_name=LOGGER_NAME,
)
# Run `pip freeze`
pip_freeze_stdout = _customize_and_run_template(
template_filename="3_pip_freeze.sh",
**common_args,
)
# Update pip-freeze data
logger.info(
"Add pip freeze stdout to TaskGroupV2 - start"
)
activity.log = get_current_log(log_file_path)
activity = add_commit_refresh(obj=activity, db=db)
task_group.env_info = pip_freeze_stdout
task_group = add_commit_refresh(obj=task_group, db=db)
logger.info(
"Add pip freeze stdout to TaskGroupV2 - end"
)
# Handle some specific cases for wheel-file case
if task_group.origin == TaskGroupV2OriginEnum.WHEELFILE:
logger.info(
f"Handle specific cases for {task_group.origin=}."
)
# Blocking situation: `archive_path` is not set or
# points to a missing path
if (
task_group.archive_path is None
or not fractal_ssh.remote_exists(
task_group.archive_path
)
):
error_msg = (
"Invalid wheel path for task group with "
f"{task_group_id=}. "
f"{task_group.archive_path=} is unset or "
"does not exist."
)
logger.error(error_msg)
fail_and_cleanup(
task_group=task_group,
task_group_activity=activity,
logger_name=LOGGER_NAME,
log_file_path=log_file_path,
exception=FileNotFoundError(error_msg),
db=db,
)
return
# Recoverable situation: `archive_path` was not yet
# copied over to the correct server-side folder
archive_path_parent_dir = Path(
task_group.archive_path
).parent
if archive_path_parent_dir != Path(task_group.path):
logger.warning(
f"{archive_path_parent_dir.as_posix()} "
f"differs from {task_group.path}. "
"NOTE: this should only happen for task "
"groups created before 2.9.0."
)
if (
task_group.archive_path
not in task_group.env_info
):
raise ValueError(
f"Cannot find {task_group.archive_path=} "
"in pip-freeze data. Exit."
)
logger.info(
f"Now copy wheel file into {task_group.path}."
)
new_archive_path = _copy_wheel_file_ssh(
task_group=task_group,
fractal_ssh=fractal_ssh,
logger_name=LOGGER_NAME,
)
logger.info(
f"Copied wheel file to {new_archive_path}."
)
task_group.archive_path = new_archive_path
new_pip_freeze = task_group.env_info.replace(
task_group.archive_path,
new_archive_path,
)
task_group.env_info = new_pip_freeze
task_group = add_commit_refresh(
obj=task_group, db=db
)
logger.info(
"Updated `archive_path` and `env_info` "
"task-group attributes."
)
# Fail if `env_info` includes "github", see
# https://github.com/fractal-analytics-platform/fractal-server/issues/2142
for forbidden_string in FORBIDDEN_DEPENDENCY_STRINGS:
if forbidden_string in task_group.env_info:
raise ValueError(
"Deactivation and reactivation of task "
f"packages with direct {forbidden_string} "
"dependencies are not currently supported. "
"Exit."
)
# We now have all required information for reactivating the
# virtual environment at a later point
# Actually mark the task group as non-active
logger.info("Now setting `active=False`.")
task_group.active = False
task_group = add_commit_refresh(obj=task_group, db=db)
# Proceed with deactivation
logger.info(f"Now removing {task_group.venv_path}.")
fractal_ssh.remove_folder(
folder=task_group.venv_path,
safe_root=tasks_base_dir,
)
logger.info(f"All good, {task_group.venv_path} removed.")
activity.status = TaskGroupActivityStatusV2.OK
activity.log = get_current_log(log_file_path)
activity.timestamp_ended = get_timestamp()
activity = add_commit_refresh(obj=activity, db=db)
reset_logger_handlers(logger)
except Exception as e:
fail_and_cleanup(
task_group=task_group,
task_group_activity=activity,
logger_name=LOGGER_NAME,
log_file_path=log_file_path,
exception=e,
db=db,
)
|