Merge pull request #27465 from ticosax/fix-dockerng-cmd

Fix usage of dockerng "cmd" was #27459

salt/modules/dockerng.py

@@ -343,7 +343,7 @@ argument name:
 '''
 
 VALID_CREATE_OPTS = {
-    'cmd': {
+    'command': {
         'path': 'Config:Cmd',
     },
     'hostname': {
@@ -1099,25 +1099,25 @@ def _validate_input(action,
             raise SaltInvocationError(key + ' must be a list of strings')
 
     # Custom validation functions for container creation options
-    def _valid_cmd():  # pylint: disable=unused-variable
+    def _valid_command():  # pylint: disable=unused-variable
         '''
         Must be either a string or a list of strings. Value will be translated
         to a list of strings
         '''
-        if kwargs.get('cmd') is None:
+        if kwargs.get('command') is None:
             # No need to validate
             return
-        if isinstance(kwargs['cmd'], six.string_types):
+        if isinstance(kwargs['command'], six.string_types):
             # Translate command into a list of strings
             try:
-                kwargs['cmd'] = shlex.split(kwargs['cmd'])
+                kwargs['command'] = shlex.split(kwargs['command'])
             except AttributeError:
                 pass
         try:
-            _valid_stringlist('cmd')
+            _valid_stringlist('command')
         except SaltInvocationError:
             raise SaltInvocationError(
-                'cmd must be a string or list of strings'
+                'command/cmd must be a string or list of strings'
             )
 
     def _valid_user():  # pylint: disable=unused-variable
@@ -2507,10 +2507,10 @@ def create(image,
     image
         Image from which to create the container
 
-    cmd or command
+    command or cmd
         Command to run in the container
 
-        Example: ``cmd=bash`` or ``command=bash``
+        Example: ``command=bash`` or ``cmd=bash``
 
         .. versionchanged:: 2015.8.1
             ``cmd`` is now also accepted
@@ -2646,13 +2646,13 @@ def create(image,
         # Create a CentOS 7 container that will stay running once started
         salt myminion dockerng.create centos:7 name=mycent7 interactive=True tty=True command=bash
     '''
-    if 'command' in kwargs:
-        if 'cmd' in kwargs:
+    if 'cmd' in kwargs:
+        if 'command' in kwargs:
             raise SaltInvocationError(
-                'Only one of \'cmd\' and \'command\' can be used. Both '
+                'Only one of \'command\' and \'cmd\' can be used. Both '
                 'arguments are equivalent.'
             )
-        kwargs['cmd'] = kwargs.pop('command')
+        kwargs['command'] = kwargs.pop('cmd')
 
     try:
         # Try to inspect the image, if it fails then we know we need to pull it

salt/states/dockerng.py

@@ -352,8 +352,8 @@ def _compare(actual, create_kwargs, runtime_kwargs):
                     continue
 
             elif isinstance(data, list):
-                # Compare two sorted lists of items. Won't work for "cmd" or
-                # "entrypoint" because those are both shell commands and the
+                # Compare two sorted lists of items. Won't work for "command"
+                # or "entrypoint" because those are both shell commands and the
                 # original order matters. It will, however, work for "volumes"
                 # because even though "volumes" is a sub-dict nested within the
                 # "actual" dict sorted(somedict) still just gives you a sorted
@@ -753,7 +753,7 @@ def running(name,
 
     **CONTAINER CONFIGURATION PARAMETERS**
 
-    cmd or command
+    command or cmd
         Command to run in the container
 
         .. code-block:: yaml
@@ -761,7 +761,7 @@ def running(name,
             foo:
               dockerng.running:
                 - image: bar/baz:latest
-                - cmd: bash
+                - command: bash
 
         OR
 
@@ -770,7 +770,7 @@ def running(name,
             foo:
               dockerng.running:
                 - image: bar/baz:latest
-                - command: bash
+                - cmd: bash
 
         .. versionchanged:: 2015.8.1
             ``cmd`` is now also accepted
@@ -1365,15 +1365,15 @@ def running(name,
         ret['comment'] = 'The \'image\' argument is required'
         return ret
 
-    if 'command' in kwargs:
-        if 'cmd' in kwargs:
+    if 'cmd' in kwargs:
+        if 'command' in kwargs:
             ret['comment'] = (
-                'Only one of \'cmd\' and \'command\' can be used. Both '
+                'Only one of \'command\' and \'cmd\' can be used. Both '
                 'arguments are equivalent.'
             )
             ret['result'] = False
             return ret
-        kwargs['cmd'] = kwargs.pop('command')
+        kwargs['command'] = kwargs.pop('cmd')
 
     try:
         image = ':'.join(_get_repo_tag(image))

tests/unit/modules/dockerng_test.py

@@ -26,6 +26,10 @@ dockerng_mod.__context__ = {'docker.docker_version': ''}
 dockerng_mod.__salt__ = {}
 
 
+def _docker_py_version():
+    return dockerng_mod.docker.version_info if dockerng_mod.HAS_DOCKER_PY else None
+
+
 @skipIf(NO_MOCK, NO_MOCK_REASON)
 class DockerngTestCase(TestCase):
     '''
@@ -78,6 +82,35 @@ class DockerngTestCase(TestCase):
             mine_send.assert_called_with('dockerng.ps', verbose=True, all=True,
                                          host=True)
 
+    @skipIf(_docker_py_version() < (1, 4, 0),
+            'docker module must be installed to run this test or is too old. >=1.4.0')
+    @patch.object(dockerng_mod, 'images', MagicMock())
+    @patch.object(dockerng_mod, 'inspect_image')
+    @patch.object(dockerng_mod, 'version', Mock(return_value={'ApiVersion': '1.19'}))
+    def test_create_with_arg_cmd(self, *args):
+        '''
+        When cmd argument is passed check it is renamed to command.
+        '''
+        __salt__ = {
+            'config.get': Mock(),
+            'mine.send': Mock(),
+        }
+        host_config = {}
+        client = Mock()
+        client.api_version = '1.19'
+        client.create_host_config.return_value = host_config
+        client.create_container.return_value = {}
+        with patch.dict(dockerng_mod.__dict__,
+                        {'__salt__': __salt__}):
+            with patch.dict(dockerng_mod.__context__,
+                            {'docker.client': client}):
+                dockerng_mod.create('image', cmd='ls', name='ctn')
+        client.create_container.assert_called_once_with(
+            command='ls',
+            host_config=host_config,
+            image='image',
+            name='ctn')
+
 
 if __name__ == '__main__':
     from integration import run_tests