add tests for replace and generate sidecar

Signed-off-by: Kevin <[email protected]>

Author: KPostOffice

src/codeflare_sdk/cluster/cluster.py

@@ -33,7 +33,6 @@
 from ..utils.openshift_oauth import (
     create_openshift_oauth_objects,
     delete_openshift_oauth_objects,
-    download_tls_cert,
 )
 from .config import ClusterConfiguration
 from .model import (

src/codeflare_sdk/job/jobs.py

@@ -29,7 +29,6 @@
 if TYPE_CHECKING:
     from ..cluster.cluster import Cluster
 from ..cluster.cluster import get_current_namespace
-from ..utils.openshift_oauth import download_tls_cert
 
 all_jobs: List["Job"] = []
 

src/codeflare_sdk/utils/generate_yaml.py

@@ -30,6 +30,8 @@
 
 from kubernetes import client, config
 
+from .kube_api_helpers import _get_api_host
+
 
 def read_template(template):
     with open(template, "r") as stream:
@@ -380,14 +382,14 @@ def write_user_appwrapper(user_yaml, output_file_name):
 
 def enable_openshift_oauth(user_yaml, cluster_name, namespace):
     config_check()
-    k8_client = api_config_handler()
+    k8_client = api_config_handler() or client.ApiClient()
     tls_mount_location = "/etc/tls/private"
     oauth_port = 8443
     oauth_sa_name = f"{cluster_name}-oauth-proxy"
     tls_secret_name = f"{cluster_name}-proxy-tls-secret"
     tls_volume_name = "proxy-tls-secret"
     port_name = "oauth-proxy"
-    _, _, host, _, _, _, _ = parse_url(k8_client.configuration.host)
+    host = _get_api_host(k8_client)
     host = host.replace(
         "api.", f"{gen_dashboard_route_name(cluster_name)}-{namespace}.apps."
     )
@@ -414,14 +416,14 @@ def enable_openshift_oauth(user_yaml, cluster_name, namespace):
     user_yaml["spec"]["resources"]["GenericItems"].pop(1)
     ray_headgroup_pod["serviceAccount"] = oauth_sa_name
     ray_headgroup_pod["volumes"] = ray_headgroup_pod.get("volumes", [])
+
+    # we use a generic api client here so that the serialization function doesn't need to be mocked for unit tests
     ray_headgroup_pod["volumes"].append(
-        k8_client.sanitize_for_serialization(tls_secret_volume)
+        client.ApiClient().sanitize_for_serialization(tls_secret_volume)
     )
     ray_headgroup_pod["containers"].append(
-        k8_client.sanitize_for_serialization(oauth_sidecar)
+        client.ApiClient().sanitize_for_serialization(oauth_sidecar)
     )
-    # add volume to headnode
-    # add sidecar container to ray object
 
 
 def _create_oauth_sidecar_object(

src/codeflare_sdk/utils/kube_api_helpers.py

@@ -19,6 +19,7 @@
 
 import executing
 from kubernetes import client, config
+from urllib3.util import parse_url
 
 
 # private methods
@@ -42,3 +43,7 @@ def _kube_api_error_handling(e: Exception):  # pragma: no cover
         elif e.reason == "Conflict":
             raise FileExistsError(exists_msg)
     raise e
+
+
+def _get_api_host(api_client: client.ApiClient):  # pragma: no cover
+    return parse_url(api_client.configuration.host).host

src/codeflare_sdk/utils/openshift_oauth.py

@@ -1,19 +1,16 @@
 from urllib3.util import parse_url
 from .generate_yaml import gen_dashboard_route_name
+from .kube_api_helpers import _get_api_host
 from base64 import b64decode
 
 from ..cluster.auth import config_check, api_config_handler
 
 from kubernetes import client
 
 
-def _get_api_host(api_client: client.ApiClient):
-    return parse_url(api_client.configuration.host).host
-
-
 def create_openshift_oauth_objects(cluster_name, namespace):
     config_check()
-    api_client = api_config_handler()
+    api_client = api_config_handler() or client.ApiClient()
     oauth_port = 8443
     oauth_sa_name = f"{cluster_name}-oauth-proxy"
     tls_secret_name = _gen_tls_secret_name(cluster_name)
@@ -118,19 +115,6 @@ def delete_openshift_oauth_objects(cluster_name, namespace):
     )
 
 
-def download_tls_cert(cluster_name, namespace, output_file):
-    api_client = api_config_handler()
-    b64_tls_cert = (
-        client.CoreV1Api(api_client)
-        .read_namespaced_secret(
-            name=_gen_tls_secret_name(cluster_name=cluster_name), namespace=namespace
-        )
-        .data["tls.crt"]
-    )
-    with open(output_file, "w+") as f:
-        f.write(b64decode(b64_tls_cert).decode("ascii"))
-
-
 def _create_or_replace_oauth_service_obj(
     cluster_name: str,
     namespace: str,

tests/unit_test.py

@@ -40,7 +40,6 @@
     Authentication,
     KubeConfigFileAuthentication,
     config_check,
-    api_config_handler,
 )
 from codeflare_sdk.utils.openshift_oauth import create_openshift_oauth_objects
 from codeflare_sdk.utils.pretty_print import (
@@ -76,6 +75,8 @@
     createDDPJob_with_cluster,
 )
 
+import codeflare_sdk.utils.kube_api_helpers
+
 import openshift
 from openshift.selector import Selector
 import ray
@@ -2295,7 +2296,6 @@ def test_export_env():
     )
 
 
-# TODO add checks to make sure that when calling generate oauth objects that the fields that are expected to match do
 def test_create_openshift_oauth(mocker: MockerFixture):
     create_namespaced_service_account = MagicMock()
     create_cluster_role_binding = MagicMock()
@@ -2345,6 +2345,88 @@ def test_create_openshift_oauth(mocker: MockerFixture):
     )
 
 
+def test_replace_openshift_oauth(mocker: MockerFixture):
+    # not_found_exception = client.ApiException(reason="Conflict")
+    create_namespaced_service_account = MagicMock(
+        side_effect=client.ApiException(reason="Conflict")
+    )
+    create_cluster_role_binding = MagicMock(
+        side_effect=client.ApiException(reason="Conflict")
+    )
+    create_namespaced_service = MagicMock(
+        side_effect=client.ApiException(reason="Conflict")
+    )
+    create_namespaced_ingress = MagicMock(
+        side_effect=client.ApiException(reason="Conflict")
+    )
+    mocker.patch.object(
+        client.CoreV1Api,
+        "create_namespaced_service_account",
+        create_namespaced_service_account,
+    )
+    mocker.patch.object(
+        client.RbacAuthorizationV1Api,
+        "create_cluster_role_binding",
+        create_cluster_role_binding,
+    )
+    mocker.patch.object(
+        client.CoreV1Api, "create_namespaced_service", create_namespaced_service
+    )
+    mocker.patch.object(
+        client.NetworkingV1Api, "create_namespaced_ingress", create_namespaced_ingress
+    )
+    mocker.patch(
+        "codeflare_sdk.utils.openshift_oauth._get_api_host", return_value="foo.com"
+    )
+    replace_namespaced_service_account = MagicMock()
+    replace_cluster_role_binding = MagicMock()
+    replace_namespaced_service = MagicMock()
+    replace_namespaced_ingress = MagicMock()
+    mocker.patch.object(
+        client.CoreV1Api,
+        "replace_namespaced_service_account",
+        replace_namespaced_service_account,
+    )
+    mocker.patch.object(
+        client.RbacAuthorizationV1Api,
+        "replace_cluster_role_binding",
+        replace_cluster_role_binding,
+    )
+    mocker.patch.object(
+        client.CoreV1Api, "replace_namespaced_service", replace_namespaced_service
+    )
+    mocker.patch.object(
+        client.NetworkingV1Api, "replace_namespaced_ingress", replace_namespaced_ingress
+    )
+    create_openshift_oauth_objects("foo", "bar")
+    replace_namespaced_service_account.assert_called_once()
+    replace_cluster_role_binding.assert_called_once()
+    replace_namespaced_service.assert_called_once()
+    replace_namespaced_ingress.assert_called_once()
+
+
+def test_gen_app_wrapper_with_oauth(mocker: MockerFixture):
+    mocker.patch(
+        "codeflare_sdk.utils.generate_yaml._get_api_host", return_value="foo.com"
+    )
+    mocker.patch(
+        "codeflare_sdk.cluster.cluster.get_current_namespace",
+        return_value="opendatahub",
+    )
+    write_user_appwrapper = MagicMock()
+    mocker.patch(
+        "codeflare_sdk.utils.generate_yaml.write_user_appwrapper", write_user_appwrapper
+    )
+    Cluster(ClusterConfiguration("test_cluster", openshift_oauth=True))
+    user_yaml = write_user_appwrapper.call_args.args[0]
+    assert any(
+        container["name"] == "oauth-proxy"
+        for container in user_yaml["spec"]["resources"]["GenericItems"][0][
+            "generictemplate"
+        ]["spec"]["headGroupSpec"]["template"]["spec"]["containers"]
+    )
+
+
 # Make sure to always keep this function last
 def test_cleanup():
     os.remove("unit-test-cluster.yaml")