Initial commit

tests/integration/targets/inventory_cloudscale/aliases

@@ -0,0 +1,3 @@
+cloud/cloudscale
+unsupported
+needs/target/cloudscale_common

tests/integration/targets/inventory_cloudscale/filter_plugins/group_name.py

@@ -0,0 +1,17 @@
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+from ansible.inventory.group import to_safe_group_name
+
+
+def safe_group_name(name):
+    return to_safe_group_name(name)
+
+
+class FilterModule(object):
+    filter_map = {
+        'safe_group_name': safe_group_name
+    }
+
+    def filters(self):
+        return self.filter_map

tests/integration/targets/inventory_cloudscale/inventory-private.yml

@@ -0,0 +1,14 @@
+plugin: community.general.cloudscale
+ansible_host: private
+inventory_hostname: name
+groups:
+  ansible: inventory_hostname.startswith('ansible')
+  private_net: (cloudscale.interfaces | selectattr('type', 'equalto', 'private') | list | length) > 0
+keyed_groups:
+- prefix: net
+  key: (cloudscale.interfaces.0.addresses.0.address + '/' + cloudscale.interfaces.0.addresses.0.prefix_length | string) | ansible.netcommon.ipaddr('network')
+- prefix: distro
+  key: cloudscale.image.operating_system
+compose:
+  flavor_image: cloudscale.flavor.slug + '_' + cloudscale.image.slug
+strict: false

tests/integration/targets/inventory_cloudscale/inventory-public.yml

@@ -0,0 +1,14 @@
+plugin: community.general.cloudscale
+ansible_host: public_v4
+inventory_hostname: name
+groups:
+  ansible: inventory_hostname.startswith('ansible')
+  private_net: (cloudscale.interfaces | selectattr('type', 'equalto', 'private') | list | length) > 0
+keyed_groups:
+- prefix: net
+  key: (cloudscale.interfaces.0.addresses.0.address + '/' + cloudscale.interfaces.0.addresses.0.prefix_length | string) | ansible.netcommon.ipaddr('network')
+- prefix: distro
+  key: cloudscale.image.operating_system
+compose:
+  flavor_image: cloudscale.flavor.slug + '_' + cloudscale.image.slug
+strict: false

tests/integration/targets/inventory_cloudscale/inventory-uuid.yml

@@ -0,0 +1,14 @@
+plugin: community.general.cloudscale
+ansible_host: public_v4
+inventory_hostname: uuid
+groups:
+  ansible: cloudscale.name.startswith('ansible')
+  private_net: (cloudscale.interfaces | selectattr('type', 'equalto', 'private') | list | length) > 0
+keyed_groups:
+- prefix: net
+  key: (cloudscale.interfaces.0.addresses.0.address + '/' + cloudscale.interfaces.0.addresses.0.prefix_length | string) | ansible.netcommon.ipaddr('network')
+- prefix: distro
+  key: cloudscale.image.operating_system
+compose:
+  flavor_image: cloudscale.flavor.slug + '_' + cloudscale.image.slug
+strict: false

tests/integration/targets/inventory_cloudscale/playbooks/change-inventory-config.yml

@@ -0,0 +1,8 @@
+- name: Change inventory configuration to {{ inventory_config }}
+  file:
+    src: '{{ inventory_config }}'
+    dest: ../inventory_cloudscale.yml
+    state: link
+
+- name: Refresh inventory
+  meta: refresh_inventory

tests/integration/targets/inventory_cloudscale/playbooks/cleanup.yml

@@ -0,0 +1,17 @@
+---
+- name: List all servers
+  uri:
+    url: 'https://api.cloudscale.ch/v1/servers'
+    headers:
+      Authorization: 'Bearer {{ lookup("env", "CLOUDSCALE_API_TOKEN") }}'
+    status_code: 200
+  register: server_list
+
+- name: Remove all servers created by this test run
+  cloudscale_server:
+    uuid: '{{ item.uuid }}'
+    state: 'absent'
+  when: cloudscale_resource_prefix in item.name
+  with_items: '{{ server_list.json }}'
+  loop_control:
+    label: '{{ item.name }} ({{ item.uuid }})'

tests/integration/targets/inventory_cloudscale/playbooks/common-asserts.yml

@@ -0,0 +1,50 @@
+---
+- name: '{{ inventory }}: Verify basic inventory'
+  assert:
+    that:
+      - server_public[identifier] in hostvars
+      - server_private[identifier] in hostvars
+      - server_public_private[identifier] in hostvars
+      - server_unsafe_chars[identifier] in hostvars
+
+- name: '{{ inventory }}: Verify duplicate host names in inventory'
+  assert:
+    that:
+      - cloudscale_resource_prefix + '-duplicate' not in hostvars
+      - (cloudscale_resource_prefix + '-duplicate') | safe_group_name in groups
+
+- name: '{{ inventory }}: Verify constructed groups in inventory'
+  assert:
+    that:
+      # Test for the "ansible" group
+      - '"ansible" in groups'
+      - server_public[identifier] in groups.ansible
+      - server_private[identifier] in groups.ansible
+      - server_public_private[identifier] in groups.ansible
+      - server_unsafe_chars[identifier] in groups.ansible
+      - server_other_prefix[identifier] not in groups.ansible
+      # Tests for the "private_net" group
+      - '"private_net" in groups'
+      - server_public[identifier] not in groups["private_net"]
+      - server_private[identifier] in groups["private_net"]
+      - server_public_private[identifier] in groups["private_net"]
+      # Tests for "distro" keyed group
+      - '"distro_Debian" in groups'
+      - '"distro_Ubuntu" in groups'
+      - server_public[identifier] in groups.distro_Debian
+      - server_private[identifier] not in groups.distro_Debian
+      - server_public[identifier] not in groups.distro_Ubuntu
+      - server_private[identifier] in groups.distro_Ubuntu
+      # Test for flavor_image composed variable
+      - hostvars[server_public[identifier]].flavor_image == 'flex-2_debian-9'
+      - hostvars[server_private[identifier]].flavor_image == 'flex-2_ubuntu-18.04'
+
+- name: '{{ inventory }}: Verify cloudscale specific host variables'
+  assert:
+    that:
+      - hostvars[item.0[identifier]].cloudscale[item.1] == item.0[item.1]
+  with_nested:
+    - [ '{{ server_public }}', '{{ server_private }}', '{{ server_public_private }}' ]
+    - [ 'anti_affinity_with', 'flavor', 'href', 'image', 'interfaces', 'name', 'uuid', 'volumes' ]
+  loop_control:
+    label: '{{ item.0.name }} ({{ item.0.uuid }}): {{ item.1 }}'

tests/integration/targets/inventory_cloudscale/playbooks/setup.yml

@@ -0,0 +1,74 @@
+---
+- name: Create server with public network only
+  cloudscale_server:
+    name: '{{ cloudscale_resource_prefix }}-inventory-public'
+    flavor: '{{ cloudscale_test_flavor }}'
+    image: '{{ cloudscale_test_image }}'
+    ssh_keys: '{{ cloudscale_test_ssh_key }}'
+    use_public_network: True
+    use_private_network: False
+  register: server_public
+
+- name: Create server with private network only
+  cloudscale_server:
+    name: '{{ cloudscale_resource_prefix }}-inventory-private'
+    flavor: '{{ cloudscale_test_flavor }}'
+    image: '{{ cloudscale_alt_test_image }}'
+    ssh_keys: '{{ cloudscale_test_ssh_key }}'
+    use_public_network: False
+    use_private_network: True
+  register: server_private
+
+- name: Create server with public and private network
+  cloudscale_server:
+    name: '{{ cloudscale_resource_prefix }}-inventory-public-private'
+    flavor: '{{ cloudscale_test_flavor }}'
+    image: '{{ cloudscale_test_image }}'
+    ssh_keys: '{{ cloudscale_test_ssh_key }}'
+    use_public_network: True
+    use_private_network: True
+  register: server_public_private
+
+- name: Create servers with duplicate names
+  # The cloudscale_server module does not allow creating two servers with the same
+  # name. To do this the uri module has to be used.
+  uri:
+    url: 'https://api.cloudscale.ch/v1/servers'
+    method: POST
+    headers:
+      Authorization: 'Bearer {{ lookup("env", "CLOUDSCALE_API_TOKEN") }}'
+    body:
+      name: '{{ cloudscale_resource_prefix }}-duplicate'
+      flavor: '{{ cloudscale_test_flavor }}'
+      image: '{{ cloudscale_test_image }}'
+      ssh_keys:
+        - '{{ cloudscale_test_ssh_key }}'
+    body_format: json
+    status_code: 201
+  register: duplicate
+  with_sequence: count=2
+
+- name: Create server with different prefix
+  cloudscale_server:
+    name: 'other-prefix-{{ cloudscale_resource_prefix }}-inventory'
+    flavor: '{{ cloudscale_test_flavor }}'
+    image: '{{ cloudscale_test_image }}'
+    ssh_keys: '{{ cloudscale_test_ssh_key }}'
+  register: server_other_prefix
+
+# The API does not allow creation of a server with a name containing
+# characters not allowed in DNS names. So create a server and rename
+# it afterwards (which is possible). The resaon for this restriction is
+# that on creation a PTR entry for the server is created.
+- name: Create server to be renamed with unsafe characters
+  cloudscale_server:
+    name: '{{ cloudscale_resource_prefix }}-unsafe-chars'
+    flavor: '{{ cloudscale_test_flavor }}'
+    image: '{{ cloudscale_test_image }}'
+    ssh_keys: '{{ cloudscale_test_ssh_key }}'
+  register: server_unsafe_chars
+- name: Rename server to contain unsafe characters
+  cloudscale_server:
+    uuid: '{{ server_unsafe_chars.uuid }}'
+    name: '{{ cloudscale_resource_prefix }}-snowmans-are-cool-☃!'
+  register: server_unsafe_chars

tests/integration/targets/inventory_cloudscale/playbooks/test-inventory.yml

@@ -0,0 +1,68 @@
+---
+- name: Create servers and test cloudscale inventory plugin
+  hosts: localhost
+  gather_facts: False
+  roles:
+    - cloudscale_common
+  tasks:
+    - block:
+        - import_tasks: setup.yml
+
+        - import_tasks: change-inventory-config.yml
+          vars:
+            inventory_config: inventory-public.yml
+
+        - import_tasks: common-asserts.yml
+          vars:
+            identifier: 'name'
+            inventory: 'Public v4'
+
+        - name: Verify inventory with public IP
+          assert:
+            that:
+              # Test ansible_host setting
+              - server_public.interfaces.0.addresses.0.address
+                == hostvars[server_public.name].ansible_host
+              - server_public_private.interfaces.0.addresses.0.address
+                == hostvars[server_public_private.name].ansible_host
+              - '"ansible_host" not in hostvars[server_private.name]'
+
+        - import_tasks: change-inventory-config.yml
+          vars:
+            inventory_config: inventory-private.yml
+
+        - import_tasks: common-asserts.yml
+          vars:
+            identifier: 'name'
+            inventory: 'Private v4'
+
+        - name: Verify inventory with private IP
+          assert:
+            that:
+              # Test ansible_host setting
+              - '"ansible_host" not in hostvars[server_public.name]'
+              - server_private.interfaces.0.addresses.0.address
+                == hostvars[server_private.name].ansible_host
+              - server_public_private.interfaces.1.addresses.0.address
+                == hostvars[server_public_private.name].ansible_host
+
+        - import_tasks: change-inventory-config.yml
+          vars:
+            inventory_config: inventory-uuid.yml
+
+        - import_tasks: common-asserts.yml
+          vars:
+            identifier: 'uuid'
+            inventory: 'UUID'
+
+        - name: Verify inventory with UUID
+          assert:
+            that:
+              # Test server name groups
+              - groups[server_public.name | safe_group_name] == [server_public.uuid]
+              - groups[server_private.name | safe_group_name] == [server_private.uuid]
+              - groups[server_public_private.name | safe_group_name] == [server_public_private.uuid]
+              - groups[server_unsafe_chars.name | safe_group_name] == [server_unsafe_chars.uuid]
+
+      always:
+        - import_tasks: cleanup.yml

tests/integration/targets/inventory_cloudscale/runme.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+# Exit on errors, exit when accessing unset variables and print all commands
+set -eux
+
+# Set the role path so that the cloudscale_common role is available
+export ANSIBLE_ROLES_PATH="../"
+
+# Set the filter plugin search path so that the safe_group_name filter is available
+export ANSIBLE_FILTER_PLUGINS="./filter_plugins"
+
+rm -f inventory.yml
+export ANSIBLE_INVENTORY="./inventory_cloudscale.yml"
+
+# Run without converting invalid characters in group names
+export ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS=never
+ansible-playbook playbooks/test-inventory.yml "$@"
+
+# Run with converting invalid characters in group names
+export ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS=always
+ansible-playbook playbooks/test-inventory.yml "$@"