Merge pull request #5 from silogen/refactor/better-internal-config

General deduplication of function arguments

Author: johannes-graner

codehub/cli/config.py

@@ -1,5 +1,7 @@
+from dataclasses import dataclass
 import os
 from pathlib import Path
+from typing import Optional
 
 
 ROOT = Path(__file__).parents[2]
@@ -34,3 +36,55 @@
 SLEEP_THRESHOLD = 600
 TIMEOUT_ERROR = "Timeout expired."
 CLUSTER_MAX_LEN = 14
+
+
+@dataclass
+class CloudState:
+    nfs_ip: str
+    nfs_name: str
+    cluster_id: str
+    hub_sa_key: str
+    cluster_endpoint: str
+    cluster_cert: str
+    gcp_token: str
+    docker_registry_hostname: str
+    docker_image: str
+
+
+@dataclass
+class OAuthConfig:
+    client_id: str
+    client_secret: str
+
+
+@dataclass
+class HubConfig:
+    admins: list[str]
+    https: Optional[str] = None
+    oauth_config: Optional[OAuthConfig] = None
+    contact_email: Optional[str] = None
+
+
+@dataclass
+class CreateConfig:
+    name: str
+    admins: list[str]
+    region: str
+    zone: str
+    machine_type: str
+
+
+@dataclass
+class UpgradeConfig:
+    name: str
+    hub_config: HubConfig
+
+
+@dataclass
+class DeployConfig:
+    name: str
+    region: str
+    helm_dir: str
+    hub_dir: str
+    k8s_dir: str
+    cloud_state: CloudState

codehub/cli/create.py

@@ -3,102 +3,80 @@
 import logging
 import json
 from codehub.cli.gcp.terraform import (
-    TerraformOutput,
     setup_terraform,
     terraform_apply,
     terraform_output,
 )
 from distutils.dir_util import copy_tree
-from codehub.cli.config import STRUCTURE
+from codehub.cli.config import (
+    STRUCTURE,
+    CreateConfig,
+    DeployConfig,
+    HubConfig,
+    UpgradeConfig,
+)
 from codehub.cli.gcp.helpers import authenticate_k8s_GKE
 from codehub.cli.k8s.create import create_k8s_resources
 from codehub.cli.helm.create import create_deploy
-from codehub.cli.helm.install import install_helm_chart, upgrade_helm_chart
+from codehub.cli.helm.install import install_helm_chart
 from codehub.cli.helpers import get_cloud_dir, get_latest_deployment, read_yaml
-from codehub.cli.manage import wait_for_hub_to_get_ready, get_ip
+from codehub.cli.manage import wait_for_hub_to_get_ready
 import kubernetes.client.rest  # Add this import for the exception handling
 
 
-def create_infrastructure(name, region, zone, machine_type):
-    _, _, k8s_dir, cloud_dir = __create_deploy_structure(name)
+def create_infrastructure(config: CreateConfig) -> DeployConfig:
+    helm_dir, hub_dir, k8s_dir, cloud_dir = __create_deploy_structure(config.name)
 
     setup_terraform(
-        cluster_name=name,
-        region=region,
-        zone=zone,
-        machine_type=machine_type,
+        config=config,
         cloud_dir=cloud_dir,
     )
 
-    cloud_config = terraform_apply(cloud_dir=cloud_dir)
-    __create_k8s_resources(
-        name,
-        deploy_dir=k8s_dir,
-        nfs_name=cloud_config.nfs_name,
-        nfs_ip=cloud_config.nfs_ip,
+    cloud_state = terraform_apply(cloud_dir=cloud_dir)
+    deploy_config = DeployConfig(
+        config.name, config.region, helm_dir, hub_dir, k8s_dir, cloud_state
     )
+    __create_k8s_resources(deploy_config)
 
-    return get_ip(name, k8s_dir)
+    return deploy_config
 
 
-def create(name, admins, region, zone, machine_type):
-    helm_dir, hub_dir, k8s_dir, cloud_dir = __create_deploy_structure(name)
+def create(config: CreateConfig) -> DeployConfig:
+    deploy_config = create_infrastructure(config)
+    hub_config = HubConfig(config.admins)
 
-    setup_terraform(
-        cluster_name=name,
-        region=region,
-        zone=zone,
-        machine_type=machine_type,
-        cloud_dir=cloud_dir,
-    )
+    __create_k8s_resources(deploy_config)
 
-    cloud_state = terraform_apply(cloud_dir=cloud_dir)
-    __create_k8s_resources(
-        name,
-        deploy_dir=k8s_dir,
-        nfs_name=cloud_state.nfs_name,
-        nfs_ip=cloud_state.nfs_ip,
-    )
-
-    __install_helm_chart(
-        name,
-        region=region,
-        helm_deploy_dir=helm_dir,
-        hub_deploy_dir=hub_dir,
-        cloud_state=cloud_state,
-        admins=admins,
-    )
+    __create_deploy(deploy_config, hub_config)
+    install_helm_chart(deploy_config, upgrade=False)
 
-    wait_for_hub_to_get_ready(k8s_dir)
+    wait_for_hub_to_get_ready(deploy_config.k8s_dir)
 
-    return get_ip(name, k8s_dir)
+    return deploy_config
 
 
-def upgrade(name, admins, https=None, client_id=None, client_secret=None):
-    old_deploy_dir = get_latest_deployment(name=name)
+def upgrade(config: UpgradeConfig):
+    old_deploy_dir = get_latest_deployment(config.name)
 
     helm_dir, hub_dir, k8s_dir, cloud_dir = __upgrade_deploy_structure(
-        name, old_deploy_dir
+        config.name, old_deploy_dir
     )
     cloud_state = terraform_output(cloud_dir=cloud_dir)
 
-    last_helm_install = read_yaml(os.path.join(old_deploy_dir, "helm", "chart.yaml"))[
-        "install"
+    region = read_yaml(os.path.join(old_deploy_dir, "helm", "chart.yaml"))["install"][
+        "region"
     ]
+    deploy_config = DeployConfig(
+        config.name, region, helm_dir, hub_dir, k8s_dir, cloud_state
+    )
 
-    __upgrade_helm_chart(
-        name,
-        region=last_helm_install["region"],
-        helm_deploy_dir=helm_dir,
-        hub_deploy_dir=hub_dir,
-        cloud_state=cloud_state,
-        admins=admins,
-        https=https,
-        client_id=client_id,
-        client_secret=client_secret,
+    __create_deploy(
+        deploy_config,
+        config.hub_config,
     )
+    install_helm_chart(deploy_config, upgrade=True)
 
-    authenticate_k8s_GKE(name)
+    authenticate_k8s_GKE(config.name)
     wait_for_hub_to_get_ready(k8s_dir)
 
 
@@ -136,10 +114,10 @@ def __upgrade_deploy_structure(name, old_deploy_dir):
     return helm_dir, hub_dir, k8s_dir, cloud_dir
 
 
-def __create_k8s_resources(name, deploy_dir, nfs_name, nfs_ip):
-    authenticate_k8s_GKE(name)
+def __create_k8s_resources(deploy_config: DeployConfig):
+    authenticate_k8s_GKE(deploy_config.name)
     try:
-        create_k8s_resources(deploy_dir, nfs_name, nfs_ip)
+        create_k8s_resources(deploy_config)
     except kubernetes.client.rest.ApiException as e:
         logger = logging.getLogger(__name__)
         # If the error is due to a resource already existing, we can continue
@@ -150,72 +128,11 @@ def __create_k8s_resources(name, deploy_dir, nfs_name, nfs_ip):
             raise
 
 
-def __install_helm_chart(
-    name,
-    region,
-    helm_deploy_dir,
-    hub_deploy_dir,
-    cloud_state: TerraformOutput,
-    admins,
-):
-    __create_deploy(name, helm_deploy_dir, hub_deploy_dir, cloud_state, admins)
-    install_helm_chart(
-        name,
-        region=region,
-        helm_deploy_dir=helm_deploy_dir,
-        hub_deploy_dir=hub_deploy_dir,
-    )
-
-
-def __upgrade_helm_chart(
-    name,
-    region,
-    helm_deploy_dir,
-    hub_deploy_dir,
-    cloud_state: TerraformOutput,
-    admins,
-    https=None,
-    client_id=None,
-    client_secret=None,
-):
-    __create_deploy(
-        name,
-        helm_deploy_dir,
-        hub_deploy_dir,
-        cloud_state=cloud_state,
-        admins=admins,
-        https=https,
-        client_id=client_id,
-        client_secret=client_secret,
-    )
-
-    upgrade_helm_chart(
-        name, region, helm_deploy_dir=helm_deploy_dir, hub_deploy_dir=hub_deploy_dir
-    )
-
-
 def __create_deploy(
-    name,
-    helm_deploy_dir,
-    hub_deploy_dir,
-    cloud_state: TerraformOutput,
-    admins,
-    https=None,
-    client_id=None,
-    client_secret=None,
+    deploy_config: DeployConfig,
+    hub_config: HubConfig,
 ):
-    contact_email = None
     with open(STRUCTURE["secrets"]["gcp"]["sa"], "rt") as f:
-        contact_email = json.loads(f.read())["client_email"]
-
-    create_deploy(
-        name,
-        contact_email=contact_email,
-        admins=admins,
-        helm_deploy_dir=helm_deploy_dir,
-        hub_deploy_dir=hub_deploy_dir,
-        cloud_state=cloud_state,
-        https=https,
-        client_id=client_id,
-        client_secret=client_secret,
-    )
+        hub_config.contact_email = json.loads(f.read())["client_email"]
+
+    create_deploy(deploy_config, hub_config)

codehub/cli/entrypoint.py

@@ -1,6 +1,8 @@
+from typing import Optional
 import click
 import logging
 import sys
+from codehub.cli.config import CreateConfig, HubConfig, OAuthConfig, UpgradeConfig
 from codehub.cli.create import create, upgrade, scale, create_infrastructure
 from codehub.cli.delete import delete
 from codehub.cli.helpers import check_commands, validate_cluster_name, check_credentials
@@ -37,15 +39,11 @@ def createcluster(name, admin, region, zone, machine_type):
     logger = logging.getLogger(__name__)
     logger.info(f"Creating cluster '{name}'")
 
-    admins = [i.lower() for i in admin]
+    admins = [user.lower() for user in admin]
+    config = CreateConfig(name, admins, region, zone, machine_type)
 
-    res = create(
-        name=name,
-        admins=admins,
-        region=region,
-        zone=zone,
-        machine_type=machine_type,
-    )
+    deploy_config = create(config)
+    res = get_ip(name, deploy_config.k8s_dir)
 
     logger.debug(f"{create.__module__}.{create.__name__} output:")
     logger.debug(res)
@@ -64,32 +62,31 @@ def upgradecluster(name, admin, https=None, client_id=None, client_secret=None):
     logger = logging.getLogger(__name__)
     logger.info(f"Updating cluster '{name}'")
 
-    https_passed = https is not None
-    client_id_passed = client_id is not None
-    client_secret_passed = client_secret is not None
-    passed_correct_args = https_passed and (client_id_passed is client_secret_passed)
-    passed_no_args = not https_passed and not (client_id_passed or client_secret_passed)
+    hub_config = HubConfig([i.lower() for i in admin])
 
-    admins = [i.lower() for i in admin]
+    if https is not None:
+        hub_config.https = https
+        if client_id and client_secret:
+            hub_config.oauth_config = OAuthConfig(
+                client_id=client_id, client_secret=client_secret
+            )
+        # None or both need to be passed
+        elif client_id or client_secret:
+            raise ValueError(
+                "To add oauth you need to pass the following arguments\n"
+                + "`--https` <host-name>\n"
+                + "`--client-id` <github-client-id>\n"
+                + "`--client-secret` <github-client-secret>"
+            )
 
-    if passed_correct_args or passed_no_args:
-        res = upgrade(
-            name=name,
-            admins=admins,
-            https=https,
-            client_id=client_id,
-            client_secret=client_secret,
-        )
+    config = UpgradeConfig(name, hub_config)
 
-        logger.debug(f"{upgrade.__module__}.{upgrade.__name__} output:")
-        logger.debug(res)
+    res = upgrade(config)
 
-        logger.info(f"Cluster '{name}' upgraded successfully")
-    else:
-        logger.warning("To add oauth you need to pass the following arguments")
-        logger.warning("`--https` <host-name>")
-        logger.warning("`--client-id` <github-client-id>")
-        logger.warning("`--client-secret` <github-client-secret>")
+    logger.debug(f"{upgrade.__module__}.{upgrade.__name__} output:")
+    logger.debug(res)
+
+    logger.info(f"Cluster '{name}' upgraded successfully")
 
 
 @cli.command()
@@ -153,12 +150,11 @@ def createclusterinfra(name, region, zone, machine_type):
     logger = logging.getLogger(__name__)
     logger.info(f"Creating cluster '{name}'")
 
-    res = create_infrastructure(
-        name=name,
-        region=region,
-        zone=zone,
-        machine_type=machine_type,
-    )
+    admins = []
+    config = CreateConfig(name, admins, region, zone, machine_type)
+
+    deploy_config = create_infrastructure(config)
+    res = get_ip(name, deploy_config.k8s_dir)
 
     logger.debug(f"{create.__module__}.{create.__name__} output:")
     logger.debug(res)