Merge pull request #9 from guidograzioli/version_sort

Version sort

Author: guidograzioli

README.md

@@ -1,7 +1,7 @@
 # Ansible Collection - Common
-
+<!--start build_status -->
 [![Build Status](https://github.com/ansible-middleware/common/workflows/CI/badge.svg?branch=main)](https://github.com/ansible-middleware/common/actions/workflows/ci.yml)
-
+<!--end build_status -->
 ## About
 
 Collection containing common utilities to support Ansible Middleware automation
@@ -20,17 +20,23 @@ This collection has been tested against following Pyhton versions: **>=3.6**.
 
 ## Included content
 
-### Modules:
+### Modules
 
 * `product_download`: downloads products from the JBoss Network API
 * `product_search`: searches products from the JBoss Network API
 
+### Filters
+
+* `version_sort`: sort a list of strings according to version ordering
+
+
 ## Installation
 
+<!--start galaxy_download -->
 ### Download from galaxy
 
     ansible-galaxy collection install middleware_automation.common
-
+<!--end galaxy_download -->
 
 ### Build and install locally
 
@@ -50,9 +56,8 @@ To install all the dependencies via galaxy:
 
     pip install -r requirements.txt
 
-## Support
-
-The common collection is for [Technical Preview](https://access.redhat.com/support/offerings/techpreview). If you have any issues or questions related to collection, please don't hesitate to contact us on <Ansible-middleware-core@redhat.com> or open an issue on <https://github.com/ansible-middleware/common/issues>
+<!--start support -->
+<!--end support -->
 
 ## License
 

galaxy.yml

@@ -1,10 +1,11 @@
 ---
 namespace: middleware_automation
 name: common
-version: "1.0.2"
+version: "1.1.0"
 readme: README.md
 authors:
   - Andrew Block <ablock@redhat.com>
+  - Guido Grazioli <ggraziol@redhat.com>
 description: Common utilities to support Ansible Middleware automation.
 license_file: "LICENSE"
 tags:

plugins/filter/version_sort.py

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+# Copyright (C) 2021 Eric Lavarde <elavarde@redhat.com>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+DOCUMENTATION = '''
+  name: version_sort
+  short_description: Sort a list according to version order instead of pure alphabetical one
+  version_added: 2.2.0
+  author: Eric L. (@ericzolf)
+  description:
+    - Sort a list according to version order instead of pure alphabetical one.
+  options:
+    _input:
+      description: A list of strings to sort.
+      type: list
+      elements: string
+      required: true
+'''
+
+EXAMPLES = '''
+- name: Convert list of tuples into dictionary
+  ansible.builtin.set_fact:
+    dictionary: "{{ ['2.1', '2.10', '2.9'] | middleware_automation.common.version_sort }}"
+    # Result is ['2.1', '2.9', '2.10']
+'''
+
+RETURN = '''
+  _value:
+    description: The list of strings sorted by version.
+    type: list
+    elements: string
+'''
+
+from ansible_collections.middleware_automation.common.plugins.module_utils.version import LooseVersion
+
+
+def version_sort(value, reverse=False):
+    '''Sort a list according to loose versions so that e.g. 2.9 is smaller than 2.10'''
+    return sorted(value, key=LooseVersion, reverse=reverse)
+
+
+class FilterModule(object):
+    ''' Version sort filter '''
+
+    def filters(self):
+        return {
+            'version_sort': version_sort
+        }

plugins/module_utils/version.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Felix Fontein <felix@fontein.de>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+"""Provide version object to compare version numbers."""
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+from ansible.module_utils.six import raise_from
+
+try:
+    from ansible.module_utils.compat.version import LooseVersion  # noqa: F401, pylint: disable=unused-import
+except ImportError:
+    try:
+        from distutils.version import LooseVersion  # noqa: F401, pylint: disable=unused-import
+    except ImportError as exc:
+        msg = 'To use this plugin or module with ansible-core 2.11, you need to use Python < 3.12 with distutils.version present'
+        raise_from(ImportError(msg), exc)