mirror of
				https://github.com/arcan1s/ahriman.git
				synced 2025-11-04 15:53:41 +00:00 
			
		
		
		
	Compare commits
	
		
			1 Commits
		
	
	
		
			0626078319
			...
			9a1b34b08d
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 9a1b34b08d | 
@ -475,7 +475,7 @@ The following environment variables are supported:
 | 
				
			|||||||
* ``AHRIMAN_REPOSITORY`` - repository name, default is ``aur-clone``.
 | 
					* ``AHRIMAN_REPOSITORY`` - repository name, default is ``aur-clone``.
 | 
				
			||||||
* ``AHRIMAN_REPOSITORY_SERVER`` - optional override for the repository URL. Useful if you would like to download packages from remote instead of local filesystem.
 | 
					* ``AHRIMAN_REPOSITORY_SERVER`` - optional override for the repository URL. Useful if you would like to download packages from remote instead of local filesystem.
 | 
				
			||||||
* ``AHRIMAN_REPOSITORY_ROOT`` - repository root. Because of filesystem rights it is required to override default repository root. By default, it uses ``ahriman`` directory inside ahriman's home, which can be passed as mount volume.
 | 
					* ``AHRIMAN_REPOSITORY_ROOT`` - repository root. Because of filesystem rights it is required to override default repository root. By default, it uses ``ahriman`` directory inside ahriman's home, which can be passed as mount volume.
 | 
				
			||||||
* ``AHRIMAN_UNIX_SOCKET`` - full path to unix socket which is used by web server, default is empty. Note that more likely you would like to put it inside ``AHRIMAN_REPOSITORY_ROOT`` directory (e.g. ``/var/lib/ahriman/ahriman/ahriman-web.sock``) or to ``/run/ahriman``.
 | 
					* ``AHRIMAN_UNIX_SOCKET`` - full path to unix socket which is used by web server, default is empty. Note that more likely you would like to put it inside ``AHRIMAN_REPOSITORY_ROOT`` directory (e.g. ``/var/lib/ahriman/ahriman/ahriman-web.sock``) or to ``/tmp``.
 | 
				
			||||||
* ``AHRIMAN_USER`` - ahriman user, usually must not be overwritten, default is ``ahriman``.
 | 
					* ``AHRIMAN_USER`` - ahriman user, usually must not be overwritten, default is ``ahriman``.
 | 
				
			||||||
* ``AHRIMAN_VALIDATE_CONFIGURATION`` - if set (default) validate service configuration.
 | 
					* ``AHRIMAN_VALIDATE_CONFIGURATION`` - if set (default) validate service configuration.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -1318,7 +1318,7 @@ How to enable basic authorization
 | 
				
			|||||||
   .. code-block:: ini
 | 
					   .. code-block:: ini
 | 
				
			||||||
 | 
					
 | 
				
			||||||
      [web]
 | 
					      [web]
 | 
				
			||||||
      unix_socket = /run/ahriman/ahriman-web.sock
 | 
					      unix_socket = /var/lib/ahriman/ahriman-web.sock
 | 
				
			||||||
 | 
					
 | 
				
			||||||
   This socket path must be available for web service instance and must be available for all application instances (e.g. in case if you are using docker container - see above - you need to make sure that the socket is passed to the root filesystem).
 | 
					   This socket path must be available for web service instance and must be available for all application instances (e.g. in case if you are using docker container - see above - you need to make sure that the socket is passed to the root filesystem).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -1,2 +1 @@
 | 
				
			|||||||
d /var/lib/ahriman 0755 ahriman ahriman
 | 
					d /var/lib/ahriman 0755 ahriman ahriman
 | 
				
			||||||
d /run/ahriman 0755 ahriman ahriman
 | 
					 | 
				
			||||||
@ -19,6 +19,7 @@
 | 
				
			|||||||
#
 | 
					#
 | 
				
			||||||
# pylint: disable=too-many-lines
 | 
					# pylint: disable=too-many-lines
 | 
				
			||||||
import argparse
 | 
					import argparse
 | 
				
			||||||
 | 
					import tempfile
 | 
				
			||||||
 | 
					
 | 
				
			||||||
from pathlib import Path
 | 
					from pathlib import Path
 | 
				
			||||||
from typing import TypeVar
 | 
					from typing import TypeVar
 | 
				
			||||||
@ -72,7 +73,8 @@ def _parser() -> argparse.ArgumentParser:
 | 
				
			|||||||
    parser.add_argument("-c", "--configuration", help="configuration path", type=Path,
 | 
					    parser.add_argument("-c", "--configuration", help="configuration path", type=Path,
 | 
				
			||||||
                        default=Path("/") / "etc" / "ahriman.ini")
 | 
					                        default=Path("/") / "etc" / "ahriman.ini")
 | 
				
			||||||
    parser.add_argument("--force", help="force run, remove file lock", action="store_true")
 | 
					    parser.add_argument("--force", help="force run, remove file lock", action="store_true")
 | 
				
			||||||
    parser.add_argument("-l", "--lock", help="lock file", type=Path, default=Path("ahriman.pid"))
 | 
					    parser.add_argument("-l", "--lock", help="lock file", type=Path,
 | 
				
			||||||
 | 
					                        default=Path(tempfile.gettempdir()) / "ahriman.lock")
 | 
				
			||||||
    parser.add_argument("--log-handler", help="explicit log handler specification. If none set, the handler will be "
 | 
					    parser.add_argument("--log-handler", help="explicit log handler specification. If none set, the handler will be "
 | 
				
			||||||
                                              "guessed from environment",
 | 
					                                              "guessed from environment",
 | 
				
			||||||
                        type=LogHandler, choices=enum_values(LogHandler))
 | 
					                        type=LogHandler, choices=enum_values(LogHandler))
 | 
				
			||||||
@ -626,7 +628,8 @@ def _set_repo_daemon_parser(root: SubParserAction) -> argparse.ArgumentParser:
 | 
				
			|||||||
    parser.add_argument("-y", "--refresh", help="download fresh package databases from the mirror before actions, "
 | 
					    parser.add_argument("-y", "--refresh", help="download fresh package databases from the mirror before actions, "
 | 
				
			||||||
                                                "-yy to force refresh even if up to date",
 | 
					                                                "-yy to force refresh even if up to date",
 | 
				
			||||||
                        action="count", default=False)
 | 
					                        action="count", default=False)
 | 
				
			||||||
    parser.set_defaults(handler=handlers.Daemon, exit_code=False, lock=Path("ahriman-daemon.pid"), package=[])
 | 
					    parser.set_defaults(handler=handlers.Daemon, exit_code=False,
 | 
				
			||||||
 | 
					                        lock=Path(tempfile.gettempdir()) / "ahriman-daemon.lock", package=[])
 | 
				
			||||||
    return parser
 | 
					    return parser
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -877,7 +880,7 @@ def _set_service_clean_parser(root: SubParserAction) -> argparse.ArgumentParser:
 | 
				
			|||||||
                        action=argparse.BooleanOptionalAction, default=False)
 | 
					                        action=argparse.BooleanOptionalAction, default=False)
 | 
				
			||||||
    parser.add_argument("--pacman", help="clear directory with pacman local database cache",
 | 
					    parser.add_argument("--pacman", help="clear directory with pacman local database cache",
 | 
				
			||||||
                        action=argparse.BooleanOptionalAction, default=False)
 | 
					                        action=argparse.BooleanOptionalAction, default=False)
 | 
				
			||||||
    parser.set_defaults(handler=handlers.Clean, lock=None, quiet=True, unsafe=True)
 | 
					    parser.set_defaults(handler=handlers.Clean, quiet=True, unsafe=True)
 | 
				
			||||||
    return parser
 | 
					    return parser
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -1136,8 +1139,8 @@ def _set_web_parser(root: SubParserAction) -> argparse.ArgumentParser:
 | 
				
			|||||||
        argparse.ArgumentParser: created argument parser
 | 
					        argparse.ArgumentParser: created argument parser
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    parser = root.add_parser("web", help="web server", description="start web server", formatter_class=_formatter)
 | 
					    parser = root.add_parser("web", help="web server", description="start web server", formatter_class=_formatter)
 | 
				
			||||||
    parser.set_defaults(handler=handlers.Web, architecture="", lock=Path("ahriman-web.pid"), report=False,
 | 
					    parser.set_defaults(handler=handlers.Web, architecture="", lock=Path(tempfile.gettempdir()) / "ahriman-web.lock",
 | 
				
			||||||
                        repository="", parser=_parser)
 | 
					                        report=False, repository="", parser=_parser)
 | 
				
			||||||
    return parser
 | 
					    return parser
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -18,10 +18,7 @@
 | 
				
			|||||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
 | 
					# along with this program. If not, see <http://www.gnu.org/licenses/>.
 | 
				
			||||||
#
 | 
					#
 | 
				
			||||||
import argparse
 | 
					import argparse
 | 
				
			||||||
import fcntl
 | 
					 | 
				
			||||||
import os
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
from io import TextIOWrapper
 | 
					 | 
				
			||||||
from pathlib import Path
 | 
					from pathlib import Path
 | 
				
			||||||
from types import TracebackType
 | 
					from types import TracebackType
 | 
				
			||||||
from typing import Literal, Self
 | 
					from typing import Literal, Self
 | 
				
			||||||
@ -39,7 +36,7 @@ from ahriman.models.waiter import Waiter
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
class Lock(LazyLogging):
 | 
					class Lock(LazyLogging):
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    wrapper for application lock file. Credits for idea to https://github.com/bmhatfield/python-pidfile.git
 | 
					    wrapper for application lock file
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    Attributes:
 | 
					    Attributes:
 | 
				
			||||||
        force(bool): remove lock file on start if any
 | 
					        force(bool): remove lock file on start if any
 | 
				
			||||||
@ -73,13 +70,8 @@ class Lock(LazyLogging):
 | 
				
			|||||||
            repository_id(RepositoryId): repository unique identifier
 | 
					            repository_id(RepositoryId): repository unique identifier
 | 
				
			||||||
            configuration(Configuration): configuration instance
 | 
					            configuration(Configuration): configuration instance
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        self.path: Path | None = None
 | 
					        self.path: Path | None = \
 | 
				
			||||||
        if args.lock is not None:
 | 
					            args.lock.with_stem(f"{args.lock.stem}_{repository_id.id}") if args.lock is not None else None
 | 
				
			||||||
            self.path = args.lock.with_stem(f"{args.lock.stem}_{repository_id.id}")
 | 
					 | 
				
			||||||
            if not self.path.is_absolute():
 | 
					 | 
				
			||||||
                # prepend full path to the lock file
 | 
					 | 
				
			||||||
                self.path = Path("/") / "run" / "ahriman" / self.path
 | 
					 | 
				
			||||||
        self._pid_file: TextIOWrapper | None = None
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
        self.force: bool = args.force
 | 
					        self.force: bool = args.force
 | 
				
			||||||
        self.unsafe: bool = args.unsafe
 | 
					        self.unsafe: bool = args.unsafe
 | 
				
			||||||
@ -88,72 +80,6 @@ class Lock(LazyLogging):
 | 
				
			|||||||
        self.paths = configuration.repository_paths
 | 
					        self.paths = configuration.repository_paths
 | 
				
			||||||
        self.reporter = Client.load(repository_id, configuration, report=args.report)
 | 
					        self.reporter = Client.load(repository_id, configuration, report=args.report)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    @staticmethod
 | 
					 | 
				
			||||||
    def perform_lock(fd: int) -> bool:
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        perform file lock
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Args:
 | 
					 | 
				
			||||||
            fd(int): file descriptor:
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Returns:
 | 
					 | 
				
			||||||
            bool: True in case if file is locked and False otherwise
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        try:
 | 
					 | 
				
			||||||
            fcntl.flock(fd, fcntl.LOCK_EX | fcntl.LOCK_NB)
 | 
					 | 
				
			||||||
        except OSError:
 | 
					 | 
				
			||||||
            return False
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        return True
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    def _open(self) -> None:
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        create lock file
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        if self.path is None:
 | 
					 | 
				
			||||||
            return
 | 
					 | 
				
			||||||
        self._pid_file = self.path.open("a+")
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    def _watch(self) -> bool:
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        watch until lock disappear
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Returns:
 | 
					 | 
				
			||||||
            bool: True in case if file is locked and False otherwise
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        # there are reasons why we are not using inotify here. First of all, if we would use it, it would bring to
 | 
					 | 
				
			||||||
        # race conditions because multiple processes will be notified at the same time. Secondly, it is good library,
 | 
					 | 
				
			||||||
        # but platform-specific, and we only need to check if file exists
 | 
					 | 
				
			||||||
        if self._pid_file is None:
 | 
					 | 
				
			||||||
            return False
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        waiter = Waiter(self.wait_timeout)
 | 
					 | 
				
			||||||
        return bool(waiter.wait(lambda fd: not self.perform_lock(fd), self._pid_file.fileno()))
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    def _write(self, *, is_locked: bool = False) -> None:
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        write pid to the lock file
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Args:
 | 
					 | 
				
			||||||
            is_locked(bool, optional): indicates if file was already locked or not (Default value = False)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Raises:
 | 
					 | 
				
			||||||
            DuplicateRunError: if it cannot lock PID file
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        if self._pid_file is None:
 | 
					 | 
				
			||||||
            return
 | 
					 | 
				
			||||||
        if not is_locked:
 | 
					 | 
				
			||||||
            if not self.perform_lock(self._pid_file.fileno()):
 | 
					 | 
				
			||||||
                raise DuplicateRunError
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        self._pid_file.seek(0)  # reset position and remove file content if any
 | 
					 | 
				
			||||||
        self._pid_file.truncate()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        self._pid_file.write(str(os.getpid()))  # write current pid
 | 
					 | 
				
			||||||
        self._pid_file.flush()  # flush data to disk
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        self._pid_file.seek(0)  # reset position again
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    def check_user(self) -> None:
 | 
					    def check_user(self) -> None:
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        check if current user is actually owner of ahriman root
 | 
					        check if current user is actually owner of ahriman root
 | 
				
			||||||
@ -174,33 +100,46 @@ class Lock(LazyLogging):
 | 
				
			|||||||
        """
 | 
					        """
 | 
				
			||||||
        remove lock file
 | 
					        remove lock file
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        if self._pid_file is not None:  # close file descriptor
 | 
					        if self.path is None:
 | 
				
			||||||
            try:
 | 
					            return
 | 
				
			||||||
                self._pid_file.close()
 | 
					 | 
				
			||||||
            except IOError:
 | 
					 | 
				
			||||||
                pass  # suppress any IO errors occur
 | 
					 | 
				
			||||||
        if self.path is not None:  # remove lock file
 | 
					 | 
				
			||||||
        self.path.unlink(missing_ok=True)
 | 
					        self.path.unlink(missing_ok=True)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    def lock(self) -> None:
 | 
					    def create(self) -> None:
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        create pid file
 | 
					        create lock file
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        Raises:
 | 
				
			||||||
 | 
					            DuplicateRunError: if lock exists and no force flag supplied
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        if self.force:  # remove lock if force flag is set
 | 
					        if self.path is None:
 | 
				
			||||||
            self.clear()
 | 
					            return
 | 
				
			||||||
        self._open()
 | 
					        try:
 | 
				
			||||||
        is_locked = self._watch()
 | 
					            self.path.touch(exist_ok=self.force)
 | 
				
			||||||
        self._write(is_locked=is_locked)
 | 
					        except FileExistsError:
 | 
				
			||||||
 | 
					            raise DuplicateRunError from None
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    def watch(self) -> None:
 | 
				
			||||||
 | 
					        """
 | 
				
			||||||
 | 
					        watch until lock disappear
 | 
				
			||||||
 | 
					        """
 | 
				
			||||||
 | 
					        # there are reasons why we are not using inotify here. First of all, if we would use it, it would bring to
 | 
				
			||||||
 | 
					        # race conditions because multiple processes will be notified in the same time. Secondly, it is good library,
 | 
				
			||||||
 | 
					        # but platform-specific, and we only need to check if file exists
 | 
				
			||||||
 | 
					        if self.path is None:
 | 
				
			||||||
 | 
					            return
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					        waiter = Waiter(self.wait_timeout)
 | 
				
			||||||
 | 
					        waiter.wait(self.path.is_file)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    def __enter__(self) -> Self:
 | 
					    def __enter__(self) -> Self:
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        default workflow is the following:
 | 
					        default workflow is the following:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
            #. Check user UID
 | 
					            #. Check user UID
 | 
				
			||||||
 | 
					            #. Check if there is lock file
 | 
				
			||||||
            #. Check web status watcher status
 | 
					            #. Check web status watcher status
 | 
				
			||||||
            #. Open lock file
 | 
					 | 
				
			||||||
            #. Wait for lock file to be free
 | 
					            #. Wait for lock file to be free
 | 
				
			||||||
            #. Write current PID to the lock file
 | 
					            #. Create lock file and directory tree
 | 
				
			||||||
            #. Report to status page if enabled
 | 
					            #. Report to status page if enabled
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        Returns:
 | 
					        Returns:
 | 
				
			||||||
@ -208,7 +147,8 @@ class Lock(LazyLogging):
 | 
				
			|||||||
        """
 | 
					        """
 | 
				
			||||||
        self.check_user()
 | 
					        self.check_user()
 | 
				
			||||||
        self.check_version()
 | 
					        self.check_version()
 | 
				
			||||||
        self.lock()
 | 
					        self.watch()
 | 
				
			||||||
 | 
					        self.create()
 | 
				
			||||||
        self.reporter.status_update(BuildStatusEnum.Building)
 | 
					        self.reporter.status_update(BuildStatusEnum.Building)
 | 
				
			||||||
        return self
 | 
					        return self
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -46,8 +46,8 @@ class SyncAhrimanClient(SyncHttpClient):
 | 
				
			|||||||
            request.Session: created session object
 | 
					            request.Session: created session object
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        if urlparse(self.address).scheme == "http+unix":
 | 
					        if urlparse(self.address).scheme == "http+unix":
 | 
				
			||||||
            import requests_unixsocket
 | 
					            import requests_unixsocket  # type: ignore[import-untyped]
 | 
				
			||||||
            session: requests.Session = requests_unixsocket.Session()  # type: ignore[no-untyped-call]
 | 
					            session: requests.Session = requests_unixsocket.Session()
 | 
				
			||||||
            session.headers["User-Agent"] = f"ahriman/{__version__}"
 | 
					            session.headers["User-Agent"] = f"ahriman/{__version__}"
 | 
				
			||||||
            return session
 | 
					            return session
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -28,7 +28,7 @@ class FilesystemPackage:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
    Attributes:
 | 
					    Attributes:
 | 
				
			||||||
        package_name(str): package name
 | 
					        package_name(str): package name
 | 
				
			||||||
        depends(list[str]): list of package dependencies
 | 
					        dependencies(list[str]): list of package dependencies
 | 
				
			||||||
        directories(list[Path]): list of directories this package contains
 | 
					        directories(list[Path]): list of directories this package contains
 | 
				
			||||||
        files(list[Path]): list of files this package contains
 | 
					        files(list[Path]): list of files this package contains
 | 
				
			||||||
        groups(list[str]): list of groups of the package
 | 
					        groups(list[str]): list of groups of the package
 | 
				
			||||||
@ -36,15 +36,20 @@ class FilesystemPackage:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
    package_name: str
 | 
					    package_name: str
 | 
				
			||||||
    groups: set[str]
 | 
					    groups: set[str]
 | 
				
			||||||
    depends: set[str]
 | 
					    dependencies: set[str]
 | 
				
			||||||
    directories: list[Path] = field(default_factory=list)
 | 
					    directories: list[Path] = field(default_factory=list)
 | 
				
			||||||
    files: list[Path] = field(default_factory=list)
 | 
					    files: list[Path] = field(default_factory=list)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    def __repr__(self) -> str:
 | 
					    @property
 | 
				
			||||||
 | 
					    def is_valid(self) -> bool:
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        generate string representation of object
 | 
					        quick check if this package must be used for the dependencies calculation. It checks that
 | 
				
			||||||
 | 
					        1) package is not in the base group
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        Returns:
 | 
					        Returns:
 | 
				
			||||||
            str: unique string representation
 | 
					            bool: True in case if this package must be used for the dependencies calculation or False otherwise
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        return f'FilesystemPackage(package_name={self.package_name}, depends={self.depends})'
 | 
					        return "base" not in self.groups
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    def __repr__(self):
 | 
				
			||||||
 | 
					        return f'FilesystemPackage(package_name="{self.package_name}", dependencies={self.dependencies})'
 | 
				
			||||||
 | 
				
			|||||||
@ -111,10 +111,10 @@ class PackageArchive:
 | 
				
			|||||||
            return FilesystemPackage(
 | 
					            return FilesystemPackage(
 | 
				
			||||||
                package_name=package_name,
 | 
					                package_name=package_name,
 | 
				
			||||||
                groups=set(pacman_package.groups),
 | 
					                groups=set(pacman_package.groups),
 | 
				
			||||||
                depends=set(pacman_package.depends),
 | 
					                dependencies=set(pacman_package.depends),
 | 
				
			||||||
            )
 | 
					            )
 | 
				
			||||||
        except UnknownPackageError:
 | 
					        except UnknownPackageError:
 | 
				
			||||||
            return FilesystemPackage(package_name=package_name, groups=set(), depends=set())
 | 
					            return FilesystemPackage(package_name=package_name, groups=set(), dependencies=set())
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    def depends_on(self) -> Dependencies:
 | 
					    def depends_on(self) -> Dependencies:
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
@ -126,8 +126,6 @@ class PackageArchive:
 | 
				
			|||||||
        dependencies, roots = self.depends_on_paths()
 | 
					        dependencies, roots = self.depends_on_paths()
 | 
				
			||||||
        installed_packages = self.installed_packages()
 | 
					        installed_packages = self.installed_packages()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        # build initial map of file path -> packages containing this path
 | 
					 | 
				
			||||||
        # in fact, keys will contain all libraries the package linked to and all directories it contains
 | 
					 | 
				
			||||||
        dependencies_per_path: dict[Path, list[FilesystemPackage]] = {}
 | 
					        dependencies_per_path: dict[Path, list[FilesystemPackage]] = {}
 | 
				
			||||||
        for package_base, package in installed_packages.items():
 | 
					        for package_base, package in installed_packages.items():
 | 
				
			||||||
            if package_base in self.package.packages:
 | 
					            if package_base in self.package.packages:
 | 
				
			||||||
@ -141,32 +139,20 @@ class PackageArchive:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
        # reduce trees
 | 
					        # reduce trees
 | 
				
			||||||
        result = {}
 | 
					        result = {}
 | 
				
			||||||
        base_packages = OfficialSyncdb.info("base", pacman=self.pacman).depends
 | 
					        for path, packages in dependencies_per_path.items():
 | 
				
			||||||
        # sort items from children directories to root
 | 
					 | 
				
			||||||
        for path, packages in reversed(sorted(dependencies_per_path.items())):
 | 
					 | 
				
			||||||
            package_names = [package.package_name for package in packages]
 | 
					            package_names = [package.package_name for package in packages]
 | 
				
			||||||
            reduced_packages_list = [
 | 
					            result[str(path)] = [
 | 
				
			||||||
                package.package_name
 | 
					                package.package_name
 | 
				
			||||||
                for package in packages
 | 
					                for package in packages
 | 
				
			||||||
                # if there is any package which is dependency of this package, we can skip it here
 | 
					                # if there is any package which is dependency of this package, we can skip it here
 | 
				
			||||||
                if not package.depends.intersection(package_names)
 | 
					                # also skip packages which didn't pass validation
 | 
				
			||||||
 | 
					                if not package.dependencies.intersection(package_names) and package.is_valid
 | 
				
			||||||
            ]
 | 
					            ]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
            # skip if this path belongs to the one of the base packages
 | 
					            if str(path) == 'usr/lib/python3.12/site-packages':
 | 
				
			||||||
            if any(package in reduced_packages_list for package in base_packages):
 | 
					                print(package_names)
 | 
				
			||||||
                continue
 | 
					                print(packages)
 | 
				
			||||||
 | 
					                print(result[str(path)])
 | 
				
			||||||
            # check if there is already parent of current path in the result and has the same packages
 | 
					 | 
				
			||||||
            for children_path, children_packages in result.items():
 | 
					 | 
				
			||||||
                if not Path(children_path).is_relative_to(path):
 | 
					 | 
				
			||||||
                    continue
 | 
					 | 
				
			||||||
                reduced_packages_list = [
 | 
					 | 
				
			||||||
                    package_name
 | 
					 | 
				
			||||||
                    for package_name in reduced_packages_list
 | 
					 | 
				
			||||||
                    if package_name not in children_packages
 | 
					 | 
				
			||||||
                ]
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
            result[str(path)] = reduced_packages_list
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
        return Dependencies(result)
 | 
					        return Dependencies(result)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -202,13 +188,13 @@ class PackageArchive:
 | 
				
			|||||||
        for path in filter(lambda fn: fn.name == "files", walk(pacman_local_files)):
 | 
					        for path in filter(lambda fn: fn.name == "files", walk(pacman_local_files)):
 | 
				
			||||||
            package = self._load_pacman_package(path)
 | 
					            package = self._load_pacman_package(path)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
            is_files_section = False
 | 
					            is_files = False
 | 
				
			||||||
            for line in path.read_text(encoding="utf8").splitlines():
 | 
					            for line in path.read_text(encoding="utf8").splitlines():
 | 
				
			||||||
                if not line:  # skip empty lines
 | 
					                if not line:  # skip empty lines
 | 
				
			||||||
                    continue
 | 
					                    continue
 | 
				
			||||||
                if line.startswith("%") and line.endswith("%"):  # directive started
 | 
					                if line.startswith("%") and line.endswith("%"):  # directive started
 | 
				
			||||||
                    is_files_section = line == "%FILES%"
 | 
					                    is_files = line == "%FILES%"
 | 
				
			||||||
                if not is_files_section:  # not a files directive
 | 
					                if not is_files:  # not a files directive
 | 
				
			||||||
                    continue
 | 
					                    continue
 | 
				
			||||||
 | 
					
 | 
				
			||||||
                entry = Path(line)
 | 
					                entry = Path(line)
 | 
				
			||||||
 | 
				
			|||||||
@ -21,87 +21,27 @@ import time
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
from collections.abc import Callable
 | 
					from collections.abc import Callable
 | 
				
			||||||
from dataclasses import dataclass, field
 | 
					from dataclasses import dataclass, field
 | 
				
			||||||
from typing import Literal, ParamSpec
 | 
					from typing import ParamSpec
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Params = ParamSpec("Params")
 | 
					Params = ParamSpec("Params")
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@dataclass(frozen=True)
 | 
					 | 
				
			||||||
class WaiterResult:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    representation of a waiter result. This class should not be used directly, use derivatives instead
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    Attributes:
 | 
					 | 
				
			||||||
        took(float): consumed time in seconds
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    took: float
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    def __bool__(self) -> bool:
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        indicates whether the waiter completed with success or not
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Raises:
 | 
					 | 
				
			||||||
            NotImplementedError: not implemented method
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        raise NotImplementedError
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    def __float__(self) -> float:
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        extract time spent to retrieve the result in seconds
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Returns:
 | 
					 | 
				
			||||||
            float: consumed time in seconds
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        return self.took
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
class WaiterTaskFinished(WaiterResult):
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    a waiter result used to notify that the task has been completed successfully
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    def __bool__(self) -> Literal[True]:
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        indicates whether the waiter completed with success or not
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Returns:
 | 
					 | 
				
			||||||
            Literal[True]: always False
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        return True
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
class WaiterTimedOut(WaiterResult):
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    a waiter result used to notify that the waiter run out of time
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    def __bool__(self) -> Literal[False]:
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        indicates whether the waiter completed with success or not
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        Returns:
 | 
					 | 
				
			||||||
            Literal[False]: always False
 | 
					 | 
				
			||||||
        """
 | 
					 | 
				
			||||||
        return False
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
@dataclass(frozen=True)
 | 
					@dataclass(frozen=True)
 | 
				
			||||||
class Waiter:
 | 
					class Waiter:
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    simple waiter implementation
 | 
					    simple waiter implementation
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    Attributes:
 | 
					    Attributes:
 | 
				
			||||||
        interval(float): interval in seconds between checks
 | 
					        interval(int): interval in seconds between checks
 | 
				
			||||||
        start_time(float): monotonic time of the waiter start. More likely must not be assigned explicitly
 | 
					        start_time(float): monotonic time of the waiter start. More likely must not be assigned explicitly
 | 
				
			||||||
        wait_timeout(float): timeout in seconds to wait for. Negative value will result in immediate exit. Zero value
 | 
					        wait_timeout(int): timeout in seconds to wait for. Negative value will result in immediate exit. Zero value
 | 
				
			||||||
    means infinite timeout
 | 
					    means infinite timeout
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    wait_timeout: float
 | 
					    wait_timeout: int
 | 
				
			||||||
    start_time: float = field(default_factory=time.monotonic, kw_only=True)
 | 
					    start_time: float = field(default_factory=time.monotonic, kw_only=True)
 | 
				
			||||||
    interval: float = field(default=10, kw_only=True)
 | 
					    interval: int = field(default=10, kw_only=True)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    def is_timed_out(self) -> bool:
 | 
					    def is_timed_out(self) -> bool:
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
@ -111,10 +51,10 @@ class Waiter:
 | 
				
			|||||||
            bool: True in case current monotonic time is more than :attr:`start_time` and :attr:`wait_timeout`
 | 
					            bool: True in case current monotonic time is more than :attr:`start_time` and :attr:`wait_timeout`
 | 
				
			||||||
            doesn't equal to 0
 | 
					            doesn't equal to 0
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        since_start = time.monotonic() - self.start_time
 | 
					        since_start: float = time.monotonic() - self.start_time
 | 
				
			||||||
        return self.wait_timeout != 0 and since_start > self.wait_timeout
 | 
					        return self.wait_timeout != 0 and since_start > self.wait_timeout
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    def wait(self, in_progress: Callable[Params, bool], *args: Params.args, **kwargs: Params.kwargs) -> WaiterResult:
 | 
					    def wait(self, in_progress: Callable[Params, bool], *args: Params.args, **kwargs: Params.kwargs) -> float:
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        wait until requirements are not met
 | 
					        wait until requirements are not met
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -124,12 +64,9 @@ class Waiter:
 | 
				
			|||||||
            **kwargs(Params.kwargs): keyword arguments for check call
 | 
					            **kwargs(Params.kwargs): keyword arguments for check call
 | 
				
			||||||
 | 
					
 | 
				
			||||||
        Returns:
 | 
					        Returns:
 | 
				
			||||||
            WaiterResult: consumed time in seconds
 | 
					            float: consumed time in seconds
 | 
				
			||||||
        """
 | 
					        """
 | 
				
			||||||
        while not (timed_out := self.is_timed_out()) and in_progress(*args, **kwargs):
 | 
					        while not self.is_timed_out() and in_progress(*args, **kwargs):
 | 
				
			||||||
            time.sleep(self.interval)
 | 
					            time.sleep(self.interval)
 | 
				
			||||||
        took = time.monotonic() - self.start_time
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
        if timed_out:
 | 
					        return time.monotonic() - self.start_time
 | 
				
			||||||
            return WaiterTimedOut(took)
 | 
					 | 
				
			||||||
        return WaiterTaskFinished(took)
 | 
					 | 
				
			||||||
 | 
				
			|||||||
@ -1097,10 +1097,9 @@ def test_subparsers_repo_update_option_refresh(parser: argparse.ArgumentParser)
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
def test_subparsers_service_clean(parser: argparse.ArgumentParser) -> None:
 | 
					def test_subparsers_service_clean(parser: argparse.ArgumentParser) -> None:
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    service-clean command must imply lock, quiet and unsafe
 | 
					    service-clean command must imply quiet and unsafe
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    args = parser.parse_args(["service-clean"])
 | 
					    args = parser.parse_args(["service-clean"])
 | 
				
			||||||
    assert args.lock is None
 | 
					 | 
				
			||||||
    assert args.quiet
 | 
					    assert args.quiet
 | 
				
			||||||
    assert args.unsafe
 | 
					    assert args.unsafe
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -1,12 +1,10 @@
 | 
				
			|||||||
import argparse
 | 
					import argparse
 | 
				
			||||||
import fcntl
 | 
					 | 
				
			||||||
import os
 | 
					 | 
				
			||||||
import pytest
 | 
					import pytest
 | 
				
			||||||
 | 
					import tempfile
 | 
				
			||||||
 | 
					
 | 
				
			||||||
from pathlib import Path
 | 
					from pathlib import Path
 | 
				
			||||||
from pytest_mock import MockerFixture
 | 
					from pytest_mock import MockerFixture
 | 
				
			||||||
from tempfile import NamedTemporaryFile
 | 
					from unittest.mock import call as MockCall
 | 
				
			||||||
from unittest.mock import MagicMock, call as MockCall
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
from ahriman import __version__
 | 
					from ahriman import __version__
 | 
				
			||||||
from ahriman.application.lock import Lock
 | 
					from ahriman.application.lock import Lock
 | 
				
			||||||
@ -24,113 +22,14 @@ def test_path(args: argparse.Namespace, configuration: Configuration) -> None:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
    assert Lock(args, repository_id, configuration).path is None
 | 
					    assert Lock(args, repository_id, configuration).path is None
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    args.lock = Path("/run/ahriman.pid")
 | 
					    args.lock = Path("/run/ahriman.lock")
 | 
				
			||||||
    assert Lock(args, repository_id, configuration).path == Path("/run/ahriman_x86_64-aur-clone.pid")
 | 
					    assert Lock(args, repository_id, configuration).path == Path("/run/ahriman_x86_64-aur-clone.lock")
 | 
				
			||||||
 | 
					 | 
				
			||||||
    args.lock = Path("ahriman.pid")
 | 
					 | 
				
			||||||
    assert Lock(args, repository_id, configuration).path == Path("/run/ahriman/ahriman_x86_64-aur-clone.pid")
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
    with pytest.raises(ValueError):
 | 
					    with pytest.raises(ValueError):
 | 
				
			||||||
        args.lock = Path("/")
 | 
					        args.lock = Path("/")
 | 
				
			||||||
        assert Lock(args, repository_id, configuration).path  # special case
 | 
					        assert Lock(args, repository_id, configuration).path  # special case
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
def test_perform_lock(mocker: MockerFixture) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must lock file with fcntl
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    flock_mock = mocker.patch("fcntl.flock")
 | 
					 | 
				
			||||||
    assert Lock.perform_lock(1)
 | 
					 | 
				
			||||||
    flock_mock.assert_called_once_with(1, fcntl.LOCK_EX | fcntl.LOCK_NB)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_perform_lock_exception(mocker: MockerFixture) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must return False on OSError
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    mocker.patch("fcntl.flock", side_effect=OSError)
 | 
					 | 
				
			||||||
    assert not Lock.perform_lock(1)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_open(lock: Lock, mocker: MockerFixture) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must open file
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    open_mock = mocker.patch("pathlib.Path.open")
 | 
					 | 
				
			||||||
    lock.path = Path("ahriman.pid")
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    lock._open()
 | 
					 | 
				
			||||||
    open_mock.assert_called_once_with("a+")
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_open_skip(lock: Lock, mocker: MockerFixture) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must skip file opening if path is not set
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    open_mock = mocker.patch("pathlib.Path.open")
 | 
					 | 
				
			||||||
    lock._open()
 | 
					 | 
				
			||||||
    open_mock.assert_not_called()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_watch(lock: Lock, mocker: MockerFixture) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must check if lock file exists
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    lock._pid_file = MagicMock()
 | 
					 | 
				
			||||||
    lock._pid_file.fileno.return_value = 1
 | 
					 | 
				
			||||||
    wait_mock = mocker.patch("ahriman.models.waiter.Waiter.wait")
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    lock._watch()
 | 
					 | 
				
			||||||
    wait_mock.assert_called_once_with(pytest.helpers.anyvar(int), 1)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_watch_skip(lock: Lock, mocker: MockerFixture) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must skip watch on empty path
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    mocker.patch("ahriman.application.lock.Lock.perform_lock", return_value=True)
 | 
					 | 
				
			||||||
    lock._watch()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_write(lock: Lock) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must write PID to lock file
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    with NamedTemporaryFile("a+") as pid_file:
 | 
					 | 
				
			||||||
        lock._pid_file = pid_file
 | 
					 | 
				
			||||||
        lock._write(is_locked=False)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
        assert int(lock._pid_file.readline()) == os.getpid()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_write_skip(lock: Lock) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must skip write to file if no path set
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    lock._write(is_locked=False)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_write_locked(lock: Lock, mocker: MockerFixture) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must raise DuplicateRunError if cannot lock file
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    mocker.patch("ahriman.application.lock.Lock.perform_lock", return_value=False)
 | 
					 | 
				
			||||||
    with pytest.raises(DuplicateRunError):
 | 
					 | 
				
			||||||
        lock._pid_file = MagicMock()
 | 
					 | 
				
			||||||
        lock._write(is_locked=False)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_write_locked_before(lock: Lock, mocker: MockerFixture) -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must skip lock in case if file was locked before
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    lock_mock = mocker.patch("ahriman.application.lock.Lock.perform_lock")
 | 
					 | 
				
			||||||
    lock._pid_file = MagicMock()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    lock._write(is_locked=True)
 | 
					 | 
				
			||||||
    lock_mock.assert_not_called()
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_check_user(lock: Lock, mocker: MockerFixture) -> None:
 | 
					def test_check_user(lock: Lock, mocker: MockerFixture) -> None:
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    must check user correctly
 | 
					    must check user correctly
 | 
				
			||||||
@ -189,7 +88,7 @@ def test_clear(lock: Lock) -> None:
 | 
				
			|||||||
    """
 | 
					    """
 | 
				
			||||||
    must remove lock file
 | 
					    must remove lock file
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    lock.path = Path("ahriman-test.pid")
 | 
					    lock.path = Path(tempfile.gettempdir()) / "ahriman-test.lock"
 | 
				
			||||||
    lock.path.touch()
 | 
					    lock.path.touch()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    lock.clear()
 | 
					    lock.clear()
 | 
				
			||||||
@ -200,7 +99,7 @@ def test_clear_missing(lock: Lock) -> None:
 | 
				
			|||||||
    """
 | 
					    """
 | 
				
			||||||
    must not fail on lock removal if file is missing
 | 
					    must not fail on lock removal if file is missing
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    lock.path = Path("ahriman-test.pid")
 | 
					    lock.path = Path(tempfile.gettempdir()) / "ahriman-test.lock"
 | 
				
			||||||
    lock.clear()
 | 
					    lock.clear()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -213,52 +112,67 @@ def test_clear_skip(lock: Lock, mocker: MockerFixture) -> None:
 | 
				
			|||||||
    unlink_mock.assert_not_called()
 | 
					    unlink_mock.assert_not_called()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
def test_clear_close(lock: Lock) -> None:
 | 
					def test_create(lock: Lock) -> None:
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    must close pid file if opened
 | 
					    must create lock
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    close_mock = lock._pid_file = MagicMock()
 | 
					    lock.path = Path(tempfile.gettempdir()) / "ahriman-test.lock"
 | 
				
			||||||
    lock.clear()
 | 
					
 | 
				
			||||||
    close_mock.close.assert_called_once_with()
 | 
					    lock.create()
 | 
				
			||||||
 | 
					    assert lock.path.is_file()
 | 
				
			||||||
 | 
					    lock.path.unlink()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
def test_clear_close_exception(lock: Lock) -> None:
 | 
					def test_create_exception(lock: Lock) -> None:
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    must suppress IO exception on file closure
 | 
					    must raise exception if file already exists
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    close_mock = lock._pid_file = MagicMock()
 | 
					    lock.path = Path(tempfile.gettempdir()) / "ahriman-test.lock"
 | 
				
			||||||
    close_mock.close.side_effect = IOError()
 | 
					    lock.path.touch()
 | 
				
			||||||
    lock.clear()
 | 
					
 | 
				
			||||||
 | 
					    with pytest.raises(DuplicateRunError):
 | 
				
			||||||
 | 
					        lock.create()
 | 
				
			||||||
 | 
					    lock.path.unlink()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
def test_lock(lock: Lock, mocker: MockerFixture) -> None:
 | 
					def test_create_skip(lock: Lock, mocker: MockerFixture) -> None:
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    must perform lock correctly
 | 
					    must skip creating if no file set
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    clear_mock = mocker.patch("ahriman.application.lock.Lock.clear")
 | 
					    touch_mock = mocker.patch("pathlib.Path.touch")
 | 
				
			||||||
    open_mock = mocker.patch("ahriman.application.lock.Lock._open")
 | 
					    lock.create()
 | 
				
			||||||
    watch_mock = mocker.patch("ahriman.application.lock.Lock._watch", return_value=True)
 | 
					    touch_mock.assert_not_called()
 | 
				
			||||||
    write_mock = mocker.patch("ahriman.application.lock.Lock._write")
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
    lock.lock()
 | 
					 | 
				
			||||||
    clear_mock.assert_not_called()
 | 
					 | 
				
			||||||
    open_mock.assert_called_once_with()
 | 
					 | 
				
			||||||
    watch_mock.assert_called_once_with()
 | 
					 | 
				
			||||||
    write_mock.assert_called_once_with(is_locked=True)
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
def test_lock_clear(lock: Lock, mocker: MockerFixture) -> None:
 | 
					def test_create_unsafe(lock: Lock) -> None:
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    must clear lock file before lock if force flag is set
 | 
					    must not raise exception if force flag set
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    mocker.patch("ahriman.application.lock.Lock._open")
 | 
					 | 
				
			||||||
    mocker.patch("ahriman.application.lock.Lock._watch")
 | 
					 | 
				
			||||||
    mocker.patch("ahriman.application.lock.Lock._write")
 | 
					 | 
				
			||||||
    clear_mock = mocker.patch("ahriman.application.lock.Lock.clear")
 | 
					 | 
				
			||||||
    lock.force = True
 | 
					    lock.force = True
 | 
				
			||||||
 | 
					    lock.path = Path(tempfile.gettempdir()) / "ahriman-test.lock"
 | 
				
			||||||
 | 
					    lock.path.touch()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    lock.lock()
 | 
					    lock.create()
 | 
				
			||||||
    clear_mock.assert_called_once_with()
 | 
					    lock.path.unlink()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					def test_watch(lock: Lock, mocker: MockerFixture) -> None:
 | 
				
			||||||
 | 
					    """
 | 
				
			||||||
 | 
					    must check if lock file exists
 | 
				
			||||||
 | 
					    """
 | 
				
			||||||
 | 
					    wait_mock = mocker.patch("ahriman.models.waiter.Waiter.wait")
 | 
				
			||||||
 | 
					    lock.path = Path(tempfile.gettempdir()) / "ahriman-test.lock"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    lock.watch()
 | 
				
			||||||
 | 
					    wait_mock.assert_called_once_with(lock.path.is_file)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					def test_watch_skip(lock: Lock, mocker: MockerFixture) -> None:
 | 
				
			||||||
 | 
					    """
 | 
				
			||||||
 | 
					    must skip watch on empty path
 | 
				
			||||||
 | 
					    """
 | 
				
			||||||
 | 
					    mocker.patch("pathlib.Path.is_file", return_value=True)
 | 
				
			||||||
 | 
					    lock.watch()
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
def test_enter(lock: Lock, mocker: MockerFixture) -> None:
 | 
					def test_enter(lock: Lock, mocker: MockerFixture) -> None:
 | 
				
			||||||
@ -267,14 +181,18 @@ def test_enter(lock: Lock, mocker: MockerFixture) -> None:
 | 
				
			|||||||
    """
 | 
					    """
 | 
				
			||||||
    check_user_mock = mocker.patch("ahriman.application.lock.Lock.check_user")
 | 
					    check_user_mock = mocker.patch("ahriman.application.lock.Lock.check_user")
 | 
				
			||||||
    check_version_mock = mocker.patch("ahriman.application.lock.Lock.check_version")
 | 
					    check_version_mock = mocker.patch("ahriman.application.lock.Lock.check_version")
 | 
				
			||||||
    lock_mock = mocker.patch("ahriman.application.lock.Lock.lock")
 | 
					    watch_mock = mocker.patch("ahriman.application.lock.Lock.watch")
 | 
				
			||||||
 | 
					    clear_mock = mocker.patch("ahriman.application.lock.Lock.clear")
 | 
				
			||||||
 | 
					    create_mock = mocker.patch("ahriman.application.lock.Lock.create")
 | 
				
			||||||
    update_status_mock = mocker.patch("ahriman.core.status.Client.status_update")
 | 
					    update_status_mock = mocker.patch("ahriman.core.status.Client.status_update")
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    with lock:
 | 
					    with lock:
 | 
				
			||||||
        pass
 | 
					        pass
 | 
				
			||||||
    check_user_mock.assert_called_once_with()
 | 
					    check_user_mock.assert_called_once_with()
 | 
				
			||||||
 | 
					    clear_mock.assert_called_once_with()
 | 
				
			||||||
 | 
					    create_mock.assert_called_once_with()
 | 
				
			||||||
    check_version_mock.assert_called_once_with()
 | 
					    check_version_mock.assert_called_once_with()
 | 
				
			||||||
    lock_mock.assert_called_once_with()
 | 
					    watch_mock.assert_called_once_with()
 | 
				
			||||||
    update_status_mock.assert_has_calls([MockCall(BuildStatusEnum.Building), MockCall(BuildStatusEnum.Success)])
 | 
					    update_status_mock.assert_has_calls([MockCall(BuildStatusEnum.Building), MockCall(BuildStatusEnum.Success)])
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@ -284,7 +202,7 @@ def test_exit_with_exception(lock: Lock, mocker: MockerFixture) -> None:
 | 
				
			|||||||
    """
 | 
					    """
 | 
				
			||||||
    mocker.patch("ahriman.application.lock.Lock.check_user")
 | 
					    mocker.patch("ahriman.application.lock.Lock.check_user")
 | 
				
			||||||
    mocker.patch("ahriman.application.lock.Lock.clear")
 | 
					    mocker.patch("ahriman.application.lock.Lock.clear")
 | 
				
			||||||
    mocker.patch("ahriman.application.lock.Lock.lock")
 | 
					    mocker.patch("ahriman.application.lock.Lock.create")
 | 
				
			||||||
    update_status_mock = mocker.patch("ahriman.core.status.Client.status_update")
 | 
					    update_status_mock = mocker.patch("ahriman.core.status.Client.status_update")
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    with pytest.raises(ValueError):
 | 
					    with pytest.raises(ValueError):
 | 
				
			||||||
 | 
				
			|||||||
@ -1,36 +1,6 @@
 | 
				
			|||||||
import pytest
 | 
					 | 
				
			||||||
import time
 | 
					import time
 | 
				
			||||||
 | 
					
 | 
				
			||||||
from ahriman.models.waiter import Waiter, WaiterResult, WaiterTaskFinished, WaiterTimedOut
 | 
					from ahriman.models.waiter import Waiter
 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_result_to_float() -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must convert waiter result to float
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    assert float(WaiterResult(4.2)) == 4.2
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_result_not_implemented() -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must raise NotImplementedError for abstract class
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    with pytest.raises(NotImplementedError):
 | 
					 | 
				
			||||||
        assert bool(WaiterResult(4.2))
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_result_success_to_bool() -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must convert success waiter result to bool
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    assert bool(WaiterTaskFinished(4.2))
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_result_failure_to_bool() -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must convert failure waiter result to bool
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    assert not bool(WaiterTimedOut(4.2))
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
def test_is_timed_out() -> None:
 | 
					def test_is_timed_out() -> None:
 | 
				
			||||||
@ -52,26 +22,8 @@ def test_is_timed_out_infinite() -> None:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
def test_wait() -> None:
 | 
					def test_wait() -> None:
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    must wait for success result
 | 
					    must wait until file will disappear
 | 
				
			||||||
    """
 | 
					    """
 | 
				
			||||||
    results = iter([True, False])
 | 
					    results = iter([True, False])
 | 
				
			||||||
    waiter = Waiter(1, interval=0.1)
 | 
					    waiter = Waiter(1, interval=1)
 | 
				
			||||||
    assert float(waiter.wait(lambda: next(results))) > 0
 | 
					    assert waiter.wait(lambda: next(results)) > 0
 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_wait_timeout() -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must return WaiterTimedOut on timeout
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    results = iter([True, False])
 | 
					 | 
				
			||||||
    waiter = Waiter(-1, interval=0.1)
 | 
					 | 
				
			||||||
    assert isinstance(waiter.wait(lambda: next(results)), WaiterTimedOut)
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
def test_wait_success() -> None:
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    must return WaiterTaskFinished on success
 | 
					 | 
				
			||||||
    """
 | 
					 | 
				
			||||||
    results = iter([True, False])
 | 
					 | 
				
			||||||
    waiter = Waiter(1, interval=0.1)
 | 
					 | 
				
			||||||
    assert isinstance(waiter.wait(lambda: next(results)), WaiterTaskFinished)
 | 
					 | 
				
			||||||
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user