filters/modules: update git_log_info, add sample module

Author: Bill Meek

filter_plugins/git_log_info.py

@@ -5,7 +5,7 @@
 
 '''
 git log filter. Use this to view documentation:
-    ansible-doc -t filter mythtv.general.git_log_info
+    ansible-doc -t filter git_log_info
 '''
 
 

filter_plugins/git_log_info.yml

@@ -1,6 +1,6 @@
 ---
 DOCUMENTATION:
-  name: mythtv.general.git_log_info
+  name: git_log_info
   author: Bill Meek
   short_description: Get some git info about the playbook or a single file
   description:
@@ -28,11 +28,11 @@ DOCUMENTATION:
 EXAMPLES: |
   - name: "get a file's short SHA1, author and timestamp"
     ansible.builtin.debug:
-      var: "{{ some_file_name | mythtv.general.git_log_info('full') }}"
+      var: "{{ some_file_name | git_log_info('full') }}"
 
   - name: "get the long SHA1 for the MythTV playbook (HEAD)"
     ansible.builtin.debug:
-      var: "{{ 'HEAD' | mythtv.general.git_log_info('playbook') }}"
+      var: "{{ 'HEAD' | git_log_info('playbook') }}"
 
 RETURN:
   _output:

library/sample.py

@@ -22,29 +22,33 @@ def run_module():
     ''' Update with real module information. '''
 
     module_args = {
-        "api_port": {"type": 'int', "required": False, "default": 6544},
-        "host": {"type": 'str', "required": False, "default": 'localhost'},
+        'api_port': {
+            'type': 'int',
+            'required': False,
+            'default': 6544
+            },
+        'host': {
+            'type': 'str',
+            'required': False,
+            'default': 'localhost'
+            },
         }
 
-    result = {'changed': False}
-
-    module = AnsibleModule(
-        argument_spec=module_args,
-        supports_check_mode=True
-    )
-
     module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
 
+    result = {'changed': False}
+
     # In the check mode, really a sanity test of this module.
     if module.check_mode:
-        result['changed'] = True
+        result['comment'] = 'check mode ran'
         module.exit_json(**result)
 
     # Do something(s) here and resurn result information.
 
+    result['changed'] = True
     result['comment'] = 'library/sample.py ran'
     result['host'] = module.params['host']
-    result['port'] = module.params['api_port']
+    result['api_port'] = module.params['api_port']
 
     module.exit_json(**result)
 

library/sample.yml

@@ -1,14 +1,14 @@
 ---
 DOCUMENTATION:
-  module: mythtv.general.sample
+  module: sample
   plugin_type: module
   author: Bill Meek
   short_description: Enter something short here
   description:
     - Enter the real long description here.
   options:
-    some_option:
-      description: some need for an integer
+    api_port:
+      description: some integer
       default: 1234
       type: int
       required: true
@@ -20,28 +20,33 @@ DOCUMENTATION:
 
 EXAMPLES: |
   - name: do something
-    mythtv.general.sample:
+    sample:
 
   - name: do something with some parameters
-    mythtv.general.sample:
+    sample:
       host: some_hostname
-      some_option: 5678
+      api_port: 5678
 
 RETURN:
   changed:
     description: if true, the attempt worked
     type: bool
     returned: always
     sample: true
-  failed:
-    description: common task message
-    type: bool
-    returned: always
-    sample: false
   comment:
     description: explanatory of result text
     type: str
     returned: always
     sample: "Success, all done!"
+  host:
+    description: some hostname
+    type: str
+    returned: always, except in check mode
+    sample: "hostname"
+  api_port:
+    description: port number
+    type: int
+    returned: always, except in check mode
+    sample: "3456"
 
 # vim: set expandtab tabstop=2 shiftwidth=2 smartindent noautoindent colorcolumn=80: