ccx_ocp_results

#

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. Unit tests for ccx_ocp_results module.

#

import sys

import pytest
from ccx_ocp_results import main, schema
from common import validate
from voluptuous import Invalid

#

Provide standard schema to check messages.

@pytest.fixture
def validation_schema():

#

    return schema

#

verbosity level

verbose = (True, False)

#

attributes to check

attribute = (
        "OrgID",
        "ClusterName",
        "LastChecked",
        "Report",
        )

#

report attributes to check

report_attribute = (
        "system",
        "reports",
        "fingerprints",
        "skips",
        "info",
        )

#

Provide correct message to be tested.

@pytest.fixture
def correct_message():

#

    return {
            "OrgID": 11789772,
            "ClusterName": "5d5892d3-1f74-4ccf-91af-548dfc9767aa",
            "LastChecked": "2020-04-02T09:00:05.268294Z",
            "Report": {
                "system": {
                    "metadata": {},
                    "hostname": None,
                    },
                "reports": [],
                "fingerprints": [],
                "skips": [
                    {
                        "rule_fqdn": "ccx_rules_ocp.ocs.check_ocs_version.report",
                        "reason": "MISSING_REQUIREMENTS",
                        "details": "All: ['ccx_ocp_core.specs.must_gather_ocs.OperatorsOcsMGOCS'] Any: ",  # noqa: E501
                        "type": "skip",
                        },
                    {
                        "rule_fqdn": "ccx_rules_ocp.ocs.check_pods_scc.report",
                        "reason": "MISSING_REQUIREMENTS",
                        "details": "All: ['ccx_ocp_core.specs.must_gather_ocs.PodsMGOCS'] Any: ",
                        "type": "skip",
                        },
                    {
                        "rule_fqdn": "ccx_rules_ocp.ocs.operator_phase_check.report",
                        "reason": "MISSING_REQUIREMENTS",
                        "details": "All: ['ccx_ocp_core.specs.must_gather_ocs.OperatorsOcsMGOCS'] Any: ",  # noqa: E501
                        "type": "skip",
                        },
                    {
                        "rule_fqdn": "ccx_rules_ocp.ocs.pvc_phase_check.report",
                        "reason": "MISSING_REQUIREMENTS",
                        "details": "All: ['ccx_ocp_core.specs.must_gather_ocs.PersistentVolumeClaimsMGOCS'] Any: ",  # noqa: E501
                        "type": "skip",
                        },
                    {
                        "rule_fqdn": "ccx_rules_ocp.ocs.ceph_check_mon_clock_skew.report",
                        "reason": "MISSING_REQUIREMENTS",
                        "details": "All: ['ccx_rules_ocp.ocs.ceph_check_mon_clock_skew.get_mon_reporting_clock_skew'] Any: ",  # noqa: E501
                        "type": "skip",
                        },
                    {
                        "rule_fqdn": "ccx_rules_ocp.external.bug_rules.bug_1801300.report",
                        "reason": "MISSING_REQUIREMENTS",
                        "details": "All: ['ccx_ocp_core.specs.must_gather.DeploymentsMG'] Any: ",
                        "type": "skip",
                        },
                    {
                        "rule_fqdn": "ccx_rules_ocp.external.bug_rules.bug_1802248.report",
                        "reason": "MISSING_REQUIREMENTS",
                        "details": "All: ['ccx_ocp_core.specs.must_gather.DeploymentsMG'] Any: ",
                        "type": "skip",
                        },
                    {
                        "rule_fqdn": "ccx_rules_ocp.external.rules.image_registry_pv_no_access.report",  # noqa: E501
                        "reason": "MISSING_REQUIREMENTS",
                        "details": "All: ['ccx_rules_ocp.common.conditions.image_registry.DegradedImageRegistryOperator', 'ccx_rules_ocp.common.conditions.image_registry.ImageRegistryPod', 'ccx_rules_ocp.common.conditions.image_registry.ImageRegistryPersistentVolumeClaim'] Any: ",  # noqa: E501
                        "type": "skip",
                        },
                    {
                        "rule_fqdn": "ccx_rules_ocp.external.rules.image_registry_pv_low_capacity.report",  # noqa: E501
                        "reason": "MISSING_REQUIREMENTS",
                        "details": "All: ['ccx_rules_ocp.common.conditions.image_registry.DegradedImageRegistryOperator', 'ccx_rules_ocp.common.conditions.image_registry.ImageRegistryPod', 'ccx_rules_ocp.common.conditions.image_registry.ImageRegistryPersistentVolumeClaim'] Any: ",  # noqa: E501
                        "type": "skip",
                        },
                    {
                            "rule_fqdn": "ccx_rules_ocp.external.rules.image_registry_no_volume_set_check.report",  # noqa: E501
                            "reason": "MISSING_REQUIREMENTS",
                            "details": "All: ['ccx_rules_ocp.common.conditions.image_registry.DegradedImageRegistryOperator', 'ccx_rules_ocp.common.conditions.image_registry.ImageRegistryPod', 'ccx_rules_ocp.common.conditions.image_registry.isImageRegistryPodEmptyDirVolume', 'ccx_rules_ocp.common.conditions.image_registry.isImageRegistryPodPersistentVolume'] Any: ",  # noqa: E501
                            "type": "skip",
                            },
                    {
                            "rule_fqdn": "ccx_rules_ocp.external.rules.image_registry_pv_not_bound.report",  # noqa: E501
                            "reason": "MISSING_REQUIREMENTS",
                            "details": "All: ['ccx_rules_ocp.common.conditions.image_registry.DegradedImageRegistryOperator', 'ccx_rules_ocp.common.conditions.image_registry.ImageRegistryPod', 'ccx_rules_ocp.common.conditions.image_registry.ImageRegistryPersistentVolumeClaim'] Any: ",  # noqa: E501
                            "type": "skip",
                            },
                    ],
                "info": [],
                "pass": [],
            },
      }

#

Test the main function when -h parameter is given.

def test_main_help():

#

    sys.argv.append("-h")
    with pytest.raises(SystemExit) as excinfo:
        main()
    assert excinfo.value.code == 0

#

Test the main function when -i parameter is given.

def test_main_input():

#

    sys.argv.append("-i test")
    with pytest.raises(SystemExit) as excinfo:
        main()
    assert excinfo.value.code == 0

#

Test the validation for improper (no) payload.

@pytest.mark.parametrize("verbose", verbose)
def test_validate_no_payload(validation_schema, verbose):

#

it should fail

    with pytest.raises(ValueError):
        validate(schema, None, verbose)

#

Test the validation for proper message.

@pytest.mark.parametrize("verbose", verbose)
def test_validate_correct_message(validation_schema, verbose, correct_message):

#

it should not fail

    validate(schema, correct_message, verbose)

#

Test the validation for improper payload.

@pytest.mark.parametrize("verbose", verbose)
def test_validate_message_without_org_id_attribute(validation_schema, verbose, correct_message):

#

    del correct_message["OrgID"]

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

Test the validation for improper payload.

@pytest.mark.parametrize("verbose", verbose)
def test_validate_message_wrong_org_id_attribute(validation_schema, verbose, correct_message):

#

check with negative integer

    correct_message["OrgID"] = -1

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

check with string not representing number

    correct_message["OrgID"] = "foobar"

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

check with string representing number

    correct_message["OrgID"] = "123456"

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

check with different data type

    correct_message["OrgID"] = []

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

Test the validation for improper payload.

@pytest.mark.parametrize("attribute", attribute)
@pytest.mark.parametrize("verbose", verbose)
def test_validate_message_without_attributes(validation_schema, verbose, correct_message,
                                             attribute):

#

    del correct_message[attribute]

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

Test the validation for improper payload.

@pytest.mark.parametrize("attribute", attribute)
@pytest.mark.parametrize("verbose", verbose)
def test_validate_message_wrong_attributes(validation_schema, verbose, correct_message, attribute):

#

    correct_message[attribute] = b"foobar"

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

check with number

    correct_message[attribute] = -123456

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

check with different data type

    correct_message[attribute] = []

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

Test the validation for improper payload.

@pytest.mark.parametrize("attribute", report_attribute)
@pytest.mark.parametrize("verbose", verbose)
def test_validate_message_wrong_report_attributes(validation_schema, verbose, correct_message,
                                                  attribute):

#

    correct_message["Report"][attribute] = b"foobar"

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

check with number

    correct_message["Report"][attribute] = -123456

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

check with different data type

    correct_message["Report"][attribute] = None

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

#

Test the validation for improper payload.

@pytest.mark.parametrize("attribute", report_attribute)
@pytest.mark.parametrize("verbose", verbose)
def test_validate_message_without_report_attributes(validation_schema, verbose, correct_message,
                                                    attribute):

#

    del correct_message["Report"][attribute]

#

it should fail

    with pytest.raises(Invalid):
        validate(schema, correct_message, verbose)

ccx_ocp_results_test.py