Refactored compute_flavor_info module

Change-Id: Ic598a60c2dd6fb465965fa8beee0ea973385bbcf

ci/roles/compute_flavor/tasks/main.yml

@@ -238,7 +238,7 @@
   register: flavor_info
 
 - assert:
-    that: item in flavor_info.openstack_flavors[0]
+    that: item in flavor_info.flavors[0]
   loop: "{{ expected_fields }}"
 
 - name: List flavors with filter
@@ -250,5 +250,5 @@
 - name: Check output of list flavors with filter
   assert:
     that:
-      - flavor.openstack_flavors | length == 1
+      - flavor.flavors | length == 1
-      - flavor.openstack_flavors.0.name == "m1.tiny"
+      - flavor.flavors.0.name == "m1.tiny"

plugins/modules/compute_flavor_info.py

@@ -4,25 +4,27 @@
 # Copyright (c) 2015 IBM
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-DOCUMENTATION = '''
+DOCUMENTATION = r'''
 ---
 module: compute_flavor_info
-short_description: Retrieve information about one or more flavors
+short_description: Fetch compute flavors from OpenStack cloud
 author: OpenStack Ansible SIG
 description:
-    - Retrieve information about available OpenStack instance flavors. By default,
+  - Fetch OpenStack compute flavors.
-      information about ALL flavors are retrieved. Filters can be applied to get
-      information for only matching flavors. For example, you can filter on the
-      amount of RAM available to the flavor, or the number of virtual CPUs
-      available to the flavor, or both. When specifying multiple filters,
-      *ALL* filters must match on a flavor before that flavor is returned as
-      a fact.
-notes:
-    - The result contains a list of unsorted flavors.
 options:
+  ephemeral:
+    description:
+      - Filter flavors based on the amount of ephemeral storage.
+      - I(ephemeral) supports same format as I(ram) option.
+    type: str
+  limit:
+    description:
+      - Limits number of flavors to I(limit) results.
+      - By default all matching flavors are returned.
+    type: int
   name:
     description:
-       - A flavor name. Cannot be used with I(ram) or I(vcpus) or I(ephemeral).
+      - Flavor name.
     type: str
   ram:
     description:
@@ -30,10 +32,8 @@ options:
          (in MB) desired. This string accepts the following special values:
          'MIN' (return flavors with the minimum amount of RAM), and 'MAX'
          (return flavors with the maximum amount of RAM)."
-
       - "A specific amount of RAM may also be specified. Any flavors with this
          exact amount of RAM will be returned."
-
       - "A range of acceptable RAM may be given using a special syntax. Simply
          prefix the amount of RAM with one of these acceptable range values:
          '<', '>', '<=', '>='. These values represent less than, greater than,
@@ -41,148 +41,118 @@ options:
     type: str
   vcpus:
     description:
-       - A string used for filtering flavors based on the number of virtual
+      - Filter flavors based on the number of virtual CPUs.
-         CPUs desired. Format is the same as the I(ram) parameter.
+      - I(vcpus) supports same format as I(ram) option.
-     type: str
-   limit:
-     description:
-       - Limits the number of flavors returned. All matching flavors are
-         returned by default.
-     type: int
-   ephemeral:
-     description:
-       - A string used for filtering flavors based on the amount of ephemeral
-         storage. Format is the same as the I(ram) parameter
     type: str
 requirements:
   - "python >= 3.6"
   - "openstacksdk"
-
 extends_documentation_fragment:
-- openstack.cloud.openstack
+  - openstack.cloud.openstack
 '''
 
-EXAMPLES = '''
+EXAMPLES = r'''
-# Gather information about all available flavors
+- name: Gather information about all available flavors
-- openstack.cloud.compute_flavor_info:
+  openstack.cloud.compute_flavor_info:
     cloud: mycloud
-  register: result
 
-- debug:
+- name: Gather information for the flavor named "xlarge-flavor"
-    msg: "{{ result.openstack_flavors }}"
+  openstack.cloud.compute_flavor_info:
-
-# Gather information for the flavor named "xlarge-flavor"
-- openstack.cloud.compute_flavor_info:
     cloud: mycloud
     name: "xlarge-flavor"
 
-# Get all flavors that have exactly 512 MB of RAM.
+- name: Get all flavors with 512 MB of RAM
-- openstack.cloud.compute_flavor_info:
+  openstack.cloud.compute_flavor_info:
     cloud: mycloud
     ram: "512"
 
-# Get all flavors that have 1024 MB or more of RAM.
+- name: Get all flavors with >= 1024 MB RAM
-- openstack.cloud.compute_flavor_info:
+  openstack.cloud.compute_flavor_info:
     cloud: mycloud
     ram: ">=1024"
 
-# Get a single flavor that has the minimum amount of RAM. Using the 'limit'
+- name: Get a single flavor with minimum amount of RAM
-# option will guarantee only a single flavor is returned.
+  openstack.cloud.compute_flavor_info:
-- openstack.cloud.compute_flavor_info:
     cloud: mycloud
     ram: "MIN"
     limit: 1
 
-# Get all flavors with 1024 MB of RAM or more, AND exactly 2 virtual CPUs.
+- name: Get all flavors with >=1024 MB RAM and 2 vCPUs
-- openstack.cloud.compute_flavor_info:
+  openstack.cloud.compute_flavor_info:
     cloud: mycloud
     ram: ">=1024"
     vcpus: "2"
 
-# Get all flavors with 1024 MB of RAM or more, exactly 2 virtual CPUs, and
+- name: Get flavors with >= 1024 MB RAM 2 vCPUs and < 30gb ephemeral storage
-# less than 30gb of ephemeral storage.
+  openstack.cloud.compute_flavor_info:
-- openstack.cloud.compute_flavor_info:
     cloud: mycloud
     ram: ">=1024"
     vcpus: "2"
     ephemeral: "<30"
 '''
 
-
+RETURN = r'''
-RETURN = '''
+flavors:
-openstack_flavors:
+  description: List of dictionaries describing the compute flavors.
-    description: Dictionary describing the flavors.
+  returned: always
-    returned: On success.
+  type: list
-    type: complex
+  elements: dict
   contains:
-        id:
-            description: Flavor ID.
-            returned: success
-            type: str
-            sample: "515256b8-7027-4d73-aa54-4e30a4a4a339"
-        name:
-            description: Flavor name.
-            returned: success
-            type: str
-            sample: "tiny"
-        original_name:
-            description: Original flavor name
-            returned: success
-            type: str
-            sample: "tiny"
     description:
       description: Description of the flavor
-            returned: success
       type: str
       sample: "Small flavor"
-        is_disabled:
-            description: Wether the flavor is enabled or not
-            returned: success
-            type: bool
-            sample: False
-        rxtx_factor:
-            description: Factor to be multiplied by the rxtx_base property of
-                         the network it is attached to in order to have a
-                         different bandwidth cap.
-            returned: success
-            type: float
-            sample: 1.0
-        extra_specs:
-            description: Optional parameters to configure different flavors
-                         options.
-            returned: success
-            type: dict
-            sample: "{'hw_rng:allowed': True}"
     disk:
       description: Size of local disk, in GB.
-            returned: success
       type: int
       sample: 10
     ephemeral:
       description: Ephemeral space size, in GB.
-            returned: success
       type: int
       sample: 10
+    extra_specs:
+      description: Optional parameters to configure different flavors
+                   options.
+      type: dict
+      sample: "{'hw_rng:allowed': True}"
+    id:
+      description: Flavor ID.
+      type: str
+      sample: "515256b8-7027-4d73-aa54-4e30a4a4a339"
+    is_disabled:
+      description: Wether the flavor is enabled or not
+      type: bool
+      sample: False
+    is_public:
+      description: Make flavor accessible to the public.
+      type: bool
+      sample: true
+    name:
+      description: Flavor name.
+      type: str
+      sample: "tiny"
+    original_name:
+      description: Original flavor name
+      type: str
+      sample: "tiny"
     ram:
       description: Amount of memory, in MB.
-            returned: success
       type: int
       sample: 1024
+    rxtx_factor:
+      description: Factor to be multiplied by the rxtx_base property of
+                   the network it is attached to in order to have a
+                   different bandwidth cap.
+      type: float
+      sample: 1.0
     swap:
       description: Swap space size, in MB.
-            returned: success
       type: int
       sample: 100
     vcpus:
       description: Number of virtual CPUs.
-            returned: success
       type: int
       sample: 2
-        is_public:
-            description: Make flavor accessible to the public.
-            returned: success
-            type: bool
-            sample: true
 '''
 
 from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
@@ -190,54 +160,39 @@ from ansible_collections.openstack.cloud.plugins.module_utils.openstack import O
 
 class ComputeFlavorInfoModule(OpenStackModule):
     argument_spec = dict(
+        ephemeral=dict(),
+        limit=dict(type='int'),
         name=dict(),
         ram=dict(),
         vcpus=dict(),
-        limit=dict(type='int'),
-        ephemeral=dict(),
     )
+
     module_kwargs = dict(
-        mutually_exclusive=[
-            ['name', 'ram'],
-            ['name', 'vcpus'],
-            ['name', 'ephemeral']
-        ],
         supports_check_mode=True
     )
 
     def run(self):
         name = self.params['name']
-        vcpus = self.params['vcpus']
-        ram = self.params['ram']
-        ephemeral = self.params['ephemeral']
-        limit = self.params['limit']
 
-        filters = {}
+        filters = dict((k, self.params[k])
-        if vcpus:
+                       for k in ['ephemeral', 'ram', 'vcpus']
-            filters['vcpus'] = vcpus
+                       if self.params[k] is not None)
-        if ram:
-            filters['ram'] = ram
-        if ephemeral:
-            filters['ephemeral'] = ephemeral
 
         if name:
-            # extra_specs are exposed in the flavor representation since Rocky, so we do not
-            # need get_extra_specs=True which is not available in OpenStack SDK 0.36 (Train)
-            # Ref.: https://docs.openstack.org/nova/latest/reference/api-microversion-history.html
             flavor = self.conn.compute.find_flavor(name)
             flavors = [flavor] if flavor else []
-
         else:
             flavors = list(self.conn.compute.flavors())
+
         if filters:
             flavors = self.conn.range_search(flavors, filters)
 
+        limit = self.params['limit']
         if limit is not None:
             flavors = flavors[:limit]
 
-        # Transform entries to dict
+        self.exit_json(changed=False,
-        flavors = [flavor.to_dict(computed=False) for flavor in flavors]
+                       flavors=[f.to_dict(computed=False) for f in flavors])
-        self.exit_json(changed=False, openstack_flavors=flavors)
 
 
 def main():