waiter.py Add ClusterOperator Test

[stratus-ss]

SUMMARY

Fixes #869

During an OpenShift installation, one of the checks to see that the cluster is ready to proceed with configuration is to check to ensure that the Cluster Operators are in an Available: True Degraded: False Progressing: False state. While you can currently use the k8s_info module to get a json response, the resulting json needs to be iterated over several times to get the appropriate status.

This PR adds functionality into waiter.py which loops over all resource instances of the cluster operators. If any of them is not ready, waiter returns False and the task false. If the task returns, you can assume that all the cluster operators are healthy.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

waiter.py

ADDITIONAL INFORMATION

A simple playbook will trigger the waiter.py to watch the ClusterOperator object

---
- name: get operators
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Get cluster operators
      kubernetes.core.k8s_info:
        api_version: v1
        kind: ClusterOperator
        kubeconfig: "/home/ocp/one/auth/kubeconfig"
        wait: true
        wait_timeout: 30
      register: cluster_operators

This will produce the simple response if everything is functioning properly:

PLAY [get operators] *************************************************************************************************

TASK [Get cluster operators] *****************************************************************************************
ok: [localhost]

PLAY RECAP ***********************************************************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   

If the timeout is reached:

PLAY [get operators] *************************************************************************************************

TASK [Get cluster operators] *****************************************************************************************
An exception occurred during task execution. To see the full traceback, use -vvv. The error was: ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions.CoreException: Failed to gather information about ClusterOperator(s) even after waiting for 30 seconds
fatal: [localhost]: FAILED! => {"changed": false, "msg": "Failed to gather information about ClusterOperator(s) even after waiting for 30 seconds"}

PLAY RECAP ***********************************************************************************************************
localhost                  : ok=0    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0   

UNSOLVED: How to know which Operators are failing

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/c748c6f58f204273b7a218043dc9dd4c

✔️ ansible-galaxy-importer SUCCESS in 4m 49s
✔️ build-ansible-collection SUCCESS in 5m 18s

[mandar242]

could you please also add a changelog fragment? thanks!

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/08fbf40ed7e3432b881a4a1c954a90e6

✔️ ansible-galaxy-importer SUCCESS in 4m 11s
✔️ build-ansible-collection SUCCESS in 6m 07s

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/f481d47f890048adb0a65aa4816b5b06

✔️ ansible-galaxy-importer SUCCESS in 7m 51s
✔️ build-ansible-collection SUCCESS in 5m 40s

[stratus-ss]

could you please also add a changelog fragment? thanks!

It should be there now

[abikouo]

The code looks good; you need to fix the CI issues

[stratus-ss]

The code looks good; you need to fix the CI issues

I am having a small problem with the linter. I was copying the deployments.yml fixture which seems to have multiple documents. However, when I run the linter it's getting tripped up

ERROR: tests/unit/module_utils/fixtures/clusteroperator.yml:1:1: multiple-yaml-documents: expected a single document in the stream

I'm not exactly sure how to fix this except by removing usecases

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/70c4dc81c4e94bc4804f6760b3746ec3

✔️ ansible-galaxy-importer SUCCESS in 2m 47s
✔️ build-ansible-collection SUCCESS in 5m 23s

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/058d50faf4e8430992553207193aea08

✔️ ansible-galaxy-importer SUCCESS in 3m 55s
✔️ build-ansible-collection SUCCESS in 5m 22s

[mandar242]

The code looks good; you need to fix the CI issues

I am having a small problem with the linter. I was copying the deployments.yml fixture which seems to have multiple documents. However, when I run the linter it's getting tripped up

ERROR: tests/unit/module_utils/fixtures/clusteroperator.yml:1:1: multiple-yaml-documents: expected a single document in the stream

I'm not exactly sure how to fix this except by removing usecases

Hi @stratus-ss , for this, could you please add line below to files in https://github.com/stratus-ss/kubernetes.core/tree/ClusterOperator/tests/sanity

tests/unit/module_utils/fixtures/clusteroperator.yml yamllint!skip

similar to

kubernetes.core/tests/sanity/ignore-2.19.txt

Lines 14 to 16 in 91df2f1

	tests/unit/module_utils/fixtures/definitions.yml yamllint!skip
	tests/unit/module_utils/fixtures/deployments.yml yamllint!skip
	tests/integration/targets/k8s_delete/files/deployments.yaml yamllint!skip

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/cceb5ddf42de48ad88db6af081d84e59

✔️ ansible-galaxy-importer SUCCESS in 2m 51s
✔️ build-ansible-collection SUCCESS in 5m 18s

[mandar242]

@stratus-ss you'll need to add the change to all ignore files here https://github.com/stratus-ss/kubernetes.core/tree/ClusterOperator/tests/sanity

ignore-2.14.txt
ignore-2.15.txt
ignore-2.16.txt
ignore-2.17.txt
ignore-2.18.txt
ignore-2.19.txt

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/7c229c9577be4eb1b3fa67594905ae4d

✔️ ansible-galaxy-importer SUCCESS in 3m 57s
✔️ build-ansible-collection SUCCESS in 5m 37s

[abikouo]

LGTM!

[softwarefactory-project-zuul]

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/3459216024124eb9aacbb2b341809e54

✔️ ansible-galaxy-importer SUCCESS in 4m 20s
✔️ build-ansible-collection SUCCESS in 5m 19s