Merge pull request #349 from saito-hideki/issue/348

[CI] Fixed documentation and options to address new sanity tests

SUMMARY
Fixed documentation and options to address new sanity tests:

Addresses #348
https://docs.ansible.com/ansible/latest/dev_guide/testing_validate-modules.html

ISSUE TYPE

CI tests Pull Request

COMPONENT NAME

ansible.posix

ADDITIONAL INFORMATION
None

Reviewed-by: Andrew Klychkov <aaklychkov@mail.ru>
Reviewed-by: Abhijeet Kasurde <None>

README.md

@@ -86,12 +86,12 @@ None
 
 <!-- List the versions of Ansible the collection has been tested with. Must match what is in galaxy.yml. -->
 
-* ansible-core 2.14 (devel)
+- ansible-core 2.14 (devel)
 - ansible-core 2.13 (stable)
-* ansible-core 2.12 (stable)
+- ansible-core 2.12 (stable)
-* ansible-core 2.11 (stable)
+- ansible-core 2.11 (stable)
-* ansible-base 2.10 (stable)
+- ansible-base 2.10 (stable)
-* ansible 2.9 (stable)
+- ansible 2.9 (stable)
 
 ## Roadmap
 

changelogs/fragments/349_follow_new_guidelines.yml

@@ -0,0 +1,3 @@
+---
+trivial:
+- CI tests - following the new sanity check guideline (https://github.com/ansible-collections/ansible.posix/issues/348).

meta/runtime.yml

@@ -1,2 +1,8 @@
 ---
 requires_ansible: '>=2.9'
+plugin_routing:
+  callback:
+    skippy:
+      deprecation:
+        removal_date: '2022-06-01'
+        warning_text: See the plugin documentation for more details

plugins/callback/cgroup_perf_recap.py

@@ -11,8 +11,8 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'supported_by': 'community'}
 
 DOCUMENTATION = '''
-    callback: cgroup_perf_recap
+    name: cgroup_perf_recap
-    callback_type: aggregate
+    type: aggregate
     requirements:
       - whitelist in configuration
       - cgroups

plugins/callback/debug.py

@@ -5,7 +5,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: debug
+    name: debug
     type: stdout
     short_description: formatted stdout/stderr display
     description:

plugins/callback/json.py

@@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: json
+    name: json
     short_description: Ansible screen output as JSON
     description:
         - This callback converts all events into JSON output to stdout

plugins/callback/profile_roles.py

@@ -7,7 +7,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: profile_roles
+    name: profile_roles
     type: aggregate
     short_description: adds timing information to roles
     description:

plugins/callback/profile_tasks.py

@@ -10,7 +10,7 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: profile_tasks
+    name: profile_tasks
     type: aggregate
     short_description: adds time information to tasks
     description:

plugins/callback/skippy.py

@@ -7,14 +7,14 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: skippy
+    name: skippy
-    callback_type: stdout
+    type: stdout
     requirements:
       - set as main display callback
     short_description: Ansible screen output that ignores skipped status
     deprecated:
       why: The 'default' callback plugin now supports this functionality
-        removed_at_date: 2022-06-01
+      removed_at_date: '2022-06-01'
       alternative: "'default' callback plugin with 'display_skipped_hosts = no' option"
     extends_documentation_fragment:
       - default_callback

plugins/callback/timer.py

@@ -6,8 +6,8 @@ from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
 DOCUMENTATION = '''
-    callback: timer
+    name: timer
-    callback_type: aggregate
+    type: aggregate
     requirements:
       - whitelist in configuration
     short_description: Adds time to play stats

plugins/modules/mount.py

@@ -50,7 +50,7 @@ options:
         with subsequent runs.
       - Has no effect on Solaris systems.
     type: str
-    default: 0
+    default: '0'
   passno:
     description:
       - Passno (see fstab(5)).
@@ -59,7 +59,7 @@ options:
         with subsequent runs.
       - Deprecated on Solaris systems.
     type: str
-    default: 0
+    default: '0'
   state:
     description:
       - If C(mounted), the device will be actively mounted and appropriately
@@ -667,12 +667,12 @@ def main():
     module = AnsibleModule(
         argument_spec=dict(
             boot=dict(type='bool', default=True),
-            dump=dict(type='str'),
+            dump=dict(type='str', default='0'),
             fstab=dict(type='str'),
             fstype=dict(type='str'),
             path=dict(type='path', required=True, aliases=['name']),
             opts=dict(type='str'),
-            passno=dict(type='str', no_log=False),
+            passno=dict(type='str', no_log=False, default='0'),
             src=dict(type='path'),
             backup=dict(type='bool', default=False),
             state=dict(type='str', required=True, choices=['absent', 'mounted', 'present', 'unmounted', 'remounted']),

plugins/shell/csh.py

@@ -4,13 +4,8 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-from ansible.module_utils.six import text_type
-from ansible.module_utils.six.moves import shlex_quote
-from ansible.plugins.shell import ShellBase
-
 DOCUMENTATION = '''
     name: csh
-    plugin_type: shell
     short_description: C shell (/bin/csh)
     description:
       - When you have no other option than to use csh
@@ -18,6 +13,10 @@ DOCUMENTATION = '''
       - shell_common
 '''
 
+from ansible.module_utils.six import text_type
+from ansible.module_utils.six.moves import shlex_quote
+from ansible.plugins.shell import ShellBase
+
 
 class ShellModule(ShellBase):
 

plugins/shell/fish.py

@@ -4,13 +4,8 @@
 from __future__ import (absolute_import, division, print_function)
 __metaclass__ = type
 
-from ansible.module_utils.six import text_type
-from ansible.module_utils.six.moves import shlex_quote
-from ansible.plugins.shell.sh import ShellModule as ShModule
-
 DOCUMENTATION = '''
     name: fish
-    plugin_type: shell
     short_description: fish shell (/bin/fish)
     description:
       - This is here because some people are restricted to fish.
@@ -18,6 +13,10 @@ DOCUMENTATION = '''
       - shell_common
 '''
 
+from ansible.module_utils.six import text_type
+from ansible.module_utils.six.moves import shlex_quote
+from ansible.plugins.shell.sh import ShellModule as ShModule
+
 
 class ShellModule(ShModule):