Testing my script to update the README.md file to sync variables of tesat-operator role from defaults/main.yml

Ticket: OSPRH-19423

Add edpm-ansible-molecule-edpm_kernel for being tested when molecule change

After doing improvements in molecule CI job process [1][2], the edpm_kernel
CI job should be working now.

[1] #3421
[2] openstack-k8s-operators/edpm-ansible#1048

Signed-off-by: Daniel Pawlik <[email protected]>

Author: sauragar

README.md

@@ -27,4 +27,4 @@ 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.
+limitations under the License.

roles/test_operator/README copy.md

@@ -0,0 +1,189 @@
+# Test operator
+
+Execute tests via the [test-operator](https://openstack-k8s-operators.github.io/test-operator/).
+
+## Parameters
+* `cifmw_test_operator_artifacts_basedir`: (String) Directory where we will have all test-operator related files. Default value: `{{ cifmw_basedir }}/tests/test_operator` which defaults to `~/ci-framework-data/tests/test_operator`
+* `cifmw_test_operator_log_pod_definition`: (Object) The CR definition template for creating the test log pod. Default value:
+```
+  apiVersion: v1
+  kind: Pod
+  metadata:
+    name: "test-operator-logs-pod-{{ run_test_fw }}-{{ test_operator_instance_name }}"
+    namespace: "{{ cifmw_test_operator_namespace }}"
+  spec:
+    containers:
+      - name: test-operator-logs-container
+        image: "{{ cifmw_test_operator_logs_image }}"
+        command: ["sleep"]
+        args: ["infinity"]
+        volumeMounts: "{{ _test_operator_volume_mounts }}"
+    volumes: "{{ _test_operator_volumes }}"
+    tolerations: "{{ cifmw_test_operator_tolerations | default(omit) }}"
+```
+* `cifmw_test_operator_stages`: (List) List of dictionaries defining the stages that should be used in the test operator role. List items options are:
+  * `name`: (String) The name of the stage. The name must be unique.
+  * `type`: (String) The framework name you would like to call, currently the options are: tempest, ansibletest, horizontest, tobiko.
+  * `test_vars_file`: (String) Path to the file used for testing, this file should contain the testing params for this stage. Only parameters specific for the controller can be used (Tempest, Ansibletest, Horizontest and Tobiko).
+  * `test_vars`: (String) Testing parameters for this specific stage if a `test_vars` is used the specified parameters would override the ones in the `test_vars_file`. Only parameters specific for the controller can be used (Tempest, Ansibletest, Horizontest and Tobiko).
+  > Important note! Generally only the variables with the following structure can be used to override inside a stage: `cifmw_test_operator_[test-operator CR name]_[parameter name]`. For example, these variables cannot be overridden per stage: `cifmw_test_operator_default_registry`, `cifmw_test_operator_default_namespace`, `cifmw_test_operator_default_image_tag`. One exception is `cifmw_test_operator_namespace`, which allows running the testing frameworks in multiple namespaces.
+  * `pre_test_stage_hooks`: (List) List of pre hooks to run as described [hooks README](https://github.com/openstack-k8s-operators/ci-framework/tree/main/roles/run_hook#hooks-expected-format).
+  * `post_test_stage_hooks`: (List) List of post hooks to run as described [hooks README](https://github.com/openstack-k8s-operators/ci-framework/tree/main/roles/run_hook#hooks-expected-format).
+ Default value:
+```
+cifmw_test_operator_stages:
+  - name: tempest
+    type: tempest
+```
+
+
+## Tempest specific parameters
+* `cifmw_test_operator_tempest_name`: (String) Value used in the `Tempest.Metadata.Name` field. The value specifies the name of some resources spawned by the test-operator role. Default value: `tempest-tests`
+* `cifmw_test_operator_tempest_tempestconf_config`: (Dict) This parameter can be used to customize the execution of the `discover-tempest-config` run. Please consult the test-operator documentation. For example, to pass a custom configuration for `tempest.conf`, use the `overrides` section:
+```
+cifmw_test_operator_tempest_tempestconf_config:
+  overrides: |
+    identity.v3_endpoint_type public
+Default value: {}
+```
+* `cifmw_test_operator_tempest_config`: (Object) Definition of Tempest CRD instance that is passed to the test-operator (see [the test-operator documentation](https://openstack-k8s-operators.github.io/test-operator/crds.html#tempest-custom-resource)). Default value:
+```
+  apiVersion: test.openstack.org/v1beta1
+  kind: Tempest
+  metadata:
+    name: "{{ cifmw_test_operator_tempest_name }}"
+    namespace: "{{ cifmw_test_operator_namespace }}"
+  spec:
+    containerImage: "{{ cifmw_test_operator_tempest_image }}:{{ cifmw_test_operator_tempest_image_tag }}"
+    storageClass: "{{ cifmw_test_operator_storage_class }}"
+    tolerations: "{{ cifmw_test_operator_tolerations | default(omit) }}"
+    nodeSelector: "{{ cifmw_test_operator_node_selector | default(omit) }}"
+    networkAttachments: "{{ cifmw_test_operator_tempest_network_attachments }}"
+    tempestRun:
+      includeList: |
+        {{ cifmw_test_operator_tempest_include_list | default('') }}
+      excludeList: |
+        {{ cifmw_test_operator_tempest_exclude_list | default('') }}
+      concurrency: "{{ cifmw_test_operator_tempest_concurrency | default(8) }}"
+      externalPlugin: "{{ cifmw_test_operator_tempest_external_plugin | default([]) }}"
+      extraRPMs: "{{ cifmw_test_operator_tempest_extra_rpms | default([]) }}"
+      extraImages: "{{ cifmw_test_operator_tempest_extra_images | default([]) }}"
+    tempestconfRun: "{{ cifmw_test_operator_tempest_tempestconf_config | default(omit) }}"
+    debug: "{{ cifmw_test_operator_tempest_debug }}"
+```
+
+## Tobiko specific parameters
+* `cifmw_test_operator_tobiko_name`: (String) Value used in the `Tobiko.Metadata.Name` field. The value specifies the name of some resources spawned by the test-operator role. Default value: `tobiko-tests`
+* `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: "{{ cifmw_test_operator_tobiko_name }}"
+    namespace: "{{ cifmw_test_operator_namespace }}"
+  spec:
+    kubeconfigSecretName: "{{ cifmw_test_operator_tobiko_kubeconfig_secret }}"
+    storageClass: "{{ cifmw_test_operator_storage_class }}"
+    containerImage: "{{ cifmw_test_operator_tobiko_image }}:{{ cifmw_test_operator_tobiko_image_tag }}"
+    testenv: "{{ cifmw_test_operator_tobiko_testenv }}"
+    version: "{{ cifmw_test_operator_tobiko_version }}"
+    pytestAddopts: "{{ cifmw_test_operator_tobiko_pytest_addopts if cifmw_test_operator_tobiko_pytest_addopts is not none else omit }}"
+    tolerations: "{{ cifmw_test_operator_tolerations | default(omit) }}"
+    nodeSelector: "{{ cifmw_test_operator_node_selector | default(omit) }}"
+    networkAttachments: "{{ cifmw_test_operator_tobiko_network_attachments }}"
+    debug: "{{ cifmw_test_operator_tobiko_debug }}"
+    # preventCreate: preventCreate is generated by the test_operator role based on the value of cifmw_test_operator_tobiko_prevent_create
+    # numProcesses: numProcesses is generated by the test_operator role based on the value of cifmw_test_operator_tobiko_num_processes
+    # 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
+    workflow: "{{ cifmw_test_operator_tobiko_workflow }}"
+```
+
+## AnsibleTest specific parameters
+* `cifmw_test_operator_ansibletest_name`: (String) Value used in the `Ansibletest.Metadata.Name` field. The value specifies the name of some resources spawned by the test-operator role. Default value: `ansibletest`
+* `cifmw_test_operator_ansibletest_config`: Definition of AnsibleTest CRD instance that is passed to the test-operator (see [the test-operator documentation](https://openstack-k8s-operators.github.io/test-operator/crds.html)). Default value:
+```
+  apiVersion: test.openstack.org/v1beta1
+  kind: AnsibleTest
+  metadata:
+    name: "{{ cifmw_test_operator_ansibletest_name }}"
+    namespace: "{{ cifmw_test_operator_namespace }}"
+  spec:
+    containerImage: "{{ cifmw_test_operator_ansibletest_image }}:{{ cifmw_test_operator_ansibletest_image_tag }}"
+    extraConfigmapsMounts: "{{ cifmw_test_operator_ansibletest_extra_configmaps_mounts }}"
+    storageClass: "{{ cifmw_test_operator_storage_class }}"
+    computeSSHKeySecretName: "{{ cifmw_test_operator_ansibletest_compute_ssh_key_secret_name }}"
+    workloadSSHKeySecretName: "{{ cifmw_test_operator_ansibletest_workload_ssh_key_secret_name }}"
+    ansibleGitRepo: "{{ cifmw_test_operator_ansibletest_ansible_git_repo }}"
+    ansiblePlaybookPath: "{{ cifmw_test_operator_ansibletest_ansible_playbook_path }}"
+    ansibleCollections: "{{ cifmw_test_operator_ansibletest_ansible_collection }}"
+    ansibleVarFiles: "{{ cifmw_test_operator_ansibletest_ansible_var_files }}"
+    ansibleExtraVars: "{{ cifmw_test_operator_ansibletest_ansible_extra_vars }}"
+    ansibleInventory: "{{ cifmw_test_operator_ansibletest_ansible_inventory }}"
+    openStackConfigMap: "{{ cifmw_test_operator_ansibletest_openstack_config_map }}"
+    openStackConfigSecret: "{{ cifmw_test_operator_ansibletest_openstack_config_secret }}"
+    workflow: "{{ cifmw_test_operator_ansibletest_workflow }}"
+    debug: "{{ cifmw_test_operator_ansibletest_debug }}"
+```
+
+## Horizontest specific parameters
+* `cifmw_test_operator_horizontest_name`: (String) Value used in the `Horizontest.Metadata.Name` field. The value specifies the name of some resources spawned by the test-operator role. Default value: `horizontest-tests`
+* `cifmw_test_operator_horizontest_config`: (Dict) Definition of HorizonTest CR instance that is passed to the test-operator (see [the test-operator documentation](https://openstack-k8s-operators.github.io/test-operator/crds.html#horizontest-custom-resource)). Default value:
+```
+  apiVersion: test.openstack.org/v1beta1
+  kind: HorizonTest
+  metadata:
+    name: "{{ cifmw_test_operator_horizontest_name }}"
+    namespace: "{{ cifmw_test_operator_namespace }}"
+  spec:
+    containerImage: "{{ cifmw_test_operator_horizontest_image }}:{{ cifmw_test_operator_horizontest_image_tag }}"
+    adminUsername: "{{ cifmw_test_operator_horizontest_admin_username }}"
+    adminPassword: "{{ cifmw_test_operator_horizontest_admin_password }}"
+    dashboardUrl: "{{ cifmw_test_operator_horizontest_dashboard_url }}"
+    authUrl: "{{ cifmw_test_operator_horizontest_auth_url }}"
+    repoUrl: "{{ cifmw_test_operator_horizontest_repo_url }}"
+    horizonRepoBranch: "{{ cifmw_test_operator_horizontest_horizon_repo_branch }}"
+    imageUrl: "{{ cifmw_test_operator_horizontest_image_url }}"
+    projectName: "{{ cifmw_test_operator_horizontest_project_name }}"
+    user: "{{ cifmw_test_operator_horizontest_user }}"
+    password: "{{ cifmw_test_operator_horizontest_password }}"
+    flavorName: "{{ cifmw_test_operator_horizontest_flavor_name }}"
+    logsDirectoryName: "{{ cifmw_test_operator_horizontest_logs_directory_name }}"
+    debug: "{{ cifmw_test_operator_horizontest_debug }}"
+    extraFlag: "{{ cifmw_test_operator_horizontest_extra_flag }}"
+    projectNameXpath "{{ cifmw_test_operator_horizontest_project_name_xpath }}"
+    horizonTestDir: "{{ cifmw_test_operator_horizontest_horizon_test_dir }}"
+```
+
+## Examples
+
+### Execute the `test-operator` role multiple times within a single job
+
+If you want to run the `test-operator` role twice within a single job, make sure
+that for the second run, you specify a value for the `cifmw_test_operator_*_name`
+other than the default one (e.g., `tempest-tests`, `tobiko-tests`, ...):
+
+```
+cifmw_test_operator_tempest_name: "post-update-tempest-tests"
+```
+
+### Use test operator stages
+Test operator stages are meant to allow setting the order of stages,running stages
+of the same controller multiple times and using different hooks,vars and names for stages.
+```
+cifmw_test_operator_stages:
+  - name: basic-functionallity
+    type: tempest
+    test_vars:
+      cifmw_test_operator_tempest_name: 'basic-functionality-tests'
+  - name: ansibletest
+    type: ansibletest
+  - name: advanced-tests
+    type: tempest
+    test_vars:
+      cifmw_test_operator_tempest_name: 'advanced-tests'
+  - name: tobiko
+    type: tobiko
+    test_vars_file: /path/to/tobiko/override/test/file
+```