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
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
|
# SPDX-FileCopyrightText: Copyright 2022-2023, Arm Limited and/or its affiliates.
# SPDX-License-Identifier: Apache-2.0
"""Module for installation process."""
from __future__ import annotations
import logging
import platform
import tarfile
from abc import ABC
from abc import abstractmethod
from dataclasses import dataclass
from pathlib import Path
from typing import Callable
from typing import Optional
from typing import Union
from mlia.backend.repo import get_backend_repository
from mlia.utils.download import DownloadArtifact
from mlia.utils.filesystem import all_files_exist
from mlia.utils.filesystem import temp_directory
from mlia.utils.filesystem import working_directory
from mlia.utils.py_manager import get_package_manager
logger = logging.getLogger(__name__)
@dataclass
class InstallFromPath:
"""Installation from the local path."""
backend_path: Path
@dataclass
class DownloadAndInstall:
"""Download and install."""
eula_agreement: bool = True
InstallationType = Union[InstallFromPath, DownloadAndInstall]
class Installation(ABC):
"""Base class for the installation process of the backends."""
def __init__(self, name: str, description: str) -> None:
"""Init the installation."""
self.name = name
self.description = description
@property
@abstractmethod
def could_be_installed(self) -> bool:
"""Check if backend could be installed in current environment."""
@property
@abstractmethod
def already_installed(self) -> bool:
"""Check if backend is already installed."""
@abstractmethod
def supports(self, install_type: InstallationType) -> bool:
"""Check if installation supports requested installation type."""
@abstractmethod
def install(self, install_type: InstallationType) -> None:
"""Install the backend."""
@abstractmethod
def uninstall(self) -> None:
"""Uninstall the backend."""
@dataclass
class BackendInfo:
"""Backend information."""
backend_path: Path
copy_source: bool = True
settings: dict | None = None
PathChecker = Callable[[Path], Optional[BackendInfo]]
BackendInstaller = Callable[[bool, Path], Path]
class BackendInstallation(Installation):
"""Backend installation."""
def __init__(
self,
name: str,
description: str,
fvp_dir_name: str,
download_artifact: DownloadArtifact | None,
supported_platforms: list[str] | None,
path_checker: PathChecker,
backend_installer: BackendInstaller | None,
) -> None:
"""Init the backend installation."""
super().__init__(name, description)
self.fvp_dir_name = fvp_dir_name
self.download_artifact = download_artifact
self.supported_platforms = supported_platforms
self.path_checker = path_checker
self.backend_installer = backend_installer
@property
def already_installed(self) -> bool:
"""Return true if backend already installed."""
backend_repo = get_backend_repository()
return backend_repo.is_backend_installed(self.name)
@property
def could_be_installed(self) -> bool:
"""Return true if backend could be installed."""
return (
not self.supported_platforms
or platform.system() in self.supported_platforms
)
def supports(self, install_type: InstallationType) -> bool:
"""Return true if backends supported type of the installation."""
if isinstance(install_type, DownloadAndInstall):
return self.download_artifact is not None
if isinstance(install_type, InstallFromPath):
return self.path_checker(install_type.backend_path) is not None
return False # type: ignore
def install(self, install_type: InstallationType) -> None:
"""Install the backend."""
if isinstance(install_type, DownloadAndInstall):
assert self.download_artifact is not None, "No artifact provided"
self._download_and_install(
self.download_artifact, install_type.eula_agreement
)
elif isinstance(install_type, InstallFromPath):
backend_info = self.path_checker(install_type.backend_path)
assert backend_info is not None, "Unable to resolve backend path"
self._install_from(backend_info)
else:
raise Exception(f"Unable to install {install_type}")
def _install_from(self, backend_info: BackendInfo) -> None:
"""Install backend from the directory."""
backend_repo = get_backend_repository()
if backend_info.copy_source:
backend_repo.copy_backend(
self.name,
backend_info.backend_path,
self.fvp_dir_name,
backend_info.settings,
)
else:
backend_repo.add_backend(
self.name,
backend_info.backend_path,
backend_info.settings,
)
def _download_and_install(
self, download_artifact: DownloadArtifact, eula_agrement: bool
) -> None:
"""Download and install the backend."""
with temp_directory() as tmpdir:
try:
downloaded_to = download_artifact.download_to(tmpdir)
except Exception as err:
raise Exception("Unable to download backend artifact") from err
with working_directory(tmpdir / "dist", create_dir=True) as dist_dir:
with tarfile.open(downloaded_to) as archive:
archive.extractall(dist_dir)
backend_path = dist_dir
if self.backend_installer:
backend_path = self.backend_installer(eula_agrement, dist_dir)
if self.path_checker(backend_path) is None:
raise Exception("Downloaded artifact has invalid structure")
self.install(InstallFromPath(backend_path))
def uninstall(self) -> None:
"""Uninstall the backend."""
backend_repo = get_backend_repository()
backend_repo.remove_backend(self.name)
class PackagePathChecker:
"""Package path checker."""
def __init__(
self,
expected_files: list[str],
backend_subfolder: str | None = None,
settings: dict = None,
) -> None:
"""Init the path checker."""
self.expected_files = expected_files
self.backend_subfolder = backend_subfolder
self.settings = settings
def __call__(self, backend_path: Path) -> BackendInfo | None:
"""Check if directory contains all expected files."""
resolved_paths = (backend_path / file for file in self.expected_files)
if not all_files_exist(resolved_paths):
return None
actual_backend_path = backend_path
if self.backend_subfolder:
subfolder = backend_path / self.backend_subfolder
if subfolder.is_dir():
actual_backend_path = subfolder
return BackendInfo(actual_backend_path, settings=self.settings)
class StaticPathChecker:
"""Static path checker."""
def __init__(
self,
static_backend_path: Path,
expected_files: list[str],
copy_source: bool = False,
settings: dict | None = None,
) -> None:
"""Init static path checker."""
self.static_backend_path = static_backend_path
self.expected_files = expected_files
self.copy_source = copy_source
self.settings = settings
def __call__(self, backend_path: Path) -> BackendInfo | None:
"""Check if directory equals static backend path with all expected files."""
if backend_path != self.static_backend_path:
return None
resolved_paths = (backend_path / file for file in self.expected_files)
if not all_files_exist(resolved_paths):
return None
return BackendInfo(
backend_path,
copy_source=self.copy_source,
settings=self.settings,
)
class CompoundPathChecker:
"""Compound path checker."""
def __init__(self, *path_checkers: PathChecker) -> None:
"""Init compound path checker."""
self.path_checkers = path_checkers
def __call__(self, backend_path: Path) -> BackendInfo | None:
"""Iterate over checkers and return first non empty backend info."""
first_resolved_backend_info = (
backend_info
for path_checker in self.path_checkers
if (backend_info := path_checker(backend_path)) is not None
)
return next(first_resolved_backend_info, None)
class PyPackageBackendInstallation(Installation):
"""Backend based on the python package."""
def __init__(
self,
name: str,
description: str,
packages_to_install: list[str],
packages_to_uninstall: list[str],
expected_packages: list[str],
) -> None:
"""Init the backend installation."""
super().__init__(name, description)
self._packages_to_install = packages_to_install
self._packages_to_uninstall = packages_to_uninstall
self._expected_packages = expected_packages
self.package_manager = get_package_manager()
@property
def could_be_installed(self) -> bool:
"""Check if backend could be installed."""
return True
@property
def already_installed(self) -> bool:
"""Check if backend already installed."""
return self.package_manager.packages_installed(self._expected_packages)
def supports(self, install_type: InstallationType) -> bool:
"""Return true if installation supports requested installation type."""
return isinstance(install_type, DownloadAndInstall)
def install(self, install_type: InstallationType) -> None:
"""Install the backend."""
if not self.supports(install_type):
raise Exception(f"Unsupported installation type {install_type}")
self.package_manager.install(self._packages_to_install)
def uninstall(self) -> None:
"""Uninstall the backend."""
self.package_manager.uninstall(self._packages_to_uninstall)
|