From 0c8850303c6c9f26e4362904de9ae12f25a3d3cf Mon Sep 17 00:00:00 2001 From: Daniela Plascencia Date: Fri, 12 Apr 2024 09:47:51 +0200 Subject: [PATCH] tests: pin deployed charms to a latest and stable compatible version This commit pins all charms that get deployed from Charmhub to a compatible version to the CKF 1.8 release. This commit also refactors the test file so it takes all versions and other constants from a constants.py file Part of canonical/bundle-kubeflow#863 --- tests/integration/__init__.py | 6 ++ tests/integration/constants.py | 50 +++++++++++ tests/integration/test_charm.py | 149 ++++++++++++++++++-------------- 3 files changed, 141 insertions(+), 64 deletions(-) create mode 100644 tests/integration/__init__.py create mode 100644 tests/integration/constants.py diff --git a/tests/integration/__init__.py b/tests/integration/__init__.py new file mode 100644 index 00000000..5b778f12 --- /dev/null +++ b/tests/integration/__init__.py @@ -0,0 +1,6 @@ +# Copyright 2024 Canonical Ltd. +# See LICENSE file for licensing details. + +"""Constants and other helpers.""" + +from . import constants # noqa diff --git a/tests/integration/constants.py b/tests/integration/constants.py new file mode 100644 index 00000000..ac8f0d50 --- /dev/null +++ b/tests/integration/constants.py @@ -0,0 +1,50 @@ +# Copyright 2024 Canonical Ltd. +# See LICENSE file for licensing details. +"""Constants module including constants used in tests.""" +from pathlib import Path + +import yaml + +METADATA = yaml.safe_load(Path("./metadata.yaml").read_text()) +CHARM_ROOT = "." +DEX_AUTH = "dex-auth" +DEX_AUTH_APP_NAME = METADATA["name"] +DEX_AUTH_TRUST = True +DEX_AUTH_CONFIG = { + "static-username": "admin", + "static-password": "foobar", +} + +OIDC_GATEKEEPER = "oidc-gatekeeper" +OIDC_GATEKEEPER_CHANNEL = "latest/edge" +OIDC_GATEKEEPER_CONFIG = { + "client-name": "Ambassador Auth OIDC", + "client-secret": "oidc-client-secret", +} + +ISTIO_OPERATORS_CHANNEL = "latest/edge" +ISTIO_PILOT = "istio-pilot" +ISTIO_PILOT_TRUST = True +ISTIO_PILOT_CONFIG = {"default-gateway": "kubeflow-gateway"} +ISTIO_GATEWAY = "istio-gateway" +ISTIO_GATEWAY_APP_NAME = "istio-ingressgateway" +ISTIO_GATEWAY_TRUST = True +ISTIO_GATEWAY_CONFIG = {"kind": "ingress"} + +KUBEFLOW_PROFILES = "kubeflow-profiles" +KUBEFLOW_PROFILES_CHANNEL = "latest/edge" +KUBEFLOW_PROFILES = True + +KUBEFLOW_DASHBOARD = "kubeflow-dashboard" +KUBEFLOW_DASHBOARD_CHANNEL = "latest/edge" +KUBEFLOW_DASHBOARD = True + +PROMETHEUS_K8S = "prometheus-k8s" +PROMETHEUS_K8S_CHANNEL = "1.0/stable" +PROMETHEUS_K8S_TRUST = True +GRAFANA_K8S = "grafana-k8s" +GRAFANA_K8S_CHANNEL = "1.0/stable" +GRAFANA_K8S_TRUST = True +PROMETHEUS_SCRAPE_K8S = "prometheus-scrape-k8s" +PROMETHEUS_SCRAPE_K8S_CHANNEL = "1.0/stable" +PROMETHEUS_SCRAPE_CONFIG = {"scrape_interval": "30s"} diff --git a/tests/integration/test_charm.py b/tests/integration/test_charm.py index bbe9b9de..bf94cf0f 100644 --- a/tests/integration/test_charm.py +++ b/tests/integration/test_charm.py @@ -3,13 +3,11 @@ import json import logging -from pathlib import Path from time import sleep import lightkube import pytest import requests -import yaml from lightkube.resources.apps_v1 import StatefulSet from lightkube.resources.core_v1 import Service from pytest_operator.plugin import OpsTest @@ -20,30 +18,25 @@ from selenium.webdriver.support.ui import WebDriverWait from tenacity import Retrying, stop_after_attempt, stop_after_delay, wait_exponential +from . import constants + log = logging.getLogger(__name__) -METADATA = yaml.safe_load(Path("./metadata.yaml").read_text()) -APP_NAME = METADATA["name"] -DEX_CONFIG = { - "static-username": "admin", - "static-password": "foobar", -} -OIDC_CONFIG = { - "client-name": "Ambassador Auth OIDC", - "client-secret": "oidc-client-secret", -} @pytest.mark.abort_on_fail async def test_build_and_deploy(ops_test): my_charm = await ops_test.build_charm(".") - dex_image_path = METADATA["resources"]["oci-image"]["upstream-source"] + dex_image_path = constants.METADATA["resources"]["oci-image"]["upstream-source"] await ops_test.model.deploy( - my_charm, resources={"oci-image": dex_image_path}, trust=True, config=DEX_CONFIG + my_charm, resources={"oci-image": dex_image_path}, trust=True, config=constants.DEX_CONFIG ) await ops_test.model.wait_for_idle( - apps=[APP_NAME], status="active", raise_on_blocked=True, timeout=600 + apps=[constants.DEX_AUTH_APP_NAME], status="active", raise_on_blocked=True, timeout=600 + ) + assert ( + ops_test.model.applications[constants.DEX_AUTH_APP_NAME].units[0].workload_status + == "active" ) - assert ops_test.model.applications[APP_NAME].units[0].workload_status == "active" @pytest.mark.abort_on_fail @@ -56,7 +49,7 @@ def test_statefulset_readiness(ops_test: OpsTest): ) with attempt: statefulset = lightkube_client.get( - StatefulSet, APP_NAME, namespace=ops_test.model_name + StatefulSet, constants.DEX_AUTH_APP_NAME, namespace=ops_test.model_name ) expected_replicas = statefulset.spec.replicas @@ -67,48 +60,60 @@ def test_statefulset_readiness(ops_test: OpsTest): @pytest.mark.abort_on_fail async def test_relations(ops_test: OpsTest): - oidc_gatekeeper = "oidc-gatekeeper" - istio_pilot = "istio-pilot" - istio_gateway = "istio-ingressgateway" - await ops_test.model.deploy( - entity_url=istio_pilot, - channel="latest/edge", - config={"default-gateway": "kubeflow-gateway"}, - trust=True, + entity_url=constants.ISTIO_PILOT, + channel=constants.ISTIO_OPERATORS_CHANNEL, + config=constants.ISTIO_PILOT_CONFIG, + trust=constants.ISTIO_PILOT_TRUE, ) await ops_test.model.deploy( - entity_url="istio-gateway", - application_name=istio_gateway, - channel="latest/edge", - config={"kind": "ingress"}, - trust=True, + entity_url=constants.ISTIO_GATEWAY, + application_name=constants.ISTIO_GATEWAY_APP_NAME, + channel=constants.ISTIO_OPERATORS_CHANNEL, + config=constants.ISTIO_GATEWAY_CONFIG, + trust=constants.ISTIO_GATEWAY_TRUST, ) await ops_test.model.add_relation( - istio_pilot, - istio_gateway, + constants.ISTIO_PILOT, + constants.ISTIO_GATEWAY_APP_NAME, ) await ops_test.model.wait_for_idle( - [istio_pilot, istio_gateway], + [constants.ISTIO_PILOT, constants.ISTIO_GATEWAY_APP_NAME], raise_on_blocked=False, status="active", timeout=90 * 10, ) - await ops_test.model.deploy(oidc_gatekeeper, channel="latest/edge", config=OIDC_CONFIG) - await ops_test.model.add_relation(oidc_gatekeeper, APP_NAME) - await ops_test.model.add_relation(f"{istio_pilot}:ingress", f"{APP_NAME}:ingress") + await ops_test.model.deploy( + constants.OIDC_GATEKEEPER, + channel=constants.OIDC_GATEKEEPER_CHANNEL, + config=constants.OIDC_GATEKEEPER_CONFIG, + ) + await ops_test.model.add_relation(constants.OIDC_GATEKEEPER, constants.DEX_AUTH_APP_NAME) + await ops_test.model.add_relation( + f"{constants.ISTIO_PILOT}:ingress", f"{constants.DEX_AUTH_APP_NAME}:ingress" + ) await ops_test.model.add_relation( - f"{istio_pilot}:ingress-auth", - f"{oidc_gatekeeper}:ingress-auth", + f"{constants.ISTIO_PILOT}:ingress-auth", + f"{constants.OIDC_GATEKEEPER}:ingress-auth", ) - await ops_test.model.deploy("kubeflow-profiles", channel="latest/edge", trust=True) - await ops_test.model.deploy("kubeflow-dashboard", channel="latest/edge", trust=True) - await ops_test.model.add_relation("kubeflow-profiles", "kubeflow-dashboard") - await ops_test.model.add_relation(f"{istio_pilot}:ingress", "kubeflow-dashboard:ingress") + await ops_test.model.deploy( + constants.KUBEFLOW_PROFILES, + channel=constants.KUBEFLOW_PROFILES_CHANNEL, + trust=constants.KUBEFLOW_PROFILES, + ) + await ops_test.model.deploy( + constants.KUBEFLOW_DASHBOARD, + channel=constants.KUBEFLOW_DASHBOARD_CHANNEL, + trust=constants.KUBEFLOW_DASHBOARD, + ) + await ops_test.model.add_relation(constants.KUBEFLOW_PROFILES, constants.KUBEFLOW_DASHBOARD) + await ops_test.model.add_relation( + f"{constants.ISTIO_PILOT}:ingress", f"{constants.KUBEFLOW_DASHBOARD,}:ingress" + ) # Set public-url for dex and oidc # Note: This could be affected by a race condition (if service has not received @@ -119,8 +124,12 @@ async def test_relations(ops_test: OpsTest): namespace=ops_test.model_name, ) log.info(f"got public_url of {public_url}") - await ops_test.model.applications[APP_NAME].set_config({"public-url": public_url}) - await ops_test.model.applications["oidc-gatekeeper"].set_config({"public-url": public_url}) + await ops_test.model.applications[constants.DEX_AUTH_APP_NAME].set_config( + {"public-url": public_url} + ) + await ops_test.model.applications[constants.OIDC_GATEKEEPER].set_config( + {"public-url": public_url} + ) await ops_test.model.wait_for_idle( status="active", @@ -148,7 +157,7 @@ async def driver(ops_test: OpsTest): # Oidc may get blocked and recreate the unit await ops_test.model.wait_for_idle( - [APP_NAME, "oidc-gatekeeper"], + [constants.DEX_AUTH_APP_NAME, constants.OIDC_GATEKEEPER], status="active", raise_on_blocked=False, raise_on_error=False, @@ -185,8 +194,8 @@ def test_login(driver): driver.get_screenshot_as_file("/tmp/selenium-logon.png") # Log in using dex credentials - driver.find_element(By.ID, "login").send_keys(DEX_CONFIG["static-username"]) - driver.find_element(By.ID, "password").send_keys(DEX_CONFIG["static-password"]) + driver.find_element(By.ID, "login").send_keys(constants.DEX_CONFIG["static-username"]) + driver.find_element(By.ID, "password").send_keys(constants.DEX_CONFIG["static-password"]) driver.find_element(By.ID, "submit-login").click() # Check if main page was loaded @@ -196,31 +205,43 @@ def test_login(driver): async def test_prometheus_grafana_integration(ops_test: OpsTest): """Deploy prometheus, grafana and required relations, then test the metrics.""" - prometheus = "prometheus-k8s" - grafana = "grafana-k8s" - prometheus_scrape_charm = "prometheus-scrape-config-k8s" - scrape_config = {"scrape_interval": "5s"} + # Deploy and relate prometheus + await ops_test.model.deploy( + constants.PROMETHEUS_K8S, + channel=constants.PROMETHEUS_K8S_CHANNEL, + trust=constants.PROMETHEUS_K8S_TRUST, + ) + await ops_test.model.deploy( + constants.GRAFANA_K8S, + channel=constants.GRAFANA_K8S_CHANNEL, + trust=constants.GRAFANA_K8S_TRUST, + ) + await ops_test.model.deploy( + constants.PROMETHEUS_SCRAPE_K8S, + channel=constants.PROMETHEUS_SCRAPE_K8S_CHANNEL, + config=constants.PROMETHEUS_SCRAPE_CONFIG, + ) - await ops_test.model.deploy(prometheus, channel="latest/beta", trust=True) - await ops_test.model.deploy(grafana, channel="latest/beta", trust=True) + await ops_test.model.add_relation(constants.DEX_AUTH_APP_NAME, constants.PROMETHEUS_SCRAPE_K8S) await ops_test.model.add_relation( - f"{prometheus}:grafana-dashboard", f"{grafana}:grafana-dashboard" + f"{constants.PROMETHEUS_K8S}:grafana-dashboard", + f"{constants.GRAFANA_K8S}:grafana-dashboard", ) await ops_test.model.add_relation( - f"{APP_NAME}:grafana-dashboard", f"{grafana}:grafana-dashboard" - ) - await ops_test.model.deploy( - prometheus_scrape_charm, channel="latest/beta", config=scrape_config + f"{constants.DEX_AUTH_APP_NAME}:grafana-dashboard", + f"{constants.GRAFANA_K8S}:grafana-dashboard", ) - await ops_test.model.add_relation(APP_NAME, prometheus_scrape_charm) await ops_test.model.add_relation( - f"{prometheus}:metrics-endpoint", f"{prometheus_scrape_charm}:metrics-endpoint" + f"{constants.PROMETHEUS_K8S}:metrics-endpoint", + f"{constants.PROMETHEUS_SCRAPE_K8S}:metrics-endpoint", ) - await ops_test.model.wait_for_idle(status="active", timeout=60 * 10) + await ops_test.model.wait_for_idle(status="active", timeout=60 * 20) status = await ops_test.model.get_status() - prometheus_unit_ip = status["applications"][prometheus]["units"][f"{prometheus}/0"]["address"] + prometheus_unit_ip = status["applications"][constants.PROMETHEUS_K8S]["units"][ + f"{constants.PROMETHEUS_K8S}/0" + ]["address"] log.info(f"Prometheus available at http://{prometheus_unit_ip}:9090") for attempt in retry_for_5_attempts: @@ -230,7 +251,7 @@ async def test_prometheus_grafana_integration(ops_test: OpsTest): with attempt: r = requests.get( f"http://{prometheus_unit_ip}:9090/api/v1/query?" - f'query=up{{juju_application="{APP_NAME}"}}' + f'query=up{{juju_application="{constants.DEX_AUTH_APP_NAME}"}}' ) response = json.loads(r.content.decode("utf-8")) response_status = response["status"] @@ -238,7 +259,7 @@ async def test_prometheus_grafana_integration(ops_test: OpsTest): assert response_status == "success" response_metric = response["data"]["result"][0]["metric"] - assert response_metric["juju_application"] == APP_NAME + assert response_metric["juju_application"] == constants.DEX_AUTH_APP_NAME assert response_metric["juju_model"] == ops_test.model_name # Assert the unit is available by checking the query result