Linter

Author: hasani-h

src/arcdata/arcdata/azext_arcdata/core/kubernetes.py

@@ -18,7 +18,7 @@
 from http import HTTPStatus
 from knack.log import get_logger
 from kubernetes import client as k8sClient
-from kubernetes import client, config
+from kubernetes import config
 from kubernetes.client.exceptions import ApiException
 from kubernetes.client.rest import ApiException as K8sApiException
 from kubernetes.config.config_exception import ConfigException
@@ -43,10 +43,10 @@ def validate_namespace(cluster_name):
     namespaces = ["default", "kube-system"]
 
     if cluster_name.lower() in namespaces:
-        raise Exception("Cluster name can not be '%s'." % cluster_name)
+        raise ValueError("Cluster name can not be '%s'." % cluster_name)
 
     if not re.match(r"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", cluster_name):
-        raise Exception(
+        raise ValueError(
             "Cluster name '"
             + cluster_name
             + "' is invalid. The name must consist of lowercase alphanumeric "
@@ -347,8 +347,8 @@ def update_private_registry_secret(
                 k8sClient.CoreV1Api().create_namespaced_secret(
                     namespace=cluster_name, body=body
                 )
-            except K8sApiException as e:
-                logger.error(e.body)
+            except K8sApiException as e2:
+                logger.error(e2.body)
                 raise
         else:
             logger.error(e.body)
@@ -586,13 +586,13 @@ def patch_config_map(cluster_name, config_map_name, patch):
         raise
 
 
-def create_secret(cluster_name, config):
+def create_secret(cluster_name, secret_config):
     """
     Creates a secret in Kubernetes
     """
 
     try:
-        body = yaml.safe_load(config)
+        body = yaml.safe_load(secret_config)
         k8sClient.CoreV1Api().create_namespaced_secret(
             namespace=cluster_name, body=body
         )
@@ -801,7 +801,7 @@ def create_namespace_with_retry(
                 retry_on_exceptions=(NewConnectionError, MaxRetryError),
             )
     else:
-        raise Exception(
+        raise RuntimeError(
             "Cluster creation not initiated because the existing "
             "namespace %s "
             'is not empty. Run "kubectl get all -n %s "'
@@ -810,47 +810,61 @@ def create_namespace_with_retry(
         )
 
 
-def validate_rwx_storage_class(name: str, type: str, instanceType: str):
+def validate_rwx_storage_class(name: str, storage_type: str, instance_type: str):
     try:
         config.load_incluster_config()
     except ConfigException:
         config.load_kube_config()
     storageClass = None
-    for s in client.StorageV1Api().list_storage_class().items:
+    for s in k8sClient.StorageV1Api().list_storage_class().items:
         if s.metadata.name == name:
             storageClass = s
 
     if storageClass is None:
-        raise Exception("Storage class '{}' does not exist".format(name))
-    # A generic expression to match storage from list 
+        raise ValueError("Storage class '{}' does not exist".format(name))
+    # A generic expression to match storage from list
     # https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes and usage examples.
     #
     # example references for storage class names:
-    # csi-filestore (https://github.com/kubernetes-sigs/gcp-filestore-csi-driver/blob/45661732bea386a0275851fa5c5364a0486e6467/examples/kubernetes/demo-sc.yaml )
-    # efs-sc (https://docs.aws.amazon.com/eks/latest/userguide/efs-csi.html , https://docs.aws.amazon.com/eks/latest/userguide/efs-csi.html )
-    # quobyte-csi ( https://github.com/quobyte/quobyte-csi/blob/master/example/StorageClass.yaml ) <-- Should update this one in the list from 'quobyte'.
-    # px-shared-sc (https://github.com/portworx/helm/blob/master/charts/portworx/templates/portworx-storageclasses.yaml  and many other places for 'portworx'.)
+    # csi-filestore (
+    #   https://github.com/kubernetes-sigs/gcp-filestore-csi-driver/blob/master/examples/kubernetes/demo-sc.yaml)
+    # efs-sc (https://docs.aws.amazon.com/eks/latest/userguide/efs-csi.html,
+    #         https://docs.aws.amazon.com/eks/latest/userguide/efs-csi.html)
+    # quobyte-csi (https://github.com/quobyte/quobyte-csi/blob/master/example/StorageClass.yaml)
+    #       <-- Should update this one in the list from 'quobyte'.
+    # px-shared-sc (
+    #   https://github.com/portworx/helm/blob/master/charts/portworx/templates/portworx-storageclasses.yaml
+    #   and many other places for 'portworx'.)
     # csi-rbd-sc - (https://docs.ceph.com/en/latest/rbd/rbd-kubernetes/ ) for'ceph'.
-    # glusterfs - (https://docs.openshift.com/container-platform/3.11/install_config/persistent_storage/persistent_storage_glusterfs.html )
+    # glusterfs - (
+    #   https://docs.openshift.com/container-platform/3.11/install_config/
+    #   persistent_storage/persistent_storage_glusterfs.html)
     #
     # example references for volume provisoner names:
-    # vsphere - (https://docs.openshift.com/container-platform/3.11/install_config/persistent_storage/persistent_storage_vsphere.html)
-    # portworx - (https://docs.portworx.com/portworx-install-with-kubernetes/storage-operations/kubernetes-storage-101/volumes/)
+    # vsphere - (
+    #   https://docs.openshift.com/container-platform/3.11/install_config/
+    #   persistent_storage/persistent_storage_vsphere.html)
+    # portworx - (
+    #   https://docs.portworx.com/portworx-install-with-kubernetes/
+    #   storage-operations/kubernetes-storage-101/volumes/)
     # nfs - (https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner),
     # quobyte - (https://www.quobyte.com/kubernetes-storage/connect-k8s-storage-classes-with-quobyte-policy-engine),
-    # gluster - (https://docs.openshift.com/container-platform/3.11/install_config/storage_examples/gluster_dynamic_example.html)
+    # gluster - (
+    #   https://docs.openshift.com/container-platform/3.11/install_config/
+    #   storage_examples/gluster_dynamic_example.html)
     # ceph - (https://docs.ceph.com/en/latest/rbd/rbd-kubernetes/)
     if (
         re.match(
-            r".*(csi-filestore|efs-sc|quobyte-csi|px-shared-sc|csi-rbd-sc|azurefile|azurefile-csi|azurefile-csi-premium|azurefile-premium|nfs).*",
+            r".*(csi-filestore|efs-sc|quobyte-csi|px-shared-sc|csi-rbd-sc|azurefile|"
+            r"azurefile-csi|azurefile-csi-premium|azurefile-premium|nfs).*",
             storageClass.metadata.name,
         )
     ) is None:
         if (
             storageClass.provisioner is None
             or storageClass.provisioner == "kubernetes.io/no-provisioner"
         ):
-            raise Exception(
+            raise RuntimeError(
                 "Storage class '{}' doesn't have a dynamic provisioner configured.".format(
                     name
                 )
@@ -864,8 +878,11 @@ def validate_rwx_storage_class(name: str, type: str, instanceType: str):
                 )
             ) is None:
                 logger.warning(
-                    f"{instanceType} creation will fail if the storage class specified for the '{type}' volume ",
-                    "does not support the ReadWriteMany (RWX) access mode. Please check if the {type} storage class ",
-                    "supports ReadWriteMany (RWX) access mode. ",
-                    "Please see https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes"
+                    "%s creation will fail if the storage class specified for the '%s' volume does not support the "
+                    "ReadWriteMany (RWX) access mode. Please check if the %s storage class supports ReadWriteMany "
+                    "(RWX) access mode. "
+                    "Please see https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes",
+                    instance_type,
+                    storage_type,
+                    storage_type
                 )

src/arcdata/arcdata/azext_arcdata/dc/help.py

@@ -7,7 +7,7 @@
 from knack.help_files import helps
 from azext_arcdata.core.util import get_environment_list_by_target
 
-"""Help documentation for `control` commands."""
+# Help documentation for `control` commands.
 
 
 helps["arcdata"] = (
@@ -76,8 +76,10 @@
             az arcdata dc upgrade --k8s-namespace arc --use-k8s
 """.format(
         short="Upgrade data controller.",
-        long="Upgrade data controller to the desired-version specified.  If desired-version is not specified, an attempt to upgrade to the latest version will be made. "
-        "If you are unsure of the desired version, you may use the list-upgrades command to view available versions, or use the --dry-run argument to show which version would be used",
+        long="Upgrade data controller to the desired-version specified. If desired-version is not specified, "
+        "an attempt to upgrade to the latest version will be made. If you are unsure of the desired version, "
+        "you may use the list-upgrades command to view available versions, "
+        "or use the --dry-run argument to show which version would be used",
         ex1="Data controller upgrade.",
     )
 )
@@ -403,7 +405,8 @@
     long-summary: {long}
 """.format(
         short="Trigger memory dump.",
-        long="Trigger memory dump and copy it out from container - Kubernetes configuration is required on your system.",
+        long="Trigger memory dump and copy it out from container - "
+        "Kubernetes configuration is required on your system.",
     )
 )
 
@@ -415,13 +418,16 @@
     examples:
         - name: {ex1}
           text: >
-            az arcdata dc debug restore-controldb-snapshot -k arc-data-services -f /path/to/backup/controller-1675653451.bak
+            az arcdata dc debug restore-controldb-snapshot -k arc-data-services
+            -f /path/to/backup/controller-1675653451.bak
         - name: {ex2}
           text: >
-            az arcdata dc debug restore-controldb-snapshot -k arc-data-services -f C:\\path\\to\\backup\\controller-1675653451.bak
+            az arcdata dc debug restore-controldb-snapshot -k arc-data-services
+            -f C:\\path\\to\\backup\\controller-1675653451.bak
 """.format(
         short="Restores a unique copy of ControlDB from backup - for troubleshooting purposes only.",
-        long="Restores a COPY_ONLY backup of ControlDB under a unique name for troubleshooting - Kubernetes configuration is required on your system.",
+        long="Restores a COPY_ONLY backup of ControlDB under a unique name for troubleshooting - "
+        "Kubernetes configuration is required on your system.",
         ex1="Linux - Restore a backup taken from a previously run 'arcdata dc debug copy-logs' command.",
         ex2="Windows - Restore a backup taken from a previously run 'arcdata dc debug copy-logs' command.",
     )
@@ -441,7 +447,8 @@
             az arcdata dc debug controldb-cdc -k arc-data-services --enable false
 """.format(
         short="Enable/disable CDC on Data Controller Database and Tables - for troubleshooting purposes only.",
-        long="Enable/Disable Change Data Capture for 'controller' Database and supported tables with configurable retention hours.",
+        long="Enable/Disable Change Data Capture for 'controller' Database and "
+        "supported tables with configurable retention hours.",
         ex1="Enables Change Data Capture with 4 hours of retention.",
         ex2="Disables Change Data Capture.",
     )

src/arcdata/arcdata/azext_arcdata/dc/validators.py

@@ -6,17 +6,14 @@
 
 from azure.cli.core.azclierror import (
     ArgumentUsageError,
-    MutuallyExclusiveArgumentError,
     ValidationError,
 )
-import azext_arcdata.core.common_validators as validators
-import os
-from azext_arcdata.vendored_sdks.kubernetes_sdk.dc.constants import CONFIG_DIR
-import json
-import pydash as _
 from azext_arcdata.vendored_sdks.kubernetes_sdk.arc_docker_image_service import (
     ArcDataImageService,
 )
+import azext_arcdata.core.common_validators as validators
+import os
+import pydash as _
 
 
 def force_indirect(namespace):
@@ -87,11 +84,11 @@ def validate_delete(namespace):
 
 
 def validate_controldb_cdc_retention(namespace):
-    min = 1
-    max = 24
-    if not (min <= namespace.retention_hours <= max):
+    min_hrs = 1
+    max_hrs = 24
+    if not (min_hrs <= namespace.retention_hours <= max_hrs):
         raise ArgumentUsageError(
-            f"ControlDB Change Data Capture retention hours must be between {min} and {max}."
+            f"ControlDB Change Data Capture retention hours must be between {min_hrs} and {max_hrs}."
         )
     force_indirect(namespace)
 
@@ -222,7 +219,7 @@ def validate_client_version_for_upgrade(command_values):
         command_values.desired_version
     ):
         raise ValueError(
-            f"The desired version {command_values.desired_version} is not supported by this version of the ArcData CLI extension. "
-            "Please upgrade the extension using the following command and try again: "
+            f"The desired version {command_values.desired_version} is not supported by this version of the "
+            "ArcData CLI extension. Please upgrade the extension using the following command and try again: "
             "\naz extension update -n arcdata"
         )

src/arcdata/arcdata/azext_arcdata/failover_group/util.py

@@ -7,7 +7,7 @@
 
 import time
 from azext_arcdata.core.util import retry
-from azext_arcdata.failover_group.models.fog_cr import FogCustomResource
+from src.arcdata.arcdata.azext_arcdata.vendored_sdks.kubernetes_sdk.models.fog_cr import FogCustomResource
 from azext_arcdata.vendored_sdks.kubernetes_sdk.models.custom_resource import CustomResource
 from azext_arcdata.core.constants import ARC_API_V1BETA2
 from azext_arcdata.vendored_sdks.kubernetes_sdk.client import (

src/arcdata/arcdata/azext_arcdata/sqlmi/custom.py

@@ -312,7 +312,7 @@ def arc_sql_mi_create(
 
         if storage_class_backups is not None:
             kubernetes_util.validate_rwx_storage_class(
-                name=storage_class_backups, type="backup", instanceType="SQLMI"
+                name=storage_class_backups, storage_type="backup", instance_type="SQLMI"
             )
 
         # if readable_secondaries is not set. use default value

src/arcdata/arcdata/azext_arcdata/vendored_sdks/kubernetes_sdk/failover_group/client.py

@@ -28,7 +28,7 @@
     FOG_RESOURCE_KIND,
     FOG_RESOURCE_KIND_PLURAL,
 )
-from azext_arcdata.failover_group.models.fog_cr import FogCustomResource
+from src.arcdata.arcdata.azext_arcdata.vendored_sdks.kubernetes_sdk.models.fog_cr import FogCustomResource
 from azext_arcdata.vendored_sdks.kubernetes_sdk.util import is_valid_connectivity_mode
 from src.arcdata.arcdata.azext_arcdata.vendored_sdks.kubernetes_sdk.models.sqlmi_cr_model import SqlmiCustomResource
 from azext_arcdata.sqlmi.sqlmi_utilities import get_sqlmi_custom_resource

…_arcdata/failover_group/models/fog_cr.py …red_sdks/kubernetes_sdk/models/fog_cr.pysrc/arcdata/arcdata/azext_arcdata/failover_group/models/fog_cr.py renamed to src/arcdata/arcdata/azext_arcdata/vendored_sdks/kubernetes_sdk/models/fog_cr.py src/arcdata/arcdata/azext_arcdata/failover_group/models/fog_cr.py renamed to src/arcdata/arcdata/azext_arcdata/vendored_sdks/kubernetes_sdk/models/fog_cr.py

@@ -8,7 +8,7 @@
 from azext_arcdata.vendored_sdks.kubernetes_sdk.models import (
     CustomResource,
 )
-from azext_arcdata.failover_group.models.fog_replica import FogReplica
+from src.arcdata.arcdata.azext_arcdata.vendored_sdks.kubernetes_sdk.models.fog_replica import FogReplica
 
 
 class FogCustomResource(CustomResource):

…ata/failover_group/models/fog_replica.py …dks/kubernetes_sdk/models/fog_replica.pysrc/arcdata/arcdata/azext_arcdata/failover_group/models/fog_replica.py renamed to src/arcdata/arcdata/azext_arcdata/vendored_sdks/kubernetes_sdk/models/fog_replica.py src/arcdata/arcdata/azext_arcdata/failover_group/models/fog_replica.py renamed to src/arcdata/arcdata/azext_arcdata/vendored_sdks/kubernetes_sdk/models/fog_replica.py

@@ -1785,8 +1785,8 @@ def _validate_backup_storage(
                 try:
                     validate_rwx_storage_class(
                         name=v.class_name,
-                        type="backup",
-                        instanceType="Postgres",
+                        storage_type="backup",
+                        instance_type="Postgres",
                     )
                 except Exception as e:
                     raise CLIError(