Release 2.4.0 version

Change-Id: I7e09a849d089962aaec90d30d9e6ab8a3891aa41

.zuul.yaml

@@ -256,7 +256,7 @@
 
 - job:
     name: ansible-collections-openstack-release
-    parent: base
+    parent: openstack-tox-linters-ansible
     run: ci/publish/publish_collection.yml
     secrets:
       - ansible_galaxy_info

CHANGELOG.rst

@@ -5,6 +5,67 @@ Ansible OpenStack Collection Release Notes
 .. contents:: Topics
 
 
+v2.4.0
+======
+
+Release Summary
+---------------
+
+New trait module and minor changes
+
+Major Changes
+-------------
+
+- Add trait module
+
+Minor Changes
+-------------
+
+- Add loadbalancer quota options
+- Allow create instance with tags
+
+New Modules
+-----------
+
+- openstack.cloud.trait - Add or Delete a trait from OpenStack
+
+v2.3.3
+======
+
+Release Summary
+---------------
+
+Bugfixes and minor changes
+
+Minor Changes
+-------------
+
+- Add test to only_ipv4 in inventory
+- add an option to use only IPv4 only for ansible_host and ansible_ssh_host
+
+Bugfixes
+--------
+
+- CI - Fix deprecated ANSIBLE_COLLECTIONS_PATHS variable
+
+v2.3.2
+======
+
+Release Summary
+---------------
+
+Bugfixes and minor changes
+
+Minor Changes
+-------------
+
+- Drop compat implementations for tests
+
+Bugfixes
+--------
+
+- Fix openstack.cloud.port module failure in check mode
+
 v2.3.1
 ======
 

changelogs/changelog.yaml

@@ -578,3 +578,33 @@ releases:
       - Add ability to pass client tls certificate
       release_summary: Client TLS certificate support
     release_date: '2024-12-18'
+  2.3.2:
+    changes:
+      bugfixes:
+      - Fix openstack.cloud.port module failure in check mode
+      minor_changes:
+      - Drop compat implementations for tests
+      release_summary: Bugfixes and minor changes
+    release_date: '2024-12-20'
+  2.3.3:
+    changes:
+      bugfixes:
+      - CI - Fix deprecated ANSIBLE_COLLECTIONS_PATHS variable
+      minor_changes:
+      - Add test to only_ipv4 in inventory
+      - add an option to use only IPv4 only for ansible_host and ansible_ssh_host
+      release_summary: Bugfixes and minor changes
+    release_date: '2024-12-22'
+  2.4.0:
+    changes:
+      major_changes:
+      - Add trait module
+      minor_changes:
+      - Add loadbalancer quota options
+      - Allow create instance with tags
+      release_summary: New trait module and minor changes
+    modules:
+    - description: Add or Delete a trait from OpenStack
+      name: trait
+      namespace: ''
+    release_date: '2025-01-15'

ci/publish/publish_collection.yml

@@ -3,7 +3,8 @@
   vars:
     collection_path: "{{ ansible_user_dir }}/{{ zuul.project.src_dir }}"
     build_collection_path: /tmp/collection_built/
-    ansible_galaxy_path: "~/.local/bin/ansible-galaxy"
+    ansible_virtualenv_path: /tmp/ansible_venv
+    ansible_galaxy_path: "{{ ansible_virtualenv_path }}/bin/ansible-galaxy"
 
   tasks:
 
@@ -11,9 +12,15 @@
       include_role:
         name: ensure-pip
 
-    - name: Install ansible
+    - name: Install Ansible in virtualenv
       pip:
-        name: ansible-core<2.12
+        name: ansible-core<2.19
+        virtualenv: "{{ ansible_virtualenv_path }}"
+        virtualenv_command: "{{ ensure_pip_virtualenv_command }}"
+
+    - name: Detect ansible version
+      command: "{{ ansible_virtualenv_path }}/bin/ansible --version"
+      register: ansible_version
 
     - name: Discover tag version
       set_fact:

ci/roles/inventory/tasks/main.yml

@@ -303,6 +303,25 @@
             that:
               - inventory.all.children.RegionOne.hosts.keys() | sort == ['ansible_server1', 'ansible_server2'] | sort
 
+        - name: List servers with inventory plugin with IPv4 only
+          ansible.builtin.command:
+            cmd: ansible-inventory --list --yaml --extra-vars only_ipv4=true --inventory-file openstack.yaml
+            chdir: "{{ tmp_dir.path }}"
+          environment:
+            ANSIBLE_INVENTORY_CACHE: "True"
+            ANSIBLE_INVENTORY_CACHE_PLUGIN: "jsonfile"
+            ANSIBLE_CACHE_PLUGIN_CONNECTION: "{{ tmp_dir.path }}/.cache/"
+          register: inventory
+
+        - name: Read YAML output from inventory plugin again
+          ansible.builtin.set_fact:
+            inventory: "{{ inventory.stdout | from_yaml }}"
+
+        - name: Check YAML output from inventory plugin again
+          assert:
+            that:
+              - inventory.all.children.RegionOne.hosts.keys() | sort == ['ansible_server1', 'ansible_server2'] | sort
+
     - name: Delete server 2
       openstack.cloud.resource:
         service: compute

ci/roles/quota/defaults/main.yml

@@ -28,3 +28,9 @@ test_compute_quota:
   ram: 5
   server_group_members: 5
   server_groups: 5
+test_load_balancer_quota:
+  load_balancers: 5
+  health_monitors: 5
+  listeners: 5
+  pools: 5
+  members: 5

ci/roles/quota/tasks/loadbalancer.yml

@@ -0,0 +1,158 @@
+---
+- module_defaults:
+    group/openstack.cloud.openstack:
+      cloud: "{{ cloud }}"
+      name: "{{ test_project }}"
+    # Backward compatibility with Ansible 2.9
+    openstack.cloud.project:
+      cloud: "{{ cloud }}"
+      name: "{{ test_project }}"
+    openstack.cloud.quota:
+      cloud: "{{ cloud }}"
+      name: "{{ test_project }}"
+  block:
+    - name: Create test project
+      openstack.cloud.project:
+        state: present
+
+    - name: Clear quotas before tests
+      openstack.cloud.quota:
+        state: absent
+      register: default_quotas
+
+    - name: Set network quota
+      openstack.cloud.quota: "{{ test_network_quota }}"
+      register: quotas
+
+    - name: Assert changed
+      assert:
+        that: quotas is changed
+
+    - name: Assert field values
+      assert:
+        that: quotas.quotas.network[item.key] == item.value
+      loop: "{{ test_network_quota | dict2items }}"
+
+    - name: Set network quota again
+      openstack.cloud.quota: "{{ test_network_quota }}"
+      register: quotas
+
+    - name: Assert not changed
+      assert:
+        that: quotas is not changed
+
+    - name: Set volume quotas
+      openstack.cloud.quota: "{{ test_volume_quota }}"
+      register: quotas
+
+    - name: Assert changed
+      assert:
+        that: quotas is changed
+
+    - name: Assert field values
+      assert:
+        that: quotas.quotas.volume[item.key] == item.value
+      loop: "{{ test_volume_quota | dict2items }}"
+
+    - name: Set volume quotas again
+      openstack.cloud.quota: "{{ test_volume_quota }}"
+      register: quotas
+
+    - name: Assert not changed
+      assert:
+        that: quotas is not changed
+
+    - name: Set compute quotas
+      openstack.cloud.quota: "{{ test_compute_quota }}"
+      register: quotas
+
+    - name: Assert changed
+      assert:
+        that: quotas is changed
+
+    - name: Assert field values
+      assert:
+        that: quotas.quotas.compute[item.key] == item.value
+      loop: "{{ test_compute_quota | dict2items }}"
+
+    - name: Set compute quotas again
+      openstack.cloud.quota: "{{ test_compute_quota }}"
+      register: quotas
+
+    - name: Set load_balancer quotas
+      openstack.cloud.quota: "{{ test_load_balancer_quota }}"
+      register: quotas
+
+    - name: Assert changed
+      assert:
+        that: quotas is changed
+
+    - name: Assert field values
+      assert:
+        that: quotas.quotas.load_balancer[item.key] == item.value
+      loop: "{{ test_load_balancer_quota | dict2items }}"
+
+    - name: Set load_balancer quotas again
+      openstack.cloud.quota: "{{ test_load_balancer_quota }}"
+      register: quotas
+
+    - name: Assert not changed
+      assert:
+        that: quotas is not changed
+
+    - name: Unset all quotas
+      openstack.cloud.quota:
+        state: absent
+      register: quotas
+
+    - name: Assert defaults restore
+      assert:
+        that: quotas.quotas == default_quotas.quotas
+
+    - name: Set all quotas at once
+      openstack.cloud.quota:
+        "{{ [test_network_quota, test_volume_quota, test_compute_quota, test_load_balancer_quota] | combine }}"
+      register: quotas
+
+    - name: Assert changed
+      assert:
+        that: quotas is changed
+
+    - name: Assert volume values
+      assert:
+        that: quotas.quotas.volume[item.key] == item.value
+      loop: "{{ test_volume_quota | dict2items }}"
+
+    - name: Assert network values
+      assert:
+        that: quotas.quotas.network[item.key] == item.value
+      loop: "{{ test_network_quota | dict2items }}"
+
+    - name: Assert compute values
+      assert:
+        that: quotas.quotas.compute[item.key] == item.value
+      loop: "{{ test_compute_quota | dict2items }}"
+
+    - name: Assert load_balancer values
+      assert:
+        that: quotas.quotas.load_balancer[item.key] == item.value
+      loop: "{{ test_load_balancer_quota | dict2items }}"
+
+    - name: Set all quotas at once again
+      openstack.cloud.quota:
+        "{{ [test_network_quota, test_volume_quota, test_compute_quota, test_load_balancer_quota] | combine }}"
+      register: quotas
+
+    - name: Assert not changed
+      assert:
+        that: quotas is not changed
+
+    - name: Unset all quotas
+      openstack.cloud.quota:
+        state: absent
+      register: quotas
+
+    - name: Delete test project
+      openstack.cloud.project:
+         state: absent
+

ci/roles/quota/tasks/main.yml

@@ -128,4 +128,9 @@
 
     - name: Delete test project
       openstack.cloud.project:
-         state: absent
+        state: absent
+
+- import_tasks: loadbalancer.yml
+  tags:
+    - loadbalancer
+

ci/roles/server/tasks/main.yml

@@ -241,6 +241,40 @@
     name: "{{ server_name }}"
     wait: true
 
+- name: Create server with tags
+  openstack.cloud.server:
+    cloud: "{{ cloud }}"
+    state: present
+    name: "{{ server_name }}"
+    image: "{{ image_name }}"
+    flavor: "{{ flavor_name }}"
+    network: "{{ server_network }}"
+    auto_ip: false
+    tags:
+      - first
+      - second
+    wait: true
+  register: server
+
+- debug: var=server
+
+- name: Get info about tags
+  openstack.cloud.server_info:
+    cloud: "{{ cloud }}"
+    server: "{{ server_name }}"
+  register: info
+
+- name: Check filter results
+  assert:
+    that: info.servers[0].tags == ["first", "second"]
+
+- name: Delete server with tags
+  openstack.cloud.server:
+    cloud: "{{ cloud }}"
+    state: absent
+    name: "{{ server_name }}"
+    wait: true
+
 - name: Create server from volume
   openstack.cloud.server:
     cloud: "{{ cloud }}"

ci/roles/trait/defaults/main.yml

@@ -0,0 +1 @@
+trait_name: CUSTOM_ANSIBLE_TRAIT

ci/roles/trait/tasks/main.yml

@@ -0,0 +1,23 @@
+---
+- openstack.cloud.trait:
+    cloud: "{{ cloud }}"
+    state: present
+    id: "{{ trait_name }}"
+  delegate_to: localhost
+  register: item
+
+- assert:
+    that:
+      - "'name' in item.trait"
+      - "item.trait.id == trait_name"
+
+- openstack.cloud.trait:
+    cloud: "{{ cloud }}"
+    state: absent
+    id: "{{ trait_name }}"
+  delegate_to: localhost
+  register: item
+
+- assert:
+    that:
+      - "'trait' not in item"

ci/run-ansible-tests-collection.sh

@@ -75,10 +75,10 @@ ansible-galaxy collection install --requirements-file ci/requirements.yml
 if [ -z "$PIP_INSTALL" ]; then
     tox -ebuild
     ansible-galaxy collection install "$(find build_artifact/ -maxdepth 1 -name 'openstack-cloud-*')" --force
-    TEST_COLLECTIONS_PATHS=${HOME}/.ansible/collections:$ANSIBLE_COLLECTIONS_PATHS
+    TEST_COLLECTIONS_PATHS=${HOME}/.ansible/collections:$ANSIBLE_COLLECTIONS_PATH
 else
     pip freeze | grep ansible-collections-openstack
-    TEST_COLLECTIONS_PATHS=$VIRTUAL_ENV/share/ansible/collections:$ANSIBLE_COLLECTIONS_PATHS
+    TEST_COLLECTIONS_PATHS=$VIRTUAL_ENV/share/ansible/collections:$ANSIBLE_COLLECTIONS_PATH
 fi
 
 # We need to source the current tox environment so that Ansible will
@@ -129,7 +129,7 @@ cd ci/
 # Run tests
 set -o pipefail
 # shellcheck disable=SC2086
-ANSIBLE_COLLECTIONS_PATHS=$TEST_COLLECTIONS_PATHS ansible-playbook \
+ANSIBLE_COLLECTIONS_PATH=$TEST_COLLECTIONS_PATHS ansible-playbook \
     -vvv ./run-collection.yml \
     -e "sdk_version=${SDK_VER} cloud=${CLOUD} cloud_alt=${CLOUD_ALT} ${ANSIBLE_VARS}" \
     ${tag_opt} 2>&1 | sudo tee /opt/stack/logs/test_output.log

ci/run-collection.yml

@@ -36,6 +36,7 @@
     - { role: object, tags: object }
     - { role: object_container, tags: object_container }
     - { role: port, tags: port }
+    - { role: trait, tags: trait }
     - { role: trunk, tags: trunk }
     - { role: project, tags: project }
     - { role: quota, tags: quota }

galaxy.yml

@@ -32,4 +32,4 @@ build_ignore:
   - .vscode
   - ansible_collections_openstack.egg-info
   - changelogs
-version: 2.3.1
+version: 2.4.0

plugins/inventory/openstack.py

@@ -96,6 +96,12 @@ options:
         only.
     type: bool
     default: false
+  only_ipv4:
+    description:
+      - Use only ipv4 addresses for ansible_host and ansible_ssh_host.
+      - Using I(only_ipv4) helps when running Ansible in a ipv4 only setup.
+    type: bool
+    default: false
   show_all:
     description:
       - Whether all servers should be listed or not.
@@ -384,10 +390,17 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
                  if address['OS-EXT-IPS:type'] == 'floating'),
                 None)
 
-            fixed_ip = next(
-                (address['addr'] for address in addresses
-                 if address['OS-EXT-IPS:type'] == 'fixed'),
-                None)
+            if self.get_option('only_ipv4'):
+                fixed_ip = next(
+                    (address['addr'] for address in addresses
+                     if (address['OS-EXT-IPS:type'] == 'fixed' and address['version'] == 4)),
+                    None)
+
+            else:
+                fixed_ip = next(
+                    (address['addr'] for address in addresses
+                     if address['OS-EXT-IPS:type'] == 'fixed'),
+                    None)
 
             ip = floating_ip if floating_ip is not None and not self.get_option('private') else fixed_ip
 

plugins/modules/port.py

@@ -511,7 +511,7 @@ class PortModule(OpenStackModule):
             **(dict(network_id=network.id) if network else dict()))
 
         if self.ansible.check_mode:
-            self.exit_json(changed=self._will_change(network, port, state))
+            self.exit_json(changed=self._will_change(port, state))
 
         if state == 'present' and not port:
             # create port

plugins/modules/quota.py

@@ -38,6 +38,9 @@ options:
     groups:
         description: Number of groups that are allowed for the project
         type: int
+    health_monitors:
+        description: Maximum number of health monitors that can be created.
+        type: int
     injected_file_content_bytes:
         description:
           - Maximum file size in bytes.
@@ -61,6 +64,12 @@ options:
     key_pairs:
         description: Number of key pairs to allow.
         type: int
+    l7_policies:
+        description: The maximum amount of L7 policies you can create.
+        type: int
+    listeners:
+        description: The maximum number of listeners you can create.
+        type: int
     load_balancers:
         description: The maximum amount of load balancers you can create
         type: int
@@ -68,6 +77,9 @@ options:
     metadata_items:
        description: Number of metadata items allowed per instance.
        type: int
+    members:
+       description: Number of members allowed for loadbalancer.
+       type: int
     name:
         description: Name of the OpenStack Project to manage.
         required: true
@@ -227,6 +239,33 @@ quotas:
                 server_groups:
                     description: Number of server groups to allow.
                     type: int
+        load_balancer:
+            description: Load_balancer service quotas
+            type: dict
+            contains:
+                health_monitors:
+                    description: Maximum number of health monitors that can be
+                      created.
+                    type: int
+                l7_policies:
+                    description: The maximum amount of L7 policies you can
+                       create.
+                    type: int
+                listeners:
+                    description: The maximum number of listeners you can create
+                    type: int
+                load_balancers:
+                    description: The maximum amount of load balancers one can
+                                 create
+                    type: int
+                members:
+                    description: The maximum amount of members for
+                      loadbalancer.
+                    type: int
+                pools:
+                    description: The maximum amount of pools one can create.
+                    type: int
+
         network:
             description: Network service quotas
             type: dict
@@ -234,16 +273,9 @@ quotas:
                 floating_ips:
                     description: Number of floating IP's to allow.
                     type: int
-                load_balancers:
-                    description: The maximum amount of load balancers one can
-                                 create
-                    type: int
                 networks:
                     description: Number of networks to allow.
                     type: int
-                pools:
-                    description: The maximum amount of pools one can create.
-                    type: int
                 ports:
                     description: Number of Network ports to allow, this needs
                         to be greater than the instances limit.
@@ -312,9 +344,7 @@ quotas:
                 server_groups: 10,
             network:
                 floating_ips: 50,
-                load_balancers: 10,
                 networks: 10,
-                pools: 10,
                 ports: 160,
                 rbac_policies: 10,
                 routers: 10,
@@ -330,6 +360,13 @@ quotas:
                 per_volume_gigabytes: -1,
                 snapshots: 10,
                 volumes: 10,
+            load_balancer:
+                health_monitors: 10,
+                load_balancers: 10,
+                l7_policies: 10,
+                listeners: 10,
+                pools: 5,
+                members: 5,
 '''
 
 from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
@@ -337,9 +374,8 @@ from collections import defaultdict
 
 
 class QuotaModule(OpenStackModule):
-    # TODO: Add missing network quota options 'check_limit', 'health_monitors',
-    #       'l7_policies', 'listeners' to argument_spec, DOCUMENTATION and
-    #       RETURN docstrings
+    # TODO: Add missing network quota options 'check_limit'
+    #       to argument_spec, DOCUMENTATION and RETURN docstrings
     argument_spec = dict(
         backup_gigabytes=dict(type='int'),
         backups=dict(type='int'),
@@ -350,6 +386,7 @@ class QuotaModule(OpenStackModule):
                                  'network_floating_ips']),
         gigabytes=dict(type='int'),
         groups=dict(type='int'),
+        health_monitors=dict(type='int'),
         injected_file_content_bytes=dict(type='int',
                                          aliases=['injected_file_size']),
         injected_file_path_bytes=dict(type='int',
@@ -357,8 +394,11 @@ class QuotaModule(OpenStackModule):
         injected_files=dict(type='int'),
         instances=dict(type='int'),
         key_pairs=dict(type='int', no_log=False),
+        l7_policies=dict(type='int'),
+        listeners=dict(type='int'),
         load_balancers=dict(type='int', aliases=['loadbalancer']),
         metadata_items=dict(type='int'),
+        members=dict(type='int'),
         name=dict(required=True),
         networks=dict(type='int', aliases=['network']),
         per_volume_gigabytes=dict(type='int'),
@@ -382,9 +422,9 @@ class QuotaModule(OpenStackModule):
         supports_check_mode=True
     )
 
-    # Some attributes in quota resources don't exist in the api anymore, mostly
-    # compute quotas that were simply network proxies. This map allows marking
-    # them to be skipped.
+    # Some attributes in quota resources don't exist in the api anymore, e.g.
+    # compute quotas that were simply network proxies, and pre-Octavia network
+    # quotas. This map allows marking them to be skipped.
     exclusion_map = {
         'compute': {
             # 'fixed_ips',  # Available until Nova API version 2.35
@@ -397,7 +437,16 @@ class QuotaModule(OpenStackModule):
             # 'injected_file_path_bytes',     # Nova API
             # 'injected_files',               # version 2.56
         },
-        'network': {'name'},
+        'load_balancer': {'name'},
+        'network': {
+            'name',
+            'l7_policies',
+            'load_balancers',
+            'loadbalancer',
+            'health_monitors',
+            'pools',
+            'listeners',
+        },
         'volume': {'name'},
     }
 
@@ -409,12 +458,18 @@ class QuotaModule(OpenStackModule):
             self.warn('Block storage service aka volume service is not'
                       ' supported by your cloud. Ignoring volume quotas.')
 
+        if self.conn.has_service('load-balancer'):
+            quota['load_balancer'] = self.conn.load_balancer.get_quota(
+                project.id)
+        else:
+            self.warn('Loadbalancer service is not supported by your'
+                      ' cloud. Ignoring loadbalancer quotas.')
+
         if self.conn.has_service('network'):
             quota['network'] = self.conn.network.get_quota(project.id)
         else:
             self.warn('Network service is not supported by your cloud.'
                       ' Ignoring network quotas.')
-
         quota['compute'] = self.conn.compute.get_quota_set(project.id)
 
         return quota
@@ -452,7 +507,6 @@ class QuotaModule(OpenStackModule):
 
         # Get current quota values
         quotas = self._get_quotas(project)
-
         changed = False
 
         if self.ansible.check_mode:
@@ -468,6 +522,8 @@ class QuotaModule(OpenStackModule):
                 self.conn.network.delete_quota(project.id)
             if 'volume' in quotas:
                 self.conn.block_storage.revert_quota_set(project)
+            if 'load_balancer' in quotas:
+                self.conn.load_balancer.delete_quota(project.id)
 
             # Necessary since we can't tell what the default quotas are
             quotas = self._get_quotas(project)
@@ -485,6 +541,10 @@ class QuotaModule(OpenStackModule):
                 if 'network' in changes:
                     quotas['network'] = self.conn.network.update_quota(
                         project.id, **changes['network'])
+                if 'load_balancer' in changes:
+                    quotas['load_balancer'] = \
+                        self.conn.load_balancer.update_quota(
+                        project.id, **changes['load_balancer'])
                 changed = True
 
         quotas = {k: v.to_dict(computed=False) for k, v in quotas.items()}

plugins/modules/server.py

@@ -205,6 +205,11 @@ options:
       choices: [present, absent]
       default: present
       type: str
+    tags:
+      description:
+        -  A list of tags should be added to instance
+      type: list
+      elements: str
     terminate_volume:
       description:
         - If C(true), delete volume when deleting the instance and if it has
@@ -756,6 +761,7 @@ server:
             description:  A list of associated tags.
             returned: success
             type: list
+            elements: str
         task_state:
             description: The task state of this server.
             returned: success
@@ -825,6 +831,7 @@ class ServerModule(OpenStackModule):
         scheduler_hints=dict(type='dict'),
         security_groups=dict(default=[], type='list', elements='str'),
         state=dict(default='present', choices=['absent', 'present']),
+        tags=dict(type='list', elements='str'),
         terminate_volume=dict(default=False, type='bool'),
         userdata=dict(),
         volume_size=dict(type='int'),
@@ -1072,7 +1079,7 @@ class ServerModule(OpenStackModule):
         for k in ['auto_ip', 'availability_zone', 'boot_from_volume',
                   'boot_volume', 'config_drive', 'description', 'key_name',
                   'name', 'network', 'reuse_ips', 'scheduler_hints',
-                  'security_groups', 'terminate_volume', 'timeout',
+                  'security_groups', 'tags', 'terminate_volume', 'timeout',
                   'userdata', 'volume_size', 'volumes', 'wait']:
             if self.params[k] is not None:
                 args[k] = self.params[k]

plugins/modules/trait.py

@@ -0,0 +1,110 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2025, ScaleUp Technologies GmbH & Co. KG
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+DOCUMENTATION = '''
+---
+module: trait
+short_description: Add/Delete a trait from OpenStack
+author: OpenStack Ansible SIG
+description:
+  - Add or Delete a trait from OpenStack
+options:
+  id:
+    description:
+      - ID/Name of this trait
+    required: true
+    type: str
+  state:
+    description:
+      - Should the resource be present or absent.
+    choices: [present, absent]
+    default: present
+    type: str
+extends_documentation_fragment:
+- openstack.cloud.openstack
+'''
+
+EXAMPLES = '''
+# Creates a trait with the ID CUSTOM_WINDOWS_SPLA
+- openstack.cloud.trait:
+      cloud: openstack
+      state: present
+      id: CUSTOM_WINDOWS_SPLA
+'''
+
+RETURN = '''
+trait:
+    description: Dictionary describing the trait.
+    returned: On success when I(state) is 'present'
+    type: dict
+    contains:
+        id:
+            description: ID of the trait.
+            returned: success
+            type: str
+'''
+
+from ansible_collections.openstack.cloud.plugins.module_utils.openstack import (
+    OpenStackModule)
+
+
+class TraitModule(OpenStackModule):
+
+    argument_spec = dict(
+        id=dict(required=True),
+        state=dict(default='present',
+                   choices=['absent', 'present']),
+    )
+
+    module_kwargs = dict(
+        supports_check_mode=True,
+    )
+
+    def _system_state_change(self, trait):
+        state = self.params['state']
+        if state == 'present' and not trait:
+            return True
+        if state == 'absent' and trait:
+            return True
+        return False
+
+    def run(self):
+
+        state = self.params['state']
+        id = self.params['id']
+
+        try:
+            trait = self.conn.placement.get_trait(id)
+        except self.sdk.exceptions.NotFoundException:
+            trait = None
+
+        if self.ansible.check_mode:
+            self.exit_json(changed=self._system_state_change(trait), trait=trait)
+
+        changed = False
+        if state == 'present':
+            if not trait:
+                trait = self.conn.placement.create_trait(id)
+                changed = True
+
+            self.exit_json(
+                changed=changed, trait=trait.to_dict(computed=False))
+
+        elif state == 'absent':
+            if trait:
+                self.conn.placement.delete_trait(id, ignore_missing=False)
+                self.exit_json(changed=True)
+
+            self.exit_json(changed=False)
+
+
+def main():
+    module = TraitModule()
+    module()
+
+
+if __name__ == '__main__':
+    main()

tests/unit/compat/builtins.py

@@ -1,31 +0,0 @@
-# (c) 2014, Toshio Kuratomi <tkuratomi@ansible.com>
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-
-# Make coding more python3-ish
-
-#
-# Compat for python2.7
-#
-
-# One unittest needs to import builtins via __import__() so we need to have
-# the string that represents it
-try:
-    import __builtin__  # noqa
-except ImportError:
-    BUILTINS = 'builtins'
-else:
-    BUILTINS = '__builtin__'

tests/unit/compat/mock.py

@@ -1,120 +0,0 @@
-# (c) 2014, Toshio Kuratomi <tkuratomi@ansible.com>
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-
-# Make coding more python3-ish
-
-'''
-Compat module for Python3.x's unittest.mock module
-'''
-import sys
-
-# Python 2.7
-
-# Note: Could use the pypi mock library on python3.x as well as python2.x.  It
-# is the same as the python3 stdlib mock library
-
-try:
-    # Allow wildcard import because we really do want to import all of mock's
-    # symbols into this compat shim
-    # pylint: disable=wildcard-import,unused-wildcard-import
-    from unittest.mock import *  # noqa
-except ImportError:
-    # Python 2
-    # pylint: disable=wildcard-import,unused-wildcard-import
-    try:
-        from mock import *  # noqa
-    except ImportError:
-        print('You need the mock library installed on python2.x to run tests')
-
-
-# Prior to 3.4.4, mock_open cannot handle binary read_data
-if sys.version_info >= (3,) and sys.version_info < (3, 4, 4):
-    file_spec = None
-
-    def _iterate_read_data(read_data):
-        # Helper for mock_open:
-        # Retrieve lines from read_data via a generator so that separate calls to
-        # readline, read, and readlines are properly interleaved
-        sep = b'\n' if isinstance(read_data, bytes) else '\n'
-        data_as_list = [li + sep for li in read_data.split(sep)]
-
-        if data_as_list[-1] == sep:
-            # If the last line ended in a newline, the list comprehension will have an
-            # extra entry that's just a newline.  Remove this.
-            data_as_list = data_as_list[:-1]
-        else:
-            # If there wasn't an extra newline by itself, then the file being
-            # emulated doesn't have a newline to end the last line  remove the
-            # newline that our naive format() added
-            data_as_list[-1] = data_as_list[-1][:-1]
-
-        for line in data_as_list:
-            yield line
-
-    def mock_open(mock=None, read_data=''):
-        """
-        A helper function to create a mock to replace the use of `open`. It works
-        for `open` called directly or used as a context manager.
-
-        The `mock` argument is the mock object to configure. If `None` (the
-        default) then a `MagicMock` will be created for you, with the API limited
-        to methods or attributes available on standard file handles.
-
-        `read_data` is a string for the `read` methoddline`, and `readlines` of the
-        file handle to return.  This is an empty string by default.
-        """
-        def _readlines_side_effect(*args, **kwargs):
-            if handle.readlines.return_value is not None:
-                return handle.readlines.return_value
-            return list(_data)
-
-        def _read_side_effect(*args, **kwargs):
-            if handle.read.return_value is not None:
-                return handle.read.return_value
-            return type(read_data)().join(_data)
-
-        def _readline_side_effect():
-            if handle.readline.return_value is not None:
-                while True:
-                    yield handle.readline.return_value
-            for line in _data:
-                yield line
-
-        global file_spec
-        if file_spec is None:
-            import _io  # noqa
-            file_spec = list(set(dir(_io.TextIOWrapper)).union(set(dir(_io.BytesIO))))
-
-        if mock is None:
-            mock = MagicMock(name='open', spec=open)  # noqa
-
-        handle = MagicMock(spec=file_spec)  # noqa
-        handle.__enter__.return_value = handle
-
-        _data = _iterate_read_data(read_data)
-
-        handle.write.return_value = None
-        handle.read.return_value = None
-        handle.readline.return_value = None
-        handle.readlines.return_value = None
-
-        handle.read.side_effect = _read_side_effect
-        handle.readline.side_effect = _readline_side_effect()
-        handle.readlines.side_effect = _readlines_side_effect
-
-        mock.return_value = handle
-        return mock

tests/unit/compat/unittest.py

@@ -1,36 +0,0 @@
-# (c) 2014, Toshio Kuratomi <tkuratomi@ansible.com>
-#
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
-
-# Make coding more python3-ish
-
-'''
-Compat module for Python2.7's unittest module
-'''
-
-import sys
-
-# Allow wildcard import because we really do want to import all of
-# unittests's symbols into this compat shim
-# pylint: disable=wildcard-import,unused-wildcard-import
-if sys.version_info < (2, 7):
-    try:
-        # Need unittest2 on python2.6
-        from unittest2 import *  # noqa
-    except ImportError:
-        print('You need unittest2 installed on python2.6.x to run tests')
-else:
-    from unittest import *  # noqa

tests/unit/mock/path.py

@@ -1,4 +1,5 @@
-from ansible_collections.openstack.cloud.tests.unit.compat.mock import MagicMock
+from unittest.mock import MagicMock
+
 from ansible.utils.path import unfrackpath
 
 

tests/unit/mock/procenv.py

@@ -20,10 +20,10 @@
 
 import sys
 import json
+import unittest
 
 from contextlib import contextmanager
 from io import BytesIO, StringIO
-from ansible_collections.openstack.cloud.tests.unit.compat import unittest
 from ansible.module_utils.six import PY3
 from ansible.module_utils._text import to_bytes
 

tests/unit/modules/cloud/openstack/test_server.py

@@ -1,7 +1,7 @@
 import collections
 import inspect
-import mock
 import pytest
+from unittest import mock
 import yaml
 
 from ansible.module_utils.six import string_types

tests/unit/modules/utils.py

@@ -1,7 +1,7 @@
 import json
+import unittest
+from unittest.mock import patch
 
-from ansible_collections.openstack.cloud.tests.unit.compat import unittest
-from ansible_collections.openstack.cloud.tests.unit.compat.mock import patch
 from ansible.module_utils import basic
 from ansible.module_utils._text import to_bytes