Merge pull request #27 from ganeshrn/resource_model

Add support for new model format

Reviewed-by: Bradley A. Thornton
             https://github.com/cidrblock

Author: ansible-zuul[bot]

models/myos/interfaces/myos_interfaces.yml

@@ -1,94 +1,70 @@
-generator_version: 1.0
-metadata:
-  vesion: 1.1
-  status:
-  - preview
-  supported_by:
-  - '<support_group>'
-  copyright_str: Copyright 2019 <company_name>
-  license: gpl-3.0.txt
-info:
-  network_os: myos
-  resource: interfaces
-  version_added: 2.8
+---
+GENERATOR_VERSION: '1.0'
+ANSIBLE_METADATA: |
+    {
+      'metadata_version': '1.1',
+      'status': ['preview'],
+      'supported_by': '<support_group>'
+    }
+
+NETWORK_OS: myos
+RESOURCE: interfaces
+COPYRIGHT: Copyright 2019 Red Hat
+LICENSE: gpl-3.0.txt
+
+DOCUMENTATION: |
+  module: myos_interfaces
+  version_added: 2.9
   short_description: 'Manages <xxxx> attributes of <network_os> <resource>.'
-  description:
-  - Manages <xxxx> attributes of <network_os> <resource>.
-  authors:
-  - Ansible Network Engineer
-  extends_documentation_fragment: myos
+  description: 'Manages <xxxx> attributes of <network_os> <resource>'
+  author: Ansible Network Engineer
   notes:
-    - Tested against <network_os> <version>
-schema:
-  type: object
-  description: The schema used for the argspec and docstring
-  properties:
+    - 'Tested against <network_os> <version>'
+  options:
     config:
-      type: array
       description: The provided configuration
-      items:
-        type: object
-        properties:
-          some_string:
-            $ref: '#/definitions/some_string'
-          some_bool:
-            $ref: '#/definitions/some_bool'
-          some_int:
-            $ref: '#/definitions/some_int'
-          some_dict:
-            $ref: '#/definitions/some_dict'
-          some_list_of_dicts:
-            type: array
-            description: An array of dicts
-            items:
-              $ref: '#/definitions/some_dict'
-        required:
-        - some_string
-    state:
-      $ref: '#/definitions/state'
-
-definitions:
-  some_string:
-    type: str
-    description:
-    - The some_string_01
-    enum:
-    - choice_a
-    - choice_b
-    - choice_c
-    default: choice_a
-  some_bool:
-    description:
-    - The some_bool.
-    type: bool
-  some_int:
-    description:
-    - The some_int.
-    type: int
-    version_added: '1.1'
-  some_dict:
-    description:
-    - The some_dict.
-    type: object
-    properties:
-      property_01:
-        description:
-        - The property_01
-        type: str
-      property_02:
-        $ref: '#/definitions/some_string'
-  state:
-    description:
-    - The state the configuration should be left in
-    type: str
-    enum:
-    - merged
-    - replaced
-    - overridden
-    - deleted
-    default: merged
-examples:
-- merged_example_01.txt
-- replaced_example_01.txt
-- overridden_example_01.txt
-- deleted_example_01.txt
+      type: list
+      elements: dict
+      suboptions:
+        some_string:
+          type: str
+          description:
+          - The some_string_01
+          chocies:
+          - choice_a
+          - choice_b
+          - choice_c
+          default: choice_a
+        some_bool:
+          description:
+          - The some_bool.
+          type: bool
+        some_int:
+          description:
+          - The some_int.
+          type: int
+          version_added: '1.1'
+        some_dict:
+          type: dict
+          description:
+          - The some_dict.
+          suboptions:
+            property_01:
+              description:
+              - The property_01
+              type: str
+        state:
+          description:
+          - The state the configuration should be left in
+          type: str
+          choices:
+          - merged
+          - replaced
+          - overridden
+          - deleted
+          default: merged
+EXAMPLES:
+  - deleted_example_01.txt
+  - merged_example_01.txt
+  - overridden_example_01.txt
+  - replaced_example_01.txt

roles/init/tasks/main.yml

@@ -15,6 +15,14 @@
     file: "{{ model }}"
     name: rm
 
+- name: Set the module documentation variable
+  set_fact:
+    rm_docmentation: "{{ rm['DOCUMENTATION']|from_yaml }}"
+
+- name: Set the module ansible_metada variable
+  set_fact:
+    rm_ansible_metadata: "{{ rm['ANSIBLE_METADATA']|from_yaml }}"
+
 - name: "Create the {{ structure }} directory structure"
   file:
     path: "{{ parent }}/{{ item }}"
@@ -23,7 +31,7 @@
 
 - name: Copy the license file to the parent directory
   copy:
-    src: "{{ rm['metadata']['license'] }}"
+    src: "{{ rm['LICENSE'] | default('gpl-3.0.txt') }}"
     dest: "{{ parent }}/LICENSE.txt"
 
 - name: Ensure the 'collection_org' is set when 'structure' is set to collection

roles/resource_module/filter_plugins/to_argspec.py

@@ -1,54 +1,58 @@
-# Copyright (c) 2018 Ansible Project
+# Copyright (c) 2019 Ansible Project
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 from __future__ import (absolute_import, division, print_function)
-import jsonref
-import json
+__metaclass__ = type
+
+import yaml
 import pprint
+
 from ansible.module_utils.six import iteritems
+from ansible.module_utils.six import string_types
+from ansible.utils.display import Display
+from ansible.errors import AnsibleFilterError
 
-__metaclass__ = type
+OPTIONS_METADATA = ('type', 'elements', 'default', 'choices', 'required')
+SUBOPTIONS_METADATA = ('mutually_exclusive', 'required_together', 'required_one_of', 'supports_check_mode', 'required_if')
 
-from ansible.errors import AnsibleFilterError
+display = Display()
+
+
+def retrieve_metadata(values, out):
+    for key in OPTIONS_METADATA:
+        if key in values:
+            data = values.get(key, None)
+            if data:
+                out[key] = data
 
-def dive(obj, required=False):
+
+def dive(obj, result):
+    for k, v in iteritems(obj):
+        result[k] = dict()
+        retrieve_metadata(v, result[k])
+        suboptions = v.get('suboptions')
+        if suboptions:
+            for item in SUBOPTIONS_METADATA:
+                if item in v:
+                    result[k][item] = v[item]
+            result[k]['options'] = dict()
+            dive(suboptions, result[k]['options'])
+
+
+def to_argspec(spec):
+    if 'DOCUMENTATION' not in spec:
+        raise AnsibleFilterError("missing required element 'DOCUMENTATION' in model")
+
+    if not isinstance(spec['DOCUMENTATION'], string_types):
+        raise AnsibleFilterError("value of element 'DOCUMENTATION' should be of type string")
     result = {}
-    if not 'type' in obj:
-        raise AnsibleFilterError('missing type key')
-    if obj['type'] == 'object':
-        result['options'] = {}
-        if not 'properties' in obj:
-            raise AnsibleFilterError('missing properties key')
-        for propkey, propval in iteritems(obj['properties']):
-            required = bool('required' in obj and propkey in obj['required'])
-            result['options'][propkey] = dive(propval, required)
-    elif obj['type'] == 'array':
-        result['options'] = {}
-        if obj.get('elements'):
-            result['elements'] = obj['elements']
-        if not 'items' in obj:
-            raise AnsibleFilterError('missing items key in array')
-        if not 'properties' in obj['items']:
-            raise AnsibleFilterError('missing properties in items')
-        for propkey, propval in iteritems(obj['items']['properties']):
-            required = bool('required' in obj['items'] and propkey in obj['items']['required'])
-            result['options'][propkey] = dive(propval, required)
-            result['type'] = 'list'
-    elif obj['type'] in ['str', 'bool', 'int']:
-        if 'default' in obj:
-            result['default'] = obj['default']
-        if 'enum' in obj:
-            result['choices'] = obj['enum']
-        if 'version_added' in obj:
-            result['version_added'] = obj['version_added']
-        result['required'] = required
-        result['type'] = obj['type']
-    return result
+    doc = yaml.safe_load(spec['DOCUMENTATION'])
+
+    dive(doc['options'], result)
 
-def to_argspec(value):
-    data = jsonref.loads(json.dumps(value))
-    result = dive(data['schema'])
-    return str(result['options'])
+    result = pprint.pformat(result, indent=1)
+    display.debug("Arguments: %s" % result)
+    return result
 
 
 class FilterModule(object):