mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-21 00:01:08 +00:00
4fa82b9617
* Make all doc fragments private. * Make all plugin utils private. * Make all module utils private. * Reformat. * Changelog fragment. * Update configs and ignores. * Adjust unit test names.
116 lines
3.7 KiB
Python
116 lines
3.7 KiB
Python
# Copyright (c) 2018, Ansible Project
|
|
# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause)
|
|
# SPDX-License-Identifier: BSD-2-Clause
|
|
|
|
# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time.
|
|
# Do not use this from other collections or standalone plugins/modules!
|
|
|
|
# NOTE:
|
|
# This has been vendored from ansible.module_utils.common.file. This code has been removed from there for ansible-core 2.16.
|
|
|
|
from __future__ import annotations
|
|
|
|
import fcntl
|
|
import os
|
|
import stat
|
|
import time
|
|
import typing as t
|
|
from contextlib import contextmanager
|
|
|
|
if t.TYPE_CHECKING:
|
|
from io import TextIOWrapper
|
|
|
|
|
|
class LockTimeout(Exception):
|
|
pass
|
|
|
|
|
|
class FileLock:
|
|
"""
|
|
Currently FileLock is implemented via fcntl.flock on a lock file, however this
|
|
behaviour may change in the future. Avoid mixing lock types fcntl.flock,
|
|
fcntl.lockf and module_utils.common.file.FileLock as it will certainly cause
|
|
unwanted and/or unexpected behaviour
|
|
"""
|
|
|
|
def __init__(self) -> None:
|
|
self.lockfd: TextIOWrapper | None = None
|
|
|
|
@contextmanager
|
|
def lock_file(
|
|
self, path: os.PathLike, tmpdir: os.PathLike, lock_timeout: int | float | None = None
|
|
) -> t.Generator[None]:
|
|
"""
|
|
Context for lock acquisition
|
|
"""
|
|
try:
|
|
self.set_lock(path, tmpdir, lock_timeout)
|
|
yield
|
|
finally:
|
|
self.unlock()
|
|
|
|
def set_lock(
|
|
self, path: os.PathLike, tmpdir: os.PathLike, lock_timeout: int | float | None = None
|
|
) -> t.Literal[True]:
|
|
"""
|
|
Create a lock file based on path with flock to prevent other processes
|
|
using given path.
|
|
Please note that currently file locking only works when it is executed by
|
|
the same user, for example single user scenarios
|
|
|
|
:kw path: Path (file) to lock
|
|
:kw tmpdir: Path where to place the temporary .lock file
|
|
:kw lock_timeout:
|
|
Wait n seconds for lock acquisition, fail if timeout is reached.
|
|
0 = Do not wait, fail if lock cannot be acquired immediately,
|
|
Default is None, wait indefinitely until lock is released.
|
|
:returns: True
|
|
"""
|
|
lock_path = os.path.join(tmpdir, f"ansible-{os.path.basename(path)}.lock")
|
|
l_wait = 0.1
|
|
|
|
self.lockfd = open(lock_path, "w")
|
|
|
|
if lock_timeout is not None and lock_timeout <= 0:
|
|
fcntl.flock(self.lockfd, fcntl.LOCK_EX | fcntl.LOCK_NB)
|
|
os.chmod(lock_path, stat.S_IWRITE | stat.S_IREAD)
|
|
return True
|
|
|
|
if lock_timeout:
|
|
e_secs: float = 0
|
|
while e_secs < lock_timeout:
|
|
try:
|
|
fcntl.flock(self.lockfd, fcntl.LOCK_EX | fcntl.LOCK_NB)
|
|
os.chmod(lock_path, stat.S_IWRITE | stat.S_IREAD)
|
|
return True
|
|
except BlockingIOError:
|
|
time.sleep(l_wait)
|
|
e_secs += l_wait
|
|
continue
|
|
|
|
self.lockfd.close()
|
|
raise LockTimeout(f"{lock_timeout} sec")
|
|
|
|
fcntl.flock(self.lockfd, fcntl.LOCK_EX)
|
|
os.chmod(lock_path, stat.S_IWRITE | stat.S_IREAD)
|
|
|
|
return True
|
|
|
|
def unlock(self) -> t.Literal[True]:
|
|
"""
|
|
Make sure lock file is available for everyone and Unlock the file descriptor
|
|
locked by set_lock
|
|
|
|
:returns: True
|
|
"""
|
|
if not self.lockfd:
|
|
return True
|
|
|
|
try:
|
|
fcntl.flock(self.lockfd, fcntl.LOCK_UN)
|
|
self.lockfd.close()
|
|
except ValueError: # file wasn't opened, let context manager fail gracefully
|
|
pass
|
|
|
|
return True
|