Use extension's own copy of dockermod utils

changelog/19.fixed.md

@@ -0,0 +1 @@
+Use extension's own copy of dockermod utils (``saltext.dockermod.utils.dockermod``) instead of Salt's ``salt.utils.dockermod``.

src/saltext/dockermod/modules/dockermod.py

@@ -230,7 +230,7 @@
 from salt.state import HighState
 
 #  pylint: disable-next=import-error,no-name-in-module
-import saltext.dockermod.utils.dockermod.__init__
+import saltext.dockermod.utils.dockermod as docker_utils
 
 #  pylint: disable-next=import-error,no-name-in-module
 import saltext.dockermod.utils.dockermod.translate.container
@@ -887,7 +887,7 @@ def get_client_args(limit=None):
         salt myminion docker.get_client_args create_container,connect_container_to_network
     """
     #  pylint: disable-next=c-extension-no-member
-    return saltext.dockermod.utils.dockermod.__init__.get_client_args(limit=limit)
+    return docker_utils.get_client_args(limit=limit)
 
 
 def _get_create_kwargs(
@@ -909,7 +909,7 @@ def _get_create_kwargs(
         networks = {}
 
     #  pylint: disable-next=c-extension-no-member
-    kwargs = saltext.dockermod.utils.dockermod.__init__.translate_input(
+    kwargs = docker_utils.translate_input(
         #  pylint: disable-next=c-extension-no-member
         saltext.dockermod.utils.dockermod.translate.container,
         skip_translate=skip_translate,
@@ -2610,7 +2610,7 @@ def create(
     skip_translate=None,
     ignore_collisions=False,
     validate_ip_addrs=True,
-    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
+    client_timeout=docker_utils.CLIENT_TIMEOUT,
     **kwargs,
 ):
     """
@@ -3383,7 +3383,7 @@ def run_container(
     skip_translate=None,
     ignore_collisions=False,
     validate_ip_addrs=True,
-    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
+    client_timeout=docker_utils.CLIENT_TIMEOUT,
     bg=False,
     replace=False,
     force=False,
@@ -4577,7 +4577,7 @@ def pull(
     image,
     insecure_registry=False,
     api_response=False,
-    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
+    client_timeout=docker_utils.CLIENT_TIMEOUT,
 ):
     """
     .. versionchanged:: 2018.3.0
@@ -4677,7 +4677,7 @@ def push(
     image,
     insecure_registry=False,
     api_response=False,
-    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
+    client_timeout=docker_utils.CLIENT_TIMEOUT,
 ):
     """
     .. versionchanged:: 2015.8.4
@@ -5142,7 +5142,7 @@ def create_network(
     ignore_collisions=False,
     validate_ip_addrs=True,
     #  pylint: disable-next=unused-argument
-    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
+    client_timeout=docker_utils.CLIENT_TIMEOUT,
     **kwargs,
 ):
     """
@@ -5379,7 +5379,7 @@ def create_network(
         salt myminion docker.create_network mynet ipam_pools='[{"subnet": "10.0.0.0/24", "gateway": "10.0.0.1"}, {"subnet": "fe3f:2180:26:1::60/123", "gateway": "fe3f:2180:26:1::61"}]'
     """
     #  pylint: disable-next=c-extension-no-member
-    kwargs = saltext.dockermod.utils.dockermod.__init__.translate_input(
+    kwargs = docker_utils.translate_input(
         #  pylint: disable-next=c-extension-no-member
         saltext.dockermod.utils.dockermod.translate.network,
         skip_translate=skip_translate,
@@ -5403,9 +5403,7 @@ def create_network(
         # without specifying IPAM configuration.
         if ipam_pools or ipam_kwargs:
             #  pylint: disable-next=c-extension-no-member
-            kwargs["ipam"] = saltext.dockermod.utils.dockermod.__init__.create_ipam_config(
-                *ipam_pools, **ipam_kwargs
-            )
+            kwargs["ipam"] = docker_utils.create_ipam_config(*ipam_pools, **ipam_kwargs)
 
     response = _client_wrapper("create_network", name, **kwargs)
     _clear_context()
@@ -5862,8 +5860,8 @@ def stop(name, timeout=None, **kwargs):
             # Get timeout from container config
             timeout = inspect_container(name)["Config"]["StopTimeout"]
         except KeyError:
-            # Fall back to a global default defined in salt.utils.dockermod
-            timeout = salt.utils.dockermod.SHUTDOWN_TIMEOUT
+            # Fall back to a global default defined in saltext.dockermod.utils.dockermod
+            timeout = docker_utils.SHUTDOWN_TIMEOUT
 
     orig_state = state(name)
     if orig_state == "paused":

src/saltext/dockermod/states/docker_container.py

@@ -51,9 +51,10 @@
 
 import salt.utils.args
 import salt.utils.data
-import salt.utils.dockermod
 from salt.exceptions import CommandExecutionError
 
+import saltext.dockermod.utils.dockermod as docker_utils
+
 # Enable proper logging
 log = logging.getLogger(__name__)  # pylint: disable=invalid-name
 
@@ -211,7 +212,7 @@ def running(
     watch_action="force",
     start=True,
     shutdown_timeout=None,
-    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
+    client_timeout=docker_utils.CLIENT_TIMEOUT,
     networks=None,
     **kwargs,
 ):
@@ -2088,7 +2089,7 @@ def run(
     skip_translate=None,
     ignore_collisions=False,
     validate_ip_addrs=True,
-    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
+    client_timeout=docker_utils.CLIENT_TIMEOUT,
     **kwargs,
 ):
     """

src/saltext/dockermod/states/docker_image.py

@@ -39,9 +39,10 @@
 import logging
 
 import salt.utils.args
-import salt.utils.dockermod
 from salt.exceptions import CommandExecutionError
 
+import saltext.dockermod.utils.dockermod as docker_utils
+
 # Enable proper logging
 log = logging.getLogger(__name__)
 
@@ -66,7 +67,7 @@ def present(
     load=None,
     force=False,
     insecure_registry=False,
-    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
+    client_timeout=docker_utils.CLIENT_TIMEOUT,
     dockerfile=None,
     sls=None,
     base="opensuse/python",

src/saltext/dockermod/states/docker_network.py

@@ -37,11 +37,12 @@
 import string
 
 import salt.utils.args
-import salt.utils.dockermod.__init__
-import salt.utils.dockermod.translate.network
 from salt._compat import ipaddress
 from salt.exceptions import CommandExecutionError
 
+import saltext.dockermod.utils.dockermod as docker_utils
+import saltext.dockermod.utils.dockermod.translate.network as translate_network
+
 log = logging.getLogger(__name__)
 
 # Define the module's virtual name
@@ -566,8 +567,8 @@ def present(
     disconnected_containers = {}
 
     try:
-        kwargs = salt.utils.dockermod.__init__.translate_input(
-            salt.utils.dockermod.translate.network,
+        kwargs = docker_utils.translate_input(
+            translate_network,
             skip_translate=skip_translate,
             ignore_collisions=ignore_collisions,
             validate_ip_addrs=validate_ip_addrs,
@@ -597,9 +598,7 @@ def present(
     else:
         ipam_pools = ipam_kwargs.pop("ipam_pools", ())
         try:
-            ipam_config = salt.utils.dockermod.__init__.create_ipam_config(
-                *ipam_pools, **ipam_kwargs
-            )
+            ipam_config = docker_utils.create_ipam_config(*ipam_pools, **ipam_kwargs)
         except Exception as exc:  # pylint: disable=broad-except
             ret["comment"] = str(exc)
             return ret

src/saltext/dockermod/utils/dockermod/__init__.py

@@ -10,7 +10,6 @@
 
 import salt.utils.args
 import salt.utils.data
-import salt.utils.dockermod.translate
 from salt.exceptions import CommandExecutionError
 from salt.exceptions import SaltInvocationError
 from salt.utils.args import get_function_argspec as _argspec
@@ -170,7 +169,7 @@ def translate_input(
     """
     Translate CLI/SLS input into the format the API expects. The ``translator``
     argument must be a module containing translation functions, within
-    salt.utils.dockermod.translate. A ``skip_translate`` kwarg can be passed to
+    saltext.dockermod.utils.dockermod.translate. A ``skip_translate`` kwarg can be passed to
     control which arguments are translated. It can be either a comma-separated
     list or an iterable containing strings (e.g. a list or tuple), and members
     of that tuple will have their translation skipped. Optionally,