File: update.py

package info (click to toggle)
zabbix-cli 3.5.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,892 kB
  • sloc: python: 18,211; makefile: 3
file content (693 lines) | stat: -rw-r--r-- 24,721 bytes parent folder | download | duplicates (2)
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
"""Experimental self-update module. Powers the `update` command.

This code is largely untested and is reliant on too many external factors
to be reliably testable. It was primarily written to be used for installations
of Zabbix-CLI that are distributed as PyInstaller binaries. However, it
ended up growing in scope to encompass all the supported installation methods.

The primary use case we focus on is updating PyInstaller binaries. The other
installation methods are supported, but rely on some less-than-ideal heuristics
for detection.
"""

from __future__ import annotations

import logging
import os
import platform
import subprocess
import sys
from abc import ABC
from abc import abstractmethod
from pathlib import Path
from typing import Any
from typing import NamedTuple
from typing import Optional

import httpx
from pydantic import BaseModel
from pydantic import ValidationError
from rich.progress import Progress
from enum import StrEnum
from typing_extensions import Self

from zabbix_cli.__about__ import __version__
from zabbix_cli.exceptions import ZabbixCLIError
from zabbix_cli.output.console import exit_ok
from zabbix_cli.utils.fs import make_executable
from zabbix_cli.utils.fs import move_file
from zabbix_cli.utils.fs import temp_directory

logger = logging.getLogger(__name__)

ZCLI_PACKAGES = ["zabbix-cli", "zabbix-cli-uio"]


class UpdateError(ZabbixCLIError):  # move to zabbix_cli.exceptions?
    """Base class for update errors."""


class Updater(ABC):
    """ABC for updaters."""

    def __init__(self, installation_info: InstallationInfo) -> None:
        self.installation_info = installation_info

    @abstractmethod
    def update(self) -> Optional[UpdateInfo]:
        """Update the application to the latest version.

        May return information about the update, such as the new version.
        """
        raise NotImplementedError


class GitUpdater(Updater):
    """Updater for packages installed via Git."""

    def update(self) -> UpdateInfo:
        """Update the application to the latest version."""
        # TODO: let user pass git remote, branch and other args
        subprocess.run(["git", "pull"], cwd=self.installation_info.bindir)
        # subprocess.run(["git", "-C", str(repoself.installation_info.bindir_path.absolute()), "pull"])
        return UpdateInfo(self.installation_info.method, "latest")


class PypiUpdater(Updater):
    """ABC Updater for packages installed via PyPI."""

    @property
    @abstractmethod
    def package_manager(self) -> str:
        """The name of package manager used to install the package."""
        raise NotImplementedError

    @property
    @abstractmethod
    def uninstall_command(self) -> list[str]:
        """The command used to uninstall the package."""
        raise NotImplementedError

    @property
    @abstractmethod
    def upgrade_command(self) -> list[str]:
        """The command used to upgrade the package."""
        raise NotImplementedError

    @abstractmethod
    def get_packages(self) -> set[str]:
        """Get a list of installed packages."""
        raise NotImplementedError

    def detect_package_name(self) -> str:
        """Get the name of the package to update.

        As of v3.1.3, `zabbix-cli` is released under the alias `zabbix-cli-uio` on PyPI.
        In the future, we might obtain the name `zabbix-cli` on PyPI, and
        we need to support updating both the aliased name (`zabbix-cli-uio`)
        and the actual name (`zabbix-cli`). This method detects the name of the
        package to update based on what is installed.
        """
        packages = self.get_packages()

        # BOTH zabbix-cli and zabbix-cli-uio are installed
        if "zabbix-cli-uio" in packages and "zabbix-cli" in packages:
            # BOTH zabbix-cli and zabbix-cli-uio are installed
            if self.installation_info.executable:
                if self.installation_info.executable.name in [
                    "zabbix-cli",
                    "zabbix-cli-uio",
                ]:
                    return self.installation_info.executable.name
                else:
                    raise UpdateError(
                        f"Unknown executable: {self.installation_info.executable}"
                    )
            raise UpdateError(
                "Found both [code]zabbix-cli[/] and [code]zabbix-cli-uio[/]. "
                "Unable to determine which package to update. "
                "Uninstall zabbix-cli or zabbix-cli-uio with "
                f"[code]{' '.join(self.uninstall_command)} <package>[/code] and try again."
            )
        elif "zabbix-cli-uio" in packages:
            return "zabbix-cli-uio"
        elif "zabbix-cli" in packages:
            return "zabbix-cli"
        raise UpdateError(f"Unable to detect package name from {self.package_manager}.")

    def update(self) -> None:
        """Update the package to the latest version."""
        package = self.detect_package_name()
        cmd = self.upgrade_command + [package]
        subprocess.run(cmd)


class PipxListOutput(BaseModel):
    """Model for the output of `pipx list --json`."""

    # pipx_spec_version: str # ignore this for now
    venvs: dict[str, Any]  # we just care about the keys

    @classmethod
    def from_json(cls, j: str) -> Self:
        """Parse JSON output from `pipx list --json`."""
        return cls.model_validate_json(j)

    def package_names(self) -> set[str]:
        """Get installed package names."""
        return set(self.venvs.keys())


class PipxUpdater(PypiUpdater):
    """Updater for packages installed via pipx."""

    @property
    def package_manager(self) -> str:
        """The name of package manager used to install the package."""
        return "pipx"

    @property
    def uninstall_command(self) -> list[str]:
        """The command used to uninstall the package."""
        return ["pipx", "uninstall"]

    @property
    @abstractmethod
    def upgrade_command(self) -> list[str]:
        """The command used to upgrade the package."""
        return ["pipx", "upgrade"]

    def get_packages(self) -> set[str]:
        """Get all installed pipx packages."""
        out = subprocess.check_output(["pipx", "list", "--json"], text=True)

        try:
            return PipxListOutput.from_json(out).package_names()
        except Exception as e:
            raise UpdateError(f"Unable to parse pipx list output: {e}") from e


class PipUpdater(PypiUpdater):
    """Updater for bare pip installations (PLEASE DONT USE THIS!!!!)."""

    @property
    def package_manager(self) -> str:
        """The name of package manager used to install the package."""
        return "pip"

    @property
    def uninstall_command(self) -> list[str]:
        """The command used to uninstall the package."""
        return ["pip", "uninstall"]

    @property
    @abstractmethod
    def upgrade_command(self) -> list[str]:
        """The command used to upgrade the package."""
        return ["pip", "install", "--upgrade"]

    def get_packages(self) -> set[str]:
        """Get all installed pip packages."""
        pkgs: set[str] = set()

        out = subprocess.check_output(["pip", "freeze"], text=True)
        lines = out.splitlines()
        for line in lines:
            if " @ " in line:
                pkg, _, _ = line.partition(" @ ")
            else:
                pkg, _, _ = line.partition("==")
            pkgs.add(pkg)
        return pkgs

    def detect_package_name(self) -> str:
        """Get the name of the package to update."""
        # Special case for pip, since if we are at the point where
        # we have both zabbix-cli and zabbix-cli-uio installed, we
        # might have already migrated to a mirror package on PyPI
        # where `zabbix-cli-uio` has a single dependency on `zabbix-cli`
        # in which case, we can just assume we can update `zabbix-cli`
        #
        # NOTE: there could be some edge cases where this assumption
        # is wrong, especially as we migrate to a new package name
        # however, that is such as special case - especially considering
        # NO ONE should be using pip instead of pipx or uv anyway
        packages = self.get_packages()
        if "zabbix-cli" in packages:
            return "zabbix-cli"
        elif "zabbix-cli-uio" in packages:
            return "zabbix-cli-uio"
        raise UpdateError(f"Unable to detect package name from {self.package_manager}.")


class UvUpdater(PypiUpdater):
    """Updater for packages installed via uv."""

    @property
    def package_manager(self) -> str:
        """The name of package manager used to install the package."""
        return "uv"

    @property
    def uninstall_command(self) -> list[str]:
        """The command used to uninstall the package."""
        return ["uv", "tool" "uninstall"]

    @property
    @abstractmethod
    def upgrade_command(self) -> list[str]:
        """The command used to upgrade the package."""
        return ["uv", "tool", "upgrade"]

    def get_packages(self) -> set[str]:
        """Get all installed uv packages."""
        pkgs: set[str] = set()

        out = subprocess.check_output(["uv", "tool", "list"], text=True)

        lines = out.splitlines()
        for line in lines:
            line = line.strip()
            if not line or line.startswith("-"):
                continue
            pkg, _, _ = line.partition(" ")
            pkgs.add(pkg)
        return pkgs


def download_file(url: str, destination: Path) -> None:
    """Download a file from a URL to a destination path."""
    logger.debug("Downloading %s to %s", url, destination)
    with httpx.stream("GET", url, follow_redirects=True) as response:
        with Progress() as progress:
            if response.status_code != 200:
                raise UpdateError(
                    f"Unable to download file {url}, status code {response.status_code}"
                )
            total = int(response.headers["Content-Length"])
            task = progress.add_task("[red]Downloading...[/red]", total=total)
            with open(destination, "wb") as file:
                for data in response.iter_bytes():
                    progress.update(
                        task,
                        advance=len(data),
                        description="[yellow]Downloading...[/yellow]",
                    )
                    file.write(data)
                progress.update(task, description="[green]Download Complete[/green]")
    logger.info("Downloaded %s to %s", url, destination)


class GitHubRelease(BaseModel):
    """Model for a GitHub release."""

    url: str
    tag_name: str


def get_release_arch(arch: str) -> str:
    """Get the correct arch name for a GitHub release artifact.

    Attempts to map the platform.machine() name to the name used
    in the GitHub release artifacts. If no mapping is found, the
    original name is returned.
    """
    ARCH_MAP: dict[str, str] = {
        "x86_64": "x86_64",
        "amd64": "x86_64",
        "arm64": "arm64",
        "aarch64": "arm64",
    }
    """Mapping of platform.machine() names to artifact arch names"""
    return ARCH_MAP.get(arch.lower(), arch)


def get_release_os(os: str) -> str:
    """Get the correct os name for a GitHub release artifact.

    Attempts to map the sys.platform name to the name used
    in the GitHub release artifacts. If no mapping is found, the
    original name is returned.
    """
    PLATFORM_MAP: dict[str, str] = {
        "linux": "linux",
        "darwin": "macos",
        "win32": "win",
    }
    """Mapping of sys.platform names to artifact os names"""
    return PLATFORM_MAP.get(os.lower(), os)


class PyInstallerUpdater(Updater):
    """Updater for PyInstaller installations."""

    URL_FMT = "https://github.com/unioslo/zabbix-cli/releases/latest/download/zabbix-cli-{version}-{os}-{arch}{ext}"
    """URL format for downloading the latest release."""

    URL_API_LATEST = "https://api.github.com/repos/unioslo/zabbix-cli/releases/latest"
    """URL for latest release info from API."""

    def update(self) -> Optional[UpdateInfo]:
        """Update the application to the latest version."""
        if not self.installation_info.bindir:
            raise UpdateError("Unable to determine PyInstaller binary directory")
        if not self.installation_info.executable:
            raise UpdateError("Unable to determine PyInstaller executable")

        version = self.get_release_version()
        if version == __version__:
            exit_ok(f"Application is already up-to-date ({version})")

        # The path to the binary being executed
        binfile = self.resolve_path(self.installation_info.executable)

        with temp_directory() as tmpdir:
            tmpfile = self.download(version, tmpdir)
            move_file(tmpfile, binfile)
            make_executable(binfile)

        return UpdateInfo(self.installation_info.method, version, path=binfile)

    def download(self, version: str, dest_dir: Path) -> Path:
        """Download the latest release and return the path to the downloaded file."""
        os = sys.platform
        arch = platform.machine()
        url = self.get_url(os, arch, version)
        dest = dest_dir / "zabbix-cli"
        download_file(url, dest)
        return dest

    def get_release_version(self) -> str:
        """Get the latest release info."""
        resp = httpx.get(self.URL_API_LATEST)
        if resp.status_code != 200:
            raise UpdateError(f"Failed to get latest release: {resp.text}")
        try:
            release = GitHubRelease.model_validate_json(resp.text)
        except ValidationError as e:
            raise UpdateError(
                f"Failed to parse GitHub release info: {resp.text}"
            ) from e
        if not release.tag_name:
            raise UpdateError(f"Latest GitHub release {release.url!r} has no tag name.")
        return release.tag_name

    def resolve_path(self, path: Path) -> Path:
        """Attempts to resolve a Path in strict mode, falling back to resolving aliases."""
        try:
            return path.resolve(strict=True)
        except FileNotFoundError:
            # File does not exist, assume it's a shell alias, resolve that
            alias_path = self.resolve_alias(path.name)
            # Special case for python alias - we failed to resolve it properly here
            # and ended up resolving it to a Python interpreter instead of the
            # Zabbix-CLI pyinstaller executable
            if alias_path.name == "python":
                raise UpdateError(
                    "Unable to resolve PyInstaller executable. Please update manually."
                ) from None
            return alias_path

    @staticmethod
    def resolve_alias(alias: str) -> Path:
        """Resolve a shell alias to its target path."""
        if sys.platform == "win32":
            raise UpdateError(f"Unable to resolve alias {alias!r} on Windows")

        out = subprocess.check_output(["type", "-a", alias], env=os.environ, text=True)
        lines = out.splitlines()
        logger.debug("Resolved alias %s to %s", alias, lines)
        for line in lines:
            if any(x in line for x in ["is an alias for", "is a shell function"]):
                logger.debug("Skipping line when resolving alias: %s", line)
                continue
            alias, _, path_str = line.partition(" is ")
            path_str = path_str.strip()
            return Path(path_str).resolve()
        raise UpdateError(f"Unable to resolve alias {alias}")

    # NOTE: this is a class method for ease of testing only
    @classmethod
    def get_url(cls, os: str, arch: str, version: str) -> str:
        """Get the download URL for the latest release artifact for a given platform+arch."""
        os = cls.get_release_os(os)
        arch = cls.get_release_arch(arch)
        ext = ".exe" if os == "win" else ""
        return cls.URL_FMT.format(version=version, os=os, arch=arch, ext=ext)

    @staticmethod
    def get_release_arch(arch: str) -> str:
        """Get the correct arch name for a GitHub release artifact.

        Attempts to map the platform.machine() name to the name used
        in the GitHub release artifacts. If no mapping is found, the
        original name is returned.
        """
        ARCH_MAP: dict[str, str] = {
            "x86_64": "x86_64",
            "amd64": "x86_64",
            "arm64": "arm64",
            "aarch64": "arm64",
        }
        """Mapping of platform.machine() names to artifact arch names"""
        return ARCH_MAP.get(arch.lower(), arch)

    @staticmethod
    def get_release_os(os: str) -> str:
        """Get the correct os name for a GitHub release artifact.

        Attempts to map the sys.platform name to the name used
        in the GitHub release artifacts. If no mapping is found, the
        original name is returned.
        """
        PLATFORM_MAP: dict[str, str] = {
            "linux": "linux",
            "darwin": "macos",
            "win32": "win",
        }
        """Mapping of sys.platform names to artifact os names"""
        return PLATFORM_MAP.get(os.lower(), os)


class InstallationMethod(StrEnum):
    """Installation method of the application."""

    GIT = "git"
    PIP = "pip"
    PIPX = "pipx"
    UV = "uv"
    PYINSTALLER = "pyinstaller"


class InstallationInfo(NamedTuple):
    """Information about the installation method of the application."""

    method: InstallationMethod
    package: Optional[str] = None
    executable: Optional[Path] = None
    bindir: Optional[Path] = None


def to_path(p: str) -> Optional[Path]:
    """Convert a string to a Path, returning None if the path is invalid."""
    try:
        return Path(p).expanduser().resolve()
    except Exception as e:
        logger.debug("Unable to resolve path %s: %s", p, e)
    return None


def cmd_exists(command: str, *, help: bool = True) -> bool:
    """Check if a command is available in the system."""
    cmd = [command, "--help"] if help else [command]
    try:
        subprocess.check_call(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
    except (subprocess.CalledProcessError, FileNotFoundError):
        return False
    return True


# TODO: Consider moving static methods into each updater class
# or maybe even move all the detection methods into the updaters
# and have the InstallationMethodDetector just call `updater.detect()`


class InstallationMethodDetector:
    """Detects the installation method of the application."""

    def __init__(self) -> None:
        self.executable = Path(sys.argv[0])
        self.parent_dir = self.executable.parent

    @classmethod
    def detect(cls) -> InstallationInfo:
        """Attempt to detect the installation method of the application."""
        try:
            return cls()._do_detect()
        except Exception as e:
            raise UpdateError(f"Unable to detect installation method: {e}") from e

    def _do_detect(self) -> InstallationInfo:
        for method in [
            # Methods ranked in order of best->worst detection heuristics
            # as well as likelyhood of being used by the user
            self.detect_pyinstaller,
            self.detect_uv,
            self.detect_pipx,
            self.detect_pip,
            self.detect_git,
        ]:
            if (info := method()) is not None:
                logger.info("Detected installation method: %s", info.method)
                return info
        raise NotImplementedError("No detection methods succeeded")

    def detect_git(self) -> Optional[InstallationInfo]:
        """Get app installation via a local Git repository."""
        f = Path(__file__).resolve()
        package_dir = f.parent.parent
        git_dir = package_dir / ".git"
        if not git_dir.exists():
            return
        if not git_dir.is_dir():
            return
        return InstallationInfo(method=InstallationMethod.GIT, bindir=package_dir)

    @staticmethod
    def get_pipx_bin_dir() -> Optional[Path]:
        """Detect the pipx bin directory."""
        if (bd := os.environ.get("PIPX_BIN_DIR")) and (bindir := to_path(bd)):
            return bindir
        try:
            t = subprocess.check_output(
                ["pipx", "environment", "--value", "PIPX_BIN_DIR"], text=True
            )
        except subprocess.CalledProcessError as e:
            logger.error("Failed to get pipx bin dir with command %r: %s", e.cmd, e)
            return
        except FileNotFoundError:
            return  # pipx not installed
        return to_path(t)

    def detect_pipx(self) -> Optional[InstallationInfo]:
        """Detect app installation via pipx."""
        if not cmd_exists("pipx"):
            return
        bindir = self.get_pipx_bin_dir()
        if not bindir:
            return
        if not (self.parent_dir == bindir or self.parent_dir in bindir.parents):
            return
        return InstallationInfo(method=InstallationMethod.PIPX, bindir=bindir)

    @staticmethod
    def has_pip_package(pkg: str) -> bool:
        """Check if a package is installed via pip."""
        try:
            subprocess.check_call(["pip", "show", pkg])
        except subprocess.CalledProcessError:
            return False
        return True

    def detect_pip(self) -> Optional[InstallationInfo]:
        """Detect app installation via pip."""
        if not cmd_exists("pip"):
            return
        for pkg in ["zabbix-cli", "zabbix-cli-uio"]:
            if self.has_pip_package(pkg):
                return InstallationInfo(method=InstallationMethod.PIP, package=pkg)

    def detect_pyinstaller(self) -> Optional[InstallationInfo]:
        """Detect app installation via pyinstaller."""
        if not hasattr(sys, "_MEIPASS"):
            return
        # TODO: resolve alias, symlinks, etc.
        return InstallationInfo(
            method=InstallationMethod.PYINSTALLER,
            executable=self.executable,
            bindir=self.parent_dir,
        )

    @staticmethod
    def get_uv_bin_dir() -> Optional[Path]:
        """Detect the uv bin directory."""
        try:
            t = subprocess.check_output(["uv", "tool", "dir"], text=True)
        except subprocess.CalledProcessError:
            return
        except FileNotFoundError:
            return
        return to_path(t)

    @staticmethod
    def get_uv_pkg_name() -> Optional[str]:
        """Detect the installed uv package name."""
        for pkg in ZCLI_PACKAGES:
            try:
                subprocess.check_output(["uv", "tool", "list", pkg])
            except subprocess.CalledProcessError:
                continue
            return pkg

    def detect_uv(self) -> Optional[InstallationInfo]:
        """Detect app installation via uv."""
        if not cmd_exists("uv"):
            return
        bindir = self.get_uv_bin_dir()
        if not bindir:
            return
        if not (self.parent_dir == bindir or self.parent_dir in bindir.parents):
            return
        return InstallationInfo(method=InstallationMethod.UV, bindir=bindir)


UPDATERS: dict[InstallationMethod, type[Updater]] = {
    InstallationMethod.PYINSTALLER: PyInstallerUpdater,
    # InstallationMethod.GIT: GitUpdater,
    # InstallationMethod.PIP: PipUpdater,
    # InstallationMethod.PIPX: PipxUpdater,
    # InstallationMethod.UV: UvUpdater,
}


class UpdateInfo(NamedTuple):
    """Information about a completed update."""

    method: InstallationMethod
    version: str
    path: Optional[Path] = None


def get_updater(method: InstallationMethod) -> type[Updater]:
    """Get the updater class for an installation method."""
    updater = UPDATERS.get(method)
    if updater is None:
        raise UpdateError(f"No updater available for installation method {method}")
    return updater


def update(update_method: Optional[InstallationMethod] = None) -> Optional[UpdateInfo]:
    """Update the application to the latest version.

    Args:
        update_method (Optional[InstallationMethod], optional):
            Update using a specific update method. Defaults to None.
            Auto-detects the installation method if not provided.

    Raises:
        UpdateError: If the update fails.

    Returns:
        Optional[UpdateInfo]: Information about the update, such as version, method, etc.
    """
    if not update_method:
        info = InstallationMethodDetector.detect()
    else:
        info = InstallationInfo(method=update_method)

    updater = get_updater(info.method)

    try:
        return updater(info).update()
    except Exception as e:
        raise UpdateError(f"Failed to update using {info.method}: {e}") from e