qontract-reconcile 0.10.1rc1202__py3-none-any.whl → 0.10.2.dev1__py3-none-any.whl

reconcile/test/test_openshift_resources_base.py

@@ -1,478 +0,0 @@
-import copy
-from typing import Any
-from unittest.mock import (
-    Mock,
-    patch,
-)
-
-import pytest
-from kubernetes.dynamic import Resource
-
-from reconcile import openshift_resources_base as orb
-from reconcile.openshift_base import CurrentStateSpec
-from reconcile.openshift_resources_base import (
-    CheckClusterScopedResourceDuplicates,
-    canonicalize_namespaces,
-    ob,
-)
-from reconcile.test.fixtures import Fixtures
-from reconcile.utils import oc
-from reconcile.utils.openshift_resource import ResourceInventory
-
-fxt = Fixtures("namespaces")
-
-
-@pytest.fixture
-def namespaces() -> list[dict[str, Any]]:
-    return [fxt.get_anymarkup("openshift-resources-only.yml")]
-
-
-@pytest.fixture
-@patch("reconcile.utils.oc.OCNative")
-def oc_cs1(self) -> oc.OCClient:
-    client = oc.OCNative(cluster_name="cs1", server="s", token="t", local=True)
-    client.init_api_resources = True
-    client.api_resources = {
-        "Template": ["template.openshift.io/v1"],
-        "Subscription": ["apps.open-cluster-management.io/v1", "operators.coreos.com"],
-    }
-    client.get_items = lambda kind, **kwargs: []
-    return client
-
-
-@pytest.fixture
-def tmpl1() -> dict[str, Any]:
-    return {
-        "kind": "Template",
-        "apiVersion": "template.openshift.io/v1",
-        "metadata": {"name": "tmpl1"},
-    }
-
-
-@pytest.fixture
-def current_state_spec(oc_cs1: oc.OCNative) -> CurrentStateSpec:
-    return CurrentStateSpec(
-        oc=oc_cs1, cluster="cs1", namespace="ns1", kind="Template", resource_names=None
-    )
-
-
-def test_secret(namespaces: list[dict[str, Any]], mocker):
-    mocker.patch.object(ob, "aggregate_shared_resources", autospec=True)
-    expected = (
-        [
-            {
-                "name": "ns1",
-                "cluster": {"name": "cs1"},
-                "managedResourceTypes": ["Template"],
-                "openshiftResources": [
-                    {
-                        "provider": "vault-secret",
-                        "path": "/secret/place.yml",
-                    }
-                ],
-            }
-        ],
-        ["Secret"],
-    )
-
-    ns, override = canonicalize_namespaces(namespaces, ["vault-secret"])
-    assert (ns, override) == expected
-
-
-def test_route(namespaces: list[dict[str, Any]], mocker):
-    mocker.patch.object(ob, "aggregate_shared_resources", autospec=True)
-    expected = (
-        [
-            {
-                "name": "ns1",
-                "cluster": {"name": "cs1"},
-                "managedResourceTypes": ["Template"],
-                "openshiftResources": [
-                    {"provider": "route", "path": "/route/network.yml"}
-                ],
-            }
-        ],
-        ["Route"],
-    )
-    ns, override = canonicalize_namespaces(namespaces, ["route"])
-    assert (ns, override) == expected
-
-
-def test_no_overrides(namespaces: list[dict[str, Any]], mocker):
-    mocker.patch.object(ob, "aggregate_shared_resources", autospec=True)
-    expected = (
-        [
-            {
-                "name": "ns1",
-                "cluster": {"name": "cs1"},
-                "managedResourceTypes": ["Template"],
-                "openshiftResources": [
-                    {"provider": "resource", "path": "/some/path.yml"}
-                ],
-            }
-        ],
-        None,
-    )
-
-    ns, override = canonicalize_namespaces(namespaces, ["resource"])
-    assert (ns, override) == expected
-
-
-@pytest.fixture
-@patch("reconcile.utils.oc.OCNative")
-def test_fetch_current_state_ri_not_initialized(
-    oc_cs1: oc.OCClient, tmpl1: dict[str, Any]
-):
-    ri = ResourceInventory()
-    oc_cs1.get_items = lambda kind, **kwargs: [tmpl1]  # type: ignore[method-assign]
-    ri.initialize_resource_type("cs1", "wrong_namespace", "Template")
-    ri.initialize_resource_type("wrong_cluster", "ns1", "Template")
-    ri.initialize_resource_type("cs1", "ns1", "wrong_kind")
-    with pytest.raises(KeyError):
-        orb.fetch_current_state(
-            oc=oc_cs1,
-            ri=ri,
-            cluster="cs1",
-            namespace="ns1",
-            kind="Template",
-            resource_names=[],
-        )
-
-    for _, _, _, resource in ri:
-        assert len(resource["current"]) == 0
-
-
-def test_fetch_current_state_ri_initialized(oc_cs1: oc.OCClient, tmpl1: dict[str, Any]):
-    ri = ResourceInventory()
-    ri.initialize_resource_type("cs1", "ns1", "Template")
-    oc_cs1.get_items = lambda kind, **kwargs: [tmpl1]  # type: ignore[method-assign]
-    orb.fetch_current_state(
-        oc=oc_cs1,
-        ri=ri,
-        cluster="cs1",
-        namespace="ns1",
-        kind="Template",
-        resource_names=[],
-    )
-
-    _, _, _, resource = next(iter(ri))
-    assert len(resource["current"]) == 1
-    assert "tmpl1" in resource["current"]
-    assert resource["current"]["tmpl1"].kind == "Template"
-
-
-@pytest.fixture
-@patch("reconcile.utils.oc.OCNative")
-def test_fetch_current_state_kind_not_supported(
-    oc_cs1: oc.OCNative, tmpl1: dict[str, Any]
-):
-    ri = ResourceInventory()
-    ri.initialize_resource_type("cs1", "ns1", "AnUnsupportedKind")
-    oc_cs1.get_items = lambda kind, **kwargs: [tmpl1]
-    orb.fetch_current_state(
-        oc=oc_cs1,
-        ri=ri,
-        cluster="cs1",
-        namespace="ns1",
-        kind="AnUnsupportedKind",
-        resource_names=[],
-    )
-
-    _, _, _, resource = next(iter(ri))
-    assert len(resource["current"]) == 0
-
-
-def test_fetch_current_state_long_kind(oc_cs1: oc.OCClient, tmpl1: dict[str, Any]):
-    ri = ResourceInventory()
-    ri.initialize_resource_type("cs1", "ns1", "Template.template.openshift.io")
-    oc_cs1.get_items = lambda kind, **kwargs: [tmpl1]  # type: ignore
-    orb.fetch_current_state(
-        oc=oc_cs1,
-        ri=ri,
-        cluster="cs1",
-        namespace="ns1",
-        kind="Template.template.openshift.io",
-        resource_names=[],
-    )
-
-    _, _, _, resource = next(iter(ri))
-    assert len(resource["current"]) == 1
-    assert "tmpl1" in resource["current"]
-    assert resource["current"]["tmpl1"].kind == "Template"
-
-
-@pytest.fixture
-@patch("reconcile.utils.oc.OCNative")
-def test_fetch_current_state_long_kind_not_supported(
-    oc_cs1: oc.OCNative, tmpl1: dict[str, Any]
-):
-    ri = ResourceInventory()
-    ri.initialize_resource_type("cs1", "ns1", "UnknownKind.mysterious.io")
-    oc_cs1.get_items = lambda kind, **kwargs: [tmpl1]
-    orb.fetch_current_state(
-        oc=oc_cs1,
-        ri=ri,
-        cluster="cs1",
-        namespace="ns1",
-        kind="UnknownKind.mysterious.io",
-        resource_names=[],
-    )
-
-    _, _, _, resource = next(iter(ri))
-    assert len(resource["current"]) == 0
-
-
-def test_fetch_states(current_state_spec: CurrentStateSpec, tmpl1: dict[str, Any]):
-    ri = ResourceInventory()
-    ri.initialize_resource_type("cs1", "ns1", "Template")
-    current_state_spec.oc.get_items = lambda kind, **kwargs: [tmpl1]  # type: ignore[method-assign]
-    orb.fetch_states(ri=ri, spec=current_state_spec)
-    _, _, _, resource = next(iter(ri))
-    assert len(resource["current"]) == 1
-    assert "tmpl1" in resource["current"]
-    assert resource["current"]["tmpl1"].kind == "Template"
-
-
-def test_fetch_states_unknown_kind(current_state_spec: CurrentStateSpec):
-    current_state_spec.kind = "UnknownKind"
-    ri = ResourceInventory()
-    ri.initialize_resource_type("cs1", "ns1", "UnknownKind")
-    orb.fetch_states(ri=ri, spec=current_state_spec)
-    _, _, _, resource = next(iter(ri))
-    assert len(resource["current"]) == 0
-
-
-def test_fetch_states_oc_error(current_state_spec: CurrentStateSpec):
-    current_state_spec.oc.get_items = Mock(  # type: ignore[method-assign]
-        side_effect=oc.StatusCodeError("something wrong with openshift")
-    )
-    ri = ResourceInventory()
-    ri.initialize_resource_type("cs1", "ns1", "Template")
-    orb.fetch_states(ri=ri, spec=current_state_spec)
-    assert ri.has_error_registered("cs1")
-    _, _, _, resource = next(iter(ri))
-    assert len(resource["current"]) == 0
-
-
-@pytest.fixture
-def nss_csr_overrides() -> list[dict[str, Any]]:
-    return [fxt.get_anymarkup("ns-overrides-cluster-resources.yml")]
-
-
-@pytest.fixture
-def api_resources():
-    p1 = Resource(
-        prefix="",
-        kind="Project",
-        group="project.openshift.io",
-        api_version="v1",
-        namespaced=False,
-    )
-    p2 = Resource(
-        prefix="",
-        kind="Project",
-        group="config.openshift.io",
-        api_version="v1",
-        namespaced=False,
-    )
-    cr = Resource(
-        prefix="",
-        kind="ClusterRole",
-        group="rbac.authorization.k8s.io",
-        api_version="v1",
-        namespaced=False,
-    )
-    d1 = Resource(
-        prefix="",
-        kind="Deployment",
-        group="apps",
-        api_version="v1",
-        namespaced=True,
-    )
-    return {"Project": [p1, p2], "ClusterRole": [cr], "Deployment": [d1]}
-
-
-@pytest.fixture
-def oc_api_resources(mocker, api_resources):
-    mock = mocker.patch("reconcile.utils.oc.OCNative", autospec=True).return_value
-    mock.get_api_resources.return_value = api_resources
-    mock.is_kind_namespaced.side_effect = lambda k: k == "Deployment"
-    return oc.OCNative("cluster", "server", "token", local=True)
-
-
-@pytest.fixture
-def oc_map_api_resources(mocker, oc_api_resources):
-    ocmap = mocker.patch("reconcile.utils.oc.OC_Map", autospec=True).return_value
-    ocmap.get_cluster.return_value = oc_api_resources
-    ocmap.clusters.side_effect = (
-        lambda include_errors=False, privileged=False: ["cs1"] if not privileged else []
-    )
-    return oc.OC_Map(clusters=["cs1"])
-
-
-def test_get_namespace_cluster_scoped_resources(
-    oc_map_api_resources, nss_csr_overrides
-):
-    expected = (
-        "cs1",
-        "ns1",
-        {
-            "ClusterRole": ["cr1"],
-            "Project.config.openshift.io": ["pr1", "pr2"],
-        },
-    )
-
-    result = orb._get_namespace_cluster_scoped_resources(
-        nss_csr_overrides[0],
-        oc_map_api_resources,
-    )
-    assert result == expected
-
-
-def test_get_cluster_scoped_resources(oc_map_api_resources, nss_csr_overrides):
-    expected = {
-        "cs1": {
-            "ns1": {
-                "ClusterRole": ["cr1"],
-                "Project.config.openshift.io": ["pr1", "pr2"],
-            }
-        }
-    }
-    result = orb.get_cluster_scoped_resources(
-        oc_map_api_resources, clusters=["cs1"], namespaces=nss_csr_overrides
-    )
-    assert result == expected
-
-
-def test_find_resource_duplicates(oc_map_api_resources):
-    input = {
-        "cs1": {
-            "ns1": {
-                "ClusterRole": ["cr1"],
-                "Project.config.openshift.io": ["pr1", "pr2"],
-            },
-            "ns2": {
-                "ClusterRole": ["cr1"],
-            },
-        },
-        "cs2": {
-            "ns3": {
-                "ClusterRole": ["cr1"],
-                "ClusterRoleBinding": ["crb1"],
-            },
-            "ns4": {
-                "ClusterRoleBinding": ["crb1"],
-            },
-        },
-    }
-    expected = [
-        ("cs1", "ClusterRole", "cr1", ["ns1", "ns2"]),
-        ("cs2", "ClusterRoleBinding", "crb1", ["ns3", "ns4"]),
-    ]
-    c = CheckClusterScopedResourceDuplicates(oc_map_api_resources)
-    result = c._find_resource_duplicates(input)
-    assert result == expected
-
-
-@pytest.fixture
-def resource_inventory_csr_tests():
-    ri = ResourceInventory()
-    ri.initialize_resource_type("cs1", "ns1", "ClusterRole")
-    ri.initialize_resource_type("cs1", "ns1", "Project.config.openshift.io")
-    ri.add_desired("cs1", "ns1", "ClusterRole", "cr1", "dummy_values", True)
-    ri.add_desired(
-        "cs1", "ns1", "Project.config.openshift.io", "pr1", "dummy_values", True
-    )
-    ri.add_desired(
-        "cs1", "ns1", "Project.config.openshift.io", "pr2", "dummy_values", True
-    )
-    return ri
-
-
-def test_check_cluster_scoped_resources_ok(
-    oc_map_api_resources, resource_inventory_csr_tests, nss_csr_overrides
-):
-    error = orb.check_cluster_scoped_resources(
-        oc_map_api_resources,
-        resource_inventory_csr_tests,
-        nss_csr_overrides,
-        nss_csr_overrides,
-    )
-
-    assert error is False
-
-
-def test_check_cluster_scoper_resources_non_declared(
-    oc_map_api_resources, resource_inventory_csr_tests, nss_csr_overrides
-):
-    resource_inventory_csr_tests.add_desired(
-        "cs1", "ns1", "ClusterRole", "cr3", "dummy_value", True
-    )
-    error = orb.check_cluster_scoped_resources(
-        oc_map_api_resources,
-        resource_inventory_csr_tests,
-        nss_csr_overrides,
-        nss_csr_overrides,
-    )
-
-    assert error is True
-
-
-def test_check_cluster_scoped_resources_duplicated(
-    oc_map_api_resources, resource_inventory_csr_tests, nss_csr_overrides
-):
-    ns2 = copy.deepcopy(nss_csr_overrides[0])
-    ns2["name"] = "ns3"
-
-    all_namespaces = [nss_csr_overrides[0], ns2]
-    error = orb.check_cluster_scoped_resources(
-        oc_map_api_resources,
-        resource_inventory_csr_tests,
-        nss_csr_overrides,
-        all_namespaces,
-    )
-
-    assert error is True
-
-
-def test_check_error():
-    e = orb.CheckError("message")
-    print(e)
-
-
-def test_cluster_params():
-    with pytest.raises(RuntimeError):
-        orb.run(dry_run=False, exclude_cluster=["test-cluster"])
-
-    with pytest.raises(RuntimeError):
-        orb.run(
-            dry_run=False, cluster_name=["cluster-1"], exclude_cluster=["cluster-2"]
-        )
-
-    with pytest.raises(RuntimeError):
-        orb.run(dry_run=False, cluster_name=["cluster-1", "cluster-2"])
-
-
-@pytest.mark.parametrize(
-    "test_parameters, exception_expected",
-    [
-        ({" leading_space": "test"}, orb.SecretKeyFormatError),
-        ({" space_padding ": "test"}, orb.SecretKeyFormatError),
-        ({"trailing_space ": "test"}, orb.SecretKeyFormatError),
-        ({"&invalidkey": "test"}, orb.SecretKeyFormatError),
-        ({"!invalidkey": "test"}, orb.SecretKeyFormatError),
-        ({"space issues": "test"}, orb.SecretKeyFormatError),
-        ({"/etc/passwd": "test"}, orb.SecretKeyFormatError),
-        ({"": "test"}, orb.SecretKeyFormatError),
-        ({".": "test"}, None),
-        ({"0validkey": "test"}, None),
-        ({"no_spacing": "test"}, None),
-        ({"-": "test"}, None),
-    ],
-)
-def test_secret_keys(test_parameters, exception_expected):
-    if exception_expected is not None:
-        with pytest.raises(exception_expected):
-            orb.assert_valid_secret_keys(test_parameters)
-    else:
-        orb.assert_valid_secret_keys(test_parameters)

reconcile/test/test_openshift_saas_deploy.py

@@ -1,188 +0,0 @@
-from collections.abc import Callable
-from unittest.mock import create_autospec
-
-import pytest
-
-from reconcile.openshift_saas_deploy import (
-    compose_console_url,
-    slack_notify,
-)
-from reconcile.openshift_tekton_resources import (
-    OpenshiftTektonResourcesNameTooLongError,
-)
-from reconcile.typed_queries.saas_files import SaasFile
-from reconcile.utils import (
-    openshift_resource,
-    slack_api,
-)
-from reconcile.utils.saasherder.saasherder import UNIQUE_SAAS_FILE_ENV_COMBO_LEN
-
-
-@pytest.fixture
-def saas_file_builder(
-    gql_class_factory: Callable[..., SaasFile],
-) -> Callable[..., SaasFile]:
-    def builder(saas_name: str) -> SaasFile:
-        return gql_class_factory(
-            SaasFile,
-            {
-                "name": saas_name,
-                "app": {"name": "app_name"},
-                "pipelinesProvider": {
-                    "namespace": {
-                        "name": "namespace_name",
-                        "cluster": {"consoleUrl": "https://console.url"},
-                    },
-                    "defaults": {
-                        "pipelineTemplates": {
-                            "openshiftSaasDeploy": {"name": "saas-deploy"}
-                        },
-                    },
-                },
-                "managedResourceTypes": [],
-                "managedResourceNames": None,
-                "imagePatterns": [],
-                "resourceTemplates": [],
-            },
-        )
-
-    return builder
-
-
-def test_compose_console_url(
-    saas_file_builder: Callable[..., SaasFile],
-) -> None:
-    saas_file = saas_file_builder("saas_name")
-    env_name = "production"
-
-    url = compose_console_url(saas_file, env_name)
-
-    assert (
-        url
-        == "https://console.url/k8s/ns/namespace_name/tekton.dev~v1~Pipeline/o-saas-deploy-saas_name/"
-        "Runs?name=saas_name-production"
-    )
-
-
-def test_compose_console_url_with_medium_saas_name(
-    saas_file_builder: Callable[..., SaasFile],
-) -> None:
-    saas_name = "saas-openshift-cert-manager-routes"
-    saas_file = saas_file_builder(saas_name)
-    env_name = "app-sre-production"
-
-    url = compose_console_url(saas_file, env_name)
-
-    expected_run_name = f"{saas_name}-{env_name}"[:UNIQUE_SAAS_FILE_ENV_COMBO_LEN]
-    assert (
-        url == "https://console.url/k8s/ns/namespace_name/tekton.dev~v1~Pipeline/"
-        "o-saas-deploy-saas-openshift-cert-manager-routes/"
-        f"Runs?name={expected_run_name}"
-    )
-
-
-def test_compose_console_url_with_long_saas_name(
-    saas_file_builder: Callable[..., SaasFile],
-) -> None:
-    saas_name = "this-is-a-very-looooooooooooooooooooooong-saas-name"
-    saas_file = saas_file_builder(saas_name)
-    env_name = "app-sre-production"
-
-    with pytest.raises(OpenshiftTektonResourcesNameTooLongError) as e:
-        compose_console_url(saas_file, env_name)
-
-    assert (
-        f"Pipeline name o-saas-deploy-{saas_name} is longer than 56 characters"
-        == str(e.value)
-    )
-
-
-def test_slack_notify_skipped_success():
-    api = create_autospec(slack_api.SlackApi)
-    slack_notify(
-        saas_file_name="test-slack_notify--skipped-success.yaml",
-        env_name="test",
-        slack=api,
-        ri=openshift_resource.ResourceInventory(),
-        console_url="https://test.local/console",
-        in_progress=False,
-        skip_successful_notifications=True,
-    )
-    api.chat_post_message.assert_not_called()
-
-
-def test_slack_notify_unskipped_success():
-    api = create_autospec(slack_api.SlackApi)
-    slack_notify(
-        saas_file_name="test-slack_notify--unskipped-success.yaml",
-        env_name="test",
-        slack=api,
-        ri=openshift_resource.ResourceInventory(),
-        console_url="https://test.local/console",
-        in_progress=False,
-        skip_successful_notifications=False,
-    )
-    api.chat_post_message.assert_called_once_with(
-        ":green_jenkins_circle: SaaS file *test-slack_notify--unskipped-success.yaml* "
-        "deployment to environment *test*: Success "
-        "(<https://test.local/console|Open>)"
-    )
-
-
-def test_slack_notify_unskipped_failure():
-    api = create_autospec(slack_api.SlackApi)
-    ri = openshift_resource.ResourceInventory()
-    ri.register_error()
-    slack_notify(
-        saas_file_name="test-saas-file-name.yaml",
-        env_name="test",
-        slack=api,
-        ri=ri,
-        console_url="https://test.local/console",
-        in_progress=False,
-        skip_successful_notifications=False,
-    )
-    api.chat_post_message.assert_called_once_with(
-        ":red_jenkins_circle: SaaS file *test-saas-file-name.yaml* "
-        "deployment to environment *test*: Failure "
-        "(<https://test.local/console|Open>)"
-    )
-
-
-def test_slack_notify_skipped_failure():
-    api = create_autospec(slack_api.SlackApi)
-    ri = openshift_resource.ResourceInventory()
-    ri.register_error()
-    slack_notify(
-        saas_file_name="test-saas-file-name.yaml",
-        env_name="test",
-        slack=api,
-        ri=ri,
-        console_url="https://test.local/console",
-        in_progress=False,
-        skip_successful_notifications=True,
-    )
-    api.chat_post_message.assert_called_once_with(
-        ":red_jenkins_circle: SaaS file *test-saas-file-name.yaml* "
-        "deployment to environment *test*: Failure "
-        "(<https://test.local/console|Open>)"
-    )
-
-
-def test_slack_notify_skipped_in_progress():
-    api = create_autospec(slack_api.SlackApi)
-    ri = openshift_resource.ResourceInventory()
-    slack_notify(
-        saas_file_name="test-saas-file-name.yaml",
-        env_name="test",
-        slack=api,
-        ri=ri,
-        console_url="https://test.local/console",
-        in_progress=True,
-        skip_successful_notifications=True,
-    )
-    api.chat_post_message.assert_called_once_with(
-        ":yellow_jenkins_circle: SaaS file *test-saas-file-name.yaml* "
-        "deployment to environment *test*: In Progress "
-        "(<https://test.local/console|Open>). There will not be a notice for success."
-    )