Merge pull request #56857 from terminalmage/issue56669

Rename salt/utils/docker/ to salt/utils/dockermod/

salt/modules/dockermod.py

@@ -225,8 +225,8 @@
 import salt.exceptions
 import salt.fileclient
 import salt.pillar
-import salt.utils.docker.translate.container
-import salt.utils.docker.translate.network
+import salt.utils.dockermod.translate.container
+import salt.utils.dockermod.translate.network
 import salt.utils.functools
 import salt.utils.json
 import salt.utils.path
@@ -903,7 +903,7 @@ def _get_create_kwargs(
         networks = {}
 
     kwargs = __utils__["docker.translate_input"](
-        salt.utils.docker.translate.container,
+        salt.utils.dockermod.translate.container,
         skip_translate=skip_translate,
         ignore_collisions=ignore_collisions,
         validate_ip_addrs=validate_ip_addrs,
@@ -2566,7 +2566,7 @@ def create(
     skip_translate=None,
     ignore_collisions=False,
     validate_ip_addrs=True,
-    client_timeout=salt.utils.docker.CLIENT_TIMEOUT,
+    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
     **kwargs
 ):
     """
@@ -3339,7 +3339,7 @@ def run_container(
     skip_translate=None,
     ignore_collisions=False,
     validate_ip_addrs=True,
-    client_timeout=salt.utils.docker.CLIENT_TIMEOUT,
+    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
     bg=False,
     replace=False,
     force=False,
@@ -4563,7 +4563,7 @@ def pull(
     image,
     insecure_registry=False,
     api_response=False,
-    client_timeout=salt.utils.docker.CLIENT_TIMEOUT,
+    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
 ):
     """
     .. versionchanged:: 2018.3.0
@@ -4662,7 +4662,7 @@ def push(
     image,
     insecure_registry=False,
     api_response=False,
-    client_timeout=salt.utils.docker.CLIENT_TIMEOUT,
+    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
 ):
     """
     .. versionchanged:: 2015.8.4
@@ -5129,7 +5129,7 @@ def create_network(
     skip_translate=None,
     ignore_collisions=False,
     validate_ip_addrs=True,
-    client_timeout=salt.utils.docker.CLIENT_TIMEOUT,
+    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
     **kwargs
 ):
     """
@@ -5367,7 +5367,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"}]'
     """
     kwargs = __utils__["docker.translate_input"](
-        salt.utils.docker.translate.network,
+        salt.utils.dockermod.translate.network,
         skip_translate=skip_translate,
         ignore_collisions=ignore_collisions,
         validate_ip_addrs=validate_ip_addrs,
@@ -5857,8 +5857,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.docker
-            timeout = salt.utils.docker.SHUTDOWN_TIMEOUT
+            # Fall back to a global default defined in salt.utils.dockermod
+            timeout = salt.utils.dockermod.SHUTDOWN_TIMEOUT
 
     orig_state = state(name)
     if orig_state == "paused":

salt/states/docker_container.py

@@ -53,7 +53,7 @@
 
 import salt.utils.args
 import salt.utils.data
-import salt.utils.docker
+import salt.utils.dockermod
 
 # Import Salt libs
 from salt.exceptions import CommandExecutionError
@@ -225,7 +225,7 @@ def running(
     watch_action="force",
     start=True,
     shutdown_timeout=None,
-    client_timeout=salt.utils.docker.CLIENT_TIMEOUT,
+    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
     networks=None,
     **kwargs
 ):
@@ -2107,7 +2107,7 @@ def run(
     skip_translate=None,
     ignore_collisions=False,
     validate_ip_addrs=True,
-    client_timeout=salt.utils.docker.CLIENT_TIMEOUT,
+    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
     **kwargs
 ):
     """

salt/states/docker_image.py

@@ -42,7 +42,7 @@
 import salt.utils.args
 
 # Import salt libs
-import salt.utils.docker
+import salt.utils.dockermod
 from salt.exceptions import CommandExecutionError
 from salt.ext import six
 from salt.ext.six.moves import zip
@@ -71,7 +71,7 @@ def present(
     load=None,
     force=False,
     insecure_registry=False,
-    client_timeout=salt.utils.docker.CLIENT_TIMEOUT,
+    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
     dockerfile=None,
     sls=None,
     base="opensuse/python",

salt/states/docker_network.py

@@ -38,7 +38,7 @@
 import string
 
 # Import Salt libs
-import salt.utils.docker.translate.network
+import salt.utils.dockermod.translate.network
 from salt._compat import ipaddress
 from salt.exceptions import CommandExecutionError
 
@@ -579,7 +579,7 @@ def present(
 
     try:
         kwargs = __utils__["docker.translate_input"](
-            salt.utils.docker.translate.network,
+            salt.utils.dockermod.translate.network,
             skip_translate=skip_translate,
             ignore_collisions=ignore_collisions,
             validate_ip_addrs=validate_ip_addrs,

salt/utils/docker/__init__.py → salt/utils/dockermod/__init__.py

@@ -15,20 +15,18 @@
 # Import Salt libs
 import salt.utils.args
 import salt.utils.data
-import salt.utils.docker.translate
+import salt.utils.dockermod.translate
 from salt.exceptions import CommandExecutionError, SaltInvocationError
 
 # Import 3rd-party libs
 from salt.ext import six
 from salt.utils.args import get_function_argspec as _argspec
-from salt.utils.docker.translate.helpers import split as _split
+from salt.utils.dockermod.translate.helpers import split as _split
 
 try:
     import docker
-
-    HAS_DOCKER_PY = True
 except ImportError:
-    HAS_DOCKER_PY = False
+    docker = None
 
 # These next two imports are only necessary to have access to the needed
 # functions so that we can get argspecs for the container config, host config,
@@ -44,6 +42,8 @@
 
 NOTSET = object()
 
+__virtualname__ = "docker"
+
 # Default timeout as of docker-py 1.0.0
 CLIENT_TIMEOUT = 60
 # Timeout for stopping the container, before a kill is invoked
@@ -52,8 +52,14 @@
 log = logging.getLogger(__name__)
 
 
+def __virtual__():
+    if docker is None:
+        return False
+    return __virtualname__
+
+
 def get_client_args(limit=None):
-    if not HAS_DOCKER_PY:
+    if docker is None:
         raise CommandExecutionError("docker Python module not imported")
 
     limit = salt.utils.args.split_input(limit or [])
@@ -180,7 +186,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.docker.translate. A ``skip_translate`` kwarg can be passed to
+    salt.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,