Vendor Galaxy Roles and Collections

ansible_collections/community/docker/plugins/plugin_utils/_common.py

@@ -0,0 +1,59 @@
+# Copyright (c) 2019-2020, Felix Fontein <felix@fontein.de>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# 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!
+
+from __future__ import annotations
+
+import typing as t
+
+from ansible.errors import AnsibleConnectionFailure
+from ansible.utils.display import Display
+
+from ansible_collections.community.docker.plugins.module_utils._common import (
+    AnsibleDockerClientBase,
+)
+from ansible_collections.community.docker.plugins.module_utils._util import (
+    DOCKER_COMMON_ARGS,
+)
+
+if t.TYPE_CHECKING:
+    from ansible.plugins import AnsiblePlugin
+
+
+class AnsibleDockerClient(AnsibleDockerClientBase):
+    def __init__(
+        self,
+        plugin: AnsiblePlugin,
+        min_docker_version: str | None = None,
+        min_docker_api_version: str | None = None,
+    ) -> None:
+        self.plugin = plugin
+        self.display = Display()
+        super().__init__(
+            min_docker_version=min_docker_version,
+            min_docker_api_version=min_docker_api_version,
+        )
+
+    def fail(self, msg: str, **kwargs: t.Any) -> t.NoReturn:
+        if kwargs:
+            msg += "\nContext:\n" + "\n".join(
+                f"  {k} = {v!r}" for (k, v) in kwargs.items()
+            )
+        raise AnsibleConnectionFailure(msg)
+
+    def deprecate(
+        self,
+        msg: str,
+        version: str | None = None,
+        date: str | None = None,
+        collection_name: str | None = None,
+    ) -> None:
+        self.display.deprecated(
+            msg, version=version, date=date, collection_name=collection_name
+        )
+
+    def _get_params(self) -> dict[str, t.Any]:
+        return {option: self.plugin.get_option(option) for option in DOCKER_COMMON_ARGS}

ansible_collections/community/docker/plugins/plugin_utils/_common_api.py

@@ -0,0 +1,53 @@
+# Copyright (c) 2019-2020, Felix Fontein <felix@fontein.de>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# 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!
+
+from __future__ import annotations
+
+import typing as t
+
+from ansible.errors import AnsibleConnectionFailure
+from ansible.utils.display import Display
+
+from ansible_collections.community.docker.plugins.module_utils._common_api import (
+    AnsibleDockerClientBase,
+)
+from ansible_collections.community.docker.plugins.module_utils._util import (
+    DOCKER_COMMON_ARGS,
+)
+
+if t.TYPE_CHECKING:
+    from ansible.plugins import AnsiblePlugin
+
+
+class AnsibleDockerClient(AnsibleDockerClientBase):
+    def __init__(
+        self, plugin: AnsiblePlugin, min_docker_api_version: str | None = None
+    ) -> None:
+        self.plugin = plugin
+        self.display = Display()
+        super().__init__(min_docker_api_version=min_docker_api_version)
+
+    def fail(self, msg: str, **kwargs: t.Any) -> t.NoReturn:
+        if kwargs:
+            msg += "\nContext:\n" + "\n".join(
+                f"  {k} = {v!r}" for (k, v) in kwargs.items()
+            )
+        raise AnsibleConnectionFailure(msg)
+
+    def deprecate(
+        self,
+        msg: str,
+        version: str | None = None,
+        date: str | None = None,
+        collection_name: str | None = None,
+    ) -> None:
+        self.display.deprecated(
+            msg, version=version, date=date, collection_name=collection_name
+        )
+
+    def _get_params(self) -> dict[str, t.Any]:
+        return {option: self.plugin.get_option(option) for option in DOCKER_COMMON_ARGS}

ansible_collections/community/docker/plugins/plugin_utils/_socket_handler.py

@@ -0,0 +1,28 @@
+# Copyright (c) 2019-2020, Felix Fontein <felix@fontein.de>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# 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!
+
+from __future__ import annotations
+
+import typing as t
+
+from ansible_collections.community.docker.plugins.module_utils._socket_handler import (
+    DockerSocketHandlerBase,
+)
+
+if t.TYPE_CHECKING:
+    from ansible.utils.display import Display
+
+    from ansible_collections.community.docker.plugins.module_utils._socket_helper import (
+        SocketLike,
+    )
+
+
+class DockerSocketHandler(DockerSocketHandlerBase):
+    def __init__(
+        self, display: Display, sock: SocketLike, container: str | None = None
+    ) -> None:
+        super().__init__(sock, log=lambda msg: display.vvvv(msg, host=container))

ansible_collections/community/docker/plugins/plugin_utils/_unsafe.py

@@ -0,0 +1,43 @@
+# Copyright (c) 2023, Felix Fontein <felix@fontein.de>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# 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!
+
+from __future__ import annotations
+
+import re
+import typing as t
+from collections.abc import Mapping, Set
+
+from ansible.module_utils.common.collections import is_sequence
+from ansible.utils.unsafe_proxy import (
+    AnsibleUnsafe,
+)
+from ansible.utils.unsafe_proxy import wrap_var as _make_unsafe
+
+_RE_TEMPLATE_CHARS = re.compile("[{}]")
+_RE_TEMPLATE_CHARS_BYTES = re.compile(b"[{}]")
+
+
+def make_unsafe(value: t.Any) -> t.Any:
+    if value is None or isinstance(value, AnsibleUnsafe):
+        return value
+
+    if isinstance(value, Mapping):
+        return dict((make_unsafe(key), make_unsafe(val)) for key, val in value.items())
+    if isinstance(value, Set):
+        return set(make_unsafe(elt) for elt in value)
+    if is_sequence(value):
+        return type(value)(make_unsafe(elt) for elt in value)
+    if isinstance(value, bytes):
+        if _RE_TEMPLATE_CHARS_BYTES.search(value):
+            value = _make_unsafe(value)
+        return value
+    if isinstance(value, str):
+        if _RE_TEMPLATE_CHARS.search(value):
+            value = _make_unsafe(value)
+        return value
+
+    return value