cmd_runner: added flag check_mode_skip to context (#4736)

* cmd_runner: added flag skip_if_check_mode to context

* added changelog fragment

* adjusted param name and added new one

tests/integration/targets/cmd_runner/library/cmd_echo.py

@@ -6,36 +6,8 @@
 from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
-import sys
 
-DOCUMENTATION = '''
-module: cmd_echo
-author: "Alexei Znamensky (@russoz)"
-short_description: Simple module for testing
-description:
-  - Simple module test description.
-options:
-  command:
-    description: aaa
-    type: list
-    elements: str
-    required: true
-  arg_formats:
-    description: bbb
-    type: dict
-    required: true
-  arg_order:
-    description: ccc
-    type: raw
-    required: true
-  arg_values:
-    description: ddd
-    type: list
-    required: true
-  aa:
-    description: eee
-    type: raw
-'''
+DOCUMENTATION = ""
 
 EXAMPLES = ""
 
@@ -51,11 +23,15 @@ def main():
             arg_formats=dict(type="dict", default={}),
             arg_order=dict(type="raw", required=True),
             arg_values=dict(type="dict", default={}),
+            check_mode_skip=dict(type="bool", default=False),
             aa=dict(type="raw"),
         ),
+        supports_check_mode=True,
     )
     p = module.params
 
+    info = None
+
     arg_formats = {}
     for arg, fmt_spec in p['arg_formats'].items():
         func = getattr(fmt, fmt_spec['func'])
@@ -65,11 +41,11 @@ def main():
 
     runner = CmdRunner(module, ['echo', '--'], arg_formats=arg_formats)
 
-    info = None
-    with runner.context(p['arg_order']) as ctx:
+    with runner.context(p['arg_order'], check_mode_skip=p['check_mode_skip']) as ctx:
         result = ctx.run(**p['arg_values'])
         info = ctx.run_info
-    rc, out, err = result
+    check = "check"
+    rc, out, err = result if result is not None else (None, None, None)
 
     module.exit_json(rc=rc, out=out, err=err, info=info)
 

tests/integration/targets/cmd_runner/tasks/test_cmd_echo.yml

@@ -4,8 +4,10 @@
     arg_formats: "{{ item.arg_formats|default(omit) }}"
     arg_order: "{{ item.arg_order }}"
     arg_values: "{{ item.arg_values|default(omit) }}"
+    check_mode_skip: "{{ item.check_mode_skip|default(omit) }}"
     aa: "{{ item.aa|default(omit) }}"
   register: test_result
+  check_mode: "{{ item.check_mode|default(omit) }}"
   ignore_errors: "{{ item.expect_error|default(omit) }}"
 
 - name: check results [{{ item.name }}]

tests/integration/targets/cmd_runner/vars/main.yml

@@ -82,3 +82,41 @@ cmd_echo_tests:
       - >-
         "MissingArgumentValue: Cannot find value for parameter bb"
         in test_result.module_stderr
+
+  - name: set aa and bb value with check_mode on
+    arg_formats:
+      aa:
+        func: as_opt_eq_val
+        args: [--answer]
+      bb:
+        func: as_bool
+        args: [--bb-here]
+    arg_order: 'aa bb'
+    arg_values:
+      bb: true
+    aa: 11
+    check_mode: true
+    assertions:
+      - test_result.rc == 0
+      - test_result.out == "-- --answer=11 --bb-here\n"
+      - test_result.err == ""
+
+  - name: set aa and bb value with check_mode and check_mode_skip on
+    arg_formats:
+      aa:
+        func: as_opt_eq_val
+        args: [--answer]
+      bb:
+        func: as_bool
+        args: [--bb-here]
+    arg_order: 'aa bb'
+    arg_values:
+      bb: true
+    check_mode_skip: true
+    aa: 11
+    check_mode: true
+    expect_error: true  # because if result contains rc != 0, ansible assumes error
+    assertions:
+      - test_result.rc == None
+      - test_result.out == None
+      - test_result.err == None