Tobiko can be executed with test-operator

Before this patch, tobiko tests could only be executed using the
ci-fmw's tobiko role and the ci-fmw's test_operator role only supported
tempest.
With this patch, tobiko tests can be run using the test_operator role as
well.

TODO:
- support tobiko workflows - requires changes in tcib
- pass relevant env variables to the tobiko container - requires changes
  in test-operator

Author: eduolivares

deploy-edpm.yml

@@ -47,27 +47,13 @@
   tags:
     - admin-setup
 
-- name: Import run tempest test playbook
+- name: Import run test playbook
   ansible.builtin.import_playbook: playbooks/08-run-tests.yml
   vars:
     pre_tests: "{{ (lookup('vars', 'pre_tempest', default=[])) }}"
     post_tests: "{{ (lookup('vars', 'post_tempest', default=[])) }}"
-    test_fw: "tempest"
   when:
     - cifmw_run_tests | default('false') | bool
-    - cifmw_run_tempest | default('true') | bool
-  tags:
-    - run-tests
-
-- name: Import run tobiko test playbook
-  ansible.builtin.import_playbook: playbooks/08-run-tests.yml
-  vars:
-    pre_tests: "{{ (lookup('vars', 'pre_tobiko', default=[])) }}"
-    post_tests: "{{ (lookup('vars', 'post_tobiko', default=[])) }}"
-    test_fw: "tobiko"
-  when:
-    - cifmw_run_tests | default('false') | bool
-    - cifmw_run_tobiko | default('false') | bool
   tags:
     - run-tests
 

playbooks/08-run-tests.yml

@@ -1,22 +1,28 @@
-- name: "Run pre_tests hooks for {{ test_fw | default('tempest') }}"
+- name: "Run pre_tests hooks"
   vars:
     hooks: "{{ pre_tests | default([]) }}"
     step: pre_tests
   ansible.builtin.import_playbook: ./hooks.yml
 
-- name: "Test playbook for {{ run_test_fw }}"
-  vars:
-    run_test_fw: "{{ test_fw | default('tempest') }}"
+- name: "Test playbook"
   hosts: "{{ cifmw_target_host | default('localhost') }}"
   gather_facts: false
   tasks:
-    - name: "Run {{ run_test_fw }}"
+    - name: "Run tests"
+      vars:
+        tempest_bool: cifmw_run_tempest | default('true') | bool
+        tobiko_bool: cifmw_run_tobiko | default('false') | bool
+        test_role: >-
+          {{ cifmw_run_test_role |
+             default('tempest' if tempest_bool
+                     else ('tobiko' if tobiko_bool else None))
+          }}
       tags:
         - tests
       ansible.builtin.import_role:
-        name: "{{ run_test_fw }}"
+        name: "{{ test_role }}"
 
-- name: "Run post_tests hooks for {{ test_fw | default('tempest') }}"
+- name: "Run post_tests hooks"
   vars:
     hooks: "{{ post_tests | default([]) }}"
     step: post_tests

roles/test_operator/README.md

@@ -46,3 +46,32 @@ Execute tests via the [test-operator](https://openstack-k8s-operators.github.io/
       externalPlugin: "{{ cifmw_test_operator_tempest_external_plugin | default([]) }}"
     tempestconfRun: "{{ cifmw_tempest_tempestconf_config | default(omit) }}"
 ```
+
+## Tobiko specific parameters
+* `cifmw_test_operator_tobiko_registry`: (String) The registry where to pull tobiko container. Default value: `quay.io`
+* `cifmw_test_operator_tobiko_namespace`: (String) Registry's namespace where to pull tobiko container. Default value: `podified-antelope-centos9`
+* `cifmw_test_operator_tobiko_container`: (String) Name of the tobiko container. Default value: `openstack-tobiko`
+* `cifmw_test_operator_tobiko_image`: (String) Tobiko image to be used. Default value: `{{ cifmw_test_operator_tobiko_registry }}/{{ cifmw_test_operator_tobiko_namespace }}/{{ cifmw_test_operator_tobiko_container }}`
+* `cifmw_test_operator_tobiko_image_tag`: (String) Tag for the `cifmw_test_operator_tobiko_image`. Default value: `current-podified`
+* `cifmw_test_operator_tobiko_testenv`: (String) Executed tobiko testenv. See tobiko `tox.ini` file for further details. Some allowed values: scenario, sanity, faults, neutron, octavia, py3, etc. Default value: `scenario`
+* `cifmw_test_operator_tobiko_version`: (String) Tobiko version to install. It could refer to a branch (master, osp-16.2), a tag (0.6.x, 0.7.x) or an sha-1. Default value: `master`
+* `cifmw_test_operator_tobiko_kubeconfig_secret`: (String) Name of the Openshift Secret required to use Openshift Client from the Tobiko pod. Default value: `tobiko-secret`
+* `cifmw_test_operator_tobiko_override_conf`: (Dict) Overrides the default configuration from `cifmw_test_operator_tobiko_default_conf` that is used to generate the tobiko.conf file. Default value: empty dictionary
+* `cifmw_test_operator_tobiko_ssh_keytype`: (String) Type of ssh key that tobiko will use to connect to the VM instances it creates. Defaults to `cifmw_ssh_keytype` which default to `ecdsa`.
+* `cifmw_test_operator_tobiko_ssh_keysize`: (Integer) Size of ssh key that tobiko will use to connect to the VM instances it creates. Defaults to `cifmw_ssh_keysize` which defaults to 521.
+* `cifmw_test_operator_tobiko_config`: (Dict) Definition of Tobiko CRD instance that is passed to the test-operator (see [the test-operator documentation](https://openstack-k8s-operators.github.io/test-operator/crds.html#tobiko-custom-resource)). Default value:
+```
+  apiVersion: test.openstack.org/v1beta1
+  kind: Tobiko
+  metadata:
+    name: tobiko-tests
+    namespace: "{{ cifmw_test_operator_namespace }}"
+  spec:
+    kubeconfigSecretName: "{{ cifmw_test_operator_tobiko_kubeconfig_secret }}"
+    containerImage: "{{ cifmw_test_operator_tobiko_image }}:{{ cifmw_test_operator_tobiko_image_tag }}"
+    testenv: "{{ cifmw_test_operator_tobiko_testenv }}"
+    version: "{{ cifmw_test_operator_tobiko_version }}"
+    # privateKey: privateKey is automatically generated by the test_operator role
+    # publicKey: publicKey is automatically generated by the test_operator role
+    # config: config is generated combining cifmw_test_operator_tobiko_default_conf and cifmw_test_operator_tobiko_override_conf
+```

roles/test_operator/defaults/main.yml

@@ -17,6 +17,8 @@
 
 # defaults file for test_operator
 # All variables within this role should have a prefix of "cifmw_test_operator"
+
+# Section 1: generic parameters (applied to all supported test frameworks)
 cifmw_test_operator_artifacts_basedir: "{{ cifmw_basedir | default(ansible_user_dir ~ '/ci-framework-data') }}/tests/test_operator"
 cifmw_test_operator_namespace: openstack
 cifmw_test_operator_index: quay.io/openstack-k8s-operators/test-operator-index:latest
@@ -25,12 +27,19 @@ cifmw_test_operator_logs_image: quay.io/quay/busybox
 cifmw_test_operator_concurrency: 8
 cifmw_test_operator_cleanup: false
 cifmw_test_operator_dry_run: false
+cifmw_test_operator_default_groups:
+  - default
+cifmw_test_operator_default_jobs:
+  - default
+
+# Section 2: tempest parameters - used when run_test_fw is 'tempest'
 cifmw_test_operator_tempest_registry: quay.io
 cifmw_test_operator_tempest_namespace: podified-antelope-centos9
 cifmw_test_operator_tempest_container: openstack-tempest
 cifmw_test_operator_tempest_image: "{{ cifmw_test_operator_tempest_registry }}/{{ cifmw_test_operator_tempest_namespace }}/{{ cifmw_test_operator_tempest_container }}"
 cifmw_test_operator_tempest_image_tag: current-podified
-
+cifmw_test_operator_tempest_tests_include_override_scenario: false
+cifmw_test_operator_tempest_tests_exclude_override_scenario: false
 # Please refer to https://openstack-k8s-operators.github.io/test-operator/guide.html#executing-tempest-tests
 cifmw_test_operator_tempest_config:
   apiVersion: test.openstack.org/v1beta1
@@ -51,9 +60,29 @@ cifmw_test_operator_tempest_config:
       externalPlugin: "{{ cifmw_test_operator_tempest_external_plugin | default([]) }}"
     tempestconfRun: "{{ cifmw_tempest_tempestconf_config | default(omit) }}"
 
-cifmw_test_operator_default_groups:
-  - default
-cifmw_test_operator_default_jobs:
-  - default
-cifmw_test_operator_tempest_tests_include_override_scenario: false
-cifmw_test_operator_tempest_tests_exclude_override_scenario: false
+# Section 3: tobiko parameters - used when run_test_fw is 'tobiko'
+cifmw_test_operator_tobiko_registry: quay.io
+cifmw_test_operator_tobiko_namespace: podified-antelope-centos9
+cifmw_test_operator_tobiko_container: openstack-tobiko
+cifmw_test_operator_tobiko_image: "{{ cifmw_test_operator_tobiko_registry }}/{{ cifmw_test_operator_tobiko_namespace }}/{{ cifmw_test_operator_tobiko_container }}"
+cifmw_test_operator_tobiko_image_tag: current-podified
+cifmw_test_operator_tobiko_testenv: scenario
+cifmw_test_operator_tobiko_version: master
+cifmw_test_operator_tobiko_override_conf: {}
+cifmw_test_operator_tobiko_kubeconfig_secret: tobiko-secret
+cifmw_test_operator_tobiko_ssh_keytype: "{{ cifmw_ssh_keytype | default('ecdsa') }}"
+cifmw_test_operator_tobiko_ssh_keysize: "{{ cifmw_ssh_keysize | default(521) }}"
+cifmw_test_operator_tobiko_config:
+  apiVersion: test.openstack.org/v1beta1
+  kind: Tobiko
+  metadata:
+    name: tobiko-tests
+    namespace: "{{ cifmw_test_operator_namespace }}"
+  spec:
+    kubeconfigSecretName: "{{ cifmw_test_operator_tobiko_kubeconfig_secret }}"
+    containerImage: "{{ cifmw_test_operator_tobiko_image }}:{{ cifmw_test_operator_tobiko_image_tag }}"
+    testenv: "{{ cifmw_test_operator_tobiko_testenv }}"
+    version: "{{ cifmw_test_operator_tobiko_version }}"
+    # privateKey: privateKey is automatically by the test_operator role
+    # publicKey: publicKey is automatically generated by the test_operator role
+    # config: config is generated combining cifmw_test_operator_tobiko_default_conf and cifmw_test_operator_tobiko_override_conf

roles/test_operator/tasks/cleanup.yml

@@ -14,30 +14,6 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-- name: Delete Tempest
-  kubernetes.core.k8s:
-    kubeconfig: "{{ cifmw_openshift_kubeconfig }}"
-    api_key: "{{ cifmw_openshift_token | default(omit)}}"
-    context: "{{ cifmw_openshift_context | default(omit)}}"
-    kind: Tempest
-    state: absent
-    api_version: test.openstack.org/v1beta1
-    name: "{{ cifmw_test_operator_tempest_name }}"
-    namespace: "{{ cifmw_test_operator_namespace }}"
-    wait: true
-
-- name: Delete Tempest CRD
-  kubernetes.core.k8s:
-    kubeconfig: "{{ cifmw_openshift_kubeconfig }}"
-    api_key: "{{ cifmw_openshift_token | default(omit)}}"
-    context: "{{ cifmw_openshift_context | default(omit)}}"
-    kind: CustomResourceDefinition
-    state: absent
-    api_version: v1
-    name: tempests.test.openstack.org
-    namespace: "{{ cifmw_test_operator_namespace }}"
-    wait: true
-
 - name: Delete Subscription
   kubernetes.core.k8s:
     kubeconfig: "{{ cifmw_openshift_kubeconfig }}"
@@ -97,15 +73,3 @@
     name: test-operator.openstack
     namespace: "{{ cifmw_test_operator_namespace }}"
     wait: true
-
-- name: Delete test-operator-logs-pod
-  kubernetes.core.k8s:
-    kubeconfig: "{{ cifmw_openshift_kubeconfig }}"
-    api_key: "{{ cifmw_openshift_token | default(omit)}}"
-    context: "{{ cifmw_openshift_context | default(omit)}}"
-    kind: Pod
-    state: absent
-    api_version: v1
-    name: test-operator-logs-pod
-    namespace: "{{ cifmw_test_operator_namespace }}"
-    wait: true

roles/test_operator/tasks/create-tobiko-conf.yml

@@ -0,0 +1,25 @@
+---
+# Copyright Red Hat, Inc.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+- name: Create tobiko.conf section by section
+  community.general.ini_file:
+    path: "{{ cifmw_test_operator_artifacts_basedir }}/tobiko.conf"
+    section: "{{ tobikoconf_section.key }}"
+    option: "{{ tobikoconf_option.key }}"
+    value: "{{ tobikoconf_option.value }}"
+  loop: "{{ tobikoconf_section.value | dict2items }}"
+  loop_control:
+    loop_var: tobikoconf_option