Merge pull request #83 from equinix-labs/add_proper_integration_test_…

…workflow

Fixing integrations tests, Take #2

.github/workflows/integration-tests.yml

@@ -15,6 +15,7 @@ jobs:
     defaults:
       run:
         working-directory: .ansible/collections/ansible_collections/equinix/cloud
+    environment: 'METAL_API_TOKEN'
     steps:
       - name: checkout repo
         uses: actions/checkout@v3
@@ -41,6 +42,6 @@ jobs:
 
 
       - name: run tests
-        run: make test
+        run: make testall
         env:
           METAL_API_TOKEN: ${{ secrets.METAL_API_TOKEN }}

Makefile

@@ -43,14 +43,15 @@ docs:
 injected-docs:
 	DOCS_PATH=$(DOCS_PATH) ./scripts/specdoc_inject.sh
 
+test: integration-test
 
+testall: create-integration-config
+		./scripts/test_all.sh
 
-integration-test: $(INTEGRATION_CONFIG)
+integration-test: create-integration-config
 	ansible-test integration $(TEST_ARGS)
 
-test: integration-test
-
-$(INTEGRATION_CONFIG):
+create-integration-config:
 ifneq ("${METAL_API_TOKEN}", "")
 	@echo "metal_api_token: ${METAL_API_TOKEN}" > $(INTEGRATION_CONFIG);
 else

plugins/inventory/metal_device.py

@@ -32,51 +32,29 @@
   file that ends with equinix_metal.(yml|yaml). ansible_host is set to first public
   IP address of the device.
 module: metal_device
+extends_documentation_fragment: [constructed]
 notes: []
 options:
-  keyed_groups:
+  plugin:
+    choices: ['equinix_metal', 'equinix.cloud.metal_device']
     description:
-    - List of groups to create based on the values of a variable.
-    elements: dict
-    required: false
-    suboptions:
-      key:
-        description:
-        - The key to group by.
-        required: false
-        type: str
-      prefix:
-        description:
-        - Prefix to prepend to the group name.
-        required: false
-        type: str
-      separator:
-        default: ''
-        description:
-        - Separator to use when joining the key and value.
-        required: false
-        type: str
-    type: list
+    - Token that ensures this is a source file for the plugin.
+    required: true
+    type: str
   metal_api_token:
     description:
     - Equinix Metal API token. Can also be specified via METAL_AUTH_TOKEN environment
       variable.
-    required: false
-    type: str
-  plugin:
-    choices:
-    - equinix_metal
-    - equinix.cloud.metal_device
-    description:
-    - Token that ensures this is a source file for the plugin.
     required: true
+    env:
+        - name: METAL_AUTH_TOKEN
     type: str
   project_ids:
     description:
     - List of Equinix Metal project IDs to query for devices.
+    type: list
     elements: str
     required: false
-    type: list
 requirements:
 - python >= 3
 - metal_python >= 0.0.1
@@ -220,18 +198,20 @@ def verify_file(self, path):
             :param path: the path to the inventory config file
             :return the contents of the config file
         '''
-        if super(InventoryModule, self).verify_file(path):
-            if path.endswith(('equinix.yml', 'equinix.yaml', 'device.yml', 'device.yaml')):
-                return True
+        if not super().verify_file(path):
+            return False
+        endings = ('equinix.yml', 'equinix.yaml', 'device.yml', 'device.yaml')
+        if any((path.endswith(ending) for ending in endings)):
+            return True
         self.display.debug("equinix.cloud inventory filename must end with 'equinix.yml' or 'equinix.yaml'")
         return False
 
-    def parse(self, inventory, loader, path, cache):
+    def parse(self, inventory, loader, path, cache=True):
         super().parse(inventory, loader, path)
-
         self._read_config_data(path)
+        self._build_client()
 
-        strict = self.get_option('strict')
+        strict = self.get_option("strict")
         configured_project_ids = self._get_project_ids()
         devices = self._get_devices_from_project_ids(configured_project_ids)
         projects = set([device['project_id'] for device in devices])
@@ -248,7 +228,6 @@ def parse(self, inventory, loader, path, cache):
                 if k not in EXCLUDE_ATTRIBUTES:
                     self.inventory.set_variable(label(device), k, v)
 
-
         for device in devices:
             variables = self.inventory.get_host(label(device)).get_vars()
             self._add_host_to_composed_groups(
@@ -276,7 +255,6 @@ def _get_project_ids(self):
         for pid in project_ids:
             if not metal_client.is_valid_uuid(pid):
                 raise AnsibleError("Invalid project id: %s" % pid)
-        self._build_client()
         if len(project_ids) == 0:
             return [p["id"] for p in self._get_all_projects()]
         return project_ids

plugins/module_utils/metal/metal_api.py

@@ -85,7 +85,7 @@ def ip_address_getter(resource: dict):
     'id': 'id',
     'name': 'name',
     'organization_id': 'organization.id',
-    'payment_method_id': 'payment_method.id',
+    'payment_method_id': optional_str('payment_method.id'),
 }
 
 METAL_IP_RESERVATION_RESPONSE_ATTRIBUTE_MAP = {

scripts/test_all.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+PARALLEL_JOBS="${PARALLEL_JOBS:=3}"
+
+run_test() {
+  make TEST_ARGS="$1" test
+}
+
+export -f run_test
+
+parallel -j $PARALLEL_JOBS --group --keep-order run_test ::: $(ls tests/integration/targets)

tests/integration/targets/metal_device/tasks/main.yml

@@ -16,7 +16,7 @@
     - set_fact:
         test_prefix: "{{ test_resource_name_prefix }}-{{ unique_id }}"
     - set_fact:
-        test_os: nixos_22_05
+        test_os: ubuntu_22_04
     - set_fact:
         test_plan: c3.small.x86
     - set_fact:
@@ -122,4 +122,4 @@
         id: "{{ item.id }}"
         state: absent
       ignore_errors: yes
-      loop: "{{ test_projects.resources }}"
+      loop: "{{ test_projects.resources }}"

tests/integration/targets/metal_device_inventory/playbooks/setup_metal_device.yml

@@ -20,5 +20,6 @@
         plan: c3.small.x86
         operating_system: ubuntu_20_04
         metro: sv
+        provisioning_wait_seconds: 1200
         tags:
           - ansible-inventory-node

tests/integration/targets/metal_ip_assignment/tasks/main.yml

@@ -24,7 +24,7 @@
     - set_fact:
         test_prefix: "{{ test_resource_name_prefix }}-{{ unique_id }}"
     - set_fact:
-        test_os: nixos_22_05
+        test_os: ubuntu_22_04
     - set_fact:
         test_plan: c3.small.x86
     - set_fact:
@@ -136,4 +136,4 @@
         id: "{{ item.id }}"
         state: absent
       ignore_errors: yes
-      loop: "{{ test_projects.resources }}"
+      loop: "{{ test_projects.resources }}"

tests/integration/targets/metal_reserved_ip_block_info/tasks/main.yml

@@ -22,9 +22,11 @@
     - set_fact:
         test_metro: sv
     - set_fact:
-        test_os: nixos_22_05
+        test_os: ubuntu_22_04
     - set_fact:
         test_plan: c3.small.x86
+    - set_fact:
+        wait_seconds: 1200
 
     - name: create project for test
       equinix.cloud.metal_project:
@@ -38,6 +40,7 @@
         operating_system: "{{ test_os }}"
         plan: "{{ test_plan }}"
         metro: "{{ test_metro }}"
+        provisioning_wait_seconds: "{{ wait_seconds }}"
         state: present
       register: device
 
@@ -87,8 +90,7 @@
 
     - name: list test projects
       equinix.cloud.metal_project_info:
-        filters:
-          name: "{{ test_prefix }}"
+        name: "{{ test_prefix }}"
       register: test_projects
 
     - name: list devices in test projects
@@ -109,4 +111,4 @@
         id: "{{ item.id }}"
         state: absent
       ignore_errors: yes
-      loop: "{{ test_projects.resources }}"
+      loop: "{{ test_projects.resources }}"